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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v8.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: "v8"
  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/v8
  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/v8/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/v8/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/v8/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/v8/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/v8/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 and clients should expect changes                  to occur in the future to this field as ASDC 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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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/v8/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: pserver-id
8383           in: query
8384           description: ID of Pserver
8385           required: false
8386           type: string
8387         - name: in-maint
8388           in: query
8389           required: false
8390           type: boolean
8391         - name: pserver-name2
8392           in: query
8393           description: alternative pserver name
8394           required: false
8395           type: string
8396         - name: interface-id
8397           in: query
8398           description: ID of interface
8399           required: false
8400           type: string
8401         - name: macaddr
8402           in: query
8403           description: MAC address for the interface
8404           required: false
8405           type: string
8406         - name: network-name
8407           in: query
8408           description: Name of the network
8409           required: false
8410           type: string
8411         - name: vlan-id-inner
8412           in: query
8413           description: Inner VLAN tag
8414           required: false
8415           type: integer
8416           format: int64
8417         - name: vpn-id
8418           in: query
8419           description: This indicates the customers VPN ID associated with this vlan
8420           required: false
8421           type: string
8422         - name: vlan-id-inner
8423           in: query
8424           description: Inner VLAN tag
8425           required: false
8426           type: integer
8427           format: int64
8428         - name: neutron-network-id
8429           in: query
8430           description: Neutron network id of the interface that address belongs to
8431           required: false
8432           type: string
8433         - name: neutron-subnet-id
8434           in: query
8435           description: Neutron id of subnet that address belongs to
8436           required: false
8437           type: string
8438     put:
8439       tags:
8440         - CloudInfrastructure
8441       summary: create or update an existing l3-interface-ipv4-address-list
8442       description: |
8443         Create or update an existing l3-interface-ipv4-address-list.
8444         #
8445         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
8446       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8447       consumes:
8448         - application/json
8449         - application/xml
8450       produces:
8451         - application/json
8452         - application/xml
8453       responses:
8454         "default":
8455           description: Response codes found in [response codes](https://wiki.onap.org/).
8456       parameters:
8457         - name: hostname
8458           in: path
8459           description: Value from executing hostname on the compute node.
8460           required: true
8461           type: string
8462           example: __HOSTNAME__
8463         - name: interface-name
8464           in: path
8465           description: Name that identifies the physical interface
8466           required: true
8467           type: string
8468           example: __INTERFACE-NAME__
8469         - name: interface-name
8470           in: path
8471           description: Name given to the interface
8472           required: true
8473           type: string
8474           example: __INTERFACE-NAME__
8475         - name: vlan-interface
8476           in: path
8477           description: String that identifies the interface
8478           required: true
8479           type: string
8480           example: __VLAN-INTERFACE__
8481         - name: l3-interface-ipv4-address
8482           in: path
8483           description: IP address
8484           required: true
8485           type: string
8486           example: __L3-INTERFACE-IPV4-ADDRESS__
8487         - name: body
8488           in: body
8489           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8490           required: true
8491           schema:
8492             $ref: "#/definitions/l3-interface-ipv4-address-list"
8493     patch:
8494       tags:
8495         - CloudInfrastructure
8496       summary: update an existing l3-interface-ipv4-address-list
8497       description: |
8498         Update an existing l3-interface-ipv4-address-list
8499         #
8500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8501         The PUT operation will entirely replace an existing object.
8502         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.
8503         #
8504         Other differences between PUT and PATCH are:
8505         #
8506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8509       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8510       consumes:
8511         - application/json
8512         - application/xml
8513       produces:
8514         - application/json
8515         - application/xml
8516       responses:
8517         "default":
8518           description: Response codes found in [response codes](https://wiki.onap.org/).
8519       parameters:
8520         - name: hostname
8521           in: path
8522           description: Value from executing hostname on the compute node.
8523           required: true
8524           type: string
8525           example: __HOSTNAME__
8526         - name: interface-name
8527           in: path
8528           description: Name that identifies the physical interface
8529           required: true
8530           type: string
8531           example: __INTERFACE-NAME__
8532         - name: interface-name
8533           in: path
8534           description: Name given to the interface
8535           required: true
8536           type: string
8537           example: __INTERFACE-NAME__
8538         - name: vlan-interface
8539           in: path
8540           description: String that identifies the interface
8541           required: true
8542           type: string
8543           example: __VLAN-INTERFACE__
8544         - name: l3-interface-ipv4-address
8545           in: path
8546           description: IP address
8547           required: true
8548           type: string
8549           example: __L3-INTERFACE-IPV4-ADDRESS__
8550         - name: body
8551           in: body
8552           description: l3-interface-ipv4-address-list object that needs to be created or updated.
8553           required: true
8554           schema:
8555             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8556     delete:
8557       tags:
8558         - CloudInfrastructure
8559       summary: delete an existing l3-interface-ipv4-address-list
8560       description: delete an existing l3-interface-ipv4-address-list
8561       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8562       consumes:
8563         - application/json
8564         - application/xml
8565       produces:
8566         - application/json
8567         - application/xml
8568       responses:
8569         "default":
8570           description: Response codes found in [response codes](https://wiki.onap.org/).
8571       parameters:
8572         - name: hostname
8573           in: path
8574           description: Value from executing hostname on the compute node.
8575           required: true
8576           type: string
8577           example: __HOSTNAME__
8578         - name: interface-name
8579           in: path
8580           description: Name that identifies the physical interface
8581           required: true
8582           type: string
8583           example: __INTERFACE-NAME__
8584         - name: interface-name
8585           in: path
8586           description: Name given to the interface
8587           required: true
8588           type: string
8589           example: __INTERFACE-NAME__
8590         - name: vlan-interface
8591           in: path
8592           description: String that identifies the interface
8593           required: true
8594           type: string
8595           example: __VLAN-INTERFACE__
8596         - name: l3-interface-ipv4-address
8597           in: path
8598           description: IP address
8599           required: true
8600           type: string
8601           example: __L3-INTERFACE-IPV4-ADDRESS__
8602         - name: resource-version
8603           in: query
8604           description: resource-version for concurrency
8605           required: true
8606           type: string
8607   /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:
8608     put:
8609       tags:
8610         - CloudInfrastructure
8611       summary: see node definition for valid relationships
8612       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8613       consumes:
8614         - application/json
8615         - application/xml
8616       produces:
8617         - application/json
8618         - application/xml
8619       responses:
8620         "default":
8621           description: Response codes found in [response codes](https://wiki.onap.org/).
8622       parameters:
8623         - name: hostname
8624           in: path
8625           description: Value from executing hostname on the compute node.
8626           required: true
8627           type: string
8628           example: __HOSTNAME__
8629         - name: interface-name
8630           in: path
8631           description: Name that identifies the physical interface
8632           required: true
8633           type: string
8634           example: __INTERFACE-NAME__
8635         - name: interface-name
8636           in: path
8637           description: Name given to the interface
8638           required: true
8639           type: string
8640           example: __INTERFACE-NAME__
8641         - name: vlan-interface
8642           in: path
8643           description: String that identifies the interface
8644           required: true
8645           type: string
8646           example: __VLAN-INTERFACE__
8647         - name: l3-interface-ipv6-address
8648           in: path
8649           description: IP address
8650           required: true
8651           type: string
8652           example: __L3-INTERFACE-IPV6-ADDRESS__
8653         - name: body
8654           in: body
8655           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8656           required: true
8657           schema:
8658             $ref: "#/definitions/relationship"
8659     delete:
8660       tags:
8661         - CloudInfrastructure
8662       summary: delete an existing relationship
8663       description: delete an existing relationship
8664       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8665       consumes:
8666         - application/json
8667         - application/xml
8668       produces:
8669         - application/json
8670         - application/xml
8671       responses:
8672         "default":
8673           description: Response codes found in [response codes](https://wiki.onap.org/).
8674       parameters:
8675         - name: hostname
8676           in: path
8677           description: Value from executing hostname on the compute node.
8678           required: true
8679           type: string
8680           example: __HOSTNAME__
8681         - name: interface-name
8682           in: path
8683           description: Name that identifies the physical interface
8684           required: true
8685           type: string
8686           example: __INTERFACE-NAME__
8687         - name: interface-name
8688           in: path
8689           description: Name given to the interface
8690           required: true
8691           type: string
8692           example: __INTERFACE-NAME__
8693         - name: vlan-interface
8694           in: path
8695           description: String that identifies the interface
8696           required: true
8697           type: string
8698           example: __VLAN-INTERFACE__
8699         - name: l3-interface-ipv6-address
8700           in: path
8701           description: IP address
8702           required: true
8703           type: string
8704           example: __L3-INTERFACE-IPV6-ADDRESS__
8705   /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}:
8706     get:
8707       tags:
8708         - CloudInfrastructure
8709       summary: returns l3-interface-ipv6-address-list
8710       description: returns l3-interface-ipv6-address-list
8711       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8712       produces:
8713         - application/json
8714         - application/xml
8715       responses:
8716         "200":
8717           description: successful operation
8718           schema:
8719               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8720         "default":
8721           description: Response codes found in [response codes](https://wiki.onap.org/).
8722       parameters:
8723         - name: hostname
8724           in: path
8725           description: Value from executing hostname on the compute node.
8726           required: true
8727           type: string
8728           example: __HOSTNAME__
8729         - name: interface-name
8730           in: path
8731           description: Name that identifies the physical interface
8732           required: true
8733           type: string
8734           example: __INTERFACE-NAME__
8735         - name: interface-name
8736           in: path
8737           description: Name given to the interface
8738           required: true
8739           type: string
8740           example: __INTERFACE-NAME__
8741         - name: vlan-interface
8742           in: path
8743           description: String that identifies the interface
8744           required: true
8745           type: string
8746           example: __VLAN-INTERFACE__
8747         - name: l3-interface-ipv6-address
8748           in: path
8749           description: IP address
8750           required: true
8751           type: string
8752           example: __L3-INTERFACE-IPV6-ADDRESS__
8753         - name: pserver-id
8754           in: query
8755           description: ID of Pserver
8756           required: false
8757           type: string
8758         - name: in-maint
8759           in: query
8760           required: false
8761           type: boolean
8762         - name: pserver-name2
8763           in: query
8764           description: alternative pserver name
8765           required: false
8766           type: string
8767         - name: interface-id
8768           in: query
8769           description: ID of interface
8770           required: false
8771           type: string
8772         - name: macaddr
8773           in: query
8774           description: MAC address for the interface
8775           required: false
8776           type: string
8777         - name: network-name
8778           in: query
8779           description: Name of the network
8780           required: false
8781           type: string
8782         - name: vlan-id-inner
8783           in: query
8784           description: Inner VLAN tag
8785           required: false
8786           type: integer
8787           format: int64
8788         - name: vpn-id
8789           in: query
8790           description: This indicates the customers VPN ID associated with this vlan
8791           required: false
8792           type: string
8793         - name: vlan-id-inner
8794           in: query
8795           description: Inner VLAN tag
8796           required: false
8797           type: integer
8798           format: int64
8799         - name: neutron-network-id
8800           in: query
8801           description: Neutron network id of the interface that address belongs to
8802           required: false
8803           type: string
8804         - name: neutron-subnet-id
8805           in: query
8806           description: Neutron id of subnet that address belongs to
8807           required: false
8808           type: string
8809     put:
8810       tags:
8811         - CloudInfrastructure
8812       summary: create or update an existing l3-interface-ipv6-address-list
8813       description: |
8814         Create or update an existing l3-interface-ipv6-address-list.
8815         #
8816         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
8817       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8818       consumes:
8819         - application/json
8820         - application/xml
8821       produces:
8822         - application/json
8823         - application/xml
8824       responses:
8825         "default":
8826           description: Response codes found in [response codes](https://wiki.onap.org/).
8827       parameters:
8828         - name: hostname
8829           in: path
8830           description: Value from executing hostname on the compute node.
8831           required: true
8832           type: string
8833           example: __HOSTNAME__
8834         - name: interface-name
8835           in: path
8836           description: Name that identifies the physical interface
8837           required: true
8838           type: string
8839           example: __INTERFACE-NAME__
8840         - name: interface-name
8841           in: path
8842           description: Name given to the interface
8843           required: true
8844           type: string
8845           example: __INTERFACE-NAME__
8846         - name: vlan-interface
8847           in: path
8848           description: String that identifies the interface
8849           required: true
8850           type: string
8851           example: __VLAN-INTERFACE__
8852         - name: l3-interface-ipv6-address
8853           in: path
8854           description: IP address
8855           required: true
8856           type: string
8857           example: __L3-INTERFACE-IPV6-ADDRESS__
8858         - name: body
8859           in: body
8860           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8861           required: true
8862           schema:
8863             $ref: "#/definitions/l3-interface-ipv6-address-list"
8864     patch:
8865       tags:
8866         - CloudInfrastructure
8867       summary: update an existing l3-interface-ipv6-address-list
8868       description: |
8869         Update an existing l3-interface-ipv6-address-list
8870         #
8871         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8872         The PUT operation will entirely replace an existing object.
8873         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.
8874         #
8875         Other differences between PUT and PATCH are:
8876         #
8877         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8878         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8879         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8880       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8881       consumes:
8882         - application/json
8883         - application/xml
8884       produces:
8885         - application/json
8886         - application/xml
8887       responses:
8888         "default":
8889           description: Response codes found in [response codes](https://wiki.onap.org/).
8890       parameters:
8891         - name: hostname
8892           in: path
8893           description: Value from executing hostname on the compute node.
8894           required: true
8895           type: string
8896           example: __HOSTNAME__
8897         - name: interface-name
8898           in: path
8899           description: Name that identifies the physical interface
8900           required: true
8901           type: string
8902           example: __INTERFACE-NAME__
8903         - name: interface-name
8904           in: path
8905           description: Name given to the interface
8906           required: true
8907           type: string
8908           example: __INTERFACE-NAME__
8909         - name: vlan-interface
8910           in: path
8911           description: String that identifies the interface
8912           required: true
8913           type: string
8914           example: __VLAN-INTERFACE__
8915         - name: l3-interface-ipv6-address
8916           in: path
8917           description: IP address
8918           required: true
8919           type: string
8920           example: __L3-INTERFACE-IPV6-ADDRESS__
8921         - name: body
8922           in: body
8923           description: l3-interface-ipv6-address-list object that needs to be created or updated.
8924           required: true
8925           schema:
8926             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
8927     delete:
8928       tags:
8929         - CloudInfrastructure
8930       summary: delete an existing l3-interface-ipv6-address-list
8931       description: delete an existing l3-interface-ipv6-address-list
8932       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8933       consumes:
8934         - application/json
8935         - application/xml
8936       produces:
8937         - application/json
8938         - application/xml
8939       responses:
8940         "default":
8941           description: Response codes found in [response codes](https://wiki.onap.org/).
8942       parameters:
8943         - name: hostname
8944           in: path
8945           description: Value from executing hostname on the compute node.
8946           required: true
8947           type: string
8948           example: __HOSTNAME__
8949         - name: interface-name
8950           in: path
8951           description: Name that identifies the physical interface
8952           required: true
8953           type: string
8954           example: __INTERFACE-NAME__
8955         - name: interface-name
8956           in: path
8957           description: Name given to the interface
8958           required: true
8959           type: string
8960           example: __INTERFACE-NAME__
8961         - name: vlan-interface
8962           in: path
8963           description: String that identifies the interface
8964           required: true
8965           type: string
8966           example: __VLAN-INTERFACE__
8967         - name: l3-interface-ipv6-address
8968           in: path
8969           description: IP address
8970           required: true
8971           type: string
8972           example: __L3-INTERFACE-IPV6-ADDRESS__
8973         - name: resource-version
8974           in: query
8975           description: resource-version for concurrency
8976           required: true
8977           type: string
8978   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8979     get:
8980       tags:
8981         - CloudInfrastructure
8982       summary: returns vlan
8983       description: returns vlan
8984       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
8985       produces:
8986         - application/json
8987         - application/xml
8988       responses:
8989         "200":
8990           description: successful operation
8991           schema:
8992               $ref: "#/getDefinitions/vlan"
8993         "default":
8994           description: Response codes found in [response codes](https://wiki.onap.org/).
8995       parameters:
8996         - name: hostname
8997           in: path
8998           description: Value from executing hostname on the compute node.
8999           required: true
9000           type: string
9001           example: __HOSTNAME__
9002         - name: interface-name
9003           in: path
9004           description: Name that identifies the physical interface
9005           required: true
9006           type: string
9007           example: __INTERFACE-NAME__
9008         - name: interface-name
9009           in: path
9010           description: Name given to the interface
9011           required: true
9012           type: string
9013           example: __INTERFACE-NAME__
9014         - name: vlan-interface
9015           in: path
9016           description: String that identifies the interface
9017           required: true
9018           type: string
9019           example: __VLAN-INTERFACE__
9020         - name: pserver-id
9021           in: query
9022           description: ID of Pserver
9023           required: false
9024           type: string
9025         - name: in-maint
9026           in: query
9027           required: false
9028           type: boolean
9029         - name: pserver-name2
9030           in: query
9031           description: alternative pserver name
9032           required: false
9033           type: string
9034         - name: interface-id
9035           in: query
9036           description: ID of interface
9037           required: false
9038           type: string
9039         - name: macaddr
9040           in: query
9041           description: MAC address for the interface
9042           required: false
9043           type: string
9044         - name: network-name
9045           in: query
9046           description: Name of the network
9047           required: false
9048           type: string
9049         - name: vlan-id-inner
9050           in: query
9051           description: Inner VLAN tag
9052           required: false
9053           type: integer
9054           format: int64
9055         - name: vpn-id
9056           in: query
9057           description: This indicates the customers VPN ID associated with this vlan
9058           required: false
9059           type: string
9060     put:
9061       tags:
9062         - CloudInfrastructure
9063       summary: create or update an existing vlan
9064       description: |
9065         Create or update an existing vlan.
9066         #
9067         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
9068       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9069       consumes:
9070         - application/json
9071         - application/xml
9072       produces:
9073         - application/json
9074         - application/xml
9075       responses:
9076         "default":
9077           description: Response codes found in [response codes](https://wiki.onap.org/).
9078       parameters:
9079         - name: hostname
9080           in: path
9081           description: Value from executing hostname on the compute node.
9082           required: true
9083           type: string
9084           example: __HOSTNAME__
9085         - name: interface-name
9086           in: path
9087           description: Name that identifies the physical interface
9088           required: true
9089           type: string
9090           example: __INTERFACE-NAME__
9091         - name: interface-name
9092           in: path
9093           description: Name given to the interface
9094           required: true
9095           type: string
9096           example: __INTERFACE-NAME__
9097         - name: vlan-interface
9098           in: path
9099           description: String that identifies the interface
9100           required: true
9101           type: string
9102           example: __VLAN-INTERFACE__
9103         - name: body
9104           in: body
9105           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9106           required: true
9107           schema:
9108             $ref: "#/definitions/vlan"
9109     patch:
9110       tags:
9111         - CloudInfrastructure
9112       summary: update an existing vlan
9113       description: |
9114         Update an existing vlan
9115         #
9116         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9117         The PUT operation will entirely replace an existing object.
9118         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.
9119         #
9120         Other differences between PUT and PATCH are:
9121         #
9122         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9123         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9124         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9125       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9126       consumes:
9127         - application/json
9128         - application/xml
9129       produces:
9130         - application/json
9131         - application/xml
9132       responses:
9133         "default":
9134           description: Response codes found in [response codes](https://wiki.onap.org/).
9135       parameters:
9136         - name: hostname
9137           in: path
9138           description: Value from executing hostname on the compute node.
9139           required: true
9140           type: string
9141           example: __HOSTNAME__
9142         - name: interface-name
9143           in: path
9144           description: Name that identifies the physical interface
9145           required: true
9146           type: string
9147           example: __INTERFACE-NAME__
9148         - name: interface-name
9149           in: path
9150           description: Name given to the interface
9151           required: true
9152           type: string
9153           example: __INTERFACE-NAME__
9154         - name: vlan-interface
9155           in: path
9156           description: String that identifies the interface
9157           required: true
9158           type: string
9159           example: __VLAN-INTERFACE__
9160         - name: body
9161           in: body
9162           description: vlan object that needs to be created or updated.
9163           required: true
9164           schema:
9165             $ref: "#/patchDefinitions/vlan"
9166     delete:
9167       tags:
9168         - CloudInfrastructure
9169       summary: delete an existing vlan
9170       description: delete an existing vlan
9171       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9172       consumes:
9173         - application/json
9174         - application/xml
9175       produces:
9176         - application/json
9177         - application/xml
9178       responses:
9179         "default":
9180           description: Response codes found in [response codes](https://wiki.onap.org/).
9181       parameters:
9182         - name: hostname
9183           in: path
9184           description: Value from executing hostname on the compute node.
9185           required: true
9186           type: string
9187           example: __HOSTNAME__
9188         - name: interface-name
9189           in: path
9190           description: Name that identifies the physical interface
9191           required: true
9192           type: string
9193           example: __INTERFACE-NAME__
9194         - name: interface-name
9195           in: path
9196           description: Name given to the interface
9197           required: true
9198           type: string
9199           example: __INTERFACE-NAME__
9200         - name: vlan-interface
9201           in: path
9202           description: String that identifies the interface
9203           required: true
9204           type: string
9205           example: __VLAN-INTERFACE__
9206         - name: resource-version
9207           in: query
9208           description: resource-version for concurrency
9209           required: true
9210           type: string
9211   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9212     get:
9213       tags:
9214         - CloudInfrastructure
9215       summary: returns vlans
9216       description: returns vlans
9217       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9218       produces:
9219         - application/json
9220         - application/xml
9221       responses:
9222         "200":
9223           description: successful operation
9224           schema:
9225               $ref: "#/getDefinitions/vlans"
9226         "default":
9227           description: Response codes found in [response codes](https://wiki.onap.org/).
9228       parameters:
9229         - name: hostname
9230           in: path
9231           description: Value from executing hostname on the compute node.
9232           required: true
9233           type: string
9234           example: __HOSTNAME__
9235         - name: interface-name
9236           in: path
9237           description: Name that identifies the physical interface
9238           required: true
9239           type: string
9240           example: __INTERFACE-NAME__
9241         - name: interface-name
9242           in: path
9243           description: Name given to the interface
9244           required: true
9245           type: string
9246           example: __INTERFACE-NAME__
9247         - name: pserver-id
9248           in: query
9249           description: ID of Pserver
9250           required: false
9251           type: string
9252         - name: in-maint
9253           in: query
9254           required: false
9255           type: boolean
9256         - name: pserver-name2
9257           in: query
9258           description: alternative pserver name
9259           required: false
9260           type: string
9261         - name: interface-id
9262           in: query
9263           description: ID of interface
9264           required: false
9265           type: string
9266         - name: macaddr
9267           in: query
9268           description: MAC address for the interface
9269           required: false
9270           type: string
9271         - name: network-name
9272           in: query
9273           description: Name of the network
9274           required: false
9275           type: string
9276   /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:
9277     put:
9278       tags:
9279         - CloudInfrastructure
9280       summary: see node definition for valid relationships
9281       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9282       consumes:
9283         - application/json
9284         - application/xml
9285       produces:
9286         - application/json
9287         - application/xml
9288       responses:
9289         "default":
9290           description: Response codes found in [response codes](https://wiki.onap.org/).
9291       parameters:
9292         - name: hostname
9293           in: path
9294           description: Value from executing hostname on the compute node.
9295           required: true
9296           type: string
9297           example: __HOSTNAME__
9298         - name: interface-name
9299           in: path
9300           description: Name that identifies the physical interface
9301           required: true
9302           type: string
9303           example: __INTERFACE-NAME__
9304         - name: interface-name
9305           in: path
9306           description: Name given to the interface
9307           required: true
9308           type: string
9309           example: __INTERFACE-NAME__
9310         - name: pci-id
9311           in: path
9312           description: PCI ID used to identify the sriov-vf
9313           required: true
9314           type: string
9315           example: __PCI-ID__
9316         - name: body
9317           in: body
9318           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9319           required: true
9320           schema:
9321             $ref: "#/definitions/relationship"
9322     delete:
9323       tags:
9324         - CloudInfrastructure
9325       summary: delete an existing relationship
9326       description: delete an existing relationship
9327       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9328       consumes:
9329         - application/json
9330         - application/xml
9331       produces:
9332         - application/json
9333         - application/xml
9334       responses:
9335         "default":
9336           description: Response codes found in [response codes](https://wiki.onap.org/).
9337       parameters:
9338         - name: hostname
9339           in: path
9340           description: Value from executing hostname on the compute node.
9341           required: true
9342           type: string
9343           example: __HOSTNAME__
9344         - name: interface-name
9345           in: path
9346           description: Name that identifies the physical interface
9347           required: true
9348           type: string
9349           example: __INTERFACE-NAME__
9350         - name: interface-name
9351           in: path
9352           description: Name given to the interface
9353           required: true
9354           type: string
9355           example: __INTERFACE-NAME__
9356         - name: pci-id
9357           in: path
9358           description: PCI ID used to identify the sriov-vf
9359           required: true
9360           type: string
9361           example: __PCI-ID__
9362   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9363     get:
9364       tags:
9365         - CloudInfrastructure
9366       summary: returns sriov-vf
9367       description: returns sriov-vf
9368       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9369       produces:
9370         - application/json
9371         - application/xml
9372       responses:
9373         "200":
9374           description: successful operation
9375           schema:
9376               $ref: "#/getDefinitions/sriov-vf"
9377         "default":
9378           description: Response codes found in [response codes](https://wiki.onap.org/).
9379       parameters:
9380         - name: hostname
9381           in: path
9382           description: Value from executing hostname on the compute node.
9383           required: true
9384           type: string
9385           example: __HOSTNAME__
9386         - name: interface-name
9387           in: path
9388           description: Name that identifies the physical interface
9389           required: true
9390           type: string
9391           example: __INTERFACE-NAME__
9392         - name: interface-name
9393           in: path
9394           description: Name given to the interface
9395           required: true
9396           type: string
9397           example: __INTERFACE-NAME__
9398         - name: pci-id
9399           in: path
9400           description: PCI ID used to identify the sriov-vf
9401           required: true
9402           type: string
9403           example: __PCI-ID__
9404         - name: pserver-id
9405           in: query
9406           description: ID of Pserver
9407           required: false
9408           type: string
9409         - name: in-maint
9410           in: query
9411           required: false
9412           type: boolean
9413         - name: pserver-name2
9414           in: query
9415           description: alternative pserver name
9416           required: false
9417           type: string
9418         - name: interface-id
9419           in: query
9420           description: ID of interface
9421           required: false
9422           type: string
9423         - name: macaddr
9424           in: query
9425           description: MAC address for the interface
9426           required: false
9427           type: string
9428         - name: network-name
9429           in: query
9430           description: Name of the network
9431           required: false
9432           type: string
9433         - name: vf-vlan-filter
9434           in: query
9435           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
9436           required: false
9437           type: string
9438         - name: vf-mac-filter
9439           in: query
9440           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
9441           required: false
9442           type: string
9443         - name: vf-vlan-strip
9444           in: query
9445           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
9446           required: false
9447           type: boolean
9448         - name: neutron-network-id
9449           in: query
9450           description: Neutron network id of the interface
9451           required: false
9452           type: string
9453     put:
9454       tags:
9455         - CloudInfrastructure
9456       summary: create or update an existing sriov-vf
9457       description: |
9458         Create or update an existing sriov-vf.
9459         #
9460         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
9461       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9462       consumes:
9463         - application/json
9464         - application/xml
9465       produces:
9466         - application/json
9467         - application/xml
9468       responses:
9469         "default":
9470           description: Response codes found in [response codes](https://wiki.onap.org/).
9471       parameters:
9472         - name: hostname
9473           in: path
9474           description: Value from executing hostname on the compute node.
9475           required: true
9476           type: string
9477           example: __HOSTNAME__
9478         - name: interface-name
9479           in: path
9480           description: Name that identifies the physical interface
9481           required: true
9482           type: string
9483           example: __INTERFACE-NAME__
9484         - name: interface-name
9485           in: path
9486           description: Name given to the interface
9487           required: true
9488           type: string
9489           example: __INTERFACE-NAME__
9490         - name: pci-id
9491           in: path
9492           description: PCI ID used to identify the sriov-vf
9493           required: true
9494           type: string
9495           example: __PCI-ID__
9496         - name: body
9497           in: body
9498           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9499           required: true
9500           schema:
9501             $ref: "#/definitions/sriov-vf"
9502     patch:
9503       tags:
9504         - CloudInfrastructure
9505       summary: update an existing sriov-vf
9506       description: |
9507         Update an existing sriov-vf
9508         #
9509         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9510         The PUT operation will entirely replace an existing object.
9511         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.
9512         #
9513         Other differences between PUT and PATCH are:
9514         #
9515         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9516         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9517         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9518       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9519       consumes:
9520         - application/json
9521         - application/xml
9522       produces:
9523         - application/json
9524         - application/xml
9525       responses:
9526         "default":
9527           description: Response codes found in [response codes](https://wiki.onap.org/).
9528       parameters:
9529         - name: hostname
9530           in: path
9531           description: Value from executing hostname on the compute node.
9532           required: true
9533           type: string
9534           example: __HOSTNAME__
9535         - name: interface-name
9536           in: path
9537           description: Name that identifies the physical interface
9538           required: true
9539           type: string
9540           example: __INTERFACE-NAME__
9541         - name: interface-name
9542           in: path
9543           description: Name given to the interface
9544           required: true
9545           type: string
9546           example: __INTERFACE-NAME__
9547         - name: pci-id
9548           in: path
9549           description: PCI ID used to identify the sriov-vf
9550           required: true
9551           type: string
9552           example: __PCI-ID__
9553         - name: body
9554           in: body
9555           description: sriov-vf object that needs to be created or updated.
9556           required: true
9557           schema:
9558             $ref: "#/patchDefinitions/sriov-vf"
9559     delete:
9560       tags:
9561         - CloudInfrastructure
9562       summary: delete an existing sriov-vf
9563       description: delete an existing sriov-vf
9564       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9565       consumes:
9566         - application/json
9567         - application/xml
9568       produces:
9569         - application/json
9570         - application/xml
9571       responses:
9572         "default":
9573           description: Response codes found in [response codes](https://wiki.onap.org/).
9574       parameters:
9575         - name: hostname
9576           in: path
9577           description: Value from executing hostname on the compute node.
9578           required: true
9579           type: string
9580           example: __HOSTNAME__
9581         - name: interface-name
9582           in: path
9583           description: Name that identifies the physical interface
9584           required: true
9585           type: string
9586           example: __INTERFACE-NAME__
9587         - name: interface-name
9588           in: path
9589           description: Name given to the interface
9590           required: true
9591           type: string
9592           example: __INTERFACE-NAME__
9593         - name: pci-id
9594           in: path
9595           description: PCI ID used to identify the sriov-vf
9596           required: true
9597           type: string
9598           example: __PCI-ID__
9599         - name: resource-version
9600           in: query
9601           description: resource-version for concurrency
9602           required: true
9603           type: string
9604   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9605     get:
9606       tags:
9607         - CloudInfrastructure
9608       summary: returns sriov-vfs
9609       description: returns sriov-vfs
9610       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9611       produces:
9612         - application/json
9613         - application/xml
9614       responses:
9615         "200":
9616           description: successful operation
9617           schema:
9618               $ref: "#/getDefinitions/sriov-vfs"
9619         "default":
9620           description: Response codes found in [response codes](https://wiki.onap.org/).
9621       parameters:
9622         - name: hostname
9623           in: path
9624           description: Value from executing hostname on the compute node.
9625           required: true
9626           type: string
9627           example: __HOSTNAME__
9628         - name: interface-name
9629           in: path
9630           description: Name that identifies the physical interface
9631           required: true
9632           type: string
9633           example: __INTERFACE-NAME__
9634         - name: interface-name
9635           in: path
9636           description: Name given to the interface
9637           required: true
9638           type: string
9639           example: __INTERFACE-NAME__
9640         - name: pserver-id
9641           in: query
9642           description: ID of Pserver
9643           required: false
9644           type: string
9645         - name: in-maint
9646           in: query
9647           required: false
9648           type: boolean
9649         - name: pserver-name2
9650           in: query
9651           description: alternative pserver name
9652           required: false
9653           type: string
9654         - name: interface-id
9655           in: query
9656           description: ID of interface
9657           required: false
9658           type: string
9659         - name: macaddr
9660           in: query
9661           description: MAC address for the interface
9662           required: false
9663           type: string
9664         - name: network-name
9665           in: query
9666           description: Name of the network
9667           required: false
9668           type: string
9669   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9670     put:
9671       tags:
9672         - CloudInfrastructure
9673       summary: see node definition for valid relationships
9674       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9675       consumes:
9676         - application/json
9677         - application/xml
9678       produces:
9679         - application/json
9680         - application/xml
9681       responses:
9682         "default":
9683           description: Response codes found in [response codes](https://wiki.onap.org/).
9684       parameters:
9685         - name: hostname
9686           in: path
9687           description: Value from executing hostname on the compute node.
9688           required: true
9689           type: string
9690           example: __HOSTNAME__
9691         - name: interface-name
9692           in: path
9693           description: Name that identifies the physical interface
9694           required: true
9695           type: string
9696           example: __INTERFACE-NAME__
9697         - name: interface-name
9698           in: path
9699           description: Name given to the interface
9700           required: true
9701           type: string
9702           example: __INTERFACE-NAME__
9703         - name: body
9704           in: body
9705           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9706           required: true
9707           schema:
9708             $ref: "#/definitions/relationship"
9709     delete:
9710       tags:
9711         - CloudInfrastructure
9712       summary: delete an existing relationship
9713       description: delete an existing relationship
9714       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9715       consumes:
9716         - application/json
9717         - application/xml
9718       produces:
9719         - application/json
9720         - application/xml
9721       responses:
9722         "default":
9723           description: Response codes found in [response codes](https://wiki.onap.org/).
9724       parameters:
9725         - name: hostname
9726           in: path
9727           description: Value from executing hostname on the compute node.
9728           required: true
9729           type: string
9730           example: __HOSTNAME__
9731         - name: interface-name
9732           in: path
9733           description: Name that identifies the physical interface
9734           required: true
9735           type: string
9736           example: __INTERFACE-NAME__
9737         - name: interface-name
9738           in: path
9739           description: Name given to the interface
9740           required: true
9741           type: string
9742           example: __INTERFACE-NAME__
9743   /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:
9744     put:
9745       tags:
9746         - CloudInfrastructure
9747       summary: see node definition for valid relationships
9748       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9749       consumes:
9750         - application/json
9751         - application/xml
9752       produces:
9753         - application/json
9754         - application/xml
9755       responses:
9756         "default":
9757           description: Response codes found in [response codes](https://wiki.onap.org/).
9758       parameters:
9759         - name: hostname
9760           in: path
9761           description: Value from executing hostname on the compute node.
9762           required: true
9763           type: string
9764           example: __HOSTNAME__
9765         - name: interface-name
9766           in: path
9767           description: Name that identifies the physical interface
9768           required: true
9769           type: string
9770           example: __INTERFACE-NAME__
9771         - name: interface-name
9772           in: path
9773           description: Name given to the interface
9774           required: true
9775           type: string
9776           example: __INTERFACE-NAME__
9777         - name: l3-interface-ipv4-address
9778           in: path
9779           description: IP address
9780           required: true
9781           type: string
9782           example: __L3-INTERFACE-IPV4-ADDRESS__
9783         - name: body
9784           in: body
9785           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9786           required: true
9787           schema:
9788             $ref: "#/definitions/relationship"
9789     delete:
9790       tags:
9791         - CloudInfrastructure
9792       summary: delete an existing relationship
9793       description: delete an existing relationship
9794       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9795       consumes:
9796         - application/json
9797         - application/xml
9798       produces:
9799         - application/json
9800         - application/xml
9801       responses:
9802         "default":
9803           description: Response codes found in [response codes](https://wiki.onap.org/).
9804       parameters:
9805         - name: hostname
9806           in: path
9807           description: Value from executing hostname on the compute node.
9808           required: true
9809           type: string
9810           example: __HOSTNAME__
9811         - name: interface-name
9812           in: path
9813           description: Name that identifies the physical interface
9814           required: true
9815           type: string
9816           example: __INTERFACE-NAME__
9817         - name: interface-name
9818           in: path
9819           description: Name given to the interface
9820           required: true
9821           type: string
9822           example: __INTERFACE-NAME__
9823         - name: l3-interface-ipv4-address
9824           in: path
9825           description: IP address
9826           required: true
9827           type: string
9828           example: __L3-INTERFACE-IPV4-ADDRESS__
9829   /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}:
9830     get:
9831       tags:
9832         - CloudInfrastructure
9833       summary: returns l3-interface-ipv4-address-list
9834       description: returns l3-interface-ipv4-address-list
9835       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9836       produces:
9837         - application/json
9838         - application/xml
9839       responses:
9840         "200":
9841           description: successful operation
9842           schema:
9843               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9844         "default":
9845           description: Response codes found in [response codes](https://wiki.onap.org/).
9846       parameters:
9847         - name: hostname
9848           in: path
9849           description: Value from executing hostname on the compute node.
9850           required: true
9851           type: string
9852           example: __HOSTNAME__
9853         - name: interface-name
9854           in: path
9855           description: Name that identifies the physical interface
9856           required: true
9857           type: string
9858           example: __INTERFACE-NAME__
9859         - name: interface-name
9860           in: path
9861           description: Name given to the interface
9862           required: true
9863           type: string
9864           example: __INTERFACE-NAME__
9865         - name: l3-interface-ipv4-address
9866           in: path
9867           description: IP address
9868           required: true
9869           type: string
9870           example: __L3-INTERFACE-IPV4-ADDRESS__
9871         - name: pserver-id
9872           in: query
9873           description: ID of Pserver
9874           required: false
9875           type: string
9876         - name: in-maint
9877           in: query
9878           required: false
9879           type: boolean
9880         - name: pserver-name2
9881           in: query
9882           description: alternative pserver name
9883           required: false
9884           type: string
9885         - name: interface-id
9886           in: query
9887           description: ID of interface
9888           required: false
9889           type: string
9890         - name: macaddr
9891           in: query
9892           description: MAC address for the interface
9893           required: false
9894           type: string
9895         - name: network-name
9896           in: query
9897           description: Name of the network
9898           required: false
9899           type: string
9900         - name: vlan-id-inner
9901           in: query
9902           description: Inner VLAN tag
9903           required: false
9904           type: integer
9905           format: int64
9906         - name: neutron-network-id
9907           in: query
9908           description: Neutron network id of the interface that address belongs to
9909           required: false
9910           type: string
9911         - name: neutron-subnet-id
9912           in: query
9913           description: Neutron id of subnet that address belongs to
9914           required: false
9915           type: string
9916     put:
9917       tags:
9918         - CloudInfrastructure
9919       summary: create or update an existing l3-interface-ipv4-address-list
9920       description: |
9921         Create or update an existing l3-interface-ipv4-address-list.
9922         #
9923         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
9924       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9925       consumes:
9926         - application/json
9927         - application/xml
9928       produces:
9929         - application/json
9930         - application/xml
9931       responses:
9932         "default":
9933           description: Response codes found in [response codes](https://wiki.onap.org/).
9934       parameters:
9935         - name: hostname
9936           in: path
9937           description: Value from executing hostname on the compute node.
9938           required: true
9939           type: string
9940           example: __HOSTNAME__
9941         - name: interface-name
9942           in: path
9943           description: Name that identifies the physical interface
9944           required: true
9945           type: string
9946           example: __INTERFACE-NAME__
9947         - name: interface-name
9948           in: path
9949           description: Name given to the interface
9950           required: true
9951           type: string
9952           example: __INTERFACE-NAME__
9953         - name: l3-interface-ipv4-address
9954           in: path
9955           description: IP address
9956           required: true
9957           type: string
9958           example: __L3-INTERFACE-IPV4-ADDRESS__
9959         - name: body
9960           in: body
9961           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9962           required: true
9963           schema:
9964             $ref: "#/definitions/l3-interface-ipv4-address-list"
9965     patch:
9966       tags:
9967         - CloudInfrastructure
9968       summary: update an existing l3-interface-ipv4-address-list
9969       description: |
9970         Update an existing l3-interface-ipv4-address-list
9971         #
9972         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9973         The PUT operation will entirely replace an existing object.
9974         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.
9975         #
9976         Other differences between PUT and PATCH are:
9977         #
9978         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9979         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9980         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9981       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9982       consumes:
9983         - application/json
9984         - application/xml
9985       produces:
9986         - application/json
9987         - application/xml
9988       responses:
9989         "default":
9990           description: Response codes found in [response codes](https://wiki.onap.org/).
9991       parameters:
9992         - name: hostname
9993           in: path
9994           description: Value from executing hostname on the compute node.
9995           required: true
9996           type: string
9997           example: __HOSTNAME__
9998         - name: interface-name
9999           in: path
10000           description: Name that identifies the physical interface
10001           required: true
10002           type: string
10003           example: __INTERFACE-NAME__
10004         - name: interface-name
10005           in: path
10006           description: Name given to the interface
10007           required: true
10008           type: string
10009           example: __INTERFACE-NAME__
10010         - name: l3-interface-ipv4-address
10011           in: path
10012           description: IP address
10013           required: true
10014           type: string
10015           example: __L3-INTERFACE-IPV4-ADDRESS__
10016         - name: body
10017           in: body
10018           description: l3-interface-ipv4-address-list object that needs to be created or updated.
10019           required: true
10020           schema:
10021             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10022     delete:
10023       tags:
10024         - CloudInfrastructure
10025       summary: delete an existing l3-interface-ipv4-address-list
10026       description: delete an existing l3-interface-ipv4-address-list
10027       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10028       consumes:
10029         - application/json
10030         - application/xml
10031       produces:
10032         - application/json
10033         - application/xml
10034       responses:
10035         "default":
10036           description: Response codes found in [response codes](https://wiki.onap.org/).
10037       parameters:
10038         - name: hostname
10039           in: path
10040           description: Value from executing hostname on the compute node.
10041           required: true
10042           type: string
10043           example: __HOSTNAME__
10044         - name: interface-name
10045           in: path
10046           description: Name that identifies the physical interface
10047           required: true
10048           type: string
10049           example: __INTERFACE-NAME__
10050         - name: interface-name
10051           in: path
10052           description: Name given to the interface
10053           required: true
10054           type: string
10055           example: __INTERFACE-NAME__
10056         - name: l3-interface-ipv4-address
10057           in: path
10058           description: IP address
10059           required: true
10060           type: string
10061           example: __L3-INTERFACE-IPV4-ADDRESS__
10062         - name: resource-version
10063           in: query
10064           description: resource-version for concurrency
10065           required: true
10066           type: string
10067   /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:
10068     put:
10069       tags:
10070         - CloudInfrastructure
10071       summary: see node definition for valid relationships
10072       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10073       consumes:
10074         - application/json
10075         - application/xml
10076       produces:
10077         - application/json
10078         - application/xml
10079       responses:
10080         "default":
10081           description: Response codes found in [response codes](https://wiki.onap.org/).
10082       parameters:
10083         - name: hostname
10084           in: path
10085           description: Value from executing hostname on the compute node.
10086           required: true
10087           type: string
10088           example: __HOSTNAME__
10089         - name: interface-name
10090           in: path
10091           description: Name that identifies the physical interface
10092           required: true
10093           type: string
10094           example: __INTERFACE-NAME__
10095         - name: interface-name
10096           in: path
10097           description: Name given to the interface
10098           required: true
10099           type: string
10100           example: __INTERFACE-NAME__
10101         - name: l3-interface-ipv6-address
10102           in: path
10103           description: IP address
10104           required: true
10105           type: string
10106           example: __L3-INTERFACE-IPV6-ADDRESS__
10107         - name: body
10108           in: body
10109           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10110           required: true
10111           schema:
10112             $ref: "#/definitions/relationship"
10113     delete:
10114       tags:
10115         - CloudInfrastructure
10116       summary: delete an existing relationship
10117       description: delete an existing relationship
10118       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10119       consumes:
10120         - application/json
10121         - application/xml
10122       produces:
10123         - application/json
10124         - application/xml
10125       responses:
10126         "default":
10127           description: Response codes found in [response codes](https://wiki.onap.org/).
10128       parameters:
10129         - name: hostname
10130           in: path
10131           description: Value from executing hostname on the compute node.
10132           required: true
10133           type: string
10134           example: __HOSTNAME__
10135         - name: interface-name
10136           in: path
10137           description: Name that identifies the physical interface
10138           required: true
10139           type: string
10140           example: __INTERFACE-NAME__
10141         - name: interface-name
10142           in: path
10143           description: Name given to the interface
10144           required: true
10145           type: string
10146           example: __INTERFACE-NAME__
10147         - name: l3-interface-ipv6-address
10148           in: path
10149           description: IP address
10150           required: true
10151           type: string
10152           example: __L3-INTERFACE-IPV6-ADDRESS__
10153   /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}:
10154     get:
10155       tags:
10156         - CloudInfrastructure
10157       summary: returns l3-interface-ipv6-address-list
10158       description: returns l3-interface-ipv6-address-list
10159       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10160       produces:
10161         - application/json
10162         - application/xml
10163       responses:
10164         "200":
10165           description: successful operation
10166           schema:
10167               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10168         "default":
10169           description: Response codes found in [response codes](https://wiki.onap.org/).
10170       parameters:
10171         - name: hostname
10172           in: path
10173           description: Value from executing hostname on the compute node.
10174           required: true
10175           type: string
10176           example: __HOSTNAME__
10177         - name: interface-name
10178           in: path
10179           description: Name that identifies the physical interface
10180           required: true
10181           type: string
10182           example: __INTERFACE-NAME__
10183         - name: interface-name
10184           in: path
10185           description: Name given to the interface
10186           required: true
10187           type: string
10188           example: __INTERFACE-NAME__
10189         - name: l3-interface-ipv6-address
10190           in: path
10191           description: IP address
10192           required: true
10193           type: string
10194           example: __L3-INTERFACE-IPV6-ADDRESS__
10195         - name: pserver-id
10196           in: query
10197           description: ID of Pserver
10198           required: false
10199           type: string
10200         - name: in-maint
10201           in: query
10202           required: false
10203           type: boolean
10204         - name: pserver-name2
10205           in: query
10206           description: alternative pserver name
10207           required: false
10208           type: string
10209         - name: interface-id
10210           in: query
10211           description: ID of interface
10212           required: false
10213           type: string
10214         - name: macaddr
10215           in: query
10216           description: MAC address for the interface
10217           required: false
10218           type: string
10219         - name: network-name
10220           in: query
10221           description: Name of the network
10222           required: false
10223           type: string
10224         - name: vlan-id-inner
10225           in: query
10226           description: Inner VLAN tag
10227           required: false
10228           type: integer
10229           format: int64
10230         - name: neutron-network-id
10231           in: query
10232           description: Neutron network id of the interface that address belongs to
10233           required: false
10234           type: string
10235         - name: neutron-subnet-id
10236           in: query
10237           description: Neutron id of subnet that address belongs to
10238           required: false
10239           type: string
10240     put:
10241       tags:
10242         - CloudInfrastructure
10243       summary: create or update an existing l3-interface-ipv6-address-list
10244       description: |
10245         Create or update an existing l3-interface-ipv6-address-list.
10246         #
10247         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
10248       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10249       consumes:
10250         - application/json
10251         - application/xml
10252       produces:
10253         - application/json
10254         - application/xml
10255       responses:
10256         "default":
10257           description: Response codes found in [response codes](https://wiki.onap.org/).
10258       parameters:
10259         - name: hostname
10260           in: path
10261           description: Value from executing hostname on the compute node.
10262           required: true
10263           type: string
10264           example: __HOSTNAME__
10265         - name: interface-name
10266           in: path
10267           description: Name that identifies the physical interface
10268           required: true
10269           type: string
10270           example: __INTERFACE-NAME__
10271         - name: interface-name
10272           in: path
10273           description: Name given to the interface
10274           required: true
10275           type: string
10276           example: __INTERFACE-NAME__
10277         - name: l3-interface-ipv6-address
10278           in: path
10279           description: IP address
10280           required: true
10281           type: string
10282           example: __L3-INTERFACE-IPV6-ADDRESS__
10283         - name: body
10284           in: body
10285           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10286           required: true
10287           schema:
10288             $ref: "#/definitions/l3-interface-ipv6-address-list"
10289     patch:
10290       tags:
10291         - CloudInfrastructure
10292       summary: update an existing l3-interface-ipv6-address-list
10293       description: |
10294         Update an existing l3-interface-ipv6-address-list
10295         #
10296         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10297         The PUT operation will entirely replace an existing object.
10298         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.
10299         #
10300         Other differences between PUT and PATCH are:
10301         #
10302         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10303         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10304         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10305       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10306       consumes:
10307         - application/json
10308         - application/xml
10309       produces:
10310         - application/json
10311         - application/xml
10312       responses:
10313         "default":
10314           description: Response codes found in [response codes](https://wiki.onap.org/).
10315       parameters:
10316         - name: hostname
10317           in: path
10318           description: Value from executing hostname on the compute node.
10319           required: true
10320           type: string
10321           example: __HOSTNAME__
10322         - name: interface-name
10323           in: path
10324           description: Name that identifies the physical interface
10325           required: true
10326           type: string
10327           example: __INTERFACE-NAME__
10328         - name: interface-name
10329           in: path
10330           description: Name given to the interface
10331           required: true
10332           type: string
10333           example: __INTERFACE-NAME__
10334         - name: l3-interface-ipv6-address
10335           in: path
10336           description: IP address
10337           required: true
10338           type: string
10339           example: __L3-INTERFACE-IPV6-ADDRESS__
10340         - name: body
10341           in: body
10342           description: l3-interface-ipv6-address-list object that needs to be created or updated.
10343           required: true
10344           schema:
10345             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10346     delete:
10347       tags:
10348         - CloudInfrastructure
10349       summary: delete an existing l3-interface-ipv6-address-list
10350       description: delete an existing l3-interface-ipv6-address-list
10351       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10352       consumes:
10353         - application/json
10354         - application/xml
10355       produces:
10356         - application/json
10357         - application/xml
10358       responses:
10359         "default":
10360           description: Response codes found in [response codes](https://wiki.onap.org/).
10361       parameters:
10362         - name: hostname
10363           in: path
10364           description: Value from executing hostname on the compute node.
10365           required: true
10366           type: string
10367           example: __HOSTNAME__
10368         - name: interface-name
10369           in: path
10370           description: Name that identifies the physical interface
10371           required: true
10372           type: string
10373           example: __INTERFACE-NAME__
10374         - name: interface-name
10375           in: path
10376           description: Name given to the interface
10377           required: true
10378           type: string
10379           example: __INTERFACE-NAME__
10380         - name: l3-interface-ipv6-address
10381           in: path
10382           description: IP address
10383           required: true
10384           type: string
10385           example: __L3-INTERFACE-IPV6-ADDRESS__
10386         - name: resource-version
10387           in: query
10388           description: resource-version for concurrency
10389           required: true
10390           type: string
10391   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10392     get:
10393       tags:
10394         - CloudInfrastructure
10395       summary: returns l-interface
10396       description: returns l-interface
10397       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10398       produces:
10399         - application/json
10400         - application/xml
10401       responses:
10402         "200":
10403           description: successful operation
10404           schema:
10405               $ref: "#/getDefinitions/l-interface"
10406         "default":
10407           description: Response codes found in [response codes](https://wiki.onap.org/).
10408       parameters:
10409         - name: hostname
10410           in: path
10411           description: Value from executing hostname on the compute node.
10412           required: true
10413           type: string
10414           example: __HOSTNAME__
10415         - name: interface-name
10416           in: path
10417           description: Name that identifies the physical interface
10418           required: true
10419           type: string
10420           example: __INTERFACE-NAME__
10421         - name: interface-name
10422           in: path
10423           description: Name given to the interface
10424           required: true
10425           type: string
10426           example: __INTERFACE-NAME__
10427         - name: pserver-id
10428           in: query
10429           description: ID of Pserver
10430           required: false
10431           type: string
10432         - name: in-maint
10433           in: query
10434           required: false
10435           type: boolean
10436         - name: pserver-name2
10437           in: query
10438           description: alternative pserver name
10439           required: false
10440           type: string
10441         - name: interface-id
10442           in: query
10443           description: ID of interface
10444           required: false
10445           type: string
10446         - name: macaddr
10447           in: query
10448           description: MAC address for the interface
10449           required: false
10450           type: string
10451         - name: network-name
10452           in: query
10453           description: Name of the network
10454           required: false
10455           type: string
10456     put:
10457       tags:
10458         - CloudInfrastructure
10459       summary: create or update an existing l-interface
10460       description: |
10461         Create or update an existing l-interface.
10462         #
10463         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
10464       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10465       consumes:
10466         - application/json
10467         - application/xml
10468       produces:
10469         - application/json
10470         - application/xml
10471       responses:
10472         "default":
10473           description: Response codes found in [response codes](https://wiki.onap.org/).
10474       parameters:
10475         - name: hostname
10476           in: path
10477           description: Value from executing hostname on the compute node.
10478           required: true
10479           type: string
10480           example: __HOSTNAME__
10481         - name: interface-name
10482           in: path
10483           description: Name that identifies the physical interface
10484           required: true
10485           type: string
10486           example: __INTERFACE-NAME__
10487         - name: interface-name
10488           in: path
10489           description: Name given to the interface
10490           required: true
10491           type: string
10492           example: __INTERFACE-NAME__
10493         - name: body
10494           in: body
10495           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10496           required: true
10497           schema:
10498             $ref: "#/definitions/l-interface"
10499     patch:
10500       tags:
10501         - CloudInfrastructure
10502       summary: update an existing l-interface
10503       description: |
10504         Update an existing l-interface
10505         #
10506         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10507         The PUT operation will entirely replace an existing object.
10508         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.
10509         #
10510         Other differences between PUT and PATCH are:
10511         #
10512         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10513         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10514         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10515       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10516       consumes:
10517         - application/json
10518         - application/xml
10519       produces:
10520         - application/json
10521         - application/xml
10522       responses:
10523         "default":
10524           description: Response codes found in [response codes](https://wiki.onap.org/).
10525       parameters:
10526         - name: hostname
10527           in: path
10528           description: Value from executing hostname on the compute node.
10529           required: true
10530           type: string
10531           example: __HOSTNAME__
10532         - name: interface-name
10533           in: path
10534           description: Name that identifies the physical interface
10535           required: true
10536           type: string
10537           example: __INTERFACE-NAME__
10538         - name: interface-name
10539           in: path
10540           description: Name given to the interface
10541           required: true
10542           type: string
10543           example: __INTERFACE-NAME__
10544         - name: body
10545           in: body
10546           description: l-interface object that needs to be created or updated.
10547           required: true
10548           schema:
10549             $ref: "#/patchDefinitions/l-interface"
10550     delete:
10551       tags:
10552         - CloudInfrastructure
10553       summary: delete an existing l-interface
10554       description: delete an existing l-interface
10555       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10556       consumes:
10557         - application/json
10558         - application/xml
10559       produces:
10560         - application/json
10561         - application/xml
10562       responses:
10563         "default":
10564           description: Response codes found in [response codes](https://wiki.onap.org/).
10565       parameters:
10566         - name: hostname
10567           in: path
10568           description: Value from executing hostname on the compute node.
10569           required: true
10570           type: string
10571           example: __HOSTNAME__
10572         - name: interface-name
10573           in: path
10574           description: Name that identifies the physical interface
10575           required: true
10576           type: string
10577           example: __INTERFACE-NAME__
10578         - name: interface-name
10579           in: path
10580           description: Name given to the interface
10581           required: true
10582           type: string
10583           example: __INTERFACE-NAME__
10584         - name: resource-version
10585           in: query
10586           description: resource-version for concurrency
10587           required: true
10588           type: string
10589   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10590     get:
10591       tags:
10592         - CloudInfrastructure
10593       summary: returns l-interfaces
10594       description: returns l-interfaces
10595       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10596       produces:
10597         - application/json
10598         - application/xml
10599       responses:
10600         "200":
10601           description: successful operation
10602           schema:
10603               $ref: "#/getDefinitions/l-interfaces"
10604         "default":
10605           description: Response codes found in [response codes](https://wiki.onap.org/).
10606       parameters:
10607         - name: hostname
10608           in: path
10609           description: Value from executing hostname on the compute node.
10610           required: true
10611           type: string
10612           example: __HOSTNAME__
10613         - name: interface-name
10614           in: path
10615           description: Name that identifies the physical interface
10616           required: true
10617           type: string
10618           example: __INTERFACE-NAME__
10619         - name: pserver-id
10620           in: query
10621           description: ID of Pserver
10622           required: false
10623           type: string
10624         - name: in-maint
10625           in: query
10626           required: false
10627           type: boolean
10628         - name: pserver-name2
10629           in: query
10630           description: alternative pserver name
10631           required: false
10632           type: string
10633   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10634     get:
10635       tags:
10636         - CloudInfrastructure
10637       summary: returns p-interface
10638       description: returns p-interface
10639       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10640       produces:
10641         - application/json
10642         - application/xml
10643       responses:
10644         "200":
10645           description: successful operation
10646           schema:
10647               $ref: "#/getDefinitions/p-interface"
10648         "default":
10649           description: Response codes found in [response codes](https://wiki.onap.org/).
10650       parameters:
10651         - name: hostname
10652           in: path
10653           description: Value from executing hostname on the compute node.
10654           required: true
10655           type: string
10656           example: __HOSTNAME__
10657         - name: interface-name
10658           in: path
10659           description: Name that identifies the physical interface
10660           required: true
10661           type: string
10662           example: __INTERFACE-NAME__
10663         - name: pserver-id
10664           in: query
10665           description: ID of Pserver
10666           required: false
10667           type: string
10668         - name: in-maint
10669           in: query
10670           required: false
10671           type: boolean
10672         - name: pserver-name2
10673           in: query
10674           description: alternative pserver name
10675           required: false
10676           type: string
10677     put:
10678       tags:
10679         - CloudInfrastructure
10680       summary: create or update an existing p-interface
10681       description: |
10682         Create or update an existing p-interface.
10683         #
10684         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
10685       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10686       consumes:
10687         - application/json
10688         - application/xml
10689       produces:
10690         - application/json
10691         - application/xml
10692       responses:
10693         "default":
10694           description: Response codes found in [response codes](https://wiki.onap.org/).
10695       parameters:
10696         - name: hostname
10697           in: path
10698           description: Value from executing hostname on the compute node.
10699           required: true
10700           type: string
10701           example: __HOSTNAME__
10702         - name: interface-name
10703           in: path
10704           description: Name that identifies the physical interface
10705           required: true
10706           type: string
10707           example: __INTERFACE-NAME__
10708         - name: body
10709           in: body
10710           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10711           required: true
10712           schema:
10713             $ref: "#/definitions/p-interface"
10714     patch:
10715       tags:
10716         - CloudInfrastructure
10717       summary: update an existing p-interface
10718       description: |
10719         Update an existing p-interface
10720         #
10721         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10722         The PUT operation will entirely replace an existing object.
10723         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.
10724         #
10725         Other differences between PUT and PATCH are:
10726         #
10727         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10728         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10729         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10730       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10731       consumes:
10732         - application/json
10733         - application/xml
10734       produces:
10735         - application/json
10736         - application/xml
10737       responses:
10738         "default":
10739           description: Response codes found in [response codes](https://wiki.onap.org/).
10740       parameters:
10741         - name: hostname
10742           in: path
10743           description: Value from executing hostname on the compute node.
10744           required: true
10745           type: string
10746           example: __HOSTNAME__
10747         - name: interface-name
10748           in: path
10749           description: Name that identifies the physical interface
10750           required: true
10751           type: string
10752           example: __INTERFACE-NAME__
10753         - name: body
10754           in: body
10755           description: p-interface object that needs to be created or updated.
10756           required: true
10757           schema:
10758             $ref: "#/patchDefinitions/p-interface"
10759     delete:
10760       tags:
10761         - CloudInfrastructure
10762       summary: delete an existing p-interface
10763       description: delete an existing p-interface
10764       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10765       consumes:
10766         - application/json
10767         - application/xml
10768       produces:
10769         - application/json
10770         - application/xml
10771       responses:
10772         "default":
10773           description: Response codes found in [response codes](https://wiki.onap.org/).
10774       parameters:
10775         - name: hostname
10776           in: path
10777           description: Value from executing hostname on the compute node.
10778           required: true
10779           type: string
10780           example: __HOSTNAME__
10781         - name: interface-name
10782           in: path
10783           description: Name that identifies the physical interface
10784           required: true
10785           type: string
10786           example: __INTERFACE-NAME__
10787         - name: resource-version
10788           in: query
10789           description: resource-version for concurrency
10790           required: true
10791           type: string
10792   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10793     get:
10794       tags:
10795         - CloudInfrastructure
10796       summary: returns p-interfaces
10797       description: returns p-interfaces
10798       operationId: getCloudInfrastructurePserversPserverPInterfaces
10799       produces:
10800         - application/json
10801         - application/xml
10802       responses:
10803         "200":
10804           description: successful operation
10805           schema:
10806               $ref: "#/getDefinitions/p-interfaces"
10807         "default":
10808           description: Response codes found in [response codes](https://wiki.onap.org/).
10809       parameters:
10810         - name: hostname
10811           in: path
10812           description: Value from executing hostname on the compute node.
10813           required: true
10814           type: string
10815           example: __HOSTNAME__
10816         - name: pserver-id
10817           in: query
10818           description: ID of Pserver
10819           required: false
10820           type: string
10821         - name: in-maint
10822           in: query
10823           required: false
10824           type: boolean
10825         - name: pserver-name2
10826           in: query
10827           description: alternative pserver name
10828           required: false
10829           type: string
10830   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10831     put:
10832       tags:
10833         - CloudInfrastructure
10834       summary: see node definition for valid relationships
10835       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10836       consumes:
10837         - application/json
10838         - application/xml
10839       produces:
10840         - application/json
10841         - application/xml
10842       responses:
10843         "default":
10844           description: Response codes found in [response codes](https://wiki.onap.org/).
10845       parameters:
10846         - name: hostname
10847           in: path
10848           description: Value from executing hostname on the compute node.
10849           required: true
10850           type: string
10851           example: __HOSTNAME__
10852         - name: interface-name
10853           in: path
10854           description: Name that identifies the link aggregate interface
10855           required: true
10856           type: string
10857           example: __INTERFACE-NAME__
10858         - name: body
10859           in: body
10860           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10861           required: true
10862           schema:
10863             $ref: "#/definitions/relationship"
10864     delete:
10865       tags:
10866         - CloudInfrastructure
10867       summary: delete an existing relationship
10868       description: delete an existing relationship
10869       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10870       consumes:
10871         - application/json
10872         - application/xml
10873       produces:
10874         - application/json
10875         - application/xml
10876       responses:
10877         "default":
10878           description: Response codes found in [response codes](https://wiki.onap.org/).
10879       parameters:
10880         - name: hostname
10881           in: path
10882           description: Value from executing hostname on the compute node.
10883           required: true
10884           type: string
10885           example: __HOSTNAME__
10886         - name: interface-name
10887           in: path
10888           description: Name that identifies the link aggregate interface
10889           required: true
10890           type: string
10891           example: __INTERFACE-NAME__
10892   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
10893     put:
10894       tags:
10895         - CloudInfrastructure
10896       summary: see node definition for valid relationships
10897       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10898       consumes:
10899         - application/json
10900         - application/xml
10901       produces:
10902         - application/json
10903         - application/xml
10904       responses:
10905         "default":
10906           description: Response codes found in [response codes](https://wiki.onap.org/).
10907       parameters:
10908         - name: hostname
10909           in: path
10910           description: Value from executing hostname on the compute node.
10911           required: true
10912           type: string
10913           example: __HOSTNAME__
10914         - name: interface-name
10915           in: path
10916           description: Name that identifies the link aggregate interface
10917           required: true
10918           type: string
10919           example: __INTERFACE-NAME__
10920         - name: interface-name
10921           in: path
10922           description: Name given to the interface
10923           required: true
10924           type: string
10925           example: __INTERFACE-NAME__
10926         - name: vlan-interface
10927           in: path
10928           description: String that identifies the interface
10929           required: true
10930           type: string
10931           example: __VLAN-INTERFACE__
10932         - name: body
10933           in: body
10934           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
10935           required: true
10936           schema:
10937             $ref: "#/definitions/relationship"
10938     delete:
10939       tags:
10940         - CloudInfrastructure
10941       summary: delete an existing relationship
10942       description: delete an existing relationship
10943       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
10944       consumes:
10945         - application/json
10946         - application/xml
10947       produces:
10948         - application/json
10949         - application/xml
10950       responses:
10951         "default":
10952           description: Response codes found in [response codes](https://wiki.onap.org/).
10953       parameters:
10954         - name: hostname
10955           in: path
10956           description: Value from executing hostname on the compute node.
10957           required: true
10958           type: string
10959           example: __HOSTNAME__
10960         - name: interface-name
10961           in: path
10962           description: Name that identifies the link aggregate interface
10963           required: true
10964           type: string
10965           example: __INTERFACE-NAME__
10966         - name: interface-name
10967           in: path
10968           description: Name given to the interface
10969           required: true
10970           type: string
10971           example: __INTERFACE-NAME__
10972         - name: vlan-interface
10973           in: path
10974           description: String that identifies the interface
10975           required: true
10976           type: string
10977           example: __VLAN-INTERFACE__
10978   /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:
10979     put:
10980       tags:
10981         - CloudInfrastructure
10982       summary: see node definition for valid relationships
10983       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
10984       consumes:
10985         - application/json
10986         - application/xml
10987       produces:
10988         - application/json
10989         - application/xml
10990       responses:
10991         "default":
10992           description: Response codes found in [response codes](https://wiki.onap.org/).
10993       parameters:
10994         - name: hostname
10995           in: path
10996           description: Value from executing hostname on the compute node.
10997           required: true
10998           type: string
10999           example: __HOSTNAME__
11000         - name: interface-name
11001           in: path
11002           description: Name that identifies the link aggregate interface
11003           required: true
11004           type: string
11005           example: __INTERFACE-NAME__
11006         - name: interface-name
11007           in: path
11008           description: Name given to the interface
11009           required: true
11010           type: string
11011           example: __INTERFACE-NAME__
11012         - name: vlan-interface
11013           in: path
11014           description: String that identifies the interface
11015           required: true
11016           type: string
11017           example: __VLAN-INTERFACE__
11018         - name: l3-interface-ipv4-address
11019           in: path
11020           description: IP address
11021           required: true
11022           type: string
11023           example: __L3-INTERFACE-IPV4-ADDRESS__
11024         - name: body
11025           in: body
11026           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11027           required: true
11028           schema:
11029             $ref: "#/definitions/relationship"
11030     delete:
11031       tags:
11032         - CloudInfrastructure
11033       summary: delete an existing relationship
11034       description: delete an existing relationship
11035       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11036       consumes:
11037         - application/json
11038         - application/xml
11039       produces:
11040         - application/json
11041         - application/xml
11042       responses:
11043         "default":
11044           description: Response codes found in [response codes](https://wiki.onap.org/).
11045       parameters:
11046         - name: hostname
11047           in: path
11048           description: Value from executing hostname on the compute node.
11049           required: true
11050           type: string
11051           example: __HOSTNAME__
11052         - name: interface-name
11053           in: path
11054           description: Name that identifies the link aggregate interface
11055           required: true
11056           type: string
11057           example: __INTERFACE-NAME__
11058         - name: interface-name
11059           in: path
11060           description: Name given to the interface
11061           required: true
11062           type: string
11063           example: __INTERFACE-NAME__
11064         - name: vlan-interface
11065           in: path
11066           description: String that identifies the interface
11067           required: true
11068           type: string
11069           example: __VLAN-INTERFACE__
11070         - name: l3-interface-ipv4-address
11071           in: path
11072           description: IP address
11073           required: true
11074           type: string
11075           example: __L3-INTERFACE-IPV4-ADDRESS__
11076   /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}:
11077     get:
11078       tags:
11079         - CloudInfrastructure
11080       summary: returns l3-interface-ipv4-address-list
11081       description: returns l3-interface-ipv4-address-list
11082       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11083       produces:
11084         - application/json
11085         - application/xml
11086       responses:
11087         "200":
11088           description: successful operation
11089           schema:
11090               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11091         "default":
11092           description: Response codes found in [response codes](https://wiki.onap.org/).
11093       parameters:
11094         - name: hostname
11095           in: path
11096           description: Value from executing hostname on the compute node.
11097           required: true
11098           type: string
11099           example: __HOSTNAME__
11100         - name: interface-name
11101           in: path
11102           description: Name that identifies the link aggregate interface
11103           required: true
11104           type: string
11105           example: __INTERFACE-NAME__
11106         - name: interface-name
11107           in: path
11108           description: Name given to the interface
11109           required: true
11110           type: string
11111           example: __INTERFACE-NAME__
11112         - name: vlan-interface
11113           in: path
11114           description: String that identifies the interface
11115           required: true
11116           type: string
11117           example: __VLAN-INTERFACE__
11118         - name: l3-interface-ipv4-address
11119           in: path
11120           description: IP address
11121           required: true
11122           type: string
11123           example: __L3-INTERFACE-IPV4-ADDRESS__
11124         - name: pserver-id
11125           in: query
11126           description: ID of Pserver
11127           required: false
11128           type: string
11129         - name: in-maint
11130           in: query
11131           required: false
11132           type: boolean
11133         - name: pserver-name2
11134           in: query
11135           description: alternative pserver name
11136           required: false
11137           type: string
11138         - name: interface-id
11139           in: query
11140           description: ID of interface
11141           required: false
11142           type: string
11143         - name: macaddr
11144           in: query
11145           description: MAC address for the interface
11146           required: false
11147           type: string
11148         - name: network-name
11149           in: query
11150           description: Name of the network
11151           required: false
11152           type: string
11153         - name: vlan-id-inner
11154           in: query
11155           description: Inner VLAN tag
11156           required: false
11157           type: integer
11158           format: int64
11159         - name: vpn-id
11160           in: query
11161           description: This indicates the customers VPN ID associated with this vlan
11162           required: false
11163           type: string
11164         - name: vlan-id-inner
11165           in: query
11166           description: Inner VLAN tag
11167           required: false
11168           type: integer
11169           format: int64
11170         - name: neutron-network-id
11171           in: query
11172           description: Neutron network id of the interface that address belongs to
11173           required: false
11174           type: string
11175         - name: neutron-subnet-id
11176           in: query
11177           description: Neutron id of subnet that address belongs to
11178           required: false
11179           type: string
11180     put:
11181       tags:
11182         - CloudInfrastructure
11183       summary: create or update an existing l3-interface-ipv4-address-list
11184       description: |
11185         Create or update an existing l3-interface-ipv4-address-list.
11186         #
11187         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
11188       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11189       consumes:
11190         - application/json
11191         - application/xml
11192       produces:
11193         - application/json
11194         - application/xml
11195       responses:
11196         "default":
11197           description: Response codes found in [response codes](https://wiki.onap.org/).
11198       parameters:
11199         - name: hostname
11200           in: path
11201           description: Value from executing hostname on the compute node.
11202           required: true
11203           type: string
11204           example: __HOSTNAME__
11205         - name: interface-name
11206           in: path
11207           description: Name that identifies the link aggregate interface
11208           required: true
11209           type: string
11210           example: __INTERFACE-NAME__
11211         - name: interface-name
11212           in: path
11213           description: Name given to the interface
11214           required: true
11215           type: string
11216           example: __INTERFACE-NAME__
11217         - name: vlan-interface
11218           in: path
11219           description: String that identifies the interface
11220           required: true
11221           type: string
11222           example: __VLAN-INTERFACE__
11223         - name: l3-interface-ipv4-address
11224           in: path
11225           description: IP address
11226           required: true
11227           type: string
11228           example: __L3-INTERFACE-IPV4-ADDRESS__
11229         - name: body
11230           in: body
11231           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11232           required: true
11233           schema:
11234             $ref: "#/definitions/l3-interface-ipv4-address-list"
11235     patch:
11236       tags:
11237         - CloudInfrastructure
11238       summary: update an existing l3-interface-ipv4-address-list
11239       description: |
11240         Update an existing l3-interface-ipv4-address-list
11241         #
11242         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11243         The PUT operation will entirely replace an existing object.
11244         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.
11245         #
11246         Other differences between PUT and PATCH are:
11247         #
11248         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11249         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11250         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11251       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11252       consumes:
11253         - application/json
11254         - application/xml
11255       produces:
11256         - application/json
11257         - application/xml
11258       responses:
11259         "default":
11260           description: Response codes found in [response codes](https://wiki.onap.org/).
11261       parameters:
11262         - name: hostname
11263           in: path
11264           description: Value from executing hostname on the compute node.
11265           required: true
11266           type: string
11267           example: __HOSTNAME__
11268         - name: interface-name
11269           in: path
11270           description: Name that identifies the link aggregate interface
11271           required: true
11272           type: string
11273           example: __INTERFACE-NAME__
11274         - name: interface-name
11275           in: path
11276           description: Name given to the interface
11277           required: true
11278           type: string
11279           example: __INTERFACE-NAME__
11280         - name: vlan-interface
11281           in: path
11282           description: String that identifies the interface
11283           required: true
11284           type: string
11285           example: __VLAN-INTERFACE__
11286         - name: l3-interface-ipv4-address
11287           in: path
11288           description: IP address
11289           required: true
11290           type: string
11291           example: __L3-INTERFACE-IPV4-ADDRESS__
11292         - name: body
11293           in: body
11294           description: l3-interface-ipv4-address-list object that needs to be created or updated.
11295           required: true
11296           schema:
11297             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11298     delete:
11299       tags:
11300         - CloudInfrastructure
11301       summary: delete an existing l3-interface-ipv4-address-list
11302       description: delete an existing l3-interface-ipv4-address-list
11303       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11304       consumes:
11305         - application/json
11306         - application/xml
11307       produces:
11308         - application/json
11309         - application/xml
11310       responses:
11311         "default":
11312           description: Response codes found in [response codes](https://wiki.onap.org/).
11313       parameters:
11314         - name: hostname
11315           in: path
11316           description: Value from executing hostname on the compute node.
11317           required: true
11318           type: string
11319           example: __HOSTNAME__
11320         - name: interface-name
11321           in: path
11322           description: Name that identifies the link aggregate interface
11323           required: true
11324           type: string
11325           example: __INTERFACE-NAME__
11326         - name: interface-name
11327           in: path
11328           description: Name given to the interface
11329           required: true
11330           type: string
11331           example: __INTERFACE-NAME__
11332         - name: vlan-interface
11333           in: path
11334           description: String that identifies the interface
11335           required: true
11336           type: string
11337           example: __VLAN-INTERFACE__
11338         - name: l3-interface-ipv4-address
11339           in: path
11340           description: IP address
11341           required: true
11342           type: string
11343           example: __L3-INTERFACE-IPV4-ADDRESS__
11344         - name: resource-version
11345           in: query
11346           description: resource-version for concurrency
11347           required: true
11348           type: string
11349   /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:
11350     put:
11351       tags:
11352         - CloudInfrastructure
11353       summary: see node definition for valid relationships
11354       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11355       consumes:
11356         - application/json
11357         - application/xml
11358       produces:
11359         - application/json
11360         - application/xml
11361       responses:
11362         "default":
11363           description: Response codes found in [response codes](https://wiki.onap.org/).
11364       parameters:
11365         - name: hostname
11366           in: path
11367           description: Value from executing hostname on the compute node.
11368           required: true
11369           type: string
11370           example: __HOSTNAME__
11371         - name: interface-name
11372           in: path
11373           description: Name that identifies the link aggregate interface
11374           required: true
11375           type: string
11376           example: __INTERFACE-NAME__
11377         - name: interface-name
11378           in: path
11379           description: Name given to the interface
11380           required: true
11381           type: string
11382           example: __INTERFACE-NAME__
11383         - name: vlan-interface
11384           in: path
11385           description: String that identifies the interface
11386           required: true
11387           type: string
11388           example: __VLAN-INTERFACE__
11389         - name: l3-interface-ipv6-address
11390           in: path
11391           description: IP address
11392           required: true
11393           type: string
11394           example: __L3-INTERFACE-IPV6-ADDRESS__
11395         - name: body
11396           in: body
11397           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11398           required: true
11399           schema:
11400             $ref: "#/definitions/relationship"
11401     delete:
11402       tags:
11403         - CloudInfrastructure
11404       summary: delete an existing relationship
11405       description: delete an existing relationship
11406       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11407       consumes:
11408         - application/json
11409         - application/xml
11410       produces:
11411         - application/json
11412         - application/xml
11413       responses:
11414         "default":
11415           description: Response codes found in [response codes](https://wiki.onap.org/).
11416       parameters:
11417         - name: hostname
11418           in: path
11419           description: Value from executing hostname on the compute node.
11420           required: true
11421           type: string
11422           example: __HOSTNAME__
11423         - name: interface-name
11424           in: path
11425           description: Name that identifies the link aggregate interface
11426           required: true
11427           type: string
11428           example: __INTERFACE-NAME__
11429         - name: interface-name
11430           in: path
11431           description: Name given to the interface
11432           required: true
11433           type: string
11434           example: __INTERFACE-NAME__
11435         - name: vlan-interface
11436           in: path
11437           description: String that identifies the interface
11438           required: true
11439           type: string
11440           example: __VLAN-INTERFACE__
11441         - name: l3-interface-ipv6-address
11442           in: path
11443           description: IP address
11444           required: true
11445           type: string
11446           example: __L3-INTERFACE-IPV6-ADDRESS__
11447   /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}:
11448     get:
11449       tags:
11450         - CloudInfrastructure
11451       summary: returns l3-interface-ipv6-address-list
11452       description: returns l3-interface-ipv6-address-list
11453       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11454       produces:
11455         - application/json
11456         - application/xml
11457       responses:
11458         "200":
11459           description: successful operation
11460           schema:
11461               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11462         "default":
11463           description: Response codes found in [response codes](https://wiki.onap.org/).
11464       parameters:
11465         - name: hostname
11466           in: path
11467           description: Value from executing hostname on the compute node.
11468           required: true
11469           type: string
11470           example: __HOSTNAME__
11471         - name: interface-name
11472           in: path
11473           description: Name that identifies the link aggregate interface
11474           required: true
11475           type: string
11476           example: __INTERFACE-NAME__
11477         - name: interface-name
11478           in: path
11479           description: Name given to the interface
11480           required: true
11481           type: string
11482           example: __INTERFACE-NAME__
11483         - name: vlan-interface
11484           in: path
11485           description: String that identifies the interface
11486           required: true
11487           type: string
11488           example: __VLAN-INTERFACE__
11489         - name: l3-interface-ipv6-address
11490           in: path
11491           description: IP address
11492           required: true
11493           type: string
11494           example: __L3-INTERFACE-IPV6-ADDRESS__
11495         - name: pserver-id
11496           in: query
11497           description: ID of Pserver
11498           required: false
11499           type: string
11500         - name: in-maint
11501           in: query
11502           required: false
11503           type: boolean
11504         - name: pserver-name2
11505           in: query
11506           description: alternative pserver name
11507           required: false
11508           type: string
11509         - name: interface-id
11510           in: query
11511           description: ID of interface
11512           required: false
11513           type: string
11514         - name: macaddr
11515           in: query
11516           description: MAC address for the interface
11517           required: false
11518           type: string
11519         - name: network-name
11520           in: query
11521           description: Name of the network
11522           required: false
11523           type: string
11524         - name: vlan-id-inner
11525           in: query
11526           description: Inner VLAN tag
11527           required: false
11528           type: integer
11529           format: int64
11530         - name: vpn-id
11531           in: query
11532           description: This indicates the customers VPN ID associated with this vlan
11533           required: false
11534           type: string
11535         - name: vlan-id-inner
11536           in: query
11537           description: Inner VLAN tag
11538           required: false
11539           type: integer
11540           format: int64
11541         - name: neutron-network-id
11542           in: query
11543           description: Neutron network id of the interface that address belongs to
11544           required: false
11545           type: string
11546         - name: neutron-subnet-id
11547           in: query
11548           description: Neutron id of subnet that address belongs to
11549           required: false
11550           type: string
11551     put:
11552       tags:
11553         - CloudInfrastructure
11554       summary: create or update an existing l3-interface-ipv6-address-list
11555       description: |
11556         Create or update an existing l3-interface-ipv6-address-list.
11557         #
11558         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
11559       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11560       consumes:
11561         - application/json
11562         - application/xml
11563       produces:
11564         - application/json
11565         - application/xml
11566       responses:
11567         "default":
11568           description: Response codes found in [response codes](https://wiki.onap.org/).
11569       parameters:
11570         - name: hostname
11571           in: path
11572           description: Value from executing hostname on the compute node.
11573           required: true
11574           type: string
11575           example: __HOSTNAME__
11576         - name: interface-name
11577           in: path
11578           description: Name that identifies the link aggregate interface
11579           required: true
11580           type: string
11581           example: __INTERFACE-NAME__
11582         - name: interface-name
11583           in: path
11584           description: Name given to the interface
11585           required: true
11586           type: string
11587           example: __INTERFACE-NAME__
11588         - name: vlan-interface
11589           in: path
11590           description: String that identifies the interface
11591           required: true
11592           type: string
11593           example: __VLAN-INTERFACE__
11594         - name: l3-interface-ipv6-address
11595           in: path
11596           description: IP address
11597           required: true
11598           type: string
11599           example: __L3-INTERFACE-IPV6-ADDRESS__
11600         - name: body
11601           in: body
11602           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11603           required: true
11604           schema:
11605             $ref: "#/definitions/l3-interface-ipv6-address-list"
11606     patch:
11607       tags:
11608         - CloudInfrastructure
11609       summary: update an existing l3-interface-ipv6-address-list
11610       description: |
11611         Update an existing l3-interface-ipv6-address-list
11612         #
11613         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11614         The PUT operation will entirely replace an existing object.
11615         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.
11616         #
11617         Other differences between PUT and PATCH are:
11618         #
11619         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11620         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11621         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11622       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11623       consumes:
11624         - application/json
11625         - application/xml
11626       produces:
11627         - application/json
11628         - application/xml
11629       responses:
11630         "default":
11631           description: Response codes found in [response codes](https://wiki.onap.org/).
11632       parameters:
11633         - name: hostname
11634           in: path
11635           description: Value from executing hostname on the compute node.
11636           required: true
11637           type: string
11638           example: __HOSTNAME__
11639         - name: interface-name
11640           in: path
11641           description: Name that identifies the link aggregate interface
11642           required: true
11643           type: string
11644           example: __INTERFACE-NAME__
11645         - name: interface-name
11646           in: path
11647           description: Name given to the interface
11648           required: true
11649           type: string
11650           example: __INTERFACE-NAME__
11651         - name: vlan-interface
11652           in: path
11653           description: String that identifies the interface
11654           required: true
11655           type: string
11656           example: __VLAN-INTERFACE__
11657         - name: l3-interface-ipv6-address
11658           in: path
11659           description: IP address
11660           required: true
11661           type: string
11662           example: __L3-INTERFACE-IPV6-ADDRESS__
11663         - name: body
11664           in: body
11665           description: l3-interface-ipv6-address-list object that needs to be created or updated.
11666           required: true
11667           schema:
11668             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11669     delete:
11670       tags:
11671         - CloudInfrastructure
11672       summary: delete an existing l3-interface-ipv6-address-list
11673       description: delete an existing l3-interface-ipv6-address-list
11674       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11675       consumes:
11676         - application/json
11677         - application/xml
11678       produces:
11679         - application/json
11680         - application/xml
11681       responses:
11682         "default":
11683           description: Response codes found in [response codes](https://wiki.onap.org/).
11684       parameters:
11685         - name: hostname
11686           in: path
11687           description: Value from executing hostname on the compute node.
11688           required: true
11689           type: string
11690           example: __HOSTNAME__
11691         - name: interface-name
11692           in: path
11693           description: Name that identifies the link aggregate interface
11694           required: true
11695           type: string
11696           example: __INTERFACE-NAME__
11697         - name: interface-name
11698           in: path
11699           description: Name given to the interface
11700           required: true
11701           type: string
11702           example: __INTERFACE-NAME__
11703         - name: vlan-interface
11704           in: path
11705           description: String that identifies the interface
11706           required: true
11707           type: string
11708           example: __VLAN-INTERFACE__
11709         - name: l3-interface-ipv6-address
11710           in: path
11711           description: IP address
11712           required: true
11713           type: string
11714           example: __L3-INTERFACE-IPV6-ADDRESS__
11715         - name: resource-version
11716           in: query
11717           description: resource-version for concurrency
11718           required: true
11719           type: string
11720   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11721     get:
11722       tags:
11723         - CloudInfrastructure
11724       summary: returns vlan
11725       description: returns vlan
11726       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11727       produces:
11728         - application/json
11729         - application/xml
11730       responses:
11731         "200":
11732           description: successful operation
11733           schema:
11734               $ref: "#/getDefinitions/vlan"
11735         "default":
11736           description: Response codes found in [response codes](https://wiki.onap.org/).
11737       parameters:
11738         - name: hostname
11739           in: path
11740           description: Value from executing hostname on the compute node.
11741           required: true
11742           type: string
11743           example: __HOSTNAME__
11744         - name: interface-name
11745           in: path
11746           description: Name that identifies the link aggregate interface
11747           required: true
11748           type: string
11749           example: __INTERFACE-NAME__
11750         - name: interface-name
11751           in: path
11752           description: Name given to the interface
11753           required: true
11754           type: string
11755           example: __INTERFACE-NAME__
11756         - name: vlan-interface
11757           in: path
11758           description: String that identifies the interface
11759           required: true
11760           type: string
11761           example: __VLAN-INTERFACE__
11762         - name: pserver-id
11763           in: query
11764           description: ID of Pserver
11765           required: false
11766           type: string
11767         - name: in-maint
11768           in: query
11769           required: false
11770           type: boolean
11771         - name: pserver-name2
11772           in: query
11773           description: alternative pserver name
11774           required: false
11775           type: string
11776         - name: interface-id
11777           in: query
11778           description: ID of interface
11779           required: false
11780           type: string
11781         - name: macaddr
11782           in: query
11783           description: MAC address for the interface
11784           required: false
11785           type: string
11786         - name: network-name
11787           in: query
11788           description: Name of the network
11789           required: false
11790           type: string
11791         - name: vlan-id-inner
11792           in: query
11793           description: Inner VLAN tag
11794           required: false
11795           type: integer
11796           format: int64
11797         - name: vpn-id
11798           in: query
11799           description: This indicates the customers VPN ID associated with this vlan
11800           required: false
11801           type: string
11802     put:
11803       tags:
11804         - CloudInfrastructure
11805       summary: create or update an existing vlan
11806       description: |
11807         Create or update an existing vlan.
11808         #
11809         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
11810       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11811       consumes:
11812         - application/json
11813         - application/xml
11814       produces:
11815         - application/json
11816         - application/xml
11817       responses:
11818         "default":
11819           description: Response codes found in [response codes](https://wiki.onap.org/).
11820       parameters:
11821         - name: hostname
11822           in: path
11823           description: Value from executing hostname on the compute node.
11824           required: true
11825           type: string
11826           example: __HOSTNAME__
11827         - name: interface-name
11828           in: path
11829           description: Name that identifies the link aggregate interface
11830           required: true
11831           type: string
11832           example: __INTERFACE-NAME__
11833         - name: interface-name
11834           in: path
11835           description: Name given to the interface
11836           required: true
11837           type: string
11838           example: __INTERFACE-NAME__
11839         - name: vlan-interface
11840           in: path
11841           description: String that identifies the interface
11842           required: true
11843           type: string
11844           example: __VLAN-INTERFACE__
11845         - name: body
11846           in: body
11847           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11848           required: true
11849           schema:
11850             $ref: "#/definitions/vlan"
11851     patch:
11852       tags:
11853         - CloudInfrastructure
11854       summary: update an existing vlan
11855       description: |
11856         Update an existing vlan
11857         #
11858         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11859         The PUT operation will entirely replace an existing object.
11860         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.
11861         #
11862         Other differences between PUT and PATCH are:
11863         #
11864         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11865         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11866         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11867       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11868       consumes:
11869         - application/json
11870         - application/xml
11871       produces:
11872         - application/json
11873         - application/xml
11874       responses:
11875         "default":
11876           description: Response codes found in [response codes](https://wiki.onap.org/).
11877       parameters:
11878         - name: hostname
11879           in: path
11880           description: Value from executing hostname on the compute node.
11881           required: true
11882           type: string
11883           example: __HOSTNAME__
11884         - name: interface-name
11885           in: path
11886           description: Name that identifies the link aggregate interface
11887           required: true
11888           type: string
11889           example: __INTERFACE-NAME__
11890         - name: interface-name
11891           in: path
11892           description: Name given to the interface
11893           required: true
11894           type: string
11895           example: __INTERFACE-NAME__
11896         - name: vlan-interface
11897           in: path
11898           description: String that identifies the interface
11899           required: true
11900           type: string
11901           example: __VLAN-INTERFACE__
11902         - name: body
11903           in: body
11904           description: vlan object that needs to be created or updated.
11905           required: true
11906           schema:
11907             $ref: "#/patchDefinitions/vlan"
11908     delete:
11909       tags:
11910         - CloudInfrastructure
11911       summary: delete an existing vlan
11912       description: delete an existing vlan
11913       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11914       consumes:
11915         - application/json
11916         - application/xml
11917       produces:
11918         - application/json
11919         - application/xml
11920       responses:
11921         "default":
11922           description: Response codes found in [response codes](https://wiki.onap.org/).
11923       parameters:
11924         - name: hostname
11925           in: path
11926           description: Value from executing hostname on the compute node.
11927           required: true
11928           type: string
11929           example: __HOSTNAME__
11930         - name: interface-name
11931           in: path
11932           description: Name that identifies the link aggregate interface
11933           required: true
11934           type: string
11935           example: __INTERFACE-NAME__
11936         - name: interface-name
11937           in: path
11938           description: Name given to the interface
11939           required: true
11940           type: string
11941           example: __INTERFACE-NAME__
11942         - name: vlan-interface
11943           in: path
11944           description: String that identifies the interface
11945           required: true
11946           type: string
11947           example: __VLAN-INTERFACE__
11948         - name: resource-version
11949           in: query
11950           description: resource-version for concurrency
11951           required: true
11952           type: string
11953   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
11954     get:
11955       tags:
11956         - CloudInfrastructure
11957       summary: returns vlans
11958       description: returns vlans
11959       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
11960       produces:
11961         - application/json
11962         - application/xml
11963       responses:
11964         "200":
11965           description: successful operation
11966           schema:
11967               $ref: "#/getDefinitions/vlans"
11968         "default":
11969           description: Response codes found in [response codes](https://wiki.onap.org/).
11970       parameters:
11971         - name: hostname
11972           in: path
11973           description: Value from executing hostname on the compute node.
11974           required: true
11975           type: string
11976           example: __HOSTNAME__
11977         - name: interface-name
11978           in: path
11979           description: Name that identifies the link aggregate interface
11980           required: true
11981           type: string
11982           example: __INTERFACE-NAME__
11983         - name: interface-name
11984           in: path
11985           description: Name given to the interface
11986           required: true
11987           type: string
11988           example: __INTERFACE-NAME__
11989         - name: pserver-id
11990           in: query
11991           description: ID of Pserver
11992           required: false
11993           type: string
11994         - name: in-maint
11995           in: query
11996           required: false
11997           type: boolean
11998         - name: pserver-name2
11999           in: query
12000           description: alternative pserver name
12001           required: false
12002           type: string
12003         - name: interface-id
12004           in: query
12005           description: ID of interface
12006           required: false
12007           type: string
12008         - name: macaddr
12009           in: query
12010           description: MAC address for the interface
12011           required: false
12012           type: string
12013         - name: network-name
12014           in: query
12015           description: Name of the network
12016           required: false
12017           type: string
12018   /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:
12019     put:
12020       tags:
12021         - CloudInfrastructure
12022       summary: see node definition for valid relationships
12023       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12024       consumes:
12025         - application/json
12026         - application/xml
12027       produces:
12028         - application/json
12029         - application/xml
12030       responses:
12031         "default":
12032           description: Response codes found in [response codes](https://wiki.onap.org/).
12033       parameters:
12034         - name: hostname
12035           in: path
12036           description: Value from executing hostname on the compute node.
12037           required: true
12038           type: string
12039           example: __HOSTNAME__
12040         - name: interface-name
12041           in: path
12042           description: Name that identifies the link aggregate interface
12043           required: true
12044           type: string
12045           example: __INTERFACE-NAME__
12046         - name: interface-name
12047           in: path
12048           description: Name given to the interface
12049           required: true
12050           type: string
12051           example: __INTERFACE-NAME__
12052         - name: pci-id
12053           in: path
12054           description: PCI ID used to identify the sriov-vf
12055           required: true
12056           type: string
12057           example: __PCI-ID__
12058         - name: body
12059           in: body
12060           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12061           required: true
12062           schema:
12063             $ref: "#/definitions/relationship"
12064     delete:
12065       tags:
12066         - CloudInfrastructure
12067       summary: delete an existing relationship
12068       description: delete an existing relationship
12069       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12070       consumes:
12071         - application/json
12072         - application/xml
12073       produces:
12074         - application/json
12075         - application/xml
12076       responses:
12077         "default":
12078           description: Response codes found in [response codes](https://wiki.onap.org/).
12079       parameters:
12080         - name: hostname
12081           in: path
12082           description: Value from executing hostname on the compute node.
12083           required: true
12084           type: string
12085           example: __HOSTNAME__
12086         - name: interface-name
12087           in: path
12088           description: Name that identifies the link aggregate interface
12089           required: true
12090           type: string
12091           example: __INTERFACE-NAME__
12092         - name: interface-name
12093           in: path
12094           description: Name given to the interface
12095           required: true
12096           type: string
12097           example: __INTERFACE-NAME__
12098         - name: pci-id
12099           in: path
12100           description: PCI ID used to identify the sriov-vf
12101           required: true
12102           type: string
12103           example: __PCI-ID__
12104   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12105     get:
12106       tags:
12107         - CloudInfrastructure
12108       summary: returns sriov-vf
12109       description: returns sriov-vf
12110       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12111       produces:
12112         - application/json
12113         - application/xml
12114       responses:
12115         "200":
12116           description: successful operation
12117           schema:
12118               $ref: "#/getDefinitions/sriov-vf"
12119         "default":
12120           description: Response codes found in [response codes](https://wiki.onap.org/).
12121       parameters:
12122         - name: hostname
12123           in: path
12124           description: Value from executing hostname on the compute node.
12125           required: true
12126           type: string
12127           example: __HOSTNAME__
12128         - name: interface-name
12129           in: path
12130           description: Name that identifies the link aggregate interface
12131           required: true
12132           type: string
12133           example: __INTERFACE-NAME__
12134         - name: interface-name
12135           in: path
12136           description: Name given to the interface
12137           required: true
12138           type: string
12139           example: __INTERFACE-NAME__
12140         - name: pci-id
12141           in: path
12142           description: PCI ID used to identify the sriov-vf
12143           required: true
12144           type: string
12145           example: __PCI-ID__
12146         - name: pserver-id
12147           in: query
12148           description: ID of Pserver
12149           required: false
12150           type: string
12151         - name: in-maint
12152           in: query
12153           required: false
12154           type: boolean
12155         - name: pserver-name2
12156           in: query
12157           description: alternative pserver name
12158           required: false
12159           type: string
12160         - name: interface-id
12161           in: query
12162           description: ID of interface
12163           required: false
12164           type: string
12165         - name: macaddr
12166           in: query
12167           description: MAC address for the interface
12168           required: false
12169           type: string
12170         - name: network-name
12171           in: query
12172           description: Name of the network
12173           required: false
12174           type: string
12175         - name: vf-vlan-filter
12176           in: query
12177           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
12178           required: false
12179           type: string
12180         - name: vf-mac-filter
12181           in: query
12182           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
12183           required: false
12184           type: string
12185         - name: vf-vlan-strip
12186           in: query
12187           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
12188           required: false
12189           type: boolean
12190         - name: neutron-network-id
12191           in: query
12192           description: Neutron network id of the interface
12193           required: false
12194           type: string
12195     put:
12196       tags:
12197         - CloudInfrastructure
12198       summary: create or update an existing sriov-vf
12199       description: |
12200         Create or update an existing sriov-vf.
12201         #
12202         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
12203       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12204       consumes:
12205         - application/json
12206         - application/xml
12207       produces:
12208         - application/json
12209         - application/xml
12210       responses:
12211         "default":
12212           description: Response codes found in [response codes](https://wiki.onap.org/).
12213       parameters:
12214         - name: hostname
12215           in: path
12216           description: Value from executing hostname on the compute node.
12217           required: true
12218           type: string
12219           example: __HOSTNAME__
12220         - name: interface-name
12221           in: path
12222           description: Name that identifies the link aggregate interface
12223           required: true
12224           type: string
12225           example: __INTERFACE-NAME__
12226         - name: interface-name
12227           in: path
12228           description: Name given to the interface
12229           required: true
12230           type: string
12231           example: __INTERFACE-NAME__
12232         - name: pci-id
12233           in: path
12234           description: PCI ID used to identify the sriov-vf
12235           required: true
12236           type: string
12237           example: __PCI-ID__
12238         - name: body
12239           in: body
12240           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12241           required: true
12242           schema:
12243             $ref: "#/definitions/sriov-vf"
12244     patch:
12245       tags:
12246         - CloudInfrastructure
12247       summary: update an existing sriov-vf
12248       description: |
12249         Update an existing sriov-vf
12250         #
12251         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12252         The PUT operation will entirely replace an existing object.
12253         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.
12254         #
12255         Other differences between PUT and PATCH are:
12256         #
12257         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12258         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12259         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12260       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12261       consumes:
12262         - application/json
12263         - application/xml
12264       produces:
12265         - application/json
12266         - application/xml
12267       responses:
12268         "default":
12269           description: Response codes found in [response codes](https://wiki.onap.org/).
12270       parameters:
12271         - name: hostname
12272           in: path
12273           description: Value from executing hostname on the compute node.
12274           required: true
12275           type: string
12276           example: __HOSTNAME__
12277         - name: interface-name
12278           in: path
12279           description: Name that identifies the link aggregate interface
12280           required: true
12281           type: string
12282           example: __INTERFACE-NAME__
12283         - name: interface-name
12284           in: path
12285           description: Name given to the interface
12286           required: true
12287           type: string
12288           example: __INTERFACE-NAME__
12289         - name: pci-id
12290           in: path
12291           description: PCI ID used to identify the sriov-vf
12292           required: true
12293           type: string
12294           example: __PCI-ID__
12295         - name: body
12296           in: body
12297           description: sriov-vf object that needs to be created or updated.
12298           required: true
12299           schema:
12300             $ref: "#/patchDefinitions/sriov-vf"
12301     delete:
12302       tags:
12303         - CloudInfrastructure
12304       summary: delete an existing sriov-vf
12305       description: delete an existing sriov-vf
12306       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12307       consumes:
12308         - application/json
12309         - application/xml
12310       produces:
12311         - application/json
12312         - application/xml
12313       responses:
12314         "default":
12315           description: Response codes found in [response codes](https://wiki.onap.org/).
12316       parameters:
12317         - name: hostname
12318           in: path
12319           description: Value from executing hostname on the compute node.
12320           required: true
12321           type: string
12322           example: __HOSTNAME__
12323         - name: interface-name
12324           in: path
12325           description: Name that identifies the link aggregate interface
12326           required: true
12327           type: string
12328           example: __INTERFACE-NAME__
12329         - name: interface-name
12330           in: path
12331           description: Name given to the interface
12332           required: true
12333           type: string
12334           example: __INTERFACE-NAME__
12335         - name: pci-id
12336           in: path
12337           description: PCI ID used to identify the sriov-vf
12338           required: true
12339           type: string
12340           example: __PCI-ID__
12341         - name: resource-version
12342           in: query
12343           description: resource-version for concurrency
12344           required: true
12345           type: string
12346   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12347     get:
12348       tags:
12349         - CloudInfrastructure
12350       summary: returns sriov-vfs
12351       description: returns sriov-vfs
12352       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12353       produces:
12354         - application/json
12355         - application/xml
12356       responses:
12357         "200":
12358           description: successful operation
12359           schema:
12360               $ref: "#/getDefinitions/sriov-vfs"
12361         "default":
12362           description: Response codes found in [response codes](https://wiki.onap.org/).
12363       parameters:
12364         - name: hostname
12365           in: path
12366           description: Value from executing hostname on the compute node.
12367           required: true
12368           type: string
12369           example: __HOSTNAME__
12370         - name: interface-name
12371           in: path
12372           description: Name that identifies the link aggregate interface
12373           required: true
12374           type: string
12375           example: __INTERFACE-NAME__
12376         - name: interface-name
12377           in: path
12378           description: Name given to the interface
12379           required: true
12380           type: string
12381           example: __INTERFACE-NAME__
12382         - name: pserver-id
12383           in: query
12384           description: ID of Pserver
12385           required: false
12386           type: string
12387         - name: in-maint
12388           in: query
12389           required: false
12390           type: boolean
12391         - name: pserver-name2
12392           in: query
12393           description: alternative pserver name
12394           required: false
12395           type: string
12396         - name: interface-id
12397           in: query
12398           description: ID of interface
12399           required: false
12400           type: string
12401         - name: macaddr
12402           in: query
12403           description: MAC address for the interface
12404           required: false
12405           type: string
12406         - name: network-name
12407           in: query
12408           description: Name of the network
12409           required: false
12410           type: string
12411   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12412     put:
12413       tags:
12414         - CloudInfrastructure
12415       summary: see node definition for valid relationships
12416       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12417       consumes:
12418         - application/json
12419         - application/xml
12420       produces:
12421         - application/json
12422         - application/xml
12423       responses:
12424         "default":
12425           description: Response codes found in [response codes](https://wiki.onap.org/).
12426       parameters:
12427         - name: hostname
12428           in: path
12429           description: Value from executing hostname on the compute node.
12430           required: true
12431           type: string
12432           example: __HOSTNAME__
12433         - name: interface-name
12434           in: path
12435           description: Name that identifies the link aggregate interface
12436           required: true
12437           type: string
12438           example: __INTERFACE-NAME__
12439         - name: interface-name
12440           in: path
12441           description: Name given to the interface
12442           required: true
12443           type: string
12444           example: __INTERFACE-NAME__
12445         - name: body
12446           in: body
12447           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12448           required: true
12449           schema:
12450             $ref: "#/definitions/relationship"
12451     delete:
12452       tags:
12453         - CloudInfrastructure
12454       summary: delete an existing relationship
12455       description: delete an existing relationship
12456       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12457       consumes:
12458         - application/json
12459         - application/xml
12460       produces:
12461         - application/json
12462         - application/xml
12463       responses:
12464         "default":
12465           description: Response codes found in [response codes](https://wiki.onap.org/).
12466       parameters:
12467         - name: hostname
12468           in: path
12469           description: Value from executing hostname on the compute node.
12470           required: true
12471           type: string
12472           example: __HOSTNAME__
12473         - name: interface-name
12474           in: path
12475           description: Name that identifies the link aggregate interface
12476           required: true
12477           type: string
12478           example: __INTERFACE-NAME__
12479         - name: interface-name
12480           in: path
12481           description: Name given to the interface
12482           required: true
12483           type: string
12484           example: __INTERFACE-NAME__
12485   /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:
12486     put:
12487       tags:
12488         - CloudInfrastructure
12489       summary: see node definition for valid relationships
12490       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12491       consumes:
12492         - application/json
12493         - application/xml
12494       produces:
12495         - application/json
12496         - application/xml
12497       responses:
12498         "default":
12499           description: Response codes found in [response codes](https://wiki.onap.org/).
12500       parameters:
12501         - name: hostname
12502           in: path
12503           description: Value from executing hostname on the compute node.
12504           required: true
12505           type: string
12506           example: __HOSTNAME__
12507         - name: interface-name
12508           in: path
12509           description: Name that identifies the link aggregate interface
12510           required: true
12511           type: string
12512           example: __INTERFACE-NAME__
12513         - name: interface-name
12514           in: path
12515           description: Name given to the interface
12516           required: true
12517           type: string
12518           example: __INTERFACE-NAME__
12519         - name: l3-interface-ipv4-address
12520           in: path
12521           description: IP address
12522           required: true
12523           type: string
12524           example: __L3-INTERFACE-IPV4-ADDRESS__
12525         - name: body
12526           in: body
12527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12528           required: true
12529           schema:
12530             $ref: "#/definitions/relationship"
12531     delete:
12532       tags:
12533         - CloudInfrastructure
12534       summary: delete an existing relationship
12535       description: delete an existing relationship
12536       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12537       consumes:
12538         - application/json
12539         - application/xml
12540       produces:
12541         - application/json
12542         - application/xml
12543       responses:
12544         "default":
12545           description: Response codes found in [response codes](https://wiki.onap.org/).
12546       parameters:
12547         - name: hostname
12548           in: path
12549           description: Value from executing hostname on the compute node.
12550           required: true
12551           type: string
12552           example: __HOSTNAME__
12553         - name: interface-name
12554           in: path
12555           description: Name that identifies the link aggregate interface
12556           required: true
12557           type: string
12558           example: __INTERFACE-NAME__
12559         - name: interface-name
12560           in: path
12561           description: Name given to the interface
12562           required: true
12563           type: string
12564           example: __INTERFACE-NAME__
12565         - name: l3-interface-ipv4-address
12566           in: path
12567           description: IP address
12568           required: true
12569           type: string
12570           example: __L3-INTERFACE-IPV4-ADDRESS__
12571   /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}:
12572     get:
12573       tags:
12574         - CloudInfrastructure
12575       summary: returns l3-interface-ipv4-address-list
12576       description: returns l3-interface-ipv4-address-list
12577       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12578       produces:
12579         - application/json
12580         - application/xml
12581       responses:
12582         "200":
12583           description: successful operation
12584           schema:
12585               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12586         "default":
12587           description: Response codes found in [response codes](https://wiki.onap.org/).
12588       parameters:
12589         - name: hostname
12590           in: path
12591           description: Value from executing hostname on the compute node.
12592           required: true
12593           type: string
12594           example: __HOSTNAME__
12595         - name: interface-name
12596           in: path
12597           description: Name that identifies the link aggregate interface
12598           required: true
12599           type: string
12600           example: __INTERFACE-NAME__
12601         - name: interface-name
12602           in: path
12603           description: Name given to the interface
12604           required: true
12605           type: string
12606           example: __INTERFACE-NAME__
12607         - name: l3-interface-ipv4-address
12608           in: path
12609           description: IP address
12610           required: true
12611           type: string
12612           example: __L3-INTERFACE-IPV4-ADDRESS__
12613         - name: pserver-id
12614           in: query
12615           description: ID of Pserver
12616           required: false
12617           type: string
12618         - name: in-maint
12619           in: query
12620           required: false
12621           type: boolean
12622         - name: pserver-name2
12623           in: query
12624           description: alternative pserver name
12625           required: false
12626           type: string
12627         - name: interface-id
12628           in: query
12629           description: ID of interface
12630           required: false
12631           type: string
12632         - name: macaddr
12633           in: query
12634           description: MAC address for the interface
12635           required: false
12636           type: string
12637         - name: network-name
12638           in: query
12639           description: Name of the network
12640           required: false
12641           type: string
12642         - name: vlan-id-inner
12643           in: query
12644           description: Inner VLAN tag
12645           required: false
12646           type: integer
12647           format: int64
12648         - name: neutron-network-id
12649           in: query
12650           description: Neutron network id of the interface that address belongs to
12651           required: false
12652           type: string
12653         - name: neutron-subnet-id
12654           in: query
12655           description: Neutron id of subnet that address belongs to
12656           required: false
12657           type: string
12658     put:
12659       tags:
12660         - CloudInfrastructure
12661       summary: create or update an existing l3-interface-ipv4-address-list
12662       description: |
12663         Create or update an existing l3-interface-ipv4-address-list.
12664         #
12665         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
12666       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12667       consumes:
12668         - application/json
12669         - application/xml
12670       produces:
12671         - application/json
12672         - application/xml
12673       responses:
12674         "default":
12675           description: Response codes found in [response codes](https://wiki.onap.org/).
12676       parameters:
12677         - name: hostname
12678           in: path
12679           description: Value from executing hostname on the compute node.
12680           required: true
12681           type: string
12682           example: __HOSTNAME__
12683         - name: interface-name
12684           in: path
12685           description: Name that identifies the link aggregate interface
12686           required: true
12687           type: string
12688           example: __INTERFACE-NAME__
12689         - name: interface-name
12690           in: path
12691           description: Name given to the interface
12692           required: true
12693           type: string
12694           example: __INTERFACE-NAME__
12695         - name: l3-interface-ipv4-address
12696           in: path
12697           description: IP address
12698           required: true
12699           type: string
12700           example: __L3-INTERFACE-IPV4-ADDRESS__
12701         - name: body
12702           in: body
12703           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12704           required: true
12705           schema:
12706             $ref: "#/definitions/l3-interface-ipv4-address-list"
12707     patch:
12708       tags:
12709         - CloudInfrastructure
12710       summary: update an existing l3-interface-ipv4-address-list
12711       description: |
12712         Update an existing l3-interface-ipv4-address-list
12713         #
12714         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12715         The PUT operation will entirely replace an existing object.
12716         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.
12717         #
12718         Other differences between PUT and PATCH are:
12719         #
12720         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12721         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12722         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12723       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12724       consumes:
12725         - application/json
12726         - application/xml
12727       produces:
12728         - application/json
12729         - application/xml
12730       responses:
12731         "default":
12732           description: Response codes found in [response codes](https://wiki.onap.org/).
12733       parameters:
12734         - name: hostname
12735           in: path
12736           description: Value from executing hostname on the compute node.
12737           required: true
12738           type: string
12739           example: __HOSTNAME__
12740         - name: interface-name
12741           in: path
12742           description: Name that identifies the link aggregate interface
12743           required: true
12744           type: string
12745           example: __INTERFACE-NAME__
12746         - name: interface-name
12747           in: path
12748           description: Name given to the interface
12749           required: true
12750           type: string
12751           example: __INTERFACE-NAME__
12752         - name: l3-interface-ipv4-address
12753           in: path
12754           description: IP address
12755           required: true
12756           type: string
12757           example: __L3-INTERFACE-IPV4-ADDRESS__
12758         - name: body
12759           in: body
12760           description: l3-interface-ipv4-address-list object that needs to be created or updated.
12761           required: true
12762           schema:
12763             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12764     delete:
12765       tags:
12766         - CloudInfrastructure
12767       summary: delete an existing l3-interface-ipv4-address-list
12768       description: delete an existing l3-interface-ipv4-address-list
12769       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12770       consumes:
12771         - application/json
12772         - application/xml
12773       produces:
12774         - application/json
12775         - application/xml
12776       responses:
12777         "default":
12778           description: Response codes found in [response codes](https://wiki.onap.org/).
12779       parameters:
12780         - name: hostname
12781           in: path
12782           description: Value from executing hostname on the compute node.
12783           required: true
12784           type: string
12785           example: __HOSTNAME__
12786         - name: interface-name
12787           in: path
12788           description: Name that identifies the link aggregate interface
12789           required: true
12790           type: string
12791           example: __INTERFACE-NAME__
12792         - name: interface-name
12793           in: path
12794           description: Name given to the interface
12795           required: true
12796           type: string
12797           example: __INTERFACE-NAME__
12798         - name: l3-interface-ipv4-address
12799           in: path
12800           description: IP address
12801           required: true
12802           type: string
12803           example: __L3-INTERFACE-IPV4-ADDRESS__
12804         - name: resource-version
12805           in: query
12806           description: resource-version for concurrency
12807           required: true
12808           type: string
12809   /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:
12810     put:
12811       tags:
12812         - CloudInfrastructure
12813       summary: see node definition for valid relationships
12814       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12815       consumes:
12816         - application/json
12817         - application/xml
12818       produces:
12819         - application/json
12820         - application/xml
12821       responses:
12822         "default":
12823           description: Response codes found in [response codes](https://wiki.onap.org/).
12824       parameters:
12825         - name: hostname
12826           in: path
12827           description: Value from executing hostname on the compute node.
12828           required: true
12829           type: string
12830           example: __HOSTNAME__
12831         - name: interface-name
12832           in: path
12833           description: Name that identifies the link aggregate interface
12834           required: true
12835           type: string
12836           example: __INTERFACE-NAME__
12837         - name: interface-name
12838           in: path
12839           description: Name given to the interface
12840           required: true
12841           type: string
12842           example: __INTERFACE-NAME__
12843         - name: l3-interface-ipv6-address
12844           in: path
12845           description: IP address
12846           required: true
12847           type: string
12848           example: __L3-INTERFACE-IPV6-ADDRESS__
12849         - name: body
12850           in: body
12851           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
12852           required: true
12853           schema:
12854             $ref: "#/definitions/relationship"
12855     delete:
12856       tags:
12857         - CloudInfrastructure
12858       summary: delete an existing relationship
12859       description: delete an existing relationship
12860       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
12861       consumes:
12862         - application/json
12863         - application/xml
12864       produces:
12865         - application/json
12866         - application/xml
12867       responses:
12868         "default":
12869           description: Response codes found in [response codes](https://wiki.onap.org/).
12870       parameters:
12871         - name: hostname
12872           in: path
12873           description: Value from executing hostname on the compute node.
12874           required: true
12875           type: string
12876           example: __HOSTNAME__
12877         - name: interface-name
12878           in: path
12879           description: Name that identifies the link aggregate interface
12880           required: true
12881           type: string
12882           example: __INTERFACE-NAME__
12883         - name: interface-name
12884           in: path
12885           description: Name given to the interface
12886           required: true
12887           type: string
12888           example: __INTERFACE-NAME__
12889         - name: l3-interface-ipv6-address
12890           in: path
12891           description: IP address
12892           required: true
12893           type: string
12894           example: __L3-INTERFACE-IPV6-ADDRESS__
12895   /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}:
12896     get:
12897       tags:
12898         - CloudInfrastructure
12899       summary: returns l3-interface-ipv6-address-list
12900       description: returns l3-interface-ipv6-address-list
12901       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12902       produces:
12903         - application/json
12904         - application/xml
12905       responses:
12906         "200":
12907           description: successful operation
12908           schema:
12909               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12910         "default":
12911           description: Response codes found in [response codes](https://wiki.onap.org/).
12912       parameters:
12913         - name: hostname
12914           in: path
12915           description: Value from executing hostname on the compute node.
12916           required: true
12917           type: string
12918           example: __HOSTNAME__
12919         - name: interface-name
12920           in: path
12921           description: Name that identifies the link aggregate interface
12922           required: true
12923           type: string
12924           example: __INTERFACE-NAME__
12925         - name: interface-name
12926           in: path
12927           description: Name given to the interface
12928           required: true
12929           type: string
12930           example: __INTERFACE-NAME__
12931         - name: l3-interface-ipv6-address
12932           in: path
12933           description: IP address
12934           required: true
12935           type: string
12936           example: __L3-INTERFACE-IPV6-ADDRESS__
12937         - name: pserver-id
12938           in: query
12939           description: ID of Pserver
12940           required: false
12941           type: string
12942         - name: in-maint
12943           in: query
12944           required: false
12945           type: boolean
12946         - name: pserver-name2
12947           in: query
12948           description: alternative pserver name
12949           required: false
12950           type: string
12951         - name: interface-id
12952           in: query
12953           description: ID of interface
12954           required: false
12955           type: string
12956         - name: macaddr
12957           in: query
12958           description: MAC address for the interface
12959           required: false
12960           type: string
12961         - name: network-name
12962           in: query
12963           description: Name of the network
12964           required: false
12965           type: string
12966         - name: vlan-id-inner
12967           in: query
12968           description: Inner VLAN tag
12969           required: false
12970           type: integer
12971           format: int64
12972         - name: neutron-network-id
12973           in: query
12974           description: Neutron network id of the interface that address belongs to
12975           required: false
12976           type: string
12977         - name: neutron-subnet-id
12978           in: query
12979           description: Neutron id of subnet that address belongs to
12980           required: false
12981           type: string
12982     put:
12983       tags:
12984         - CloudInfrastructure
12985       summary: create or update an existing l3-interface-ipv6-address-list
12986       description: |
12987         Create or update an existing l3-interface-ipv6-address-list.
12988         #
12989         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
12990       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
12991       consumes:
12992         - application/json
12993         - application/xml
12994       produces:
12995         - application/json
12996         - application/xml
12997       responses:
12998         "default":
12999           description: Response codes found in [response codes](https://wiki.onap.org/).
13000       parameters:
13001         - name: hostname
13002           in: path
13003           description: Value from executing hostname on the compute node.
13004           required: true
13005           type: string
13006           example: __HOSTNAME__
13007         - name: interface-name
13008           in: path
13009           description: Name that identifies the link aggregate interface
13010           required: true
13011           type: string
13012           example: __INTERFACE-NAME__
13013         - name: interface-name
13014           in: path
13015           description: Name given to the interface
13016           required: true
13017           type: string
13018           example: __INTERFACE-NAME__
13019         - name: l3-interface-ipv6-address
13020           in: path
13021           description: IP address
13022           required: true
13023           type: string
13024           example: __L3-INTERFACE-IPV6-ADDRESS__
13025         - name: body
13026           in: body
13027           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13028           required: true
13029           schema:
13030             $ref: "#/definitions/l3-interface-ipv6-address-list"
13031     patch:
13032       tags:
13033         - CloudInfrastructure
13034       summary: update an existing l3-interface-ipv6-address-list
13035       description: |
13036         Update an existing l3-interface-ipv6-address-list
13037         #
13038         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13039         The PUT operation will entirely replace an existing object.
13040         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.
13041         #
13042         Other differences between PUT and PATCH are:
13043         #
13044         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13045         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13046         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13047       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13048       consumes:
13049         - application/json
13050         - application/xml
13051       produces:
13052         - application/json
13053         - application/xml
13054       responses:
13055         "default":
13056           description: Response codes found in [response codes](https://wiki.onap.org/).
13057       parameters:
13058         - name: hostname
13059           in: path
13060           description: Value from executing hostname on the compute node.
13061           required: true
13062           type: string
13063           example: __HOSTNAME__
13064         - name: interface-name
13065           in: path
13066           description: Name that identifies the link aggregate interface
13067           required: true
13068           type: string
13069           example: __INTERFACE-NAME__
13070         - name: interface-name
13071           in: path
13072           description: Name given to the interface
13073           required: true
13074           type: string
13075           example: __INTERFACE-NAME__
13076         - name: l3-interface-ipv6-address
13077           in: path
13078           description: IP address
13079           required: true
13080           type: string
13081           example: __L3-INTERFACE-IPV6-ADDRESS__
13082         - name: body
13083           in: body
13084           description: l3-interface-ipv6-address-list object that needs to be created or updated.
13085           required: true
13086           schema:
13087             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13088     delete:
13089       tags:
13090         - CloudInfrastructure
13091       summary: delete an existing l3-interface-ipv6-address-list
13092       description: delete an existing l3-interface-ipv6-address-list
13093       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13094       consumes:
13095         - application/json
13096         - application/xml
13097       produces:
13098         - application/json
13099         - application/xml
13100       responses:
13101         "default":
13102           description: Response codes found in [response codes](https://wiki.onap.org/).
13103       parameters:
13104         - name: hostname
13105           in: path
13106           description: Value from executing hostname on the compute node.
13107           required: true
13108           type: string
13109           example: __HOSTNAME__
13110         - name: interface-name
13111           in: path
13112           description: Name that identifies the link aggregate interface
13113           required: true
13114           type: string
13115           example: __INTERFACE-NAME__
13116         - name: interface-name
13117           in: path
13118           description: Name given to the interface
13119           required: true
13120           type: string
13121           example: __INTERFACE-NAME__
13122         - name: l3-interface-ipv6-address
13123           in: path
13124           description: IP address
13125           required: true
13126           type: string
13127           example: __L3-INTERFACE-IPV6-ADDRESS__
13128         - name: resource-version
13129           in: query
13130           description: resource-version for concurrency
13131           required: true
13132           type: string
13133   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13134     get:
13135       tags:
13136         - CloudInfrastructure
13137       summary: returns l-interface
13138       description: returns l-interface
13139       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13140       produces:
13141         - application/json
13142         - application/xml
13143       responses:
13144         "200":
13145           description: successful operation
13146           schema:
13147               $ref: "#/getDefinitions/l-interface"
13148         "default":
13149           description: Response codes found in [response codes](https://wiki.onap.org/).
13150       parameters:
13151         - name: hostname
13152           in: path
13153           description: Value from executing hostname on the compute node.
13154           required: true
13155           type: string
13156           example: __HOSTNAME__
13157         - name: interface-name
13158           in: path
13159           description: Name that identifies the link aggregate interface
13160           required: true
13161           type: string
13162           example: __INTERFACE-NAME__
13163         - name: interface-name
13164           in: path
13165           description: Name given to the interface
13166           required: true
13167           type: string
13168           example: __INTERFACE-NAME__
13169         - name: pserver-id
13170           in: query
13171           description: ID of Pserver
13172           required: false
13173           type: string
13174         - name: in-maint
13175           in: query
13176           required: false
13177           type: boolean
13178         - name: pserver-name2
13179           in: query
13180           description: alternative pserver name
13181           required: false
13182           type: string
13183         - name: interface-id
13184           in: query
13185           description: ID of interface
13186           required: false
13187           type: string
13188         - name: macaddr
13189           in: query
13190           description: MAC address for the interface
13191           required: false
13192           type: string
13193         - name: network-name
13194           in: query
13195           description: Name of the network
13196           required: false
13197           type: string
13198     put:
13199       tags:
13200         - CloudInfrastructure
13201       summary: create or update an existing l-interface
13202       description: |
13203         Create or update an existing l-interface.
13204         #
13205         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
13206       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13207       consumes:
13208         - application/json
13209         - application/xml
13210       produces:
13211         - application/json
13212         - application/xml
13213       responses:
13214         "default":
13215           description: Response codes found in [response codes](https://wiki.onap.org/).
13216       parameters:
13217         - name: hostname
13218           in: path
13219           description: Value from executing hostname on the compute node.
13220           required: true
13221           type: string
13222           example: __HOSTNAME__
13223         - name: interface-name
13224           in: path
13225           description: Name that identifies the link aggregate interface
13226           required: true
13227           type: string
13228           example: __INTERFACE-NAME__
13229         - name: interface-name
13230           in: path
13231           description: Name given to the interface
13232           required: true
13233           type: string
13234           example: __INTERFACE-NAME__
13235         - name: body
13236           in: body
13237           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13238           required: true
13239           schema:
13240             $ref: "#/definitions/l-interface"
13241     patch:
13242       tags:
13243         - CloudInfrastructure
13244       summary: update an existing l-interface
13245       description: |
13246         Update an existing l-interface
13247         #
13248         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13249         The PUT operation will entirely replace an existing object.
13250         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.
13251         #
13252         Other differences between PUT and PATCH are:
13253         #
13254         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13255         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13256         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13257       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13258       consumes:
13259         - application/json
13260         - application/xml
13261       produces:
13262         - application/json
13263         - application/xml
13264       responses:
13265         "default":
13266           description: Response codes found in [response codes](https://wiki.onap.org/).
13267       parameters:
13268         - name: hostname
13269           in: path
13270           description: Value from executing hostname on the compute node.
13271           required: true
13272           type: string
13273           example: __HOSTNAME__
13274         - name: interface-name
13275           in: path
13276           description: Name that identifies the link aggregate interface
13277           required: true
13278           type: string
13279           example: __INTERFACE-NAME__
13280         - name: interface-name
13281           in: path
13282           description: Name given to the interface
13283           required: true
13284           type: string
13285           example: __INTERFACE-NAME__
13286         - name: body
13287           in: body
13288           description: l-interface object that needs to be created or updated.
13289           required: true
13290           schema:
13291             $ref: "#/patchDefinitions/l-interface"
13292     delete:
13293       tags:
13294         - CloudInfrastructure
13295       summary: delete an existing l-interface
13296       description: delete an existing l-interface
13297       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13298       consumes:
13299         - application/json
13300         - application/xml
13301       produces:
13302         - application/json
13303         - application/xml
13304       responses:
13305         "default":
13306           description: Response codes found in [response codes](https://wiki.onap.org/).
13307       parameters:
13308         - name: hostname
13309           in: path
13310           description: Value from executing hostname on the compute node.
13311           required: true
13312           type: string
13313           example: __HOSTNAME__
13314         - name: interface-name
13315           in: path
13316           description: Name that identifies the link aggregate interface
13317           required: true
13318           type: string
13319           example: __INTERFACE-NAME__
13320         - name: interface-name
13321           in: path
13322           description: Name given to the interface
13323           required: true
13324           type: string
13325           example: __INTERFACE-NAME__
13326         - name: resource-version
13327           in: query
13328           description: resource-version for concurrency
13329           required: true
13330           type: string
13331   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13332     get:
13333       tags:
13334         - CloudInfrastructure
13335       summary: returns l-interfaces
13336       description: returns l-interfaces
13337       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13338       produces:
13339         - application/json
13340         - application/xml
13341       responses:
13342         "200":
13343           description: successful operation
13344           schema:
13345               $ref: "#/getDefinitions/l-interfaces"
13346         "default":
13347           description: Response codes found in [response codes](https://wiki.onap.org/).
13348       parameters:
13349         - name: hostname
13350           in: path
13351           description: Value from executing hostname on the compute node.
13352           required: true
13353           type: string
13354           example: __HOSTNAME__
13355         - name: interface-name
13356           in: path
13357           description: Name that identifies the link aggregate interface
13358           required: true
13359           type: string
13360           example: __INTERFACE-NAME__
13361         - name: pserver-id
13362           in: query
13363           description: ID of Pserver
13364           required: false
13365           type: string
13366         - name: in-maint
13367           in: query
13368           required: false
13369           type: boolean
13370         - name: pserver-name2
13371           in: query
13372           description: alternative pserver name
13373           required: false
13374           type: string
13375   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13376     get:
13377       tags:
13378         - CloudInfrastructure
13379       summary: returns lag-interface
13380       description: returns lag-interface
13381       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13382       produces:
13383         - application/json
13384         - application/xml
13385       responses:
13386         "200":
13387           description: successful operation
13388           schema:
13389               $ref: "#/getDefinitions/lag-interface"
13390         "default":
13391           description: Response codes found in [response codes](https://wiki.onap.org/).
13392       parameters:
13393         - name: hostname
13394           in: path
13395           description: Value from executing hostname on the compute node.
13396           required: true
13397           type: string
13398           example: __HOSTNAME__
13399         - name: interface-name
13400           in: path
13401           description: Name that identifies the link aggregate interface
13402           required: true
13403           type: string
13404           example: __INTERFACE-NAME__
13405         - name: pserver-id
13406           in: query
13407           description: ID of Pserver
13408           required: false
13409           type: string
13410         - name: in-maint
13411           in: query
13412           required: false
13413           type: boolean
13414         - name: pserver-name2
13415           in: query
13416           description: alternative pserver name
13417           required: false
13418           type: string
13419     put:
13420       tags:
13421         - CloudInfrastructure
13422       summary: create or update an existing lag-interface
13423       description: |
13424         Create or update an existing lag-interface.
13425         #
13426         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
13427       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13428       consumes:
13429         - application/json
13430         - application/xml
13431       produces:
13432         - application/json
13433         - application/xml
13434       responses:
13435         "default":
13436           description: Response codes found in [response codes](https://wiki.onap.org/).
13437       parameters:
13438         - name: hostname
13439           in: path
13440           description: Value from executing hostname on the compute node.
13441           required: true
13442           type: string
13443           example: __HOSTNAME__
13444         - name: interface-name
13445           in: path
13446           description: Name that identifies the link aggregate interface
13447           required: true
13448           type: string
13449           example: __INTERFACE-NAME__
13450         - name: body
13451           in: body
13452           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13453           required: true
13454           schema:
13455             $ref: "#/definitions/lag-interface"
13456     patch:
13457       tags:
13458         - CloudInfrastructure
13459       summary: update an existing lag-interface
13460       description: |
13461         Update an existing lag-interface
13462         #
13463         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13464         The PUT operation will entirely replace an existing object.
13465         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.
13466         #
13467         Other differences between PUT and PATCH are:
13468         #
13469         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13470         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13471         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13472       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13473       consumes:
13474         - application/json
13475         - application/xml
13476       produces:
13477         - application/json
13478         - application/xml
13479       responses:
13480         "default":
13481           description: Response codes found in [response codes](https://wiki.onap.org/).
13482       parameters:
13483         - name: hostname
13484           in: path
13485           description: Value from executing hostname on the compute node.
13486           required: true
13487           type: string
13488           example: __HOSTNAME__
13489         - name: interface-name
13490           in: path
13491           description: Name that identifies the link aggregate interface
13492           required: true
13493           type: string
13494           example: __INTERFACE-NAME__
13495         - name: body
13496           in: body
13497           description: lag-interface object that needs to be created or updated.
13498           required: true
13499           schema:
13500             $ref: "#/patchDefinitions/lag-interface"
13501     delete:
13502       tags:
13503         - CloudInfrastructure
13504       summary: delete an existing lag-interface
13505       description: delete an existing lag-interface
13506       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13507       consumes:
13508         - application/json
13509         - application/xml
13510       produces:
13511         - application/json
13512         - application/xml
13513       responses:
13514         "default":
13515           description: Response codes found in [response codes](https://wiki.onap.org/).
13516       parameters:
13517         - name: hostname
13518           in: path
13519           description: Value from executing hostname on the compute node.
13520           required: true
13521           type: string
13522           example: __HOSTNAME__
13523         - name: interface-name
13524           in: path
13525           description: Name that identifies the link aggregate interface
13526           required: true
13527           type: string
13528           example: __INTERFACE-NAME__
13529         - name: resource-version
13530           in: query
13531           description: resource-version for concurrency
13532           required: true
13533           type: string
13534   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13535     get:
13536       tags:
13537         - CloudInfrastructure
13538       summary: returns lag-interfaces
13539       description: returns lag-interfaces
13540       operationId: getCloudInfrastructurePserversPserverLagInterfaces
13541       produces:
13542         - application/json
13543         - application/xml
13544       responses:
13545         "200":
13546           description: successful operation
13547           schema:
13548               $ref: "#/getDefinitions/lag-interfaces"
13549         "default":
13550           description: Response codes found in [response codes](https://wiki.onap.org/).
13551       parameters:
13552         - name: hostname
13553           in: path
13554           description: Value from executing hostname on the compute node.
13555           required: true
13556           type: string
13557           example: __HOSTNAME__
13558         - name: pserver-id
13559           in: query
13560           description: ID of Pserver
13561           required: false
13562           type: string
13563         - name: in-maint
13564           in: query
13565           required: false
13566           type: boolean
13567         - name: pserver-name2
13568           in: query
13569           description: alternative pserver name
13570           required: false
13571           type: string
13572   /cloud-infrastructure/pservers/pserver/{hostname}:
13573     get:
13574       tags:
13575         - CloudInfrastructure
13576       summary: returns pserver
13577       description: returns pserver
13578       operationId: getCloudInfrastructurePserversPserver
13579       produces:
13580         - application/json
13581         - application/xml
13582       responses:
13583         "200":
13584           description: successful operation
13585           schema:
13586               $ref: "#/getDefinitions/pserver"
13587         "default":
13588           description: Response codes found in [response codes](https://wiki.onap.org/).
13589       parameters:
13590         - name: hostname
13591           in: path
13592           description: Value from executing hostname on the compute node.
13593           required: true
13594           type: string
13595           example: __HOSTNAME__
13596         - name: pserver-id
13597           in: query
13598           description: ID of Pserver
13599           required: false
13600           type: string
13601         - name: in-maint
13602           in: query
13603           required: false
13604           type: boolean
13605         - name: pserver-name2
13606           in: query
13607           description: alternative pserver name
13608           required: false
13609           type: string
13610     put:
13611       tags:
13612         - CloudInfrastructure
13613       summary: create or update an existing pserver
13614       description: |
13615         Create or update an existing pserver.
13616         #
13617         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
13618       operationId: createOrUpdateCloudInfrastructurePserversPserver
13619       consumes:
13620         - application/json
13621         - application/xml
13622       produces:
13623         - application/json
13624         - application/xml
13625       responses:
13626         "default":
13627           description: Response codes found in [response codes](https://wiki.onap.org/).
13628       parameters:
13629         - name: hostname
13630           in: path
13631           description: Value from executing hostname on the compute node.
13632           required: true
13633           type: string
13634           example: __HOSTNAME__
13635         - name: body
13636           in: body
13637           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructurePserversPserver.json)
13638           required: true
13639           schema:
13640             $ref: "#/definitions/pserver"
13641     patch:
13642       tags:
13643         - CloudInfrastructure
13644       summary: update an existing pserver
13645       description: |
13646         Update an existing pserver
13647         #
13648         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13649         The PUT operation will entirely replace an existing object.
13650         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.
13651         #
13652         Other differences between PUT and PATCH are:
13653         #
13654         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13655         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13656         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13657       operationId: UpdateCloudInfrastructurePserversPserver
13658       consumes:
13659         - application/json
13660         - application/xml
13661       produces:
13662         - application/json
13663         - application/xml
13664       responses:
13665         "default":
13666           description: Response codes found in [response codes](https://wiki.onap.org/).
13667       parameters:
13668         - name: hostname
13669           in: path
13670           description: Value from executing hostname on the compute node.
13671           required: true
13672           type: string
13673           example: __HOSTNAME__
13674         - name: body
13675           in: body
13676           description: pserver object that needs to be created or updated.
13677           required: true
13678           schema:
13679             $ref: "#/patchDefinitions/pserver"
13680     delete:
13681       tags:
13682         - CloudInfrastructure
13683       summary: delete an existing pserver
13684       description: delete an existing pserver
13685       operationId: deleteCloudInfrastructurePserversPserver
13686       consumes:
13687         - application/json
13688         - application/xml
13689       produces:
13690         - application/json
13691         - application/xml
13692       responses:
13693         "default":
13694           description: Response codes found in [response codes](https://wiki.onap.org/).
13695       parameters:
13696         - name: hostname
13697           in: path
13698           description: Value from executing hostname on the compute node.
13699           required: true
13700           type: string
13701           example: __HOSTNAME__
13702         - name: resource-version
13703           in: query
13704           description: resource-version for concurrency
13705           required: true
13706           type: string
13707   /cloud-infrastructure/pservers:
13708     get:
13709       tags:
13710         - CloudInfrastructure
13711       summary: returns pservers
13712       description: returns pservers
13713       operationId: getCloudInfrastructurePservers
13714       produces:
13715         - application/json
13716         - application/xml
13717       responses:
13718         "200":
13719           description: successful operation
13720           schema:
13721               $ref: "#/getDefinitions/pservers"
13722         "default":
13723           description: Response codes found in [response codes](https://wiki.onap.org/).
13724   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
13725     put:
13726       tags:
13727         - CloudInfrastructure
13728       summary: see node definition for valid relationships
13729       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13730       consumes:
13731         - application/json
13732         - application/xml
13733       produces:
13734         - application/json
13735         - application/xml
13736       responses:
13737         "default":
13738           description: Response codes found in [response codes](https://wiki.onap.org/).
13739       parameters:
13740         - name: vdc-id
13741           in: path
13742           description: Unique ID of the vdc
13743           required: true
13744           type: string
13745           example: __VDC-ID__
13746         - name: body
13747           in: body
13748           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13749           required: true
13750           schema:
13751             $ref: "#/definitions/relationship"
13752     delete:
13753       tags:
13754         - CloudInfrastructure
13755       summary: delete an existing relationship
13756       description: delete an existing relationship
13757       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
13758       consumes:
13759         - application/json
13760         - application/xml
13761       produces:
13762         - application/json
13763         - application/xml
13764       responses:
13765         "default":
13766           description: Response codes found in [response codes](https://wiki.onap.org/).
13767       parameters:
13768         - name: vdc-id
13769           in: path
13770           description: Unique ID of the vdc
13771           required: true
13772           type: string
13773           example: __VDC-ID__
13774   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
13775     get:
13776       tags:
13777         - CloudInfrastructure
13778       summary: returns virtual-data-center
13779       description: returns virtual-data-center
13780       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
13781       produces:
13782         - application/json
13783         - application/xml
13784       responses:
13785         "200":
13786           description: successful operation
13787           schema:
13788               $ref: "#/getDefinitions/virtual-data-center"
13789         "default":
13790           description: Response codes found in [response codes](https://wiki.onap.org/).
13791       parameters:
13792         - name: vdc-id
13793           in: path
13794           description: Unique ID of the vdc
13795           required: true
13796           type: string
13797           example: __VDC-ID__
13798         - name: vdc-name
13799           in: query
13800           description: Name of the virtual data center
13801           required: false
13802           type: string
13803     put:
13804       tags:
13805         - CloudInfrastructure
13806       summary: create or update an existing virtual-data-center
13807       description: |
13808         Create or update an existing virtual-data-center.
13809         #
13810         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
13811       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13812       consumes:
13813         - application/json
13814         - application/xml
13815       produces:
13816         - application/json
13817         - application/xml
13818       responses:
13819         "default":
13820           description: Response codes found in [response codes](https://wiki.onap.org/).
13821       parameters:
13822         - name: vdc-id
13823           in: path
13824           description: Unique ID of the vdc
13825           required: true
13826           type: string
13827           example: __VDC-ID__
13828         - name: body
13829           in: body
13830           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
13831           required: true
13832           schema:
13833             $ref: "#/definitions/virtual-data-center"
13834     patch:
13835       tags:
13836         - CloudInfrastructure
13837       summary: update an existing virtual-data-center
13838       description: |
13839         Update an existing virtual-data-center
13840         #
13841         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13842         The PUT operation will entirely replace an existing object.
13843         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.
13844         #
13845         Other differences between PUT and PATCH are:
13846         #
13847         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13848         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13849         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13850       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
13851       consumes:
13852         - application/json
13853         - application/xml
13854       produces:
13855         - application/json
13856         - application/xml
13857       responses:
13858         "default":
13859           description: Response codes found in [response codes](https://wiki.onap.org/).
13860       parameters:
13861         - name: vdc-id
13862           in: path
13863           description: Unique ID of the vdc
13864           required: true
13865           type: string
13866           example: __VDC-ID__
13867         - name: body
13868           in: body
13869           description: virtual-data-center object that needs to be created or updated.
13870           required: true
13871           schema:
13872             $ref: "#/patchDefinitions/virtual-data-center"
13873     delete:
13874       tags:
13875         - CloudInfrastructure
13876       summary: delete an existing virtual-data-center
13877       description: delete an existing virtual-data-center
13878       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
13879       consumes:
13880         - application/json
13881         - application/xml
13882       produces:
13883         - application/json
13884         - application/xml
13885       responses:
13886         "default":
13887           description: Response codes found in [response codes](https://wiki.onap.org/).
13888       parameters:
13889         - name: vdc-id
13890           in: path
13891           description: Unique ID of the vdc
13892           required: true
13893           type: string
13894           example: __VDC-ID__
13895         - name: resource-version
13896           in: query
13897           description: resource-version for concurrency
13898           required: true
13899           type: string
13900   /cloud-infrastructure/virtual-data-centers:
13901     get:
13902       tags:
13903         - CloudInfrastructure
13904       summary: returns virtual-data-centers
13905       description: returns virtual-data-centers
13906       operationId: getCloudInfrastructureVirtualDataCenters
13907       produces:
13908         - application/json
13909         - application/xml
13910       responses:
13911         "200":
13912           description: successful operation
13913           schema:
13914               $ref: "#/getDefinitions/virtual-data-centers"
13915         "default":
13916           description: Response codes found in [response codes](https://wiki.onap.org/).
13917   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
13918     put:
13919       tags:
13920         - Business
13921       summary: see node definition for valid relationships
13922       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
13923       consumes:
13924         - application/json
13925         - application/xml
13926       produces:
13927         - application/json
13928         - application/xml
13929       responses:
13930         "default":
13931           description: Response codes found in [response codes](https://wiki.onap.org/).
13932       parameters:
13933         - name: resource-instance-id
13934           in: path
13935           description: Unique id of resource instance.
13936           required: true
13937           type: string
13938           example: __RESOURCE-INSTANCE-ID__
13939         - name: body
13940           in: body
13941           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
13942           required: true
13943           schema:
13944             $ref: "#/definitions/relationship"
13945     delete:
13946       tags:
13947         - Business
13948       summary: delete an existing relationship
13949       description: delete an existing relationship
13950       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
13951       consumes:
13952         - application/json
13953         - application/xml
13954       produces:
13955         - application/json
13956         - application/xml
13957       responses:
13958         "default":
13959           description: Response codes found in [response codes](https://wiki.onap.org/).
13960       parameters:
13961         - name: resource-instance-id
13962           in: path
13963           description: Unique id of resource instance.
13964           required: true
13965           type: string
13966           example: __RESOURCE-INSTANCE-ID__
13967   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
13968     get:
13969       tags:
13970         - Business
13971       summary: returns metadatum
13972       description: returns metadatum
13973       operationId: getBusinessConnectorsConnectorMetadataMetadatum
13974       produces:
13975         - application/json
13976         - application/xml
13977       responses:
13978         "200":
13979           description: successful operation
13980           schema:
13981               $ref: "#/getDefinitions/metadatum"
13982         "default":
13983           description: Response codes found in [response codes](https://wiki.onap.org/).
13984       parameters:
13985         - name: resource-instance-id
13986           in: path
13987           description: Unique id of resource instance.
13988           required: true
13989           type: string
13990           example: __RESOURCE-INSTANCE-ID__
13991         - name: metaname
13992           in: path
13993           required: true
13994           type: string
13995           example: __METANAME__
13996         - name: persona-model-id
13997           in: query
13998           description: the ASDC model id for this resource or service model.
13999           required: false
14000           type: string
14001         - name: persona-model-version
14002           in: query
14003           description: the ASDC model version for this resource or service model.
14004           required: false
14005           type: string
14006         - name: widget-model-id
14007           in: query
14008           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14009           required: false
14010           type: string
14011         - name: widget-model-version
14012           in: query
14013           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14014           required: false
14015           type: string
14016     put:
14017       tags:
14018         - Business
14019       summary: create or update an existing metadatum
14020       description: |
14021         Create or update an existing metadatum.
14022         #
14023         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
14024       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14025       consumes:
14026         - application/json
14027         - application/xml
14028       produces:
14029         - application/json
14030         - application/xml
14031       responses:
14032         "default":
14033           description: Response codes found in [response codes](https://wiki.onap.org/).
14034       parameters:
14035         - name: resource-instance-id
14036           in: path
14037           description: Unique id of resource instance.
14038           required: true
14039           type: string
14040           example: __RESOURCE-INSTANCE-ID__
14041         - name: metaname
14042           in: path
14043           required: true
14044           type: string
14045           example: __METANAME__
14046         - name: body
14047           in: body
14048           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnectorMetadataMetadatum.json)
14049           required: true
14050           schema:
14051             $ref: "#/definitions/metadatum"
14052     patch:
14053       tags:
14054         - Business
14055       summary: update an existing metadatum
14056       description: |
14057         Update an existing metadatum
14058         #
14059         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14060         The PUT operation will entirely replace an existing object.
14061         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.
14062         #
14063         Other differences between PUT and PATCH are:
14064         #
14065         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14066         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14067         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14068       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14069       consumes:
14070         - application/json
14071         - application/xml
14072       produces:
14073         - application/json
14074         - application/xml
14075       responses:
14076         "default":
14077           description: Response codes found in [response codes](https://wiki.onap.org/).
14078       parameters:
14079         - name: resource-instance-id
14080           in: path
14081           description: Unique id of resource instance.
14082           required: true
14083           type: string
14084           example: __RESOURCE-INSTANCE-ID__
14085         - name: metaname
14086           in: path
14087           required: true
14088           type: string
14089           example: __METANAME__
14090         - name: body
14091           in: body
14092           description: metadatum object that needs to be created or updated.
14093           required: true
14094           schema:
14095             $ref: "#/patchDefinitions/metadatum"
14096     delete:
14097       tags:
14098         - Business
14099       summary: delete an existing metadatum
14100       description: delete an existing metadatum
14101       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
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: resource-instance-id
14113           in: path
14114           description: Unique id of resource instance.
14115           required: true
14116           type: string
14117           example: __RESOURCE-INSTANCE-ID__
14118         - name: metaname
14119           in: path
14120           required: true
14121           type: string
14122           example: __METANAME__
14123         - name: resource-version
14124           in: query
14125           description: resource-version for concurrency
14126           required: true
14127           type: string
14128   /business/connectors/connector/{resource-instance-id}/metadata:
14129     get:
14130       tags:
14131         - Business
14132       summary: returns metadata
14133       description: returns metadata
14134       operationId: getBusinessConnectorsConnectorMetadata
14135       produces:
14136         - application/json
14137         - application/xml
14138       responses:
14139         "200":
14140           description: successful operation
14141           schema:
14142               $ref: "#/getDefinitions/metadata"
14143         "default":
14144           description: Response codes found in [response codes](https://wiki.onap.org/).
14145       parameters:
14146         - name: resource-instance-id
14147           in: path
14148           description: Unique id of resource instance.
14149           required: true
14150           type: string
14151           example: __RESOURCE-INSTANCE-ID__
14152         - name: persona-model-id
14153           in: query
14154           description: the ASDC model id for this resource or service model.
14155           required: false
14156           type: string
14157         - name: persona-model-version
14158           in: query
14159           description: the ASDC model version for this resource or service model.
14160           required: false
14161           type: string
14162         - name: widget-model-id
14163           in: query
14164           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14165           required: false
14166           type: string
14167         - name: widget-model-version
14168           in: query
14169           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14170           required: false
14171           type: string
14172   /business/connectors/connector/{resource-instance-id}:
14173     get:
14174       tags:
14175         - Business
14176       summary: returns connector
14177       description: returns connector
14178       operationId: getBusinessConnectorsConnector
14179       produces:
14180         - application/json
14181         - application/xml
14182       responses:
14183         "200":
14184           description: successful operation
14185           schema:
14186               $ref: "#/getDefinitions/connector"
14187         "default":
14188           description: Response codes found in [response codes](https://wiki.onap.org/).
14189       parameters:
14190         - name: resource-instance-id
14191           in: path
14192           description: Unique id of resource instance.
14193           required: true
14194           type: string
14195           example: __RESOURCE-INSTANCE-ID__
14196         - name: persona-model-id
14197           in: query
14198           description: the ASDC model id for this resource or service model.
14199           required: false
14200           type: string
14201         - name: persona-model-version
14202           in: query
14203           description: the ASDC model version for this resource or service model.
14204           required: false
14205           type: string
14206         - name: widget-model-id
14207           in: query
14208           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14209           required: false
14210           type: string
14211         - name: widget-model-version
14212           in: query
14213           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14214           required: false
14215           type: string
14216     put:
14217       tags:
14218         - Business
14219       summary: create or update an existing connector
14220       description: |
14221         Create or update an existing connector.
14222         #
14223         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
14224       operationId: createOrUpdateBusinessConnectorsConnector
14225       consumes:
14226         - application/json
14227         - application/xml
14228       produces:
14229         - application/json
14230         - application/xml
14231       responses:
14232         "default":
14233           description: Response codes found in [response codes](https://wiki.onap.org/).
14234       parameters:
14235         - name: resource-instance-id
14236           in: path
14237           description: Unique id of resource instance.
14238           required: true
14239           type: string
14240           example: __RESOURCE-INSTANCE-ID__
14241         - name: body
14242           in: body
14243           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessConnectorsConnector.json)
14244           required: true
14245           schema:
14246             $ref: "#/definitions/connector"
14247     patch:
14248       tags:
14249         - Business
14250       summary: update an existing connector
14251       description: |
14252         Update an existing connector
14253         #
14254         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14255         The PUT operation will entirely replace an existing object.
14256         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.
14257         #
14258         Other differences between PUT and PATCH are:
14259         #
14260         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14261         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14262         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14263       operationId: UpdateBusinessConnectorsConnector
14264       consumes:
14265         - application/json
14266         - application/xml
14267       produces:
14268         - application/json
14269         - application/xml
14270       responses:
14271         "default":
14272           description: Response codes found in [response codes](https://wiki.onap.org/).
14273       parameters:
14274         - name: resource-instance-id
14275           in: path
14276           description: Unique id of resource instance.
14277           required: true
14278           type: string
14279           example: __RESOURCE-INSTANCE-ID__
14280         - name: body
14281           in: body
14282           description: connector object that needs to be created or updated.
14283           required: true
14284           schema:
14285             $ref: "#/patchDefinitions/connector"
14286     delete:
14287       tags:
14288         - Business
14289       summary: delete an existing connector
14290       description: delete an existing connector
14291       operationId: deleteBusinessConnectorsConnector
14292       consumes:
14293         - application/json
14294         - application/xml
14295       produces:
14296         - application/json
14297         - application/xml
14298       responses:
14299         "default":
14300           description: Response codes found in [response codes](https://wiki.onap.org/).
14301       parameters:
14302         - name: resource-instance-id
14303           in: path
14304           description: Unique id of resource instance.
14305           required: true
14306           type: string
14307           example: __RESOURCE-INSTANCE-ID__
14308         - name: resource-version
14309           in: query
14310           description: resource-version for concurrency
14311           required: true
14312           type: string
14313   /business/connectors:
14314     get:
14315       tags:
14316         - Business
14317       summary: returns connectors
14318       description: returns connectors
14319       operationId: getBusinessConnectors
14320       produces:
14321         - application/json
14322         - application/xml
14323       responses:
14324         "200":
14325           description: successful operation
14326           schema:
14327               $ref: "#/getDefinitions/connectors"
14328         "default":
14329           description: Response codes found in [response codes](https://wiki.onap.org/).
14330   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14331     put:
14332       tags:
14333         - Business
14334       summary: see node definition for valid relationships
14335       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14336       consumes:
14337         - application/json
14338         - application/xml
14339       produces:
14340         - application/json
14341         - application/xml
14342       responses:
14343         "default":
14344           description: Response codes found in [response codes](https://wiki.onap.org/).
14345       parameters:
14346         - name: global-customer-id
14347           in: path
14348           description: Global customer id used across ECOMP to uniquely identify customer.
14349           required: true
14350           type: string
14351           example: __GLOBAL-CUSTOMER-ID__
14352         - name: service-type
14353           in: path
14354           description: Value defined by orchestration to identify this service across ECOMP.
14355           required: true
14356           type: string
14357           example: __SERVICE-TYPE__
14358         - name: service-instance-id
14359           in: path
14360           description: Uniquely identifies this instance of a service
14361           required: true
14362           type: string
14363           example: __SERVICE-INSTANCE-ID__
14364         - name: body
14365           in: body
14366           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14367           required: true
14368           schema:
14369             $ref: "#/definitions/relationship"
14370     delete:
14371       tags:
14372         - Business
14373       summary: delete an existing relationship
14374       description: delete an existing relationship
14375       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14376       consumes:
14377         - application/json
14378         - application/xml
14379       produces:
14380         - application/json
14381         - application/xml
14382       responses:
14383         "default":
14384           description: Response codes found in [response codes](https://wiki.onap.org/).
14385       parameters:
14386         - name: global-customer-id
14387           in: path
14388           description: Global customer id used across ECOMP to uniquely identify customer.
14389           required: true
14390           type: string
14391           example: __GLOBAL-CUSTOMER-ID__
14392         - name: service-type
14393           in: path
14394           description: Value defined by orchestration to identify this service across ECOMP.
14395           required: true
14396           type: string
14397           example: __SERVICE-TYPE__
14398         - name: service-instance-id
14399           in: path
14400           description: Uniquely identifies this instance of a service
14401           required: true
14402           type: string
14403           example: __SERVICE-INSTANCE-ID__
14404   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
14405     get:
14406       tags:
14407         - Business
14408       summary: returns metadatum
14409       description: returns metadatum
14410       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14411       produces:
14412         - application/json
14413         - application/xml
14414       responses:
14415         "200":
14416           description: successful operation
14417           schema:
14418               $ref: "#/getDefinitions/metadatum"
14419         "default":
14420           description: Response codes found in [response codes](https://wiki.onap.org/).
14421       parameters:
14422         - name: global-customer-id
14423           in: path
14424           description: Global customer id used across ECOMP to uniquely identify customer.
14425           required: true
14426           type: string
14427           example: __GLOBAL-CUSTOMER-ID__
14428         - name: service-type
14429           in: path
14430           description: Value defined by orchestration to identify this service across ECOMP.
14431           required: true
14432           type: string
14433           example: __SERVICE-TYPE__
14434         - name: service-instance-id
14435           in: path
14436           description: Uniquely identifies this instance of a service
14437           required: true
14438           type: string
14439           example: __SERVICE-INSTANCE-ID__
14440         - name: metaname
14441           in: path
14442           required: true
14443           type: string
14444           example: __METANAME__
14445         - name: subscriber-name
14446           in: query
14447           description: Subscriber name, an alternate way to retrieve a customer.
14448           required: false
14449           type: string
14450         - name: subscriber-type
14451           in: query
14452           description: Subscriber type, a way to provide VID with only the INFRA customers.
14453           required: false
14454           type: string
14455         - name: service-instance-name
14456           in: query
14457           description: This field will store a name assigned to the service-instance.
14458           required: false
14459           type: string
14460         - name: persona-model-id
14461           in: query
14462           description: the ASDC model id for this resource or service model.
14463           required: false
14464           type: string
14465         - name: persona-model-version
14466           in: query
14467           description: the ASDC model version for this resource or service model.
14468           required: false
14469           type: string
14470         - name: widget-model-id
14471           in: query
14472           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14473           required: false
14474           type: string
14475         - name: widget-model-version
14476           in: query
14477           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14478           required: false
14479           type: string
14480         - name: service-instance-location-id
14481           in: query
14482           description: An identifier that customers assign to the location where this service is being used.
14483           required: false
14484           type: string
14485     put:
14486       tags:
14487         - Business
14488       summary: create or update an existing metadatum
14489       description: |
14490         Create or update an existing metadatum.
14491         #
14492         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
14493       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14494       consumes:
14495         - application/json
14496         - application/xml
14497       produces:
14498         - application/json
14499         - application/xml
14500       responses:
14501         "default":
14502           description: Response codes found in [response codes](https://wiki.onap.org/).
14503       parameters:
14504         - name: global-customer-id
14505           in: path
14506           description: Global customer id used across ECOMP to uniquely identify customer.
14507           required: true
14508           type: string
14509           example: __GLOBAL-CUSTOMER-ID__
14510         - name: service-type
14511           in: path
14512           description: Value defined by orchestration to identify this service across ECOMP.
14513           required: true
14514           type: string
14515           example: __SERVICE-TYPE__
14516         - name: service-instance-id
14517           in: path
14518           description: Uniquely identifies this instance of a service
14519           required: true
14520           type: string
14521           example: __SERVICE-INSTANCE-ID__
14522         - name: metaname
14523           in: path
14524           required: true
14525           type: string
14526           example: __METANAME__
14527         - name: body
14528           in: body
14529           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
14530           required: true
14531           schema:
14532             $ref: "#/definitions/metadatum"
14533     patch:
14534       tags:
14535         - Business
14536       summary: update an existing metadatum
14537       description: |
14538         Update an existing metadatum
14539         #
14540         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14541         The PUT operation will entirely replace an existing object.
14542         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.
14543         #
14544         Other differences between PUT and PATCH are:
14545         #
14546         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14547         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14548         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14549       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14550       consumes:
14551         - application/json
14552         - application/xml
14553       produces:
14554         - application/json
14555         - application/xml
14556       responses:
14557         "default":
14558           description: Response codes found in [response codes](https://wiki.onap.org/).
14559       parameters:
14560         - name: global-customer-id
14561           in: path
14562           description: Global customer id used across ECOMP to uniquely identify customer.
14563           required: true
14564           type: string
14565           example: __GLOBAL-CUSTOMER-ID__
14566         - name: service-type
14567           in: path
14568           description: Value defined by orchestration to identify this service across ECOMP.
14569           required: true
14570           type: string
14571           example: __SERVICE-TYPE__
14572         - name: service-instance-id
14573           in: path
14574           description: Uniquely identifies this instance of a service
14575           required: true
14576           type: string
14577           example: __SERVICE-INSTANCE-ID__
14578         - name: metaname
14579           in: path
14580           required: true
14581           type: string
14582           example: __METANAME__
14583         - name: body
14584           in: body
14585           description: metadatum object that needs to be created or updated.
14586           required: true
14587           schema:
14588             $ref: "#/patchDefinitions/metadatum"
14589     delete:
14590       tags:
14591         - Business
14592       summary: delete an existing metadatum
14593       description: delete an existing metadatum
14594       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14595       consumes:
14596         - application/json
14597         - application/xml
14598       produces:
14599         - application/json
14600         - application/xml
14601       responses:
14602         "default":
14603           description: Response codes found in [response codes](https://wiki.onap.org/).
14604       parameters:
14605         - name: global-customer-id
14606           in: path
14607           description: Global customer id used across ECOMP to uniquely identify customer.
14608           required: true
14609           type: string
14610           example: __GLOBAL-CUSTOMER-ID__
14611         - name: service-type
14612           in: path
14613           description: Value defined by orchestration to identify this service across ECOMP.
14614           required: true
14615           type: string
14616           example: __SERVICE-TYPE__
14617         - name: service-instance-id
14618           in: path
14619           description: Uniquely identifies this instance of a service
14620           required: true
14621           type: string
14622           example: __SERVICE-INSTANCE-ID__
14623         - name: metaname
14624           in: path
14625           required: true
14626           type: string
14627           example: __METANAME__
14628         - name: resource-version
14629           in: query
14630           description: resource-version for concurrency
14631           required: true
14632           type: string
14633   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14634     get:
14635       tags:
14636         - Business
14637       summary: returns metadata
14638       description: returns metadata
14639       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14640       produces:
14641         - application/json
14642         - application/xml
14643       responses:
14644         "200":
14645           description: successful operation
14646           schema:
14647               $ref: "#/getDefinitions/metadata"
14648         "default":
14649           description: Response codes found in [response codes](https://wiki.onap.org/).
14650       parameters:
14651         - name: global-customer-id
14652           in: path
14653           description: Global customer id used across ECOMP to uniquely identify customer.
14654           required: true
14655           type: string
14656           example: __GLOBAL-CUSTOMER-ID__
14657         - name: service-type
14658           in: path
14659           description: Value defined by orchestration to identify this service across ECOMP.
14660           required: true
14661           type: string
14662           example: __SERVICE-TYPE__
14663         - name: service-instance-id
14664           in: path
14665           description: Uniquely identifies this instance of a service
14666           required: true
14667           type: string
14668           example: __SERVICE-INSTANCE-ID__
14669         - name: subscriber-name
14670           in: query
14671           description: Subscriber name, an alternate way to retrieve a customer.
14672           required: false
14673           type: string
14674         - name: subscriber-type
14675           in: query
14676           description: Subscriber type, a way to provide VID with only the INFRA customers.
14677           required: false
14678           type: string
14679         - name: service-instance-name
14680           in: query
14681           description: This field will store a name assigned to the service-instance.
14682           required: false
14683           type: string
14684         - name: persona-model-id
14685           in: query
14686           description: the ASDC model id for this resource or service model.
14687           required: false
14688           type: string
14689         - name: persona-model-version
14690           in: query
14691           description: the ASDC model version for this resource or service model.
14692           required: false
14693           type: string
14694         - name: widget-model-id
14695           in: query
14696           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14697           required: false
14698           type: string
14699         - name: widget-model-version
14700           in: query
14701           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14702           required: false
14703           type: string
14704         - name: service-instance-location-id
14705           in: query
14706           description: An identifier that customers assign to the location where this service is being used.
14707           required: false
14708           type: string
14709   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
14710     get:
14711       tags:
14712         - Business
14713       summary: returns service-instance
14714       description: returns service-instance
14715       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14716       produces:
14717         - application/json
14718         - application/xml
14719       responses:
14720         "200":
14721           description: successful operation
14722           schema:
14723               $ref: "#/getDefinitions/service-instance"
14724         "default":
14725           description: Response codes found in [response codes](https://wiki.onap.org/).
14726       parameters:
14727         - name: global-customer-id
14728           in: path
14729           description: Global customer id used across ECOMP to uniquely identify customer.
14730           required: true
14731           type: string
14732           example: __GLOBAL-CUSTOMER-ID__
14733         - name: service-type
14734           in: path
14735           description: Value defined by orchestration to identify this service across ECOMP.
14736           required: true
14737           type: string
14738           example: __SERVICE-TYPE__
14739         - name: service-instance-id
14740           in: path
14741           description: Uniquely identifies this instance of a service
14742           required: true
14743           type: string
14744           example: __SERVICE-INSTANCE-ID__
14745         - name: subscriber-name
14746           in: query
14747           description: Subscriber name, an alternate way to retrieve a customer.
14748           required: false
14749           type: string
14750         - name: subscriber-type
14751           in: query
14752           description: Subscriber type, a way to provide VID with only the INFRA customers.
14753           required: false
14754           type: string
14755         - name: service-instance-name
14756           in: query
14757           description: This field will store a name assigned to the service-instance.
14758           required: false
14759           type: string
14760         - name: persona-model-id
14761           in: query
14762           description: the ASDC model id for this resource or service model.
14763           required: false
14764           type: string
14765         - name: persona-model-version
14766           in: query
14767           description: the ASDC model version for this resource or service model.
14768           required: false
14769           type: string
14770         - name: widget-model-id
14771           in: query
14772           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14773           required: false
14774           type: string
14775         - name: widget-model-version
14776           in: query
14777           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14778           required: false
14779           type: string
14780         - name: service-instance-location-id
14781           in: query
14782           description: An identifier that customers assign to the location where this service is being used.
14783           required: false
14784           type: string
14785     put:
14786       tags:
14787         - Business
14788       summary: create or update an existing service-instance
14789       description: |
14790         Create or update an existing service-instance.
14791         #
14792         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
14793       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14794       consumes:
14795         - application/json
14796         - application/xml
14797       produces:
14798         - application/json
14799         - application/xml
14800       responses:
14801         "default":
14802           description: Response codes found in [response codes](https://wiki.onap.org/).
14803       parameters:
14804         - name: global-customer-id
14805           in: path
14806           description: Global customer id used across ECOMP to uniquely identify customer.
14807           required: true
14808           type: string
14809           example: __GLOBAL-CUSTOMER-ID__
14810         - name: service-type
14811           in: path
14812           description: Value defined by orchestration to identify this service across ECOMP.
14813           required: true
14814           type: string
14815           example: __SERVICE-TYPE__
14816         - name: service-instance-id
14817           in: path
14818           description: Uniquely identifies this instance of a service
14819           required: true
14820           type: string
14821           example: __SERVICE-INSTANCE-ID__
14822         - name: body
14823           in: body
14824           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14825           required: true
14826           schema:
14827             $ref: "#/definitions/service-instance"
14828     patch:
14829       tags:
14830         - Business
14831       summary: update an existing service-instance
14832       description: |
14833         Update an existing service-instance
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: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
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: body
14874           in: body
14875           description: service-instance object that needs to be created or updated.
14876           required: true
14877           schema:
14878             $ref: "#/patchDefinitions/service-instance"
14879     delete:
14880       tags:
14881         - Business
14882       summary: delete an existing service-instance
14883       description: delete an existing service-instance
14884       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
14885       consumes:
14886         - application/json
14887         - application/xml
14888       produces:
14889         - application/json
14890         - application/xml
14891       responses:
14892         "default":
14893           description: Response codes found in [response codes](https://wiki.onap.org/).
14894       parameters:
14895         - name: global-customer-id
14896           in: path
14897           description: Global customer id used across ECOMP to uniquely identify customer.
14898           required: true
14899           type: string
14900           example: __GLOBAL-CUSTOMER-ID__
14901         - name: service-type
14902           in: path
14903           description: Value defined by orchestration to identify this service across ECOMP.
14904           required: true
14905           type: string
14906           example: __SERVICE-TYPE__
14907         - name: service-instance-id
14908           in: path
14909           description: Uniquely identifies this instance of a service
14910           required: true
14911           type: string
14912           example: __SERVICE-INSTANCE-ID__
14913         - name: resource-version
14914           in: query
14915           description: resource-version for concurrency
14916           required: true
14917           type: string
14918   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
14919     get:
14920       tags:
14921         - Business
14922       summary: returns service-instances
14923       description: returns service-instances
14924       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
14925       produces:
14926         - application/json
14927         - application/xml
14928       responses:
14929         "200":
14930           description: successful operation
14931           schema:
14932               $ref: "#/getDefinitions/service-instances"
14933         "default":
14934           description: Response codes found in [response codes](https://wiki.onap.org/).
14935       parameters:
14936         - name: global-customer-id
14937           in: path
14938           description: Global customer id used across ECOMP to uniquely identify customer.
14939           required: true
14940           type: string
14941           example: __GLOBAL-CUSTOMER-ID__
14942         - name: service-type
14943           in: path
14944           description: Value defined by orchestration to identify this service across ECOMP.
14945           required: true
14946           type: string
14947           example: __SERVICE-TYPE__
14948         - name: subscriber-name
14949           in: query
14950           description: Subscriber name, an alternate way to retrieve a customer.
14951           required: false
14952           type: string
14953         - name: subscriber-type
14954           in: query
14955           description: Subscriber type, a way to provide VID with only the INFRA customers.
14956           required: false
14957           type: string
14958   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
14959     put:
14960       tags:
14961         - Business
14962       summary: see node definition for valid relationships
14963       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14964       consumes:
14965         - application/json
14966         - application/xml
14967       produces:
14968         - application/json
14969         - application/xml
14970       responses:
14971         "default":
14972           description: Response codes found in [response codes](https://wiki.onap.org/).
14973       parameters:
14974         - name: global-customer-id
14975           in: path
14976           description: Global customer id used across ECOMP to uniquely identify customer.
14977           required: true
14978           type: string
14979           example: __GLOBAL-CUSTOMER-ID__
14980         - name: service-type
14981           in: path
14982           description: Value defined by orchestration to identify this service across ECOMP.
14983           required: true
14984           type: string
14985           example: __SERVICE-TYPE__
14986         - name: body
14987           in: body
14988           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
14989           required: true
14990           schema:
14991             $ref: "#/definitions/relationship"
14992     delete:
14993       tags:
14994         - Business
14995       summary: delete an existing relationship
14996       description: delete an existing relationship
14997       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
14998       consumes:
14999         - application/json
15000         - application/xml
15001       produces:
15002         - application/json
15003         - application/xml
15004       responses:
15005         "default":
15006           description: Response codes found in [response codes](https://wiki.onap.org/).
15007       parameters:
15008         - name: global-customer-id
15009           in: path
15010           description: Global customer id used across ECOMP to uniquely identify customer.
15011           required: true
15012           type: string
15013           example: __GLOBAL-CUSTOMER-ID__
15014         - name: service-type
15015           in: path
15016           description: Value defined by orchestration to identify this service across ECOMP.
15017           required: true
15018           type: string
15019           example: __SERVICE-TYPE__
15020   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
15021     get:
15022       tags:
15023         - Business
15024       summary: returns service-subscription
15025       description: returns service-subscription
15026       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15027       produces:
15028         - application/json
15029         - application/xml
15030       responses:
15031         "200":
15032           description: successful operation
15033           schema:
15034               $ref: "#/getDefinitions/service-subscription"
15035         "default":
15036           description: Response codes found in [response codes](https://wiki.onap.org/).
15037       parameters:
15038         - name: global-customer-id
15039           in: path
15040           description: Global customer id used across ECOMP to uniquely identify customer.
15041           required: true
15042           type: string
15043           example: __GLOBAL-CUSTOMER-ID__
15044         - name: service-type
15045           in: path
15046           description: Value defined by orchestration to identify this service across ECOMP.
15047           required: true
15048           type: string
15049           example: __SERVICE-TYPE__
15050         - name: subscriber-name
15051           in: query
15052           description: Subscriber name, an alternate way to retrieve a customer.
15053           required: false
15054           type: string
15055         - name: subscriber-type
15056           in: query
15057           description: Subscriber type, a way to provide VID with only the INFRA customers.
15058           required: false
15059           type: string
15060     put:
15061       tags:
15062         - Business
15063       summary: create or update an existing service-subscription
15064       description: |
15065         Create or update an existing service-subscription.
15066         #
15067         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
15068       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15069       consumes:
15070         - application/json
15071         - application/xml
15072       produces:
15073         - application/json
15074         - application/xml
15075       responses:
15076         "default":
15077           description: Response codes found in [response codes](https://wiki.onap.org/).
15078       parameters:
15079         - name: global-customer-id
15080           in: path
15081           description: Global customer id used across ECOMP to uniquely identify customer.
15082           required: true
15083           type: string
15084           example: __GLOBAL-CUSTOMER-ID__
15085         - name: service-type
15086           in: path
15087           description: Value defined by orchestration to identify this service across ECOMP.
15088           required: true
15089           type: string
15090           example: __SERVICE-TYPE__
15091         - name: body
15092           in: body
15093           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
15094           required: true
15095           schema:
15096             $ref: "#/definitions/service-subscription"
15097     patch:
15098       tags:
15099         - Business
15100       summary: update an existing service-subscription
15101       description: |
15102         Update an existing service-subscription
15103         #
15104         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15105         The PUT operation will entirely replace an existing object.
15106         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.
15107         #
15108         Other differences between PUT and PATCH are:
15109         #
15110         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15111         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15112         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15113       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15114       consumes:
15115         - application/json
15116         - application/xml
15117       produces:
15118         - application/json
15119         - application/xml
15120       responses:
15121         "default":
15122           description: Response codes found in [response codes](https://wiki.onap.org/).
15123       parameters:
15124         - name: global-customer-id
15125           in: path
15126           description: Global customer id used across ECOMP to uniquely identify customer.
15127           required: true
15128           type: string
15129           example: __GLOBAL-CUSTOMER-ID__
15130         - name: service-type
15131           in: path
15132           description: Value defined by orchestration to identify this service across ECOMP.
15133           required: true
15134           type: string
15135           example: __SERVICE-TYPE__
15136         - name: body
15137           in: body
15138           description: service-subscription object that needs to be created or updated.
15139           required: true
15140           schema:
15141             $ref: "#/patchDefinitions/service-subscription"
15142     delete:
15143       tags:
15144         - Business
15145       summary: delete an existing service-subscription
15146       description: delete an existing service-subscription
15147       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
15148       consumes:
15149         - application/json
15150         - application/xml
15151       produces:
15152         - application/json
15153         - application/xml
15154       responses:
15155         "default":
15156           description: Response codes found in [response codes](https://wiki.onap.org/).
15157       parameters:
15158         - name: global-customer-id
15159           in: path
15160           description: Global customer id used across ECOMP to uniquely identify customer.
15161           required: true
15162           type: string
15163           example: __GLOBAL-CUSTOMER-ID__
15164         - name: service-type
15165           in: path
15166           description: Value defined by orchestration to identify this service across ECOMP.
15167           required: true
15168           type: string
15169           example: __SERVICE-TYPE__
15170         - name: resource-version
15171           in: query
15172           description: resource-version for concurrency
15173           required: true
15174           type: string
15175   /business/customers/customer/{global-customer-id}/service-subscriptions:
15176     get:
15177       tags:
15178         - Business
15179       summary: returns service-subscriptions
15180       description: returns service-subscriptions
15181       operationId: getBusinessCustomersCustomerServiceSubscriptions
15182       produces:
15183         - application/json
15184         - application/xml
15185       responses:
15186         "200":
15187           description: successful operation
15188           schema:
15189               $ref: "#/getDefinitions/service-subscriptions"
15190         "default":
15191           description: Response codes found in [response codes](https://wiki.onap.org/).
15192       parameters:
15193         - name: global-customer-id
15194           in: path
15195           description: Global customer id used across ECOMP to uniquely identify customer.
15196           required: true
15197           type: string
15198           example: __GLOBAL-CUSTOMER-ID__
15199         - name: subscriber-name
15200           in: query
15201           description: Subscriber name, an alternate way to retrieve a customer.
15202           required: false
15203           type: string
15204         - name: subscriber-type
15205           in: query
15206           description: Subscriber type, a way to provide VID with only the INFRA customers.
15207           required: false
15208           type: string
15209   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
15210     put:
15211       tags:
15212         - Business
15213       summary: see node definition for valid relationships
15214       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
15215       consumes:
15216         - application/json
15217         - application/xml
15218       produces:
15219         - application/json
15220         - application/xml
15221       responses:
15222         "default":
15223           description: Response codes found in [response codes](https://wiki.onap.org/).
15224       parameters:
15225         - name: global-customer-id
15226           in: path
15227           description: Global customer id used across ECOMP to uniquely identify customer.
15228           required: true
15229           type: string
15230           example: __GLOBAL-CUSTOMER-ID__
15231         - name: body
15232           in: body
15233           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
15234           required: true
15235           schema:
15236             $ref: "#/definitions/relationship"
15237     delete:
15238       tags:
15239         - Business
15240       summary: delete an existing relationship
15241       description: delete an existing relationship
15242       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
15243       consumes:
15244         - application/json
15245         - application/xml
15246       produces:
15247         - application/json
15248         - application/xml
15249       responses:
15250         "default":
15251           description: Response codes found in [response codes](https://wiki.onap.org/).
15252       parameters:
15253         - name: global-customer-id
15254           in: path
15255           description: Global customer id used across ECOMP to uniquely identify customer.
15256           required: true
15257           type: string
15258           example: __GLOBAL-CUSTOMER-ID__
15259   /business/customers/customer/{global-customer-id}:
15260     get:
15261       tags:
15262         - Business
15263       summary: returns customer
15264       description: returns customer
15265       operationId: getBusinessCustomersCustomer
15266       produces:
15267         - application/json
15268         - application/xml
15269       responses:
15270         "200":
15271           description: successful operation
15272           schema:
15273               $ref: "#/getDefinitions/customer"
15274         "default":
15275           description: Response codes found in [response codes](https://wiki.onap.org/).
15276       parameters:
15277         - name: global-customer-id
15278           in: path
15279           description: Global customer id used across ECOMP to uniquely identify customer.
15280           required: true
15281           type: string
15282           example: __GLOBAL-CUSTOMER-ID__
15283         - name: subscriber-name
15284           in: query
15285           description: Subscriber name, an alternate way to retrieve a customer.
15286           required: false
15287           type: string
15288         - name: subscriber-type
15289           in: query
15290           description: Subscriber type, a way to provide VID with only the INFRA customers.
15291           required: false
15292           type: string
15293     put:
15294       tags:
15295         - Business
15296       summary: create or update an existing customer
15297       description: |
15298         Create or update an existing customer.
15299         #
15300         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
15301       operationId: createOrUpdateBusinessCustomersCustomer
15302       consumes:
15303         - application/json
15304         - application/xml
15305       produces:
15306         - application/json
15307         - application/xml
15308       responses:
15309         "default":
15310           description: Response codes found in [response codes](https://wiki.onap.org/).
15311       parameters:
15312         - name: global-customer-id
15313           in: path
15314           description: Global customer id used across ECOMP to uniquely identify customer.
15315           required: true
15316           type: string
15317           example: __GLOBAL-CUSTOMER-ID__
15318         - name: body
15319           in: body
15320           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/BusinessCustomersCustomer.json)
15321           required: true
15322           schema:
15323             $ref: "#/definitions/customer"
15324     patch:
15325       tags:
15326         - Business
15327       summary: update an existing customer
15328       description: |
15329         Update an existing customer
15330         #
15331         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15332         The PUT operation will entirely replace an existing object.
15333         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.
15334         #
15335         Other differences between PUT and PATCH are:
15336         #
15337         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15338         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15339         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15340       operationId: UpdateBusinessCustomersCustomer
15341       consumes:
15342         - application/json
15343         - application/xml
15344       produces:
15345         - application/json
15346         - application/xml
15347       responses:
15348         "default":
15349           description: Response codes found in [response codes](https://wiki.onap.org/).
15350       parameters:
15351         - name: global-customer-id
15352           in: path
15353           description: Global customer id used across ECOMP to uniquely identify customer.
15354           required: true
15355           type: string
15356           example: __GLOBAL-CUSTOMER-ID__
15357         - name: body
15358           in: body
15359           description: customer object that needs to be created or updated.
15360           required: true
15361           schema:
15362             $ref: "#/patchDefinitions/customer"
15363     delete:
15364       tags:
15365         - Business
15366       summary: delete an existing customer
15367       description: delete an existing customer
15368       operationId: deleteBusinessCustomersCustomer
15369       consumes:
15370         - application/json
15371         - application/xml
15372       produces:
15373         - application/json
15374         - application/xml
15375       responses:
15376         "default":
15377           description: Response codes found in [response codes](https://wiki.onap.org/).
15378       parameters:
15379         - name: global-customer-id
15380           in: path
15381           description: Global customer id used across ECOMP to uniquely identify customer.
15382           required: true
15383           type: string
15384           example: __GLOBAL-CUSTOMER-ID__
15385         - name: resource-version
15386           in: query
15387           description: resource-version for concurrency
15388           required: true
15389           type: string
15390   /business/customers:
15391     get:
15392       tags:
15393         - Business
15394       summary: returns customers
15395       description: returns customers
15396       operationId: getBusinessCustomers
15397       produces:
15398         - application/json
15399         - application/xml
15400       responses:
15401         "200":
15402           description: successful operation
15403           schema:
15404               $ref: "#/getDefinitions/customers"
15405         "default":
15406           description: Response codes found in [response codes](https://wiki.onap.org/).
15407   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
15408     put:
15409       tags:
15410         - ServiceDesignAndCreation
15411       summary: see node definition for valid relationships
15412       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
15413       consumes:
15414         - application/json
15415         - application/xml
15416       produces:
15417         - application/json
15418         - application/xml
15419       responses:
15420         "default":
15421           description: Response codes found in [response codes](https://wiki.onap.org/).
15422       parameters:
15423         - name: vnf-image-uuid
15424           in: path
15425           description: Unique ID of this asset
15426           required: true
15427           type: string
15428           example: __VNF-IMAGE-UUID__
15429         - name: body
15430           in: body
15431           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
15432           required: true
15433           schema:
15434             $ref: "#/definitions/relationship"
15435     delete:
15436       tags:
15437         - ServiceDesignAndCreation
15438       summary: delete an existing relationship
15439       description: delete an existing relationship
15440       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
15441       consumes:
15442         - application/json
15443         - application/xml
15444       produces:
15445         - application/json
15446         - application/xml
15447       responses:
15448         "default":
15449           description: Response codes found in [response codes](https://wiki.onap.org/).
15450       parameters:
15451         - name: vnf-image-uuid
15452           in: path
15453           description: Unique ID of this asset
15454           required: true
15455           type: string
15456           example: __VNF-IMAGE-UUID__
15457   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
15458     get:
15459       tags:
15460         - ServiceDesignAndCreation
15461       summary: returns vnf-image
15462       description: returns vnf-image
15463       operationId: getServiceDesignAndCreationVnfImagesVnfImage
15464       produces:
15465         - application/json
15466         - application/xml
15467       responses:
15468         "200":
15469           description: successful operation
15470           schema:
15471               $ref: "#/getDefinitions/vnf-image"
15472         "default":
15473           description: Response codes found in [response codes](https://wiki.onap.org/).
15474       parameters:
15475         - name: vnf-image-uuid
15476           in: path
15477           description: Unique ID of this asset
15478           required: true
15479           type: string
15480           example: __VNF-IMAGE-UUID__
15481         - name: application
15482           in: query
15483           description: The application that the image instantiates.
15484           required: false
15485           type: string
15486         - name: application-vendor
15487           in: query
15488           description: The vendor of the application.
15489           required: false
15490           type: string
15491         - name: application-version
15492           in: query
15493           description: The version of the application.
15494           required: false
15495           type: string
15496     put:
15497       tags:
15498         - ServiceDesignAndCreation
15499       summary: create or update an existing vnf-image
15500       description: |
15501         Create or update an existing vnf-image.
15502         #
15503         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
15504       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
15505       consumes:
15506         - application/json
15507         - application/xml
15508       produces:
15509         - application/json
15510         - application/xml
15511       responses:
15512         "default":
15513           description: Response codes found in [response codes](https://wiki.onap.org/).
15514       parameters:
15515         - name: vnf-image-uuid
15516           in: path
15517           description: Unique ID of this asset
15518           required: true
15519           type: string
15520           example: __VNF-IMAGE-UUID__
15521         - name: body
15522           in: body
15523           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationVnfImagesVnfImage.json)
15524           required: true
15525           schema:
15526             $ref: "#/definitions/vnf-image"
15527     patch:
15528       tags:
15529         - ServiceDesignAndCreation
15530       summary: update an existing vnf-image
15531       description: |
15532         Update an existing vnf-image
15533         #
15534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15535         The PUT operation will entirely replace an existing object.
15536         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.
15537         #
15538         Other differences between PUT and PATCH are:
15539         #
15540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15543       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
15544       consumes:
15545         - application/json
15546         - application/xml
15547       produces:
15548         - application/json
15549         - application/xml
15550       responses:
15551         "default":
15552           description: Response codes found in [response codes](https://wiki.onap.org/).
15553       parameters:
15554         - name: vnf-image-uuid
15555           in: path
15556           description: Unique ID of this asset
15557           required: true
15558           type: string
15559           example: __VNF-IMAGE-UUID__
15560         - name: body
15561           in: body
15562           description: vnf-image object that needs to be created or updated.
15563           required: true
15564           schema:
15565             $ref: "#/patchDefinitions/vnf-image"
15566     delete:
15567       tags:
15568         - ServiceDesignAndCreation
15569       summary: delete an existing vnf-image
15570       description: delete an existing vnf-image
15571       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
15572       consumes:
15573         - application/json
15574         - application/xml
15575       produces:
15576         - application/json
15577         - application/xml
15578       responses:
15579         "default":
15580           description: Response codes found in [response codes](https://wiki.onap.org/).
15581       parameters:
15582         - name: vnf-image-uuid
15583           in: path
15584           description: Unique ID of this asset
15585           required: true
15586           type: string
15587           example: __VNF-IMAGE-UUID__
15588         - name: resource-version
15589           in: query
15590           description: resource-version for concurrency
15591           required: true
15592           type: string
15593   /service-design-and-creation/vnf-images:
15594     get:
15595       tags:
15596         - ServiceDesignAndCreation
15597       summary: returns vnf-images
15598       description: returns vnf-images
15599       operationId: getServiceDesignAndCreationVnfImages
15600       produces:
15601         - application/json
15602         - application/xml
15603       responses:
15604         "200":
15605           description: successful operation
15606           schema:
15607               $ref: "#/getDefinitions/vnf-images"
15608         "default":
15609           description: Response codes found in [response codes](https://wiki.onap.org/).
15610   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
15611     put:
15612       tags:
15613         - ServiceDesignAndCreation
15614       summary: see node definition for valid relationships
15615       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
15616       consumes:
15617         - application/json
15618         - application/xml
15619       produces:
15620         - application/json
15621         - application/xml
15622       responses:
15623         "default":
15624           description: Response codes found in [response codes](https://wiki.onap.org/).
15625       parameters:
15626         - name: service-id
15627           in: path
15628           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15629           required: true
15630           type: string
15631           example: __SERVICE-ID__
15632         - name: body
15633           in: body
15634           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
15635           required: true
15636           schema:
15637             $ref: "#/definitions/relationship"
15638     delete:
15639       tags:
15640         - ServiceDesignAndCreation
15641       summary: delete an existing relationship
15642       description: delete an existing relationship
15643       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
15644       consumes:
15645         - application/json
15646         - application/xml
15647       produces:
15648         - application/json
15649         - application/xml
15650       responses:
15651         "default":
15652           description: Response codes found in [response codes](https://wiki.onap.org/).
15653       parameters:
15654         - name: service-id
15655           in: path
15656           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15657           required: true
15658           type: string
15659           example: __SERVICE-ID__
15660   /service-design-and-creation/services/service/{service-id}:
15661     get:
15662       tags:
15663         - ServiceDesignAndCreation
15664       summary: returns service
15665       description: returns service
15666       operationId: getServiceDesignAndCreationServicesService
15667       produces:
15668         - application/json
15669         - application/xml
15670       responses:
15671         "200":
15672           description: successful operation
15673           schema:
15674               $ref: "#/getDefinitions/service"
15675         "default":
15676           description: Response codes found in [response codes](https://wiki.onap.org/).
15677       parameters:
15678         - name: service-id
15679           in: path
15680           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15681           required: true
15682           type: string
15683           example: __SERVICE-ID__
15684         - name: service-description
15685           in: query
15686           description: Description of the service
15687           required: false
15688           type: string
15689     put:
15690       tags:
15691         - ServiceDesignAndCreation
15692       summary: create or update an existing service
15693       description: |
15694         Create or update an existing service.
15695         #
15696         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
15697       operationId: createOrUpdateServiceDesignAndCreationServicesService
15698       consumes:
15699         - application/json
15700         - application/xml
15701       produces:
15702         - application/json
15703         - application/xml
15704       responses:
15705         "default":
15706           description: Response codes found in [response codes](https://wiki.onap.org/).
15707       parameters:
15708         - name: service-id
15709           in: path
15710           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15711           required: true
15712           type: string
15713           example: __SERVICE-ID__
15714         - name: body
15715           in: body
15716           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServicesService.json)
15717           required: true
15718           schema:
15719             $ref: "#/definitions/service"
15720     patch:
15721       tags:
15722         - ServiceDesignAndCreation
15723       summary: update an existing service
15724       description: |
15725         Update an existing service
15726         #
15727         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15728         The PUT operation will entirely replace an existing object.
15729         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.
15730         #
15731         Other differences between PUT and PATCH are:
15732         #
15733         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15734         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15735         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15736       operationId: UpdateServiceDesignAndCreationServicesService
15737       consumes:
15738         - application/json
15739         - application/xml
15740       produces:
15741         - application/json
15742         - application/xml
15743       responses:
15744         "default":
15745           description: Response codes found in [response codes](https://wiki.onap.org/).
15746       parameters:
15747         - name: service-id
15748           in: path
15749           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15750           required: true
15751           type: string
15752           example: __SERVICE-ID__
15753         - name: body
15754           in: body
15755           description: service object that needs to be created or updated.
15756           required: true
15757           schema:
15758             $ref: "#/patchDefinitions/service"
15759     delete:
15760       tags:
15761         - ServiceDesignAndCreation
15762       summary: delete an existing service
15763       description: delete an existing service
15764       operationId: deleteServiceDesignAndCreationServicesService
15765       consumes:
15766         - application/json
15767         - application/xml
15768       produces:
15769         - application/json
15770         - application/xml
15771       responses:
15772         "default":
15773           description: Response codes found in [response codes](https://wiki.onap.org/).
15774       parameters:
15775         - name: service-id
15776           in: path
15777           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15778           required: true
15779           type: string
15780           example: __SERVICE-ID__
15781         - name: resource-version
15782           in: query
15783           description: resource-version for concurrency
15784           required: true
15785           type: string
15786   /service-design-and-creation/services:
15787     get:
15788       tags:
15789         - ServiceDesignAndCreation
15790       summary: returns services
15791       description: returns services
15792       operationId: getServiceDesignAndCreationServices
15793       produces:
15794         - application/json
15795         - application/xml
15796       responses:
15797         "200":
15798           description: successful operation
15799           schema:
15800               $ref: "#/getDefinitions/services"
15801         "default":
15802           description: Response codes found in [response codes](https://wiki.onap.org/).
15803   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
15804     put:
15805       tags:
15806         - ServiceDesignAndCreation
15807       summary: see node definition for valid relationships
15808       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
15809       consumes:
15810         - application/json
15811         - application/xml
15812       produces:
15813         - application/json
15814         - application/xml
15815       responses:
15816         "default":
15817           description: Response codes found in [response codes](https://wiki.onap.org/).
15818       parameters:
15819         - name: service-type
15820           in: path
15821           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15822           required: true
15823           type: string
15824           example: __SERVICE-TYPE__
15825         - name: vnf-type
15826           in: path
15827           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
15828           required: true
15829           type: string
15830           example: __VNF-TYPE__
15831         - name: body
15832           in: body
15833           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
15834           required: true
15835           schema:
15836             $ref: "#/definitions/relationship"
15837     delete:
15838       tags:
15839         - ServiceDesignAndCreation
15840       summary: delete an existing relationship
15841       description: delete an existing relationship
15842       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
15843       consumes:
15844         - application/json
15845         - application/xml
15846       produces:
15847         - application/json
15848         - application/xml
15849       responses:
15850         "default":
15851           description: Response codes found in [response codes](https://wiki.onap.org/).
15852       parameters:
15853         - name: service-type
15854           in: path
15855           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15856           required: true
15857           type: string
15858           example: __SERVICE-TYPE__
15859         - name: vnf-type
15860           in: path
15861           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
15862           required: true
15863           type: string
15864           example: __VNF-TYPE__
15865   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
15866     get:
15867       tags:
15868         - ServiceDesignAndCreation
15869       summary: returns service-capability
15870       description: returns service-capability
15871       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
15872       produces:
15873         - application/json
15874         - application/xml
15875       responses:
15876         "200":
15877           description: successful operation
15878           schema:
15879               $ref: "#/getDefinitions/service-capability"
15880         "default":
15881           description: Response codes found in [response codes](https://wiki.onap.org/).
15882       parameters:
15883         - name: service-type
15884           in: path
15885           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15886           required: true
15887           type: string
15888           example: __SERVICE-TYPE__
15889         - name: vnf-type
15890           in: path
15891           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
15892           required: true
15893           type: string
15894           example: __VNF-TYPE__
15895     put:
15896       tags:
15897         - ServiceDesignAndCreation
15898       summary: create or update an existing service-capability
15899       description: |
15900         Create or update an existing service-capability.
15901         #
15902         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
15903       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15904       consumes:
15905         - application/json
15906         - application/xml
15907       produces:
15908         - application/json
15909         - application/xml
15910       responses:
15911         "default":
15912           description: Response codes found in [response codes](https://wiki.onap.org/).
15913       parameters:
15914         - name: service-type
15915           in: path
15916           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15917           required: true
15918           type: string
15919           example: __SERVICE-TYPE__
15920         - name: vnf-type
15921           in: path
15922           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
15923           required: true
15924           type: string
15925           example: __VNF-TYPE__
15926         - name: body
15927           in: body
15928           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
15929           required: true
15930           schema:
15931             $ref: "#/definitions/service-capability"
15932     patch:
15933       tags:
15934         - ServiceDesignAndCreation
15935       summary: update an existing service-capability
15936       description: |
15937         Update an existing service-capability
15938         #
15939         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15940         The PUT operation will entirely replace an existing object.
15941         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.
15942         #
15943         Other differences between PUT and PATCH are:
15944         #
15945         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15946         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15947         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15948       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
15949       consumes:
15950         - application/json
15951         - application/xml
15952       produces:
15953         - application/json
15954         - application/xml
15955       responses:
15956         "default":
15957           description: Response codes found in [response codes](https://wiki.onap.org/).
15958       parameters:
15959         - name: service-type
15960           in: path
15961           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15962           required: true
15963           type: string
15964           example: __SERVICE-TYPE__
15965         - name: vnf-type
15966           in: path
15967           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
15968           required: true
15969           type: string
15970           example: __VNF-TYPE__
15971         - name: body
15972           in: body
15973           description: service-capability object that needs to be created or updated.
15974           required: true
15975           schema:
15976             $ref: "#/patchDefinitions/service-capability"
15977     delete:
15978       tags:
15979         - ServiceDesignAndCreation
15980       summary: delete an existing service-capability
15981       description: delete an existing service-capability
15982       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
15983       consumes:
15984         - application/json
15985         - application/xml
15986       produces:
15987         - application/json
15988         - application/xml
15989       responses:
15990         "default":
15991           description: Response codes found in [response codes](https://wiki.onap.org/).
15992       parameters:
15993         - name: service-type
15994           in: path
15995           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
15996           required: true
15997           type: string
15998           example: __SERVICE-TYPE__
15999         - name: vnf-type
16000           in: path
16001           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
16002           required: true
16003           type: string
16004           example: __VNF-TYPE__
16005         - name: resource-version
16006           in: query
16007           description: resource-version for concurrency
16008           required: true
16009           type: string
16010   /service-design-and-creation/service-capabilities:
16011     get:
16012       tags:
16013         - ServiceDesignAndCreation
16014       summary: returns service-capabilities
16015       description: returns service-capabilities
16016       operationId: getServiceDesignAndCreationServiceCapabilities
16017       produces:
16018         - application/json
16019         - application/xml
16020       responses:
16021         "200":
16022           description: successful operation
16023           schema:
16024               $ref: "#/getDefinitions/service-capabilities"
16025         "default":
16026           description: Response codes found in [response codes](https://wiki.onap.org/).
16027   /service-design-and-creation/models/model/{model-name-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:
16028     put:
16029       tags:
16030         - ServiceDesignAndCreation
16031       summary: see node definition for valid relationships
16032       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
16033       consumes:
16034         - application/json
16035         - application/xml
16036       produces:
16037         - application/json
16038         - application/xml
16039       responses:
16040         "default":
16041           description: Response codes found in [response codes](https://wiki.onap.org/).
16042       parameters:
16043         - name: model-name-version-id
16044           in: path
16045           description: Unique identifier corresponding to one version of a model in ASDC
16046           required: true
16047           type: string
16048           example: __MODEL-NAME-VERSION-ID__
16049         - name: model-element-uuid
16050           in: path
16051           required: true
16052           type: string
16053           example: __MODEL-ELEMENT-UUID__
16054         - name: model-constraint-uuid
16055           in: path
16056           required: true
16057           type: string
16058           example: __MODEL-CONSTRAINT-UUID__
16059         - name: constrained-element-set-uuid
16060           in: path
16061           required: true
16062           type: string
16063           example: __CONSTRAINED-ELEMENT-SET-UUID__
16064         - name: element-choice-set-uuid
16065           in: path
16066           required: true
16067           type: string
16068           example: __ELEMENT-CHOICE-SET-UUID__
16069         - name: body
16070           in: body
16071           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
16072           required: true
16073           schema:
16074             $ref: "#/definitions/relationship"
16075     delete:
16076       tags:
16077         - ServiceDesignAndCreation
16078       summary: delete an existing relationship
16079       description: delete an existing relationship
16080       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
16081       consumes:
16082         - application/json
16083         - application/xml
16084       produces:
16085         - application/json
16086         - application/xml
16087       responses:
16088         "default":
16089           description: Response codes found in [response codes](https://wiki.onap.org/).
16090       parameters:
16091         - name: model-name-version-id
16092           in: path
16093           description: Unique identifier corresponding to one version of a model in ASDC
16094           required: true
16095           type: string
16096           example: __MODEL-NAME-VERSION-ID__
16097         - name: model-element-uuid
16098           in: path
16099           required: true
16100           type: string
16101           example: __MODEL-ELEMENT-UUID__
16102         - name: model-constraint-uuid
16103           in: path
16104           required: true
16105           type: string
16106           example: __MODEL-CONSTRAINT-UUID__
16107         - name: constrained-element-set-uuid
16108           in: path
16109           required: true
16110           type: string
16111           example: __CONSTRAINED-ELEMENT-SET-UUID__
16112         - name: element-choice-set-uuid
16113           in: path
16114           required: true
16115           type: string
16116           example: __ELEMENT-CHOICE-SET-UUID__
16117   /service-design-and-creation/models/model/{model-name-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}:
16118     get:
16119       tags:
16120         - ServiceDesignAndCreation
16121       summary: returns element-choice-set
16122       description: returns element-choice-set
16123       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16124       produces:
16125         - application/json
16126         - application/xml
16127       responses:
16128         "200":
16129           description: successful operation
16130           schema:
16131               $ref: "#/getDefinitions/element-choice-set"
16132         "default":
16133           description: Response codes found in [response codes](https://wiki.onap.org/).
16134       parameters:
16135         - name: model-name-version-id
16136           in: path
16137           description: Unique identifier corresponding to one version of a model in ASDC
16138           required: true
16139           type: string
16140           example: __MODEL-NAME-VERSION-ID__
16141         - name: model-element-uuid
16142           in: path
16143           required: true
16144           type: string
16145           example: __MODEL-ELEMENT-UUID__
16146         - name: model-constraint-uuid
16147           in: path
16148           required: true
16149           type: string
16150           example: __MODEL-CONSTRAINT-UUID__
16151         - name: constrained-element-set-uuid
16152           in: path
16153           required: true
16154           type: string
16155           example: __CONSTRAINED-ELEMENT-SET-UUID__
16156         - name: element-choice-set-uuid
16157           in: path
16158           required: true
16159           type: string
16160           example: __ELEMENT-CHOICE-SET-UUID__
16161         - name: model-type
16162           in: query
16163           description: Type of the model, e.g., service, resource, widget, etc.
16164           required: false
16165           type: string
16166         - name: model-name
16167           in: query
16168           description: Name of the model, which can change from version to version.
16169           required: false
16170           type: string
16171         - name: model-id
16172           in: query
16173           description: Invariant unique ID which does not change from version to version
16174           required: false
16175           type: string
16176         - name: model-version
16177           in: query
16178           description: Version
16179           required: false
16180           type: string
16181     put:
16182       tags:
16183         - ServiceDesignAndCreation
16184       summary: create or update an existing element-choice-set
16185       description: |
16186         Create or update an existing element-choice-set.
16187         #
16188         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
16189       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16190       consumes:
16191         - application/json
16192         - application/xml
16193       produces:
16194         - application/json
16195         - application/xml
16196       responses:
16197         "default":
16198           description: Response codes found in [response codes](https://wiki.onap.org/).
16199       parameters:
16200         - name: model-name-version-id
16201           in: path
16202           description: Unique identifier corresponding to one version of a model in ASDC
16203           required: true
16204           type: string
16205           example: __MODEL-NAME-VERSION-ID__
16206         - name: model-element-uuid
16207           in: path
16208           required: true
16209           type: string
16210           example: __MODEL-ELEMENT-UUID__
16211         - name: model-constraint-uuid
16212           in: path
16213           required: true
16214           type: string
16215           example: __MODEL-CONSTRAINT-UUID__
16216         - name: constrained-element-set-uuid
16217           in: path
16218           required: true
16219           type: string
16220           example: __CONSTRAINED-ELEMENT-SET-UUID__
16221         - name: element-choice-set-uuid
16222           in: path
16223           required: true
16224           type: string
16225           example: __ELEMENT-CHOICE-SET-UUID__
16226         - name: body
16227           in: body
16228           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
16229           required: true
16230           schema:
16231             $ref: "#/definitions/element-choice-set"
16232     patch:
16233       tags:
16234         - ServiceDesignAndCreation
16235       summary: update an existing element-choice-set
16236       description: |
16237         Update an existing element-choice-set
16238         #
16239         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16240         The PUT operation will entirely replace an existing object.
16241         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.
16242         #
16243         Other differences between PUT and PATCH are:
16244         #
16245         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16246         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16247         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16248       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16249       consumes:
16250         - application/json
16251         - application/xml
16252       produces:
16253         - application/json
16254         - application/xml
16255       responses:
16256         "default":
16257           description: Response codes found in [response codes](https://wiki.onap.org/).
16258       parameters:
16259         - name: model-name-version-id
16260           in: path
16261           description: Unique identifier corresponding to one version of a model in ASDC
16262           required: true
16263           type: string
16264           example: __MODEL-NAME-VERSION-ID__
16265         - name: model-element-uuid
16266           in: path
16267           required: true
16268           type: string
16269           example: __MODEL-ELEMENT-UUID__
16270         - name: model-constraint-uuid
16271           in: path
16272           required: true
16273           type: string
16274           example: __MODEL-CONSTRAINT-UUID__
16275         - name: constrained-element-set-uuid
16276           in: path
16277           required: true
16278           type: string
16279           example: __CONSTRAINED-ELEMENT-SET-UUID__
16280         - name: element-choice-set-uuid
16281           in: path
16282           required: true
16283           type: string
16284           example: __ELEMENT-CHOICE-SET-UUID__
16285         - name: body
16286           in: body
16287           description: element-choice-set object that needs to be created or updated.
16288           required: true
16289           schema:
16290             $ref: "#/patchDefinitions/element-choice-set"
16291     delete:
16292       tags:
16293         - ServiceDesignAndCreation
16294       summary: delete an existing element-choice-set
16295       description: delete an existing element-choice-set
16296       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
16297       consumes:
16298         - application/json
16299         - application/xml
16300       produces:
16301         - application/json
16302         - application/xml
16303       responses:
16304         "default":
16305           description: Response codes found in [response codes](https://wiki.onap.org/).
16306       parameters:
16307         - name: model-name-version-id
16308           in: path
16309           description: Unique identifier corresponding to one version of a model in ASDC
16310           required: true
16311           type: string
16312           example: __MODEL-NAME-VERSION-ID__
16313         - name: model-element-uuid
16314           in: path
16315           required: true
16316           type: string
16317           example: __MODEL-ELEMENT-UUID__
16318         - name: model-constraint-uuid
16319           in: path
16320           required: true
16321           type: string
16322           example: __MODEL-CONSTRAINT-UUID__
16323         - name: constrained-element-set-uuid
16324           in: path
16325           required: true
16326           type: string
16327           example: __CONSTRAINED-ELEMENT-SET-UUID__
16328         - name: element-choice-set-uuid
16329           in: path
16330           required: true
16331           type: string
16332           example: __ELEMENT-CHOICE-SET-UUID__
16333         - name: resource-version
16334           in: query
16335           description: resource-version for concurrency
16336           required: true
16337           type: string
16338   /service-design-and-creation/models/model/{model-name-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:
16339     get:
16340       tags:
16341         - ServiceDesignAndCreation
16342       summary: returns element-choice-sets
16343       description: returns element-choice-sets
16344       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
16345       produces:
16346         - application/json
16347         - application/xml
16348       responses:
16349         "200":
16350           description: successful operation
16351           schema:
16352               $ref: "#/getDefinitions/element-choice-sets"
16353         "default":
16354           description: Response codes found in [response codes](https://wiki.onap.org/).
16355       parameters:
16356         - name: model-name-version-id
16357           in: path
16358           description: Unique identifier corresponding to one version of a model in ASDC
16359           required: true
16360           type: string
16361           example: __MODEL-NAME-VERSION-ID__
16362         - name: model-element-uuid
16363           in: path
16364           required: true
16365           type: string
16366           example: __MODEL-ELEMENT-UUID__
16367         - name: model-constraint-uuid
16368           in: path
16369           required: true
16370           type: string
16371           example: __MODEL-CONSTRAINT-UUID__
16372         - name: constrained-element-set-uuid
16373           in: path
16374           required: true
16375           type: string
16376           example: __CONSTRAINED-ELEMENT-SET-UUID__
16377         - name: model-type
16378           in: query
16379           description: Type of the model, e.g., service, resource, widget, etc.
16380           required: false
16381           type: string
16382         - name: model-name
16383           in: query
16384           description: Name of the model, which can change from version to version.
16385           required: false
16386           type: string
16387         - name: model-id
16388           in: query
16389           description: Invariant unique ID which does not change from version to version
16390           required: false
16391           type: string
16392         - name: model-version
16393           in: query
16394           description: Version
16395           required: false
16396           type: string
16397   /service-design-and-creation/models/model/{model-name-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:
16398     put:
16399       tags:
16400         - ServiceDesignAndCreation
16401       summary: see node definition for valid relationships
16402       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
16403       consumes:
16404         - application/json
16405         - application/xml
16406       produces:
16407         - application/json
16408         - application/xml
16409       responses:
16410         "default":
16411           description: Response codes found in [response codes](https://wiki.onap.org/).
16412       parameters:
16413         - name: model-name-version-id
16414           in: path
16415           description: Unique identifier corresponding to one version of a model in ASDC
16416           required: true
16417           type: string
16418           example: __MODEL-NAME-VERSION-ID__
16419         - name: model-element-uuid
16420           in: path
16421           required: true
16422           type: string
16423           example: __MODEL-ELEMENT-UUID__
16424         - name: model-constraint-uuid
16425           in: path
16426           required: true
16427           type: string
16428           example: __MODEL-CONSTRAINT-UUID__
16429         - name: constrained-element-set-uuid
16430           in: path
16431           required: true
16432           type: string
16433           example: __CONSTRAINED-ELEMENT-SET-UUID__
16434         - name: body
16435           in: body
16436           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
16437           required: true
16438           schema:
16439             $ref: "#/definitions/relationship"
16440     delete:
16441       tags:
16442         - ServiceDesignAndCreation
16443       summary: delete an existing relationship
16444       description: delete an existing relationship
16445       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
16446       consumes:
16447         - application/json
16448         - application/xml
16449       produces:
16450         - application/json
16451         - application/xml
16452       responses:
16453         "default":
16454           description: Response codes found in [response codes](https://wiki.onap.org/).
16455       parameters:
16456         - name: model-name-version-id
16457           in: path
16458           description: Unique identifier corresponding to one version of a model in ASDC
16459           required: true
16460           type: string
16461           example: __MODEL-NAME-VERSION-ID__
16462         - name: model-element-uuid
16463           in: path
16464           required: true
16465           type: string
16466           example: __MODEL-ELEMENT-UUID__
16467         - name: model-constraint-uuid
16468           in: path
16469           required: true
16470           type: string
16471           example: __MODEL-CONSTRAINT-UUID__
16472         - name: constrained-element-set-uuid
16473           in: path
16474           required: true
16475           type: string
16476           example: __CONSTRAINED-ELEMENT-SET-UUID__
16477   /service-design-and-creation/models/model/{model-name-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}:
16478     get:
16479       tags:
16480         - ServiceDesignAndCreation
16481       summary: returns constrained-element-set
16482       description: returns constrained-element-set
16483       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16484       produces:
16485         - application/json
16486         - application/xml
16487       responses:
16488         "200":
16489           description: successful operation
16490           schema:
16491               $ref: "#/getDefinitions/constrained-element-set"
16492         "default":
16493           description: Response codes found in [response codes](https://wiki.onap.org/).
16494       parameters:
16495         - name: model-name-version-id
16496           in: path
16497           description: Unique identifier corresponding to one version of a model in ASDC
16498           required: true
16499           type: string
16500           example: __MODEL-NAME-VERSION-ID__
16501         - name: model-element-uuid
16502           in: path
16503           required: true
16504           type: string
16505           example: __MODEL-ELEMENT-UUID__
16506         - name: model-constraint-uuid
16507           in: path
16508           required: true
16509           type: string
16510           example: __MODEL-CONSTRAINT-UUID__
16511         - name: constrained-element-set-uuid
16512           in: path
16513           required: true
16514           type: string
16515           example: __CONSTRAINED-ELEMENT-SET-UUID__
16516         - name: model-type
16517           in: query
16518           description: Type of the model, e.g., service, resource, widget, etc.
16519           required: false
16520           type: string
16521         - name: model-name
16522           in: query
16523           description: Name of the model, which can change from version to version.
16524           required: false
16525           type: string
16526         - name: model-id
16527           in: query
16528           description: Invariant unique ID which does not change from version to version
16529           required: false
16530           type: string
16531         - name: model-version
16532           in: query
16533           description: Version
16534           required: false
16535           type: string
16536     put:
16537       tags:
16538         - ServiceDesignAndCreation
16539       summary: create or update an existing constrained-element-set
16540       description: |
16541         Create or update an existing constrained-element-set.
16542         #
16543         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
16544       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16545       consumes:
16546         - application/json
16547         - application/xml
16548       produces:
16549         - application/json
16550         - application/xml
16551       responses:
16552         "default":
16553           description: Response codes found in [response codes](https://wiki.onap.org/).
16554       parameters:
16555         - name: model-name-version-id
16556           in: path
16557           description: Unique identifier corresponding to one version of a model in ASDC
16558           required: true
16559           type: string
16560           example: __MODEL-NAME-VERSION-ID__
16561         - name: model-element-uuid
16562           in: path
16563           required: true
16564           type: string
16565           example: __MODEL-ELEMENT-UUID__
16566         - name: model-constraint-uuid
16567           in: path
16568           required: true
16569           type: string
16570           example: __MODEL-CONSTRAINT-UUID__
16571         - name: constrained-element-set-uuid
16572           in: path
16573           required: true
16574           type: string
16575           example: __CONSTRAINED-ELEMENT-SET-UUID__
16576         - name: body
16577           in: body
16578           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
16579           required: true
16580           schema:
16581             $ref: "#/definitions/constrained-element-set"
16582     patch:
16583       tags:
16584         - ServiceDesignAndCreation
16585       summary: update an existing constrained-element-set
16586       description: |
16587         Update an existing constrained-element-set
16588         #
16589         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16590         The PUT operation will entirely replace an existing object.
16591         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.
16592         #
16593         Other differences between PUT and PATCH are:
16594         #
16595         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16596         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16597         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16598       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16599       consumes:
16600         - application/json
16601         - application/xml
16602       produces:
16603         - application/json
16604         - application/xml
16605       responses:
16606         "default":
16607           description: Response codes found in [response codes](https://wiki.onap.org/).
16608       parameters:
16609         - name: model-name-version-id
16610           in: path
16611           description: Unique identifier corresponding to one version of a model in ASDC
16612           required: true
16613           type: string
16614           example: __MODEL-NAME-VERSION-ID__
16615         - name: model-element-uuid
16616           in: path
16617           required: true
16618           type: string
16619           example: __MODEL-ELEMENT-UUID__
16620         - name: model-constraint-uuid
16621           in: path
16622           required: true
16623           type: string
16624           example: __MODEL-CONSTRAINT-UUID__
16625         - name: constrained-element-set-uuid
16626           in: path
16627           required: true
16628           type: string
16629           example: __CONSTRAINED-ELEMENT-SET-UUID__
16630         - name: body
16631           in: body
16632           description: constrained-element-set object that needs to be created or updated.
16633           required: true
16634           schema:
16635             $ref: "#/patchDefinitions/constrained-element-set"
16636     delete:
16637       tags:
16638         - ServiceDesignAndCreation
16639       summary: delete an existing constrained-element-set
16640       description: delete an existing constrained-element-set
16641       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
16642       consumes:
16643         - application/json
16644         - application/xml
16645       produces:
16646         - application/json
16647         - application/xml
16648       responses:
16649         "default":
16650           description: Response codes found in [response codes](https://wiki.onap.org/).
16651       parameters:
16652         - name: model-name-version-id
16653           in: path
16654           description: Unique identifier corresponding to one version of a model in ASDC
16655           required: true
16656           type: string
16657           example: __MODEL-NAME-VERSION-ID__
16658         - name: model-element-uuid
16659           in: path
16660           required: true
16661           type: string
16662           example: __MODEL-ELEMENT-UUID__
16663         - name: model-constraint-uuid
16664           in: path
16665           required: true
16666           type: string
16667           example: __MODEL-CONSTRAINT-UUID__
16668         - name: constrained-element-set-uuid
16669           in: path
16670           required: true
16671           type: string
16672           example: __CONSTRAINED-ELEMENT-SET-UUID__
16673         - name: resource-version
16674           in: query
16675           description: resource-version for concurrency
16676           required: true
16677           type: string
16678   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
16679     get:
16680       tags:
16681         - ServiceDesignAndCreation
16682       summary: returns constrained-element-sets
16683       description: returns constrained-element-sets
16684       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
16685       produces:
16686         - application/json
16687         - application/xml
16688       responses:
16689         "200":
16690           description: successful operation
16691           schema:
16692               $ref: "#/getDefinitions/constrained-element-sets"
16693         "default":
16694           description: Response codes found in [response codes](https://wiki.onap.org/).
16695       parameters:
16696         - name: model-name-version-id
16697           in: path
16698           description: Unique identifier corresponding to one version of a model in ASDC
16699           required: true
16700           type: string
16701           example: __MODEL-NAME-VERSION-ID__
16702         - name: model-element-uuid
16703           in: path
16704           required: true
16705           type: string
16706           example: __MODEL-ELEMENT-UUID__
16707         - name: model-constraint-uuid
16708           in: path
16709           required: true
16710           type: string
16711           example: __MODEL-CONSTRAINT-UUID__
16712         - name: model-type
16713           in: query
16714           description: Type of the model, e.g., service, resource, widget, etc.
16715           required: false
16716           type: string
16717         - name: model-name
16718           in: query
16719           description: Name of the model, which can change from version to version.
16720           required: false
16721           type: string
16722         - name: model-id
16723           in: query
16724           description: Invariant unique ID which does not change from version to version
16725           required: false
16726           type: string
16727         - name: model-version
16728           in: query
16729           description: Version
16730           required: false
16731           type: string
16732   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
16733     get:
16734       tags:
16735         - ServiceDesignAndCreation
16736       summary: returns model-constraint
16737       description: returns model-constraint
16738       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16739       produces:
16740         - application/json
16741         - application/xml
16742       responses:
16743         "200":
16744           description: successful operation
16745           schema:
16746               $ref: "#/getDefinitions/model-constraint"
16747         "default":
16748           description: Response codes found in [response codes](https://wiki.onap.org/).
16749       parameters:
16750         - name: model-name-version-id
16751           in: path
16752           description: Unique identifier corresponding to one version of a model in ASDC
16753           required: true
16754           type: string
16755           example: __MODEL-NAME-VERSION-ID__
16756         - name: model-element-uuid
16757           in: path
16758           required: true
16759           type: string
16760           example: __MODEL-ELEMENT-UUID__
16761         - name: model-constraint-uuid
16762           in: path
16763           required: true
16764           type: string
16765           example: __MODEL-CONSTRAINT-UUID__
16766         - name: model-type
16767           in: query
16768           description: Type of the model, e.g., service, resource, widget, etc.
16769           required: false
16770           type: string
16771         - name: model-name
16772           in: query
16773           description: Name of the model, which can change from version to version.
16774           required: false
16775           type: string
16776         - name: model-id
16777           in: query
16778           description: Invariant unique ID which does not change from version to version
16779           required: false
16780           type: string
16781         - name: model-version
16782           in: query
16783           description: Version
16784           required: false
16785           type: string
16786     put:
16787       tags:
16788         - ServiceDesignAndCreation
16789       summary: create or update an existing model-constraint
16790       description: |
16791         Create or update an existing model-constraint.
16792         #
16793         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
16794       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16795       consumes:
16796         - application/json
16797         - application/xml
16798       produces:
16799         - application/json
16800         - application/xml
16801       responses:
16802         "default":
16803           description: Response codes found in [response codes](https://wiki.onap.org/).
16804       parameters:
16805         - name: model-name-version-id
16806           in: path
16807           description: Unique identifier corresponding to one version of a model in ASDC
16808           required: true
16809           type: string
16810           example: __MODEL-NAME-VERSION-ID__
16811         - name: model-element-uuid
16812           in: path
16813           required: true
16814           type: string
16815           example: __MODEL-ELEMENT-UUID__
16816         - name: model-constraint-uuid
16817           in: path
16818           required: true
16819           type: string
16820           example: __MODEL-CONSTRAINT-UUID__
16821         - name: body
16822           in: body
16823           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint.json)
16824           required: true
16825           schema:
16826             $ref: "#/definitions/model-constraint"
16827     patch:
16828       tags:
16829         - ServiceDesignAndCreation
16830       summary: update an existing model-constraint
16831       description: |
16832         Update an existing model-constraint
16833         #
16834         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16835         The PUT operation will entirely replace an existing object.
16836         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.
16837         #
16838         Other differences between PUT and PATCH are:
16839         #
16840         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16841         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16842         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16843       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16844       consumes:
16845         - application/json
16846         - application/xml
16847       produces:
16848         - application/json
16849         - application/xml
16850       responses:
16851         "default":
16852           description: Response codes found in [response codes](https://wiki.onap.org/).
16853       parameters:
16854         - name: model-name-version-id
16855           in: path
16856           description: Unique identifier corresponding to one version of a model in ASDC
16857           required: true
16858           type: string
16859           example: __MODEL-NAME-VERSION-ID__
16860         - name: model-element-uuid
16861           in: path
16862           required: true
16863           type: string
16864           example: __MODEL-ELEMENT-UUID__
16865         - name: model-constraint-uuid
16866           in: path
16867           required: true
16868           type: string
16869           example: __MODEL-CONSTRAINT-UUID__
16870         - name: body
16871           in: body
16872           description: model-constraint object that needs to be created or updated.
16873           required: true
16874           schema:
16875             $ref: "#/patchDefinitions/model-constraint"
16876     delete:
16877       tags:
16878         - ServiceDesignAndCreation
16879       summary: delete an existing model-constraint
16880       description: delete an existing model-constraint
16881       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraintsModelConstraint
16882       consumes:
16883         - application/json
16884         - application/xml
16885       produces:
16886         - application/json
16887         - application/xml
16888       responses:
16889         "default":
16890           description: Response codes found in [response codes](https://wiki.onap.org/).
16891       parameters:
16892         - name: model-name-version-id
16893           in: path
16894           description: Unique identifier corresponding to one version of a model in ASDC
16895           required: true
16896           type: string
16897           example: __MODEL-NAME-VERSION-ID__
16898         - name: model-element-uuid
16899           in: path
16900           required: true
16901           type: string
16902           example: __MODEL-ELEMENT-UUID__
16903         - name: model-constraint-uuid
16904           in: path
16905           required: true
16906           type: string
16907           example: __MODEL-CONSTRAINT-UUID__
16908         - name: resource-version
16909           in: query
16910           description: resource-version for concurrency
16911           required: true
16912           type: string
16913   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
16914     get:
16915       tags:
16916         - ServiceDesignAndCreation
16917       summary: returns model-constraints
16918       description: returns model-constraints
16919       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElementModelConstraints
16920       produces:
16921         - application/json
16922         - application/xml
16923       responses:
16924         "200":
16925           description: successful operation
16926           schema:
16927               $ref: "#/getDefinitions/model-constraints"
16928         "default":
16929           description: Response codes found in [response codes](https://wiki.onap.org/).
16930       parameters:
16931         - name: model-name-version-id
16932           in: path
16933           description: Unique identifier corresponding to one version of a model in ASDC
16934           required: true
16935           type: string
16936           example: __MODEL-NAME-VERSION-ID__
16937         - name: model-element-uuid
16938           in: path
16939           required: true
16940           type: string
16941           example: __MODEL-ELEMENT-UUID__
16942         - name: model-type
16943           in: query
16944           description: Type of the model, e.g., service, resource, widget, etc.
16945           required: false
16946           type: string
16947         - name: model-name
16948           in: query
16949           description: Name of the model, which can change from version to version.
16950           required: false
16951           type: string
16952         - name: model-id
16953           in: query
16954           description: Invariant unique ID which does not change from version to version
16955           required: false
16956           type: string
16957         - name: model-version
16958           in: query
16959           description: Version
16960           required: false
16961           type: string
16962   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
16963     put:
16964       tags:
16965         - ServiceDesignAndCreation
16966       summary: see node definition for valid relationships
16967       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
16968       consumes:
16969         - application/json
16970         - application/xml
16971       produces:
16972         - application/json
16973         - application/xml
16974       responses:
16975         "default":
16976           description: Response codes found in [response codes](https://wiki.onap.org/).
16977       parameters:
16978         - name: model-name-version-id
16979           in: path
16980           description: Unique identifier corresponding to one version of a model in ASDC
16981           required: true
16982           type: string
16983           example: __MODEL-NAME-VERSION-ID__
16984         - name: model-element-uuid
16985           in: path
16986           required: true
16987           type: string
16988           example: __MODEL-ELEMENT-UUID__
16989         - name: body
16990           in: body
16991           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
16992           required: true
16993           schema:
16994             $ref: "#/definitions/relationship"
16995     delete:
16996       tags:
16997         - ServiceDesignAndCreation
16998       summary: delete an existing relationship
16999       description: delete an existing relationship
17000       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElementRelationshipListRelationship
17001       consumes:
17002         - application/json
17003         - application/xml
17004       produces:
17005         - application/json
17006         - application/xml
17007       responses:
17008         "default":
17009           description: Response codes found in [response codes](https://wiki.onap.org/).
17010       parameters:
17011         - name: model-name-version-id
17012           in: path
17013           description: Unique identifier corresponding to one version of a model in ASDC
17014           required: true
17015           type: string
17016           example: __MODEL-NAME-VERSION-ID__
17017         - name: model-element-uuid
17018           in: path
17019           required: true
17020           type: string
17021           example: __MODEL-ELEMENT-UUID__
17022   /service-design-and-creation/models/model/{model-name-version-id}/model-elements/model-element/{model-element-uuid}:
17023     get:
17024       tags:
17025         - ServiceDesignAndCreation
17026       summary: returns model-element
17027       description: returns model-element
17028       operationId: getServiceDesignAndCreationModelsModelModelElementsModelElement
17029       produces:
17030         - application/json
17031         - application/xml
17032       responses:
17033         "200":
17034           description: successful operation
17035           schema:
17036               $ref: "#/getDefinitions/model-element"
17037         "default":
17038           description: Response codes found in [response codes](https://wiki.onap.org/).
17039       parameters:
17040         - name: model-name-version-id
17041           in: path
17042           description: Unique identifier corresponding to one version of a model in ASDC
17043           required: true
17044           type: string
17045           example: __MODEL-NAME-VERSION-ID__
17046         - name: model-element-uuid
17047           in: path
17048           required: true
17049           type: string
17050           example: __MODEL-ELEMENT-UUID__
17051         - name: model-type
17052           in: query
17053           description: Type of the model, e.g., service, resource, widget, etc.
17054           required: false
17055           type: string
17056         - name: model-name
17057           in: query
17058           description: Name of the model, which can change from version to version.
17059           required: false
17060           type: string
17061         - name: model-id
17062           in: query
17063           description: Invariant unique ID which does not change from version to version
17064           required: false
17065           type: string
17066         - name: model-version
17067           in: query
17068           description: Version
17069           required: false
17070           type: string
17071     put:
17072       tags:
17073         - ServiceDesignAndCreation
17074       summary: create or update an existing model-element
17075       description: |
17076         Create or update an existing model-element.
17077         #
17078         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
17079       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelElementsModelElement
17080       consumes:
17081         - application/json
17082         - application/xml
17083       produces:
17084         - application/json
17085         - application/xml
17086       responses:
17087         "default":
17088           description: Response codes found in [response codes](https://wiki.onap.org/).
17089       parameters:
17090         - name: model-name-version-id
17091           in: path
17092           description: Unique identifier corresponding to one version of a model in ASDC
17093           required: true
17094           type: string
17095           example: __MODEL-NAME-VERSION-ID__
17096         - name: model-element-uuid
17097           in: path
17098           required: true
17099           type: string
17100           example: __MODEL-ELEMENT-UUID__
17101         - name: body
17102           in: body
17103           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelModelElementsModelElement.json)
17104           required: true
17105           schema:
17106             $ref: "#/definitions/model-element"
17107     patch:
17108       tags:
17109         - ServiceDesignAndCreation
17110       summary: update an existing model-element
17111       description: |
17112         Update an existing model-element
17113         #
17114         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17115         The PUT operation will entirely replace an existing object.
17116         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.
17117         #
17118         Other differences between PUT and PATCH are:
17119         #
17120         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17121         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17122         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17123       operationId: UpdateServiceDesignAndCreationModelsModelModelElementsModelElement
17124       consumes:
17125         - application/json
17126         - application/xml
17127       produces:
17128         - application/json
17129         - application/xml
17130       responses:
17131         "default":
17132           description: Response codes found in [response codes](https://wiki.onap.org/).
17133       parameters:
17134         - name: model-name-version-id
17135           in: path
17136           description: Unique identifier corresponding to one version of a model in ASDC
17137           required: true
17138           type: string
17139           example: __MODEL-NAME-VERSION-ID__
17140         - name: model-element-uuid
17141           in: path
17142           required: true
17143           type: string
17144           example: __MODEL-ELEMENT-UUID__
17145         - name: body
17146           in: body
17147           description: model-element object that needs to be created or updated.
17148           required: true
17149           schema:
17150             $ref: "#/patchDefinitions/model-element"
17151     delete:
17152       tags:
17153         - ServiceDesignAndCreation
17154       summary: delete an existing model-element
17155       description: delete an existing model-element
17156       operationId: deleteServiceDesignAndCreationModelsModelModelElementsModelElement
17157       consumes:
17158         - application/json
17159         - application/xml
17160       produces:
17161         - application/json
17162         - application/xml
17163       responses:
17164         "default":
17165           description: Response codes found in [response codes](https://wiki.onap.org/).
17166       parameters:
17167         - name: model-name-version-id
17168           in: path
17169           description: Unique identifier corresponding to one version of a model in ASDC
17170           required: true
17171           type: string
17172           example: __MODEL-NAME-VERSION-ID__
17173         - name: model-element-uuid
17174           in: path
17175           required: true
17176           type: string
17177           example: __MODEL-ELEMENT-UUID__
17178         - name: resource-version
17179           in: query
17180           description: resource-version for concurrency
17181           required: true
17182           type: string
17183   /service-design-and-creation/models/model/{model-name-version-id}/model-elements:
17184     get:
17185       tags:
17186         - ServiceDesignAndCreation
17187       summary: returns model-elements
17188       description: returns model-elements
17189       operationId: getServiceDesignAndCreationModelsModelModelElements
17190       produces:
17191         - application/json
17192         - application/xml
17193       responses:
17194         "200":
17195           description: successful operation
17196           schema:
17197               $ref: "#/getDefinitions/model-elements"
17198         "default":
17199           description: Response codes found in [response codes](https://wiki.onap.org/).
17200       parameters:
17201         - name: model-name-version-id
17202           in: path
17203           description: Unique identifier corresponding to one version of a model in ASDC
17204           required: true
17205           type: string
17206           example: __MODEL-NAME-VERSION-ID__
17207         - name: model-type
17208           in: query
17209           description: Type of the model, e.g., service, resource, widget, etc.
17210           required: false
17211           type: string
17212         - name: model-name
17213           in: query
17214           description: Name of the model, which can change from version to version.
17215           required: false
17216           type: string
17217         - name: model-id
17218           in: query
17219           description: Invariant unique ID which does not change from version to version
17220           required: false
17221           type: string
17222         - name: model-version
17223           in: query
17224           description: Version
17225           required: false
17226           type: string
17227   /service-design-and-creation/models/model/{model-name-version-id}/metadata/metadatum/{metaname}:
17228     get:
17229       tags:
17230         - ServiceDesignAndCreation
17231       summary: returns metadatum
17232       description: returns metadatum
17233       operationId: getServiceDesignAndCreationModelsModelMetadataMetadatum
17234       produces:
17235         - application/json
17236         - application/xml
17237       responses:
17238         "200":
17239           description: successful operation
17240           schema:
17241               $ref: "#/getDefinitions/metadatum"
17242         "default":
17243           description: Response codes found in [response codes](https://wiki.onap.org/).
17244       parameters:
17245         - name: model-name-version-id
17246           in: path
17247           description: Unique identifier corresponding to one version of a model in ASDC
17248           required: true
17249           type: string
17250           example: __MODEL-NAME-VERSION-ID__
17251         - name: metaname
17252           in: path
17253           required: true
17254           type: string
17255           example: __METANAME__
17256         - name: model-type
17257           in: query
17258           description: Type of the model, e.g., service, resource, widget, etc.
17259           required: false
17260           type: string
17261         - name: model-name
17262           in: query
17263           description: Name of the model, which can change from version to version.
17264           required: false
17265           type: string
17266         - name: model-id
17267           in: query
17268           description: Invariant unique ID which does not change from version to version
17269           required: false
17270           type: string
17271         - name: model-version
17272           in: query
17273           description: Version
17274           required: false
17275           type: string
17276     put:
17277       tags:
17278         - ServiceDesignAndCreation
17279       summary: create or update an existing metadatum
17280       description: |
17281         Create or update an existing metadatum.
17282         #
17283         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
17284       operationId: createOrUpdateServiceDesignAndCreationModelsModelMetadataMetadatum
17285       consumes:
17286         - application/json
17287         - application/xml
17288       produces:
17289         - application/json
17290         - application/xml
17291       responses:
17292         "default":
17293           description: Response codes found in [response codes](https://wiki.onap.org/).
17294       parameters:
17295         - name: model-name-version-id
17296           in: path
17297           description: Unique identifier corresponding to one version of a model in ASDC
17298           required: true
17299           type: string
17300           example: __MODEL-NAME-VERSION-ID__
17301         - name: metaname
17302           in: path
17303           required: true
17304           type: string
17305           example: __METANAME__
17306         - name: body
17307           in: body
17308           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModelMetadataMetadatum.json)
17309           required: true
17310           schema:
17311             $ref: "#/definitions/metadatum"
17312     patch:
17313       tags:
17314         - ServiceDesignAndCreation
17315       summary: update an existing metadatum
17316       description: |
17317         Update an existing metadatum
17318         #
17319         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17320         The PUT operation will entirely replace an existing object.
17321         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.
17322         #
17323         Other differences between PUT and PATCH are:
17324         #
17325         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17326         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17327         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17328       operationId: UpdateServiceDesignAndCreationModelsModelMetadataMetadatum
17329       consumes:
17330         - application/json
17331         - application/xml
17332       produces:
17333         - application/json
17334         - application/xml
17335       responses:
17336         "default":
17337           description: Response codes found in [response codes](https://wiki.onap.org/).
17338       parameters:
17339         - name: model-name-version-id
17340           in: path
17341           description: Unique identifier corresponding to one version of a model in ASDC
17342           required: true
17343           type: string
17344           example: __MODEL-NAME-VERSION-ID__
17345         - name: metaname
17346           in: path
17347           required: true
17348           type: string
17349           example: __METANAME__
17350         - name: body
17351           in: body
17352           description: metadatum object that needs to be created or updated.
17353           required: true
17354           schema:
17355             $ref: "#/patchDefinitions/metadatum"
17356     delete:
17357       tags:
17358         - ServiceDesignAndCreation
17359       summary: delete an existing metadatum
17360       description: delete an existing metadatum
17361       operationId: deleteServiceDesignAndCreationModelsModelMetadataMetadatum
17362       consumes:
17363         - application/json
17364         - application/xml
17365       produces:
17366         - application/json
17367         - application/xml
17368       responses:
17369         "default":
17370           description: Response codes found in [response codes](https://wiki.onap.org/).
17371       parameters:
17372         - name: model-name-version-id
17373           in: path
17374           description: Unique identifier corresponding to one version of a model in ASDC
17375           required: true
17376           type: string
17377           example: __MODEL-NAME-VERSION-ID__
17378         - name: metaname
17379           in: path
17380           required: true
17381           type: string
17382           example: __METANAME__
17383         - name: resource-version
17384           in: query
17385           description: resource-version for concurrency
17386           required: true
17387           type: string
17388   /service-design-and-creation/models/model/{model-name-version-id}/metadata:
17389     get:
17390       tags:
17391         - ServiceDesignAndCreation
17392       summary: returns metadata
17393       description: returns metadata
17394       operationId: getServiceDesignAndCreationModelsModelMetadata
17395       produces:
17396         - application/json
17397         - application/xml
17398       responses:
17399         "200":
17400           description: successful operation
17401           schema:
17402               $ref: "#/getDefinitions/metadata"
17403         "default":
17404           description: Response codes found in [response codes](https://wiki.onap.org/).
17405       parameters:
17406         - name: model-name-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-NAME-VERSION-ID__
17412         - name: model-type
17413           in: query
17414           description: Type of the model, e.g., service, resource, widget, etc.
17415           required: false
17416           type: string
17417         - name: model-name
17418           in: query
17419           description: Name of the model, which can change from version to version.
17420           required: false
17421           type: string
17422         - name: model-id
17423           in: query
17424           description: Invariant unique ID which does not change from version to version
17425           required: false
17426           type: string
17427         - name: model-version
17428           in: query
17429           description: Version
17430           required: false
17431           type: string
17432   /service-design-and-creation/models/model/{model-name-version-id}/relationship-list/relationship:
17433     put:
17434       tags:
17435         - ServiceDesignAndCreation
17436       summary: see node definition for valid relationships
17437       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
17438       consumes:
17439         - application/json
17440         - application/xml
17441       produces:
17442         - application/json
17443         - application/xml
17444       responses:
17445         "default":
17446           description: Response codes found in [response codes](https://wiki.onap.org/).
17447       parameters:
17448         - name: model-name-version-id
17449           in: path
17450           description: Unique identifier corresponding to one version of a model in ASDC
17451           required: true
17452           type: string
17453           example: __MODEL-NAME-VERSION-ID__
17454         - name: body
17455           in: body
17456           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
17457           required: true
17458           schema:
17459             $ref: "#/definitions/relationship"
17460     delete:
17461       tags:
17462         - ServiceDesignAndCreation
17463       summary: delete an existing relationship
17464       description: delete an existing relationship
17465       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
17466       consumes:
17467         - application/json
17468         - application/xml
17469       produces:
17470         - application/json
17471         - application/xml
17472       responses:
17473         "default":
17474           description: Response codes found in [response codes](https://wiki.onap.org/).
17475       parameters:
17476         - name: model-name-version-id
17477           in: path
17478           description: Unique identifier corresponding to one version of a model in ASDC
17479           required: true
17480           type: string
17481           example: __MODEL-NAME-VERSION-ID__
17482   /service-design-and-creation/models/model/{model-name-version-id}:
17483     get:
17484       tags:
17485         - ServiceDesignAndCreation
17486       summary: returns model
17487       description: returns model
17488       operationId: getServiceDesignAndCreationModelsModel
17489       produces:
17490         - application/json
17491         - application/xml
17492       responses:
17493         "200":
17494           description: successful operation
17495           schema:
17496               $ref: "#/getDefinitions/model"
17497         "default":
17498           description: Response codes found in [response codes](https://wiki.onap.org/).
17499       parameters:
17500         - name: model-name-version-id
17501           in: path
17502           description: Unique identifier corresponding to one version of a model in ASDC
17503           required: true
17504           type: string
17505           example: __MODEL-NAME-VERSION-ID__
17506         - name: model-type
17507           in: query
17508           description: Type of the model, e.g., service, resource, widget, etc.
17509           required: false
17510           type: string
17511         - name: model-name
17512           in: query
17513           description: Name of the model, which can change from version to version.
17514           required: false
17515           type: string
17516         - name: model-id
17517           in: query
17518           description: Invariant unique ID which does not change from version to version
17519           required: false
17520           type: string
17521         - name: model-version
17522           in: query
17523           description: Version
17524           required: false
17525           type: string
17526     put:
17527       tags:
17528         - ServiceDesignAndCreation
17529       summary: create or update an existing model
17530       description: |
17531         Create or update an existing model.
17532         #
17533         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
17534       operationId: createOrUpdateServiceDesignAndCreationModelsModel
17535       consumes:
17536         - application/json
17537         - application/xml
17538       produces:
17539         - application/json
17540         - application/xml
17541       responses:
17542         "default":
17543           description: Response codes found in [response codes](https://wiki.onap.org/).
17544       parameters:
17545         - name: model-name-version-id
17546           in: path
17547           description: Unique identifier corresponding to one version of a model in ASDC
17548           required: true
17549           type: string
17550           example: __MODEL-NAME-VERSION-ID__
17551         - name: body
17552           in: body
17553           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationModelsModel.json)
17554           required: true
17555           schema:
17556             $ref: "#/definitions/model"
17557     patch:
17558       tags:
17559         - ServiceDesignAndCreation
17560       summary: update an existing model
17561       description: |
17562         Update an existing model
17563         #
17564         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17565         The PUT operation will entirely replace an existing object.
17566         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.
17567         #
17568         Other differences between PUT and PATCH are:
17569         #
17570         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17571         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17572         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17573       operationId: UpdateServiceDesignAndCreationModelsModel
17574       consumes:
17575         - application/json
17576         - application/xml
17577       produces:
17578         - application/json
17579         - application/xml
17580       responses:
17581         "default":
17582           description: Response codes found in [response codes](https://wiki.onap.org/).
17583       parameters:
17584         - name: model-name-version-id
17585           in: path
17586           description: Unique identifier corresponding to one version of a model in ASDC
17587           required: true
17588           type: string
17589           example: __MODEL-NAME-VERSION-ID__
17590         - name: body
17591           in: body
17592           description: model object that needs to be created or updated.
17593           required: true
17594           schema:
17595             $ref: "#/patchDefinitions/model"
17596     delete:
17597       tags:
17598         - ServiceDesignAndCreation
17599       summary: delete an existing model
17600       description: delete an existing model
17601       operationId: deleteServiceDesignAndCreationModelsModel
17602       consumes:
17603         - application/json
17604         - application/xml
17605       produces:
17606         - application/json
17607         - application/xml
17608       responses:
17609         "default":
17610           description: Response codes found in [response codes](https://wiki.onap.org/).
17611       parameters:
17612         - name: model-name-version-id
17613           in: path
17614           description: Unique identifier corresponding to one version of a model in ASDC
17615           required: true
17616           type: string
17617           example: __MODEL-NAME-VERSION-ID__
17618         - name: resource-version
17619           in: query
17620           description: resource-version for concurrency
17621           required: true
17622           type: string
17623   /service-design-and-creation/models:
17624     get:
17625       tags:
17626         - ServiceDesignAndCreation
17627       summary: returns models
17628       description: returns models
17629       operationId: getServiceDesignAndCreationModels
17630       produces:
17631         - application/json
17632         - application/xml
17633       responses:
17634         "200":
17635           description: successful operation
17636           schema:
17637               $ref: "#/getDefinitions/models"
17638         "default":
17639           description: Response codes found in [response codes](https://wiki.onap.org/).
17640   /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:
17641     put:
17642       tags:
17643         - ServiceDesignAndCreation
17644       summary: see node definition for valid relationships
17645       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
17646       consumes:
17647         - application/json
17648         - application/xml
17649       produces:
17650         - application/json
17651         - application/xml
17652       responses:
17653         "default":
17654           description: Response codes found in [response codes](https://wiki.onap.org/).
17655       parameters:
17656         - name: named-query-uuid
17657           in: path
17658           required: true
17659           type: string
17660           example: __NAMED-QUERY-UUID__
17661         - name: named-query-element-uuid
17662           in: path
17663           required: true
17664           type: string
17665           example: __NAMED-QUERY-ELEMENT-UUID__
17666         - name: related-lookup-uuid
17667           in: path
17668           required: true
17669           type: string
17670           example: __RELATED-LOOKUP-UUID__
17671         - name: body
17672           in: body
17673           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17674           required: true
17675           schema:
17676             $ref: "#/definitions/relationship"
17677     delete:
17678       tags:
17679         - ServiceDesignAndCreation
17680       summary: delete an existing relationship
17681       description: delete an existing relationship
17682       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
17683       consumes:
17684         - application/json
17685         - application/xml
17686       produces:
17687         - application/json
17688         - application/xml
17689       responses:
17690         "default":
17691           description: Response codes found in [response codes](https://wiki.onap.org/).
17692       parameters:
17693         - name: named-query-uuid
17694           in: path
17695           required: true
17696           type: string
17697           example: __NAMED-QUERY-UUID__
17698         - name: named-query-element-uuid
17699           in: path
17700           required: true
17701           type: string
17702           example: __NAMED-QUERY-ELEMENT-UUID__
17703         - name: related-lookup-uuid
17704           in: path
17705           required: true
17706           type: string
17707           example: __RELATED-LOOKUP-UUID__
17708   /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}:
17709     get:
17710       tags:
17711         - ServiceDesignAndCreation
17712       summary: returns related-lookup
17713       description: returns related-lookup
17714       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17715       produces:
17716         - application/json
17717         - application/xml
17718       responses:
17719         "200":
17720           description: successful operation
17721           schema:
17722               $ref: "#/getDefinitions/related-lookup"
17723         "default":
17724           description: Response codes found in [response codes](https://wiki.onap.org/).
17725       parameters:
17726         - name: named-query-uuid
17727           in: path
17728           required: true
17729           type: string
17730           example: __NAMED-QUERY-UUID__
17731         - name: named-query-element-uuid
17732           in: path
17733           required: true
17734           type: string
17735           example: __NAMED-QUERY-ELEMENT-UUID__
17736         - name: related-lookup-uuid
17737           in: path
17738           required: true
17739           type: string
17740           example: __RELATED-LOOKUP-UUID__
17741         - name: named-query-name
17742           in: query
17743           required: false
17744           type: string
17745     put:
17746       tags:
17747         - ServiceDesignAndCreation
17748       summary: create or update an existing related-lookup
17749       description: |
17750         Create or update an existing related-lookup.
17751         #
17752         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
17753       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17754       consumes:
17755         - application/json
17756         - application/xml
17757       produces:
17758         - application/json
17759         - application/xml
17760       responses:
17761         "default":
17762           description: Response codes found in [response codes](https://wiki.onap.org/).
17763       parameters:
17764         - name: named-query-uuid
17765           in: path
17766           required: true
17767           type: string
17768           example: __NAMED-QUERY-UUID__
17769         - name: named-query-element-uuid
17770           in: path
17771           required: true
17772           type: string
17773           example: __NAMED-QUERY-ELEMENT-UUID__
17774         - name: related-lookup-uuid
17775           in: path
17776           required: true
17777           type: string
17778           example: __RELATED-LOOKUP-UUID__
17779         - name: body
17780           in: body
17781           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
17782           required: true
17783           schema:
17784             $ref: "#/definitions/related-lookup"
17785     patch:
17786       tags:
17787         - ServiceDesignAndCreation
17788       summary: update an existing related-lookup
17789       description: |
17790         Update an existing related-lookup
17791         #
17792         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17793         The PUT operation will entirely replace an existing object.
17794         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.
17795         #
17796         Other differences between PUT and PATCH are:
17797         #
17798         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17799         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17800         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17801       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17802       consumes:
17803         - application/json
17804         - application/xml
17805       produces:
17806         - application/json
17807         - application/xml
17808       responses:
17809         "default":
17810           description: Response codes found in [response codes](https://wiki.onap.org/).
17811       parameters:
17812         - name: named-query-uuid
17813           in: path
17814           required: true
17815           type: string
17816           example: __NAMED-QUERY-UUID__
17817         - name: named-query-element-uuid
17818           in: path
17819           required: true
17820           type: string
17821           example: __NAMED-QUERY-ELEMENT-UUID__
17822         - name: related-lookup-uuid
17823           in: path
17824           required: true
17825           type: string
17826           example: __RELATED-LOOKUP-UUID__
17827         - name: body
17828           in: body
17829           description: related-lookup object that needs to be created or updated.
17830           required: true
17831           schema:
17832             $ref: "#/patchDefinitions/related-lookup"
17833     delete:
17834       tags:
17835         - ServiceDesignAndCreation
17836       summary: delete an existing related-lookup
17837       description: delete an existing related-lookup
17838       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
17839       consumes:
17840         - application/json
17841         - application/xml
17842       produces:
17843         - application/json
17844         - application/xml
17845       responses:
17846         "default":
17847           description: Response codes found in [response codes](https://wiki.onap.org/).
17848       parameters:
17849         - name: named-query-uuid
17850           in: path
17851           required: true
17852           type: string
17853           example: __NAMED-QUERY-UUID__
17854         - name: named-query-element-uuid
17855           in: path
17856           required: true
17857           type: string
17858           example: __NAMED-QUERY-ELEMENT-UUID__
17859         - name: related-lookup-uuid
17860           in: path
17861           required: true
17862           type: string
17863           example: __RELATED-LOOKUP-UUID__
17864         - name: resource-version
17865           in: query
17866           description: resource-version for concurrency
17867           required: true
17868           type: string
17869   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
17870     get:
17871       tags:
17872         - ServiceDesignAndCreation
17873       summary: returns related-lookups
17874       description: returns related-lookups
17875       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
17876       produces:
17877         - application/json
17878         - application/xml
17879       responses:
17880         "200":
17881           description: successful operation
17882           schema:
17883               $ref: "#/getDefinitions/related-lookups"
17884         "default":
17885           description: Response codes found in [response codes](https://wiki.onap.org/).
17886       parameters:
17887         - name: named-query-uuid
17888           in: path
17889           required: true
17890           type: string
17891           example: __NAMED-QUERY-UUID__
17892         - name: named-query-element-uuid
17893           in: path
17894           required: true
17895           type: string
17896           example: __NAMED-QUERY-ELEMENT-UUID__
17897         - name: named-query-name
17898           in: query
17899           required: false
17900           type: string
17901   /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}:
17902     get:
17903       tags:
17904         - ServiceDesignAndCreation
17905       summary: returns property-constraint
17906       description: returns property-constraint
17907       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17908       produces:
17909         - application/json
17910         - application/xml
17911       responses:
17912         "200":
17913           description: successful operation
17914           schema:
17915               $ref: "#/getDefinitions/property-constraint"
17916         "default":
17917           description: Response codes found in [response codes](https://wiki.onap.org/).
17918       parameters:
17919         - name: named-query-uuid
17920           in: path
17921           required: true
17922           type: string
17923           example: __NAMED-QUERY-UUID__
17924         - name: named-query-element-uuid
17925           in: path
17926           required: true
17927           type: string
17928           example: __NAMED-QUERY-ELEMENT-UUID__
17929         - name: property-constraint-uuid
17930           in: path
17931           required: true
17932           type: string
17933           example: __PROPERTY-CONSTRAINT-UUID__
17934         - name: named-query-name
17935           in: query
17936           required: false
17937           type: string
17938     put:
17939       tags:
17940         - ServiceDesignAndCreation
17941       summary: create or update an existing property-constraint
17942       description: |
17943         Create or update an existing property-constraint.
17944         #
17945         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
17946       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17947       consumes:
17948         - application/json
17949         - application/xml
17950       produces:
17951         - application/json
17952         - application/xml
17953       responses:
17954         "default":
17955           description: Response codes found in [response codes](https://wiki.onap.org/).
17956       parameters:
17957         - name: named-query-uuid
17958           in: path
17959           required: true
17960           type: string
17961           example: __NAMED-QUERY-UUID__
17962         - name: named-query-element-uuid
17963           in: path
17964           required: true
17965           type: string
17966           example: __NAMED-QUERY-ELEMENT-UUID__
17967         - name: property-constraint-uuid
17968           in: path
17969           required: true
17970           type: string
17971           example: __PROPERTY-CONSTRAINT-UUID__
17972         - name: body
17973           in: body
17974           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
17975           required: true
17976           schema:
17977             $ref: "#/definitions/property-constraint"
17978     patch:
17979       tags:
17980         - ServiceDesignAndCreation
17981       summary: update an existing property-constraint
17982       description: |
17983         Update an existing property-constraint
17984         #
17985         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17986         The PUT operation will entirely replace an existing object.
17987         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.
17988         #
17989         Other differences between PUT and PATCH are:
17990         #
17991         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17992         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17993         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17994       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
17995       consumes:
17996         - application/json
17997         - application/xml
17998       produces:
17999         - application/json
18000         - application/xml
18001       responses:
18002         "default":
18003           description: Response codes found in [response codes](https://wiki.onap.org/).
18004       parameters:
18005         - name: named-query-uuid
18006           in: path
18007           required: true
18008           type: string
18009           example: __NAMED-QUERY-UUID__
18010         - name: named-query-element-uuid
18011           in: path
18012           required: true
18013           type: string
18014           example: __NAMED-QUERY-ELEMENT-UUID__
18015         - name: property-constraint-uuid
18016           in: path
18017           required: true
18018           type: string
18019           example: __PROPERTY-CONSTRAINT-UUID__
18020         - name: body
18021           in: body
18022           description: property-constraint object that needs to be created or updated.
18023           required: true
18024           schema:
18025             $ref: "#/patchDefinitions/property-constraint"
18026     delete:
18027       tags:
18028         - ServiceDesignAndCreation
18029       summary: delete an existing property-constraint
18030       description: delete an existing property-constraint
18031       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
18032       consumes:
18033         - application/json
18034         - application/xml
18035       produces:
18036         - application/json
18037         - application/xml
18038       responses:
18039         "default":
18040           description: Response codes found in [response codes](https://wiki.onap.org/).
18041       parameters:
18042         - name: named-query-uuid
18043           in: path
18044           required: true
18045           type: string
18046           example: __NAMED-QUERY-UUID__
18047         - name: named-query-element-uuid
18048           in: path
18049           required: true
18050           type: string
18051           example: __NAMED-QUERY-ELEMENT-UUID__
18052         - name: property-constraint-uuid
18053           in: path
18054           required: true
18055           type: string
18056           example: __PROPERTY-CONSTRAINT-UUID__
18057         - name: resource-version
18058           in: query
18059           description: resource-version for concurrency
18060           required: true
18061           type: string
18062   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
18063     get:
18064       tags:
18065         - ServiceDesignAndCreation
18066       summary: returns property-constraints
18067       description: returns property-constraints
18068       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
18069       produces:
18070         - application/json
18071         - application/xml
18072       responses:
18073         "200":
18074           description: successful operation
18075           schema:
18076               $ref: "#/getDefinitions/property-constraints"
18077         "default":
18078           description: Response codes found in [response codes](https://wiki.onap.org/).
18079       parameters:
18080         - name: named-query-uuid
18081           in: path
18082           required: true
18083           type: string
18084           example: __NAMED-QUERY-UUID__
18085         - name: named-query-element-uuid
18086           in: path
18087           required: true
18088           type: string
18089           example: __NAMED-QUERY-ELEMENT-UUID__
18090         - name: named-query-name
18091           in: query
18092           required: false
18093           type: string
18094   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
18095     put:
18096       tags:
18097         - ServiceDesignAndCreation
18098       summary: see node definition for valid relationships
18099       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
18100       consumes:
18101         - application/json
18102         - application/xml
18103       produces:
18104         - application/json
18105         - application/xml
18106       responses:
18107         "default":
18108           description: Response codes found in [response codes](https://wiki.onap.org/).
18109       parameters:
18110         - name: named-query-uuid
18111           in: path
18112           required: true
18113           type: string
18114           example: __NAMED-QUERY-UUID__
18115         - name: named-query-element-uuid
18116           in: path
18117           required: true
18118           type: string
18119           example: __NAMED-QUERY-ELEMENT-UUID__
18120         - name: body
18121           in: body
18122           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
18123           required: true
18124           schema:
18125             $ref: "#/definitions/relationship"
18126     delete:
18127       tags:
18128         - ServiceDesignAndCreation
18129       summary: delete an existing relationship
18130       description: delete an existing relationship
18131       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
18132       consumes:
18133         - application/json
18134         - application/xml
18135       produces:
18136         - application/json
18137         - application/xml
18138       responses:
18139         "default":
18140           description: Response codes found in [response codes](https://wiki.onap.org/).
18141       parameters:
18142         - name: named-query-uuid
18143           in: path
18144           required: true
18145           type: string
18146           example: __NAMED-QUERY-UUID__
18147         - name: named-query-element-uuid
18148           in: path
18149           required: true
18150           type: string
18151           example: __NAMED-QUERY-ELEMENT-UUID__
18152   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
18153     get:
18154       tags:
18155         - ServiceDesignAndCreation
18156       summary: returns named-query-element
18157       description: returns named-query-element
18158       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18159       produces:
18160         - application/json
18161         - application/xml
18162       responses:
18163         "200":
18164           description: successful operation
18165           schema:
18166               $ref: "#/getDefinitions/named-query-element"
18167         "default":
18168           description: Response codes found in [response codes](https://wiki.onap.org/).
18169       parameters:
18170         - name: named-query-uuid
18171           in: path
18172           required: true
18173           type: string
18174           example: __NAMED-QUERY-UUID__
18175         - name: named-query-element-uuid
18176           in: path
18177           required: true
18178           type: string
18179           example: __NAMED-QUERY-ELEMENT-UUID__
18180         - name: named-query-name
18181           in: query
18182           required: false
18183           type: string
18184     put:
18185       tags:
18186         - ServiceDesignAndCreation
18187       summary: create or update an existing named-query-element
18188       description: |
18189         Create or update an existing named-query-element.
18190         #
18191         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
18192       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18193       consumes:
18194         - application/json
18195         - application/xml
18196       produces:
18197         - application/json
18198         - application/xml
18199       responses:
18200         "default":
18201           description: Response codes found in [response codes](https://wiki.onap.org/).
18202       parameters:
18203         - name: named-query-uuid
18204           in: path
18205           required: true
18206           type: string
18207           example: __NAMED-QUERY-UUID__
18208         - name: named-query-element-uuid
18209           in: path
18210           required: true
18211           type: string
18212           example: __NAMED-QUERY-ELEMENT-UUID__
18213         - name: body
18214           in: body
18215           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
18216           required: true
18217           schema:
18218             $ref: "#/definitions/named-query-element"
18219     patch:
18220       tags:
18221         - ServiceDesignAndCreation
18222       summary: update an existing named-query-element
18223       description: |
18224         Update an existing named-query-element
18225         #
18226         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18227         The PUT operation will entirely replace an existing object.
18228         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.
18229         #
18230         Other differences between PUT and PATCH are:
18231         #
18232         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18233         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18234         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18235       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18236       consumes:
18237         - application/json
18238         - application/xml
18239       produces:
18240         - application/json
18241         - application/xml
18242       responses:
18243         "default":
18244           description: Response codes found in [response codes](https://wiki.onap.org/).
18245       parameters:
18246         - name: named-query-uuid
18247           in: path
18248           required: true
18249           type: string
18250           example: __NAMED-QUERY-UUID__
18251         - name: named-query-element-uuid
18252           in: path
18253           required: true
18254           type: string
18255           example: __NAMED-QUERY-ELEMENT-UUID__
18256         - name: body
18257           in: body
18258           description: named-query-element object that needs to be created or updated.
18259           required: true
18260           schema:
18261             $ref: "#/patchDefinitions/named-query-element"
18262     delete:
18263       tags:
18264         - ServiceDesignAndCreation
18265       summary: delete an existing named-query-element
18266       description: delete an existing named-query-element
18267       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
18268       consumes:
18269         - application/json
18270         - application/xml
18271       produces:
18272         - application/json
18273         - application/xml
18274       responses:
18275         "default":
18276           description: Response codes found in [response codes](https://wiki.onap.org/).
18277       parameters:
18278         - name: named-query-uuid
18279           in: path
18280           required: true
18281           type: string
18282           example: __NAMED-QUERY-UUID__
18283         - name: named-query-element-uuid
18284           in: path
18285           required: true
18286           type: string
18287           example: __NAMED-QUERY-ELEMENT-UUID__
18288         - name: resource-version
18289           in: query
18290           description: resource-version for concurrency
18291           required: true
18292           type: string
18293   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
18294     get:
18295       tags:
18296         - ServiceDesignAndCreation
18297       summary: returns named-query-elements
18298       description: returns named-query-elements
18299       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
18300       produces:
18301         - application/json
18302         - application/xml
18303       responses:
18304         "200":
18305           description: successful operation
18306           schema:
18307               $ref: "#/getDefinitions/named-query-elements"
18308         "default":
18309           description: Response codes found in [response codes](https://wiki.onap.org/).
18310       parameters:
18311         - name: named-query-uuid
18312           in: path
18313           required: true
18314           type: string
18315           example: __NAMED-QUERY-UUID__
18316         - name: named-query-name
18317           in: query
18318           required: false
18319           type: string
18320   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
18321     put:
18322       tags:
18323         - ServiceDesignAndCreation
18324       summary: see node definition for valid relationships
18325       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
18326       consumes:
18327         - application/json
18328         - application/xml
18329       produces:
18330         - application/json
18331         - application/xml
18332       responses:
18333         "default":
18334           description: Response codes found in [response codes](https://wiki.onap.org/).
18335       parameters:
18336         - name: named-query-uuid
18337           in: path
18338           required: true
18339           type: string
18340           example: __NAMED-QUERY-UUID__
18341         - name: body
18342           in: body
18343           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
18344           required: true
18345           schema:
18346             $ref: "#/definitions/relationship"
18347     delete:
18348       tags:
18349         - ServiceDesignAndCreation
18350       summary: delete an existing relationship
18351       description: delete an existing relationship
18352       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
18353       consumes:
18354         - application/json
18355         - application/xml
18356       produces:
18357         - application/json
18358         - application/xml
18359       responses:
18360         "default":
18361           description: Response codes found in [response codes](https://wiki.onap.org/).
18362       parameters:
18363         - name: named-query-uuid
18364           in: path
18365           required: true
18366           type: string
18367           example: __NAMED-QUERY-UUID__
18368   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
18369     get:
18370       tags:
18371         - ServiceDesignAndCreation
18372       summary: returns named-query
18373       description: returns named-query
18374       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
18375       produces:
18376         - application/json
18377         - application/xml
18378       responses:
18379         "200":
18380           description: successful operation
18381           schema:
18382               $ref: "#/getDefinitions/named-query"
18383         "default":
18384           description: Response codes found in [response codes](https://wiki.onap.org/).
18385       parameters:
18386         - name: named-query-uuid
18387           in: path
18388           required: true
18389           type: string
18390           example: __NAMED-QUERY-UUID__
18391         - name: named-query-name
18392           in: query
18393           required: false
18394           type: string
18395     put:
18396       tags:
18397         - ServiceDesignAndCreation
18398       summary: create or update an existing named-query
18399       description: |
18400         Create or update an existing named-query.
18401         #
18402         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
18403       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
18404       consumes:
18405         - application/json
18406         - application/xml
18407       produces:
18408         - application/json
18409         - application/xml
18410       responses:
18411         "default":
18412           description: Response codes found in [response codes](https://wiki.onap.org/).
18413       parameters:
18414         - name: named-query-uuid
18415           in: path
18416           required: true
18417           type: string
18418           example: __NAMED-QUERY-UUID__
18419         - name: body
18420           in: body
18421           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
18422           required: true
18423           schema:
18424             $ref: "#/definitions/named-query"
18425     patch:
18426       tags:
18427         - ServiceDesignAndCreation
18428       summary: update an existing named-query
18429       description: |
18430         Update an existing named-query
18431         #
18432         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18433         The PUT operation will entirely replace an existing object.
18434         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.
18435         #
18436         Other differences between PUT and PATCH are:
18437         #
18438         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18439         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18440         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18441       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
18442       consumes:
18443         - application/json
18444         - application/xml
18445       produces:
18446         - application/json
18447         - application/xml
18448       responses:
18449         "default":
18450           description: Response codes found in [response codes](https://wiki.onap.org/).
18451       parameters:
18452         - name: named-query-uuid
18453           in: path
18454           required: true
18455           type: string
18456           example: __NAMED-QUERY-UUID__
18457         - name: body
18458           in: body
18459           description: named-query object that needs to be created or updated.
18460           required: true
18461           schema:
18462             $ref: "#/patchDefinitions/named-query"
18463     delete:
18464       tags:
18465         - ServiceDesignAndCreation
18466       summary: delete an existing named-query
18467       description: delete an existing named-query
18468       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
18469       consumes:
18470         - application/json
18471         - application/xml
18472       produces:
18473         - application/json
18474         - application/xml
18475       responses:
18476         "default":
18477           description: Response codes found in [response codes](https://wiki.onap.org/).
18478       parameters:
18479         - name: named-query-uuid
18480           in: path
18481           required: true
18482           type: string
18483           example: __NAMED-QUERY-UUID__
18484         - name: resource-version
18485           in: query
18486           description: resource-version for concurrency
18487           required: true
18488           type: string
18489   /service-design-and-creation/named-queries:
18490     get:
18491       tags:
18492         - ServiceDesignAndCreation
18493       summary: returns named-queries
18494       description: returns named-queries
18495       operationId: getServiceDesignAndCreationNamedQueries
18496       produces:
18497         - application/json
18498         - application/xml
18499       responses:
18500         "200":
18501           description: successful operation
18502           schema:
18503               $ref: "#/getDefinitions/named-queries"
18504         "default":
18505           description: Response codes found in [response codes](https://wiki.onap.org/).
18506   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
18507     put:
18508       tags:
18509         - Network
18510       summary: see node definition for valid relationships
18511       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
18512       consumes:
18513         - application/json
18514         - application/xml
18515       produces:
18516         - application/json
18517         - application/xml
18518       responses:
18519         "default":
18520           description: Response codes found in [response codes](https://wiki.onap.org/).
18521       parameters:
18522         - name: link-name
18523           in: path
18524           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18525           required: true
18526           type: string
18527           example: __LINK-NAME__
18528         - name: body
18529           in: body
18530           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
18531           required: true
18532           schema:
18533             $ref: "#/definitions/relationship"
18534     delete:
18535       tags:
18536         - Network
18537       summary: delete an existing relationship
18538       description: delete an existing relationship
18539       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
18540       consumes:
18541         - application/json
18542         - application/xml
18543       produces:
18544         - application/json
18545         - application/xml
18546       responses:
18547         "default":
18548           description: Response codes found in [response codes](https://wiki.onap.org/).
18549       parameters:
18550         - name: link-name
18551           in: path
18552           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18553           required: true
18554           type: string
18555           example: __LINK-NAME__
18556   /network/logical-links/logical-link/{link-name}:
18557     get:
18558       tags:
18559         - Network
18560       summary: returns logical-link
18561       description: returns logical-link
18562       operationId: getNetworkLogicalLinksLogicalLink
18563       produces:
18564         - application/json
18565         - application/xml
18566       responses:
18567         "200":
18568           description: successful operation
18569           schema:
18570               $ref: "#/getDefinitions/logical-link"
18571         "default":
18572           description: Response codes found in [response codes](https://wiki.onap.org/).
18573       parameters:
18574         - name: link-name
18575           in: path
18576           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18577           required: true
18578           type: string
18579           example: __LINK-NAME__
18580         - name: persona-model-id
18581           in: query
18582           description: the ASDC model id for this resource or service model.
18583           required: false
18584           type: string
18585         - name: persona-model-version
18586           in: query
18587           description: the ASDC model version for this resource or service model.
18588           required: false
18589           type: string
18590         - name: widget-model-id
18591           in: query
18592           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
18593           required: false
18594           type: string
18595         - name: widget-model-version
18596           in: query
18597           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
18598           required: false
18599           type: string
18600         - name: link-id
18601           in: query
18602           description: UUID of the logical-link, SDNC generates this.
18603           required: false
18604           type: string
18605     put:
18606       tags:
18607         - Network
18608       summary: create or update an existing logical-link
18609       description: |
18610         Create or update an existing logical-link.
18611         #
18612         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
18613       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
18614       consumes:
18615         - application/json
18616         - application/xml
18617       produces:
18618         - application/json
18619         - application/xml
18620       responses:
18621         "default":
18622           description: Response codes found in [response codes](https://wiki.onap.org/).
18623       parameters:
18624         - name: link-name
18625           in: path
18626           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18627           required: true
18628           type: string
18629           example: __LINK-NAME__
18630         - name: body
18631           in: body
18632           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLogicalLinksLogicalLink.json)
18633           required: true
18634           schema:
18635             $ref: "#/definitions/logical-link"
18636     patch:
18637       tags:
18638         - Network
18639       summary: update an existing logical-link
18640       description: |
18641         Update an existing logical-link
18642         #
18643         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18644         The PUT operation will entirely replace an existing object.
18645         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.
18646         #
18647         Other differences between PUT and PATCH are:
18648         #
18649         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18650         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18651         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18652       operationId: UpdateNetworkLogicalLinksLogicalLink
18653       consumes:
18654         - application/json
18655         - application/xml
18656       produces:
18657         - application/json
18658         - application/xml
18659       responses:
18660         "default":
18661           description: Response codes found in [response codes](https://wiki.onap.org/).
18662       parameters:
18663         - name: link-name
18664           in: path
18665           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18666           required: true
18667           type: string
18668           example: __LINK-NAME__
18669         - name: body
18670           in: body
18671           description: logical-link object that needs to be created or updated.
18672           required: true
18673           schema:
18674             $ref: "#/patchDefinitions/logical-link"
18675     delete:
18676       tags:
18677         - Network
18678       summary: delete an existing logical-link
18679       description: delete an existing logical-link
18680       operationId: deleteNetworkLogicalLinksLogicalLink
18681       consumes:
18682         - application/json
18683         - application/xml
18684       produces:
18685         - application/json
18686         - application/xml
18687       responses:
18688         "default":
18689           description: Response codes found in [response codes](https://wiki.onap.org/).
18690       parameters:
18691         - name: link-name
18692           in: path
18693           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
18694           required: true
18695           type: string
18696           example: __LINK-NAME__
18697         - name: resource-version
18698           in: query
18699           description: resource-version for concurrency
18700           required: true
18701           type: string
18702   /network/logical-links:
18703     get:
18704       tags:
18705         - Network
18706       summary: returns logical-links
18707       description: returns logical-links
18708       operationId: getNetworkLogicalLinks
18709       produces:
18710         - application/json
18711         - application/xml
18712       responses:
18713         "200":
18714           description: successful operation
18715           schema:
18716               $ref: "#/getDefinitions/logical-links"
18717         "default":
18718           description: Response codes found in [response codes](https://wiki.onap.org/).
18719   /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:
18720     put:
18721       tags:
18722         - Network
18723       summary: see node definition for valid relationships
18724       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18725       consumes:
18726         - application/json
18727         - application/xml
18728       produces:
18729         - application/json
18730         - application/xml
18731       responses:
18732         "default":
18733           description: Response codes found in [response codes](https://wiki.onap.org/).
18734       parameters:
18735         - name: site-pair-set-id
18736           in: path
18737           description: Unique id of site pair set.
18738           required: true
18739           type: string
18740           example: __SITE-PAIR-SET-ID__
18741         - name: routing-instance-id
18742           in: path
18743           description: Unique id of routing instance
18744           required: true
18745           type: string
18746           example: __ROUTING-INSTANCE-ID__
18747         - name: site-pair-id
18748           in: path
18749           description: unique identifier of probe
18750           required: true
18751           type: string
18752           example: __SITE-PAIR-ID__
18753         - name: cos
18754           in: path
18755           description: unique identifier of probe
18756           required: true
18757           type: string
18758           example: __COS__
18759         - name: body
18760           in: body
18761           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18762           required: true
18763           schema:
18764             $ref: "#/definitions/relationship"
18765     delete:
18766       tags:
18767         - Network
18768       summary: delete an existing relationship
18769       description: delete an existing relationship
18770       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
18771       consumes:
18772         - application/json
18773         - application/xml
18774       produces:
18775         - application/json
18776         - application/xml
18777       responses:
18778         "default":
18779           description: Response codes found in [response codes](https://wiki.onap.org/).
18780       parameters:
18781         - name: site-pair-set-id
18782           in: path
18783           description: Unique id of site pair set.
18784           required: true
18785           type: string
18786           example: __SITE-PAIR-SET-ID__
18787         - name: routing-instance-id
18788           in: path
18789           description: Unique id of routing instance
18790           required: true
18791           type: string
18792           example: __ROUTING-INSTANCE-ID__
18793         - name: site-pair-id
18794           in: path
18795           description: unique identifier of probe
18796           required: true
18797           type: string
18798           example: __SITE-PAIR-ID__
18799         - name: cos
18800           in: path
18801           description: unique identifier of probe
18802           required: true
18803           type: string
18804           example: __COS__
18805   /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}:
18806     get:
18807       tags:
18808         - Network
18809       summary: returns class-of-service
18810       description: returns class-of-service
18811       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18812       produces:
18813         - application/json
18814         - application/xml
18815       responses:
18816         "200":
18817           description: successful operation
18818           schema:
18819               $ref: "#/getDefinitions/class-of-service"
18820         "default":
18821           description: Response codes found in [response codes](https://wiki.onap.org/).
18822       parameters:
18823         - name: site-pair-set-id
18824           in: path
18825           description: Unique id of site pair set.
18826           required: true
18827           type: string
18828           example: __SITE-PAIR-SET-ID__
18829         - name: routing-instance-id
18830           in: path
18831           description: Unique id of routing instance
18832           required: true
18833           type: string
18834           example: __ROUTING-INSTANCE-ID__
18835         - name: site-pair-id
18836           in: path
18837           description: unique identifier of probe
18838           required: true
18839           type: string
18840           example: __SITE-PAIR-ID__
18841         - name: cos
18842           in: path
18843           description: unique identifier of probe
18844           required: true
18845           type: string
18846           example: __COS__
18847     put:
18848       tags:
18849         - Network
18850       summary: create or update an existing class-of-service
18851       description: |
18852         Create or update an existing class-of-service.
18853         #
18854         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
18855       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18856       consumes:
18857         - application/json
18858         - application/xml
18859       produces:
18860         - application/json
18861         - application/xml
18862       responses:
18863         "default":
18864           description: Response codes found in [response codes](https://wiki.onap.org/).
18865       parameters:
18866         - name: site-pair-set-id
18867           in: path
18868           description: Unique id of site pair set.
18869           required: true
18870           type: string
18871           example: __SITE-PAIR-SET-ID__
18872         - name: routing-instance-id
18873           in: path
18874           description: Unique id of routing instance
18875           required: true
18876           type: string
18877           example: __ROUTING-INSTANCE-ID__
18878         - name: site-pair-id
18879           in: path
18880           description: unique identifier of probe
18881           required: true
18882           type: string
18883           example: __SITE-PAIR-ID__
18884         - name: cos
18885           in: path
18886           description: unique identifier of probe
18887           required: true
18888           type: string
18889           example: __COS__
18890         - name: body
18891           in: body
18892           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
18893           required: true
18894           schema:
18895             $ref: "#/definitions/class-of-service"
18896     patch:
18897       tags:
18898         - Network
18899       summary: update an existing class-of-service
18900       description: |
18901         Update an existing class-of-service
18902         #
18903         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18904         The PUT operation will entirely replace an existing object.
18905         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.
18906         #
18907         Other differences between PUT and PATCH are:
18908         #
18909         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18910         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18911         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18912       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18913       consumes:
18914         - application/json
18915         - application/xml
18916       produces:
18917         - application/json
18918         - application/xml
18919       responses:
18920         "default":
18921           description: Response codes found in [response codes](https://wiki.onap.org/).
18922       parameters:
18923         - name: site-pair-set-id
18924           in: path
18925           description: Unique id of site pair set.
18926           required: true
18927           type: string
18928           example: __SITE-PAIR-SET-ID__
18929         - name: routing-instance-id
18930           in: path
18931           description: Unique id of routing instance
18932           required: true
18933           type: string
18934           example: __ROUTING-INSTANCE-ID__
18935         - name: site-pair-id
18936           in: path
18937           description: unique identifier of probe
18938           required: true
18939           type: string
18940           example: __SITE-PAIR-ID__
18941         - name: cos
18942           in: path
18943           description: unique identifier of probe
18944           required: true
18945           type: string
18946           example: __COS__
18947         - name: body
18948           in: body
18949           description: class-of-service object that needs to be created or updated.
18950           required: true
18951           schema:
18952             $ref: "#/patchDefinitions/class-of-service"
18953     delete:
18954       tags:
18955         - Network
18956       summary: delete an existing class-of-service
18957       description: delete an existing class-of-service
18958       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
18959       consumes:
18960         - application/json
18961         - application/xml
18962       produces:
18963         - application/json
18964         - application/xml
18965       responses:
18966         "default":
18967           description: Response codes found in [response codes](https://wiki.onap.org/).
18968       parameters:
18969         - name: site-pair-set-id
18970           in: path
18971           description: Unique id of site pair set.
18972           required: true
18973           type: string
18974           example: __SITE-PAIR-SET-ID__
18975         - name: routing-instance-id
18976           in: path
18977           description: Unique id of routing instance
18978           required: true
18979           type: string
18980           example: __ROUTING-INSTANCE-ID__
18981         - name: site-pair-id
18982           in: path
18983           description: unique identifier of probe
18984           required: true
18985           type: string
18986           example: __SITE-PAIR-ID__
18987         - name: cos
18988           in: path
18989           description: unique identifier of probe
18990           required: true
18991           type: string
18992           example: __COS__
18993         - name: resource-version
18994           in: query
18995           description: resource-version for concurrency
18996           required: true
18997           type: string
18998   /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:
18999     get:
19000       tags:
19001         - Network
19002       summary: returns classes-of-service
19003       description: returns classes-of-service
19004       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
19005       produces:
19006         - application/json
19007         - application/xml
19008       responses:
19009         "200":
19010           description: successful operation
19011           schema:
19012               $ref: "#/getDefinitions/classes-of-service"
19013         "default":
19014           description: Response codes found in [response codes](https://wiki.onap.org/).
19015       parameters:
19016         - name: site-pair-set-id
19017           in: path
19018           description: Unique id of site pair set.
19019           required: true
19020           type: string
19021           example: __SITE-PAIR-SET-ID__
19022         - name: routing-instance-id
19023           in: path
19024           description: Unique id of routing instance
19025           required: true
19026           type: string
19027           example: __ROUTING-INSTANCE-ID__
19028         - name: site-pair-id
19029           in: path
19030           description: unique identifier of probe
19031           required: true
19032           type: string
19033           example: __SITE-PAIR-ID__
19034   /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:
19035     put:
19036       tags:
19037         - Network
19038       summary: see node definition for valid relationships
19039       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
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: site-pair-set-id
19051           in: path
19052           description: Unique id of site pair set.
19053           required: true
19054           type: string
19055           example: __SITE-PAIR-SET-ID__
19056         - name: routing-instance-id
19057           in: path
19058           description: Unique id of routing instance
19059           required: true
19060           type: string
19061           example: __ROUTING-INSTANCE-ID__
19062         - name: site-pair-id
19063           in: path
19064           description: unique identifier of probe
19065           required: true
19066           type: string
19067           example: __SITE-PAIR-ID__
19068         - name: body
19069           in: body
19070           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
19071           required: true
19072           schema:
19073             $ref: "#/definitions/relationship"
19074     delete:
19075       tags:
19076         - Network
19077       summary: delete an existing relationship
19078       description: delete an existing relationship
19079       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
19080       consumes:
19081         - application/json
19082         - application/xml
19083       produces:
19084         - application/json
19085         - application/xml
19086       responses:
19087         "default":
19088           description: Response codes found in [response codes](https://wiki.onap.org/).
19089       parameters:
19090         - name: site-pair-set-id
19091           in: path
19092           description: Unique id of site pair set.
19093           required: true
19094           type: string
19095           example: __SITE-PAIR-SET-ID__
19096         - name: routing-instance-id
19097           in: path
19098           description: Unique id of routing instance
19099           required: true
19100           type: string
19101           example: __ROUTING-INSTANCE-ID__
19102         - name: site-pair-id
19103           in: path
19104           description: unique identifier of probe
19105           required: true
19106           type: string
19107           example: __SITE-PAIR-ID__
19108   /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}:
19109     get:
19110       tags:
19111         - Network
19112       summary: returns site-pair
19113       description: returns site-pair
19114       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19115       produces:
19116         - application/json
19117         - application/xml
19118       responses:
19119         "200":
19120           description: successful operation
19121           schema:
19122               $ref: "#/getDefinitions/site-pair"
19123         "default":
19124           description: Response codes found in [response codes](https://wiki.onap.org/).
19125       parameters:
19126         - name: site-pair-set-id
19127           in: path
19128           description: Unique id of site pair set.
19129           required: true
19130           type: string
19131           example: __SITE-PAIR-SET-ID__
19132         - name: routing-instance-id
19133           in: path
19134           description: Unique id of routing instance
19135           required: true
19136           type: string
19137           example: __ROUTING-INSTANCE-ID__
19138         - name: site-pair-id
19139           in: path
19140           description: unique identifier of probe
19141           required: true
19142           type: string
19143           example: __SITE-PAIR-ID__
19144     put:
19145       tags:
19146         - Network
19147       summary: create or update an existing site-pair
19148       description: |
19149         Create or update an existing site-pair.
19150         #
19151         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
19152       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19153       consumes:
19154         - application/json
19155         - application/xml
19156       produces:
19157         - application/json
19158         - application/xml
19159       responses:
19160         "default":
19161           description: Response codes found in [response codes](https://wiki.onap.org/).
19162       parameters:
19163         - name: site-pair-set-id
19164           in: path
19165           description: Unique id of site pair set.
19166           required: true
19167           type: string
19168           example: __SITE-PAIR-SET-ID__
19169         - name: routing-instance-id
19170           in: path
19171           description: Unique id of routing instance
19172           required: true
19173           type: string
19174           example: __ROUTING-INSTANCE-ID__
19175         - name: site-pair-id
19176           in: path
19177           description: unique identifier of probe
19178           required: true
19179           type: string
19180           example: __SITE-PAIR-ID__
19181         - name: body
19182           in: body
19183           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
19184           required: true
19185           schema:
19186             $ref: "#/definitions/site-pair"
19187     patch:
19188       tags:
19189         - Network
19190       summary: update an existing site-pair
19191       description: |
19192         Update an existing site-pair
19193         #
19194         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19195         The PUT operation will entirely replace an existing object.
19196         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.
19197         #
19198         Other differences between PUT and PATCH are:
19199         #
19200         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19201         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19202         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19203       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19204       consumes:
19205         - application/json
19206         - application/xml
19207       produces:
19208         - application/json
19209         - application/xml
19210       responses:
19211         "default":
19212           description: Response codes found in [response codes](https://wiki.onap.org/).
19213       parameters:
19214         - name: site-pair-set-id
19215           in: path
19216           description: Unique id of site pair set.
19217           required: true
19218           type: string
19219           example: __SITE-PAIR-SET-ID__
19220         - name: routing-instance-id
19221           in: path
19222           description: Unique id of routing instance
19223           required: true
19224           type: string
19225           example: __ROUTING-INSTANCE-ID__
19226         - name: site-pair-id
19227           in: path
19228           description: unique identifier of probe
19229           required: true
19230           type: string
19231           example: __SITE-PAIR-ID__
19232         - name: body
19233           in: body
19234           description: site-pair object that needs to be created or updated.
19235           required: true
19236           schema:
19237             $ref: "#/patchDefinitions/site-pair"
19238     delete:
19239       tags:
19240         - Network
19241       summary: delete an existing site-pair
19242       description: delete an existing site-pair
19243       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
19244       consumes:
19245         - application/json
19246         - application/xml
19247       produces:
19248         - application/json
19249         - application/xml
19250       responses:
19251         "default":
19252           description: Response codes found in [response codes](https://wiki.onap.org/).
19253       parameters:
19254         - name: site-pair-set-id
19255           in: path
19256           description: Unique id of site pair set.
19257           required: true
19258           type: string
19259           example: __SITE-PAIR-SET-ID__
19260         - name: routing-instance-id
19261           in: path
19262           description: Unique id of routing instance
19263           required: true
19264           type: string
19265           example: __ROUTING-INSTANCE-ID__
19266         - name: site-pair-id
19267           in: path
19268           description: unique identifier of probe
19269           required: true
19270           type: string
19271           example: __SITE-PAIR-ID__
19272         - name: resource-version
19273           in: query
19274           description: resource-version for concurrency
19275           required: true
19276           type: string
19277   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
19278     get:
19279       tags:
19280         - Network
19281       summary: returns site-pairs
19282       description: returns site-pairs
19283       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
19284       produces:
19285         - application/json
19286         - application/xml
19287       responses:
19288         "200":
19289           description: successful operation
19290           schema:
19291               $ref: "#/getDefinitions/site-pairs"
19292         "default":
19293           description: Response codes found in [response codes](https://wiki.onap.org/).
19294       parameters:
19295         - name: site-pair-set-id
19296           in: path
19297           description: Unique id of site pair set.
19298           required: true
19299           type: string
19300           example: __SITE-PAIR-SET-ID__
19301         - name: routing-instance-id
19302           in: path
19303           description: Unique id of routing instance
19304           required: true
19305           type: string
19306           example: __ROUTING-INSTANCE-ID__
19307   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
19308     put:
19309       tags:
19310         - Network
19311       summary: see node definition for valid relationships
19312       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
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: site-pair-set-id
19324           in: path
19325           description: Unique id of site pair set.
19326           required: true
19327           type: string
19328           example: __SITE-PAIR-SET-ID__
19329         - name: routing-instance-id
19330           in: path
19331           description: Unique id of routing instance
19332           required: true
19333           type: string
19334           example: __ROUTING-INSTANCE-ID__
19335         - name: body
19336           in: body
19337           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
19338           required: true
19339           schema:
19340             $ref: "#/definitions/relationship"
19341     delete:
19342       tags:
19343         - Network
19344       summary: delete an existing relationship
19345       description: delete an existing relationship
19346       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
19347       consumes:
19348         - application/json
19349         - application/xml
19350       produces:
19351         - application/json
19352         - application/xml
19353       responses:
19354         "default":
19355           description: Response codes found in [response codes](https://wiki.onap.org/).
19356       parameters:
19357         - name: site-pair-set-id
19358           in: path
19359           description: Unique id of site pair set.
19360           required: true
19361           type: string
19362           example: __SITE-PAIR-SET-ID__
19363         - name: routing-instance-id
19364           in: path
19365           description: Unique id of routing instance
19366           required: true
19367           type: string
19368           example: __ROUTING-INSTANCE-ID__
19369   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
19370     get:
19371       tags:
19372         - Network
19373       summary: returns routing-instance
19374       description: returns routing-instance
19375       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19376       produces:
19377         - application/json
19378         - application/xml
19379       responses:
19380         "200":
19381           description: successful operation
19382           schema:
19383               $ref: "#/getDefinitions/routing-instance"
19384         "default":
19385           description: Response codes found in [response codes](https://wiki.onap.org/).
19386       parameters:
19387         - name: site-pair-set-id
19388           in: path
19389           description: Unique id of site pair set.
19390           required: true
19391           type: string
19392           example: __SITE-PAIR-SET-ID__
19393         - name: routing-instance-id
19394           in: path
19395           description: Unique id of routing instance
19396           required: true
19397           type: string
19398           example: __ROUTING-INSTANCE-ID__
19399     put:
19400       tags:
19401         - Network
19402       summary: create or update an existing routing-instance
19403       description: |
19404         Create or update an existing routing-instance.
19405         #
19406         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
19407       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19408       consumes:
19409         - application/json
19410         - application/xml
19411       produces:
19412         - application/json
19413         - application/xml
19414       responses:
19415         "default":
19416           description: Response codes found in [response codes](https://wiki.onap.org/).
19417       parameters:
19418         - name: site-pair-set-id
19419           in: path
19420           description: Unique id of site pair set.
19421           required: true
19422           type: string
19423           example: __SITE-PAIR-SET-ID__
19424         - name: routing-instance-id
19425           in: path
19426           description: Unique id of routing instance
19427           required: true
19428           type: string
19429           example: __ROUTING-INSTANCE-ID__
19430         - name: body
19431           in: body
19432           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
19433           required: true
19434           schema:
19435             $ref: "#/definitions/routing-instance"
19436     patch:
19437       tags:
19438         - Network
19439       summary: update an existing routing-instance
19440       description: |
19441         Update an existing routing-instance
19442         #
19443         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19444         The PUT operation will entirely replace an existing object.
19445         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.
19446         #
19447         Other differences between PUT and PATCH are:
19448         #
19449         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19450         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19451         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19452       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19453       consumes:
19454         - application/json
19455         - application/xml
19456       produces:
19457         - application/json
19458         - application/xml
19459       responses:
19460         "default":
19461           description: Response codes found in [response codes](https://wiki.onap.org/).
19462       parameters:
19463         - name: site-pair-set-id
19464           in: path
19465           description: Unique id of site pair set.
19466           required: true
19467           type: string
19468           example: __SITE-PAIR-SET-ID__
19469         - name: routing-instance-id
19470           in: path
19471           description: Unique id of routing instance
19472           required: true
19473           type: string
19474           example: __ROUTING-INSTANCE-ID__
19475         - name: body
19476           in: body
19477           description: routing-instance object that needs to be created or updated.
19478           required: true
19479           schema:
19480             $ref: "#/patchDefinitions/routing-instance"
19481     delete:
19482       tags:
19483         - Network
19484       summary: delete an existing routing-instance
19485       description: delete an existing routing-instance
19486       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
19487       consumes:
19488         - application/json
19489         - application/xml
19490       produces:
19491         - application/json
19492         - application/xml
19493       responses:
19494         "default":
19495           description: Response codes found in [response codes](https://wiki.onap.org/).
19496       parameters:
19497         - name: site-pair-set-id
19498           in: path
19499           description: Unique id of site pair set.
19500           required: true
19501           type: string
19502           example: __SITE-PAIR-SET-ID__
19503         - name: routing-instance-id
19504           in: path
19505           description: Unique id of routing instance
19506           required: true
19507           type: string
19508           example: __ROUTING-INSTANCE-ID__
19509         - name: resource-version
19510           in: query
19511           description: resource-version for concurrency
19512           required: true
19513           type: string
19514   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
19515     get:
19516       tags:
19517         - Network
19518       summary: returns routing-instances
19519       description: returns routing-instances
19520       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
19521       produces:
19522         - application/json
19523         - application/xml
19524       responses:
19525         "200":
19526           description: successful operation
19527           schema:
19528               $ref: "#/getDefinitions/routing-instances"
19529         "default":
19530           description: Response codes found in [response codes](https://wiki.onap.org/).
19531       parameters:
19532         - name: site-pair-set-id
19533           in: path
19534           description: Unique id of site pair set.
19535           required: true
19536           type: string
19537           example: __SITE-PAIR-SET-ID__
19538   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
19539     put:
19540       tags:
19541         - Network
19542       summary: see node definition for valid relationships
19543       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
19544       consumes:
19545         - application/json
19546         - application/xml
19547       produces:
19548         - application/json
19549         - application/xml
19550       responses:
19551         "default":
19552           description: Response codes found in [response codes](https://wiki.onap.org/).
19553       parameters:
19554         - name: site-pair-set-id
19555           in: path
19556           description: Unique id of site pair set.
19557           required: true
19558           type: string
19559           example: __SITE-PAIR-SET-ID__
19560         - name: body
19561           in: body
19562           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
19563           required: true
19564           schema:
19565             $ref: "#/definitions/relationship"
19566     delete:
19567       tags:
19568         - Network
19569       summary: delete an existing relationship
19570       description: delete an existing relationship
19571       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
19572       consumes:
19573         - application/json
19574         - application/xml
19575       produces:
19576         - application/json
19577         - application/xml
19578       responses:
19579         "default":
19580           description: Response codes found in [response codes](https://wiki.onap.org/).
19581       parameters:
19582         - name: site-pair-set-id
19583           in: path
19584           description: Unique id of site pair set.
19585           required: true
19586           type: string
19587           example: __SITE-PAIR-SET-ID__
19588   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
19589     get:
19590       tags:
19591         - Network
19592       summary: returns site-pair-set
19593       description: returns site-pair-set
19594       operationId: getNetworkSitePairSetsSitePairSet
19595       produces:
19596         - application/json
19597         - application/xml
19598       responses:
19599         "200":
19600           description: successful operation
19601           schema:
19602               $ref: "#/getDefinitions/site-pair-set"
19603         "default":
19604           description: Response codes found in [response codes](https://wiki.onap.org/).
19605       parameters:
19606         - name: site-pair-set-id
19607           in: path
19608           description: Unique id of site pair set.
19609           required: true
19610           type: string
19611           example: __SITE-PAIR-SET-ID__
19612     put:
19613       tags:
19614         - Network
19615       summary: create or update an existing site-pair-set
19616       description: |
19617         Create or update an existing site-pair-set.
19618         #
19619         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
19620       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
19621       consumes:
19622         - application/json
19623         - application/xml
19624       produces:
19625         - application/json
19626         - application/xml
19627       responses:
19628         "default":
19629           description: Response codes found in [response codes](https://wiki.onap.org/).
19630       parameters:
19631         - name: site-pair-set-id
19632           in: path
19633           description: Unique id of site pair set.
19634           required: true
19635           type: string
19636           example: __SITE-PAIR-SET-ID__
19637         - name: body
19638           in: body
19639           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkSitePairSetsSitePairSet.json)
19640           required: true
19641           schema:
19642             $ref: "#/definitions/site-pair-set"
19643     patch:
19644       tags:
19645         - Network
19646       summary: update an existing site-pair-set
19647       description: |
19648         Update an existing site-pair-set
19649         #
19650         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19651         The PUT operation will entirely replace an existing object.
19652         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.
19653         #
19654         Other differences between PUT and PATCH are:
19655         #
19656         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19657         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19658         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19659       operationId: UpdateNetworkSitePairSetsSitePairSet
19660       consumes:
19661         - application/json
19662         - application/xml
19663       produces:
19664         - application/json
19665         - application/xml
19666       responses:
19667         "default":
19668           description: Response codes found in [response codes](https://wiki.onap.org/).
19669       parameters:
19670         - name: site-pair-set-id
19671           in: path
19672           description: Unique id of site pair set.
19673           required: true
19674           type: string
19675           example: __SITE-PAIR-SET-ID__
19676         - name: body
19677           in: body
19678           description: site-pair-set object that needs to be created or updated.
19679           required: true
19680           schema:
19681             $ref: "#/patchDefinitions/site-pair-set"
19682     delete:
19683       tags:
19684         - Network
19685       summary: delete an existing site-pair-set
19686       description: delete an existing site-pair-set
19687       operationId: deleteNetworkSitePairSetsSitePairSet
19688       consumes:
19689         - application/json
19690         - application/xml
19691       produces:
19692         - application/json
19693         - application/xml
19694       responses:
19695         "default":
19696           description: Response codes found in [response codes](https://wiki.onap.org/).
19697       parameters:
19698         - name: site-pair-set-id
19699           in: path
19700           description: Unique id of site pair set.
19701           required: true
19702           type: string
19703           example: __SITE-PAIR-SET-ID__
19704         - name: resource-version
19705           in: query
19706           description: resource-version for concurrency
19707           required: true
19708           type: string
19709   /network/site-pair-sets:
19710     get:
19711       tags:
19712         - Network
19713       summary: returns site-pair-sets
19714       description: returns site-pair-sets
19715       operationId: getNetworkSitePairSets
19716       produces:
19717         - application/json
19718         - application/xml
19719       responses:
19720         "200":
19721           description: successful operation
19722           schema:
19723               $ref: "#/getDefinitions/site-pair-sets"
19724         "default":
19725           description: Response codes found in [response codes](https://wiki.onap.org/).
19726   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
19727     put:
19728       tags:
19729         - Network
19730       summary: see node definition for valid relationships
19731       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
19732       consumes:
19733         - application/json
19734         - application/xml
19735       produces:
19736         - application/json
19737         - application/xml
19738       responses:
19739         "default":
19740           description: Response codes found in [response codes](https://wiki.onap.org/).
19741       parameters:
19742         - name: vpn-id
19743           in: path
19744           description: VPN ID, globally unique within A&AI
19745           required: true
19746           type: string
19747           example: __VPN-ID__
19748         - name: body
19749           in: body
19750           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
19751           required: true
19752           schema:
19753             $ref: "#/definitions/relationship"
19754     delete:
19755       tags:
19756         - Network
19757       summary: delete an existing relationship
19758       description: delete an existing relationship
19759       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
19760       consumes:
19761         - application/json
19762         - application/xml
19763       produces:
19764         - application/json
19765         - application/xml
19766       responses:
19767         "default":
19768           description: Response codes found in [response codes](https://wiki.onap.org/).
19769       parameters:
19770         - name: vpn-id
19771           in: path
19772           description: VPN ID, globally unique within A&AI
19773           required: true
19774           type: string
19775           example: __VPN-ID__
19776   /network/vpn-bindings/vpn-binding/{vpn-id}:
19777     get:
19778       tags:
19779         - Network
19780       summary: returns vpn-binding
19781       description: returns vpn-binding
19782       operationId: getNetworkVpnBindingsVpnBinding
19783       produces:
19784         - application/json
19785         - application/xml
19786       responses:
19787         "200":
19788           description: successful operation
19789           schema:
19790               $ref: "#/getDefinitions/vpn-binding"
19791         "default":
19792           description: Response codes found in [response codes](https://wiki.onap.org/).
19793       parameters:
19794         - name: vpn-id
19795           in: path
19796           description: VPN ID, globally unique within A&AI
19797           required: true
19798           type: string
19799           example: __VPN-ID__
19800         - name: vpn-name
19801           in: query
19802           description: VPN Name
19803           required: false
19804           type: string
19805         - name: global-route-target
19806           in: query
19807           description: Number used to identify a VPN, globally unique in the network
19808           required: false
19809           type: string
19810     put:
19811       tags:
19812         - Network
19813       summary: create or update an existing vpn-binding
19814       description: |
19815         Create or update an existing vpn-binding.
19816         #
19817         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
19818       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
19819       consumes:
19820         - application/json
19821         - application/xml
19822       produces:
19823         - application/json
19824         - application/xml
19825       responses:
19826         "default":
19827           description: Response codes found in [response codes](https://wiki.onap.org/).
19828       parameters:
19829         - name: vpn-id
19830           in: path
19831           description: VPN ID, globally unique within A&AI
19832           required: true
19833           type: string
19834           example: __VPN-ID__
19835         - name: body
19836           in: body
19837           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVpnBindingsVpnBinding.json)
19838           required: true
19839           schema:
19840             $ref: "#/definitions/vpn-binding"
19841     patch:
19842       tags:
19843         - Network
19844       summary: update an existing vpn-binding
19845       description: |
19846         Update an existing vpn-binding
19847         #
19848         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19849         The PUT operation will entirely replace an existing object.
19850         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.
19851         #
19852         Other differences between PUT and PATCH are:
19853         #
19854         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19855         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19856         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19857       operationId: UpdateNetworkVpnBindingsVpnBinding
19858       consumes:
19859         - application/json
19860         - application/xml
19861       produces:
19862         - application/json
19863         - application/xml
19864       responses:
19865         "default":
19866           description: Response codes found in [response codes](https://wiki.onap.org/).
19867       parameters:
19868         - name: vpn-id
19869           in: path
19870           description: VPN ID, globally unique within A&AI
19871           required: true
19872           type: string
19873           example: __VPN-ID__
19874         - name: body
19875           in: body
19876           description: vpn-binding object that needs to be created or updated.
19877           required: true
19878           schema:
19879             $ref: "#/patchDefinitions/vpn-binding"
19880     delete:
19881       tags:
19882         - Network
19883       summary: delete an existing vpn-binding
19884       description: delete an existing vpn-binding
19885       operationId: deleteNetworkVpnBindingsVpnBinding
19886       consumes:
19887         - application/json
19888         - application/xml
19889       produces:
19890         - application/json
19891         - application/xml
19892       responses:
19893         "default":
19894           description: Response codes found in [response codes](https://wiki.onap.org/).
19895       parameters:
19896         - name: vpn-id
19897           in: path
19898           description: VPN ID, globally unique within A&AI
19899           required: true
19900           type: string
19901           example: __VPN-ID__
19902         - name: resource-version
19903           in: query
19904           description: resource-version for concurrency
19905           required: true
19906           type: string
19907   /network/vpn-bindings:
19908     get:
19909       tags:
19910         - Network
19911       summary: returns vpn-bindings
19912       description: returns vpn-bindings
19913       operationId: getNetworkVpnBindings
19914       produces:
19915         - application/json
19916         - application/xml
19917       responses:
19918         "200":
19919           description: successful operation
19920           schema:
19921               $ref: "#/getDefinitions/vpn-bindings"
19922         "default":
19923           description: Response codes found in [response codes](https://wiki.onap.org/).
19924   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
19925     put:
19926       tags:
19927         - Network
19928       summary: see node definition for valid relationships
19929       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
19930       consumes:
19931         - application/json
19932         - application/xml
19933       produces:
19934         - application/json
19935         - application/xml
19936       responses:
19937         "default":
19938           description: Response codes found in [response codes](https://wiki.onap.org/).
19939       parameters:
19940         - name: equipment-name
19941           in: path
19942           required: true
19943           type: string
19944           example: __EQUIPMENT-NAME__
19945         - name: body
19946           in: body
19947           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
19948           required: true
19949           schema:
19950             $ref: "#/definitions/relationship"
19951     delete:
19952       tags:
19953         - Network
19954       summary: delete an existing relationship
19955       description: delete an existing relationship
19956       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
19957       consumes:
19958         - application/json
19959         - application/xml
19960       produces:
19961         - application/json
19962         - application/xml
19963       responses:
19964         "default":
19965           description: Response codes found in [response codes](https://wiki.onap.org/).
19966       parameters:
19967         - name: equipment-name
19968           in: path
19969           required: true
19970           type: string
19971           example: __EQUIPMENT-NAME__
19972   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
19973     put:
19974       tags:
19975         - Network
19976       summary: see node definition for valid relationships
19977       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
19978       consumes:
19979         - application/json
19980         - application/xml
19981       produces:
19982         - application/json
19983         - application/xml
19984       responses:
19985         "default":
19986           description: Response codes found in [response codes](https://wiki.onap.org/).
19987       parameters:
19988         - name: equipment-name
19989           in: path
19990           required: true
19991           type: string
19992           example: __EQUIPMENT-NAME__
19993         - name: interface-name
19994           in: path
19995           description: Name that identifies the physical interface
19996           required: true
19997           type: string
19998           example: __INTERFACE-NAME__
19999         - name: body
20000           in: body
20001           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
20002           required: true
20003           schema:
20004             $ref: "#/definitions/relationship"
20005     delete:
20006       tags:
20007         - Network
20008       summary: delete an existing relationship
20009       description: delete an existing relationship
20010       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
20011       consumes:
20012         - application/json
20013         - application/xml
20014       produces:
20015         - application/json
20016         - application/xml
20017       responses:
20018         "default":
20019           description: Response codes found in [response codes](https://wiki.onap.org/).
20020       parameters:
20021         - name: equipment-name
20022           in: path
20023           required: true
20024           type: string
20025           example: __EQUIPMENT-NAME__
20026         - name: interface-name
20027           in: path
20028           description: Name that identifies the physical interface
20029           required: true
20030           type: string
20031           example: __INTERFACE-NAME__
20032   /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:
20033     put:
20034       tags:
20035         - Network
20036       summary: see node definition for valid relationships
20037       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20038       consumes:
20039         - application/json
20040         - application/xml
20041       produces:
20042         - application/json
20043         - application/xml
20044       responses:
20045         "default":
20046           description: Response codes found in [response codes](https://wiki.onap.org/).
20047       parameters:
20048         - name: equipment-name
20049           in: path
20050           required: true
20051           type: string
20052           example: __EQUIPMENT-NAME__
20053         - name: interface-name
20054           in: path
20055           description: Name that identifies the physical interface
20056           required: true
20057           type: string
20058           example: __INTERFACE-NAME__
20059         - name: interface-name
20060           in: path
20061           description: Name given to the interface
20062           required: true
20063           type: string
20064           example: __INTERFACE-NAME__
20065         - name: vlan-interface
20066           in: path
20067           description: String that identifies the interface
20068           required: true
20069           type: string
20070           example: __VLAN-INTERFACE__
20071         - name: body
20072           in: body
20073           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20074           required: true
20075           schema:
20076             $ref: "#/definitions/relationship"
20077     delete:
20078       tags:
20079         - Network
20080       summary: delete an existing relationship
20081       description: delete an existing relationship
20082       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
20083       consumes:
20084         - application/json
20085         - application/xml
20086       produces:
20087         - application/json
20088         - application/xml
20089       responses:
20090         "default":
20091           description: Response codes found in [response codes](https://wiki.onap.org/).
20092       parameters:
20093         - name: equipment-name
20094           in: path
20095           required: true
20096           type: string
20097           example: __EQUIPMENT-NAME__
20098         - name: interface-name
20099           in: path
20100           description: Name that identifies the physical interface
20101           required: true
20102           type: string
20103           example: __INTERFACE-NAME__
20104         - name: interface-name
20105           in: path
20106           description: Name given to the interface
20107           required: true
20108           type: string
20109           example: __INTERFACE-NAME__
20110         - name: vlan-interface
20111           in: path
20112           description: String that identifies the interface
20113           required: true
20114           type: string
20115           example: __VLAN-INTERFACE__
20116   /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:
20117     put:
20118       tags:
20119         - Network
20120       summary: see node definition for valid relationships
20121       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20122       consumes:
20123         - application/json
20124         - application/xml
20125       produces:
20126         - application/json
20127         - application/xml
20128       responses:
20129         "default":
20130           description: Response codes found in [response codes](https://wiki.onap.org/).
20131       parameters:
20132         - name: equipment-name
20133           in: path
20134           required: true
20135           type: string
20136           example: __EQUIPMENT-NAME__
20137         - name: interface-name
20138           in: path
20139           description: Name that identifies the physical interface
20140           required: true
20141           type: string
20142           example: __INTERFACE-NAME__
20143         - name: interface-name
20144           in: path
20145           description: Name given to the interface
20146           required: true
20147           type: string
20148           example: __INTERFACE-NAME__
20149         - name: vlan-interface
20150           in: path
20151           description: String that identifies the interface
20152           required: true
20153           type: string
20154           example: __VLAN-INTERFACE__
20155         - name: l3-interface-ipv4-address
20156           in: path
20157           description: IP address
20158           required: true
20159           type: string
20160           example: __L3-INTERFACE-IPV4-ADDRESS__
20161         - name: body
20162           in: body
20163           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20164           required: true
20165           schema:
20166             $ref: "#/definitions/relationship"
20167     delete:
20168       tags:
20169         - Network
20170       summary: delete an existing relationship
20171       description: delete an existing relationship
20172       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
20173       consumes:
20174         - application/json
20175         - application/xml
20176       produces:
20177         - application/json
20178         - application/xml
20179       responses:
20180         "default":
20181           description: Response codes found in [response codes](https://wiki.onap.org/).
20182       parameters:
20183         - name: equipment-name
20184           in: path
20185           required: true
20186           type: string
20187           example: __EQUIPMENT-NAME__
20188         - name: interface-name
20189           in: path
20190           description: Name that identifies the physical interface
20191           required: true
20192           type: string
20193           example: __INTERFACE-NAME__
20194         - name: interface-name
20195           in: path
20196           description: Name given to the interface
20197           required: true
20198           type: string
20199           example: __INTERFACE-NAME__
20200         - name: vlan-interface
20201           in: path
20202           description: String that identifies the interface
20203           required: true
20204           type: string
20205           example: __VLAN-INTERFACE__
20206         - name: l3-interface-ipv4-address
20207           in: path
20208           description: IP address
20209           required: true
20210           type: string
20211           example: __L3-INTERFACE-IPV4-ADDRESS__
20212   /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}:
20213     get:
20214       tags:
20215         - Network
20216       summary: returns l3-interface-ipv4-address-list
20217       description: returns l3-interface-ipv4-address-list
20218       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20219       produces:
20220         - application/json
20221         - application/xml
20222       responses:
20223         "200":
20224           description: successful operation
20225           schema:
20226               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
20227         "default":
20228           description: Response codes found in [response codes](https://wiki.onap.org/).
20229       parameters:
20230         - name: equipment-name
20231           in: path
20232           required: true
20233           type: string
20234           example: __EQUIPMENT-NAME__
20235         - name: interface-name
20236           in: path
20237           description: Name that identifies the physical interface
20238           required: true
20239           type: string
20240           example: __INTERFACE-NAME__
20241         - name: interface-name
20242           in: path
20243           description: Name given to the interface
20244           required: true
20245           type: string
20246           example: __INTERFACE-NAME__
20247         - name: vlan-interface
20248           in: path
20249           description: String that identifies the interface
20250           required: true
20251           type: string
20252           example: __VLAN-INTERFACE__
20253         - name: l3-interface-ipv4-address
20254           in: path
20255           description: IP address
20256           required: true
20257           type: string
20258           example: __L3-INTERFACE-IPV4-ADDRESS__
20259         - name: prov-status
20260           in: query
20261           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20262           required: false
20263           type: string
20264         - name: interface-id
20265           in: query
20266           description: ID of interface
20267           required: false
20268           type: string
20269         - name: macaddr
20270           in: query
20271           description: MAC address for the interface
20272           required: false
20273           type: string
20274         - name: network-name
20275           in: query
20276           description: Name of the network
20277           required: false
20278           type: string
20279         - name: vlan-id-inner
20280           in: query
20281           description: Inner VLAN tag
20282           required: false
20283           type: integer
20284           format: int64
20285         - name: vpn-id
20286           in: query
20287           description: This indicates the customers VPN ID associated with this vlan
20288           required: false
20289           type: string
20290         - name: vlan-id-inner
20291           in: query
20292           description: Inner VLAN tag
20293           required: false
20294           type: integer
20295           format: int64
20296         - name: neutron-network-id
20297           in: query
20298           description: Neutron network id of the interface that address belongs to
20299           required: false
20300           type: string
20301         - name: neutron-subnet-id
20302           in: query
20303           description: Neutron id of subnet that address belongs to
20304           required: false
20305           type: string
20306     put:
20307       tags:
20308         - Network
20309       summary: create or update an existing l3-interface-ipv4-address-list
20310       description: |
20311         Create or update an existing l3-interface-ipv4-address-list.
20312         #
20313         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
20314       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20315       consumes:
20316         - application/json
20317         - application/xml
20318       produces:
20319         - application/json
20320         - application/xml
20321       responses:
20322         "default":
20323           description: Response codes found in [response codes](https://wiki.onap.org/).
20324       parameters:
20325         - name: equipment-name
20326           in: path
20327           required: true
20328           type: string
20329           example: __EQUIPMENT-NAME__
20330         - name: interface-name
20331           in: path
20332           description: Name that identifies the physical interface
20333           required: true
20334           type: string
20335           example: __INTERFACE-NAME__
20336         - name: interface-name
20337           in: path
20338           description: Name given to the interface
20339           required: true
20340           type: string
20341           example: __INTERFACE-NAME__
20342         - name: vlan-interface
20343           in: path
20344           description: String that identifies the interface
20345           required: true
20346           type: string
20347           example: __VLAN-INTERFACE__
20348         - name: l3-interface-ipv4-address
20349           in: path
20350           description: IP address
20351           required: true
20352           type: string
20353           example: __L3-INTERFACE-IPV4-ADDRESS__
20354         - name: body
20355           in: body
20356           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
20357           required: true
20358           schema:
20359             $ref: "#/definitions/l3-interface-ipv4-address-list"
20360     patch:
20361       tags:
20362         - Network
20363       summary: update an existing l3-interface-ipv4-address-list
20364       description: |
20365         Update an existing l3-interface-ipv4-address-list
20366         #
20367         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20368         The PUT operation will entirely replace an existing object.
20369         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.
20370         #
20371         Other differences between PUT and PATCH are:
20372         #
20373         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20374         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20375         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20376       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20377       consumes:
20378         - application/json
20379         - application/xml
20380       produces:
20381         - application/json
20382         - application/xml
20383       responses:
20384         "default":
20385           description: Response codes found in [response codes](https://wiki.onap.org/).
20386       parameters:
20387         - name: equipment-name
20388           in: path
20389           required: true
20390           type: string
20391           example: __EQUIPMENT-NAME__
20392         - name: interface-name
20393           in: path
20394           description: Name that identifies the physical interface
20395           required: true
20396           type: string
20397           example: __INTERFACE-NAME__
20398         - name: interface-name
20399           in: path
20400           description: Name given to the interface
20401           required: true
20402           type: string
20403           example: __INTERFACE-NAME__
20404         - name: vlan-interface
20405           in: path
20406           description: String that identifies the interface
20407           required: true
20408           type: string
20409           example: __VLAN-INTERFACE__
20410         - name: l3-interface-ipv4-address
20411           in: path
20412           description: IP address
20413           required: true
20414           type: string
20415           example: __L3-INTERFACE-IPV4-ADDRESS__
20416         - name: body
20417           in: body
20418           description: l3-interface-ipv4-address-list object that needs to be created or updated.
20419           required: true
20420           schema:
20421             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
20422     delete:
20423       tags:
20424         - Network
20425       summary: delete an existing l3-interface-ipv4-address-list
20426       description: delete an existing l3-interface-ipv4-address-list
20427       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
20428       consumes:
20429         - application/json
20430         - application/xml
20431       produces:
20432         - application/json
20433         - application/xml
20434       responses:
20435         "default":
20436           description: Response codes found in [response codes](https://wiki.onap.org/).
20437       parameters:
20438         - name: equipment-name
20439           in: path
20440           required: true
20441           type: string
20442           example: __EQUIPMENT-NAME__
20443         - name: interface-name
20444           in: path
20445           description: Name that identifies the physical interface
20446           required: true
20447           type: string
20448           example: __INTERFACE-NAME__
20449         - name: interface-name
20450           in: path
20451           description: Name given to the interface
20452           required: true
20453           type: string
20454           example: __INTERFACE-NAME__
20455         - name: vlan-interface
20456           in: path
20457           description: String that identifies the interface
20458           required: true
20459           type: string
20460           example: __VLAN-INTERFACE__
20461         - name: l3-interface-ipv4-address
20462           in: path
20463           description: IP address
20464           required: true
20465           type: string
20466           example: __L3-INTERFACE-IPV4-ADDRESS__
20467         - name: resource-version
20468           in: query
20469           description: resource-version for concurrency
20470           required: true
20471           type: string
20472   /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:
20473     put:
20474       tags:
20475         - Network
20476       summary: see node definition for valid relationships
20477       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20478       consumes:
20479         - application/json
20480         - application/xml
20481       produces:
20482         - application/json
20483         - application/xml
20484       responses:
20485         "default":
20486           description: Response codes found in [response codes](https://wiki.onap.org/).
20487       parameters:
20488         - name: equipment-name
20489           in: path
20490           required: true
20491           type: string
20492           example: __EQUIPMENT-NAME__
20493         - name: interface-name
20494           in: path
20495           description: Name that identifies the physical interface
20496           required: true
20497           type: string
20498           example: __INTERFACE-NAME__
20499         - name: interface-name
20500           in: path
20501           description: Name given to the interface
20502           required: true
20503           type: string
20504           example: __INTERFACE-NAME__
20505         - name: vlan-interface
20506           in: path
20507           description: String that identifies the interface
20508           required: true
20509           type: string
20510           example: __VLAN-INTERFACE__
20511         - name: l3-interface-ipv6-address
20512           in: path
20513           description: IP address
20514           required: true
20515           type: string
20516           example: __L3-INTERFACE-IPV6-ADDRESS__
20517         - name: body
20518           in: body
20519           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20520           required: true
20521           schema:
20522             $ref: "#/definitions/relationship"
20523     delete:
20524       tags:
20525         - Network
20526       summary: delete an existing relationship
20527       description: delete an existing relationship
20528       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
20529       consumes:
20530         - application/json
20531         - application/xml
20532       produces:
20533         - application/json
20534         - application/xml
20535       responses:
20536         "default":
20537           description: Response codes found in [response codes](https://wiki.onap.org/).
20538       parameters:
20539         - name: equipment-name
20540           in: path
20541           required: true
20542           type: string
20543           example: __EQUIPMENT-NAME__
20544         - name: interface-name
20545           in: path
20546           description: Name that identifies the physical interface
20547           required: true
20548           type: string
20549           example: __INTERFACE-NAME__
20550         - name: interface-name
20551           in: path
20552           description: Name given to the interface
20553           required: true
20554           type: string
20555           example: __INTERFACE-NAME__
20556         - name: vlan-interface
20557           in: path
20558           description: String that identifies the interface
20559           required: true
20560           type: string
20561           example: __VLAN-INTERFACE__
20562         - name: l3-interface-ipv6-address
20563           in: path
20564           description: IP address
20565           required: true
20566           type: string
20567           example: __L3-INTERFACE-IPV6-ADDRESS__
20568   /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}:
20569     get:
20570       tags:
20571         - Network
20572       summary: returns l3-interface-ipv6-address-list
20573       description: returns l3-interface-ipv6-address-list
20574       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20575       produces:
20576         - application/json
20577         - application/xml
20578       responses:
20579         "200":
20580           description: successful operation
20581           schema:
20582               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
20583         "default":
20584           description: Response codes found in [response codes](https://wiki.onap.org/).
20585       parameters:
20586         - name: equipment-name
20587           in: path
20588           required: true
20589           type: string
20590           example: __EQUIPMENT-NAME__
20591         - name: interface-name
20592           in: path
20593           description: Name that identifies the physical interface
20594           required: true
20595           type: string
20596           example: __INTERFACE-NAME__
20597         - name: interface-name
20598           in: path
20599           description: Name given to the interface
20600           required: true
20601           type: string
20602           example: __INTERFACE-NAME__
20603         - name: vlan-interface
20604           in: path
20605           description: String that identifies the interface
20606           required: true
20607           type: string
20608           example: __VLAN-INTERFACE__
20609         - name: l3-interface-ipv6-address
20610           in: path
20611           description: IP address
20612           required: true
20613           type: string
20614           example: __L3-INTERFACE-IPV6-ADDRESS__
20615         - name: prov-status
20616           in: query
20617           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20618           required: false
20619           type: string
20620         - name: interface-id
20621           in: query
20622           description: ID of interface
20623           required: false
20624           type: string
20625         - name: macaddr
20626           in: query
20627           description: MAC address for the interface
20628           required: false
20629           type: string
20630         - name: network-name
20631           in: query
20632           description: Name of the network
20633           required: false
20634           type: string
20635         - name: vlan-id-inner
20636           in: query
20637           description: Inner VLAN tag
20638           required: false
20639           type: integer
20640           format: int64
20641         - name: vpn-id
20642           in: query
20643           description: This indicates the customers VPN ID associated with this vlan
20644           required: false
20645           type: string
20646         - name: vlan-id-inner
20647           in: query
20648           description: Inner VLAN tag
20649           required: false
20650           type: integer
20651           format: int64
20652         - name: neutron-network-id
20653           in: query
20654           description: Neutron network id of the interface that address belongs to
20655           required: false
20656           type: string
20657         - name: neutron-subnet-id
20658           in: query
20659           description: Neutron id of subnet that address belongs to
20660           required: false
20661           type: string
20662     put:
20663       tags:
20664         - Network
20665       summary: create or update an existing l3-interface-ipv6-address-list
20666       description: |
20667         Create or update an existing l3-interface-ipv6-address-list.
20668         #
20669         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
20670       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20671       consumes:
20672         - application/json
20673         - application/xml
20674       produces:
20675         - application/json
20676         - application/xml
20677       responses:
20678         "default":
20679           description: Response codes found in [response codes](https://wiki.onap.org/).
20680       parameters:
20681         - name: equipment-name
20682           in: path
20683           required: true
20684           type: string
20685           example: __EQUIPMENT-NAME__
20686         - name: interface-name
20687           in: path
20688           description: Name that identifies the physical interface
20689           required: true
20690           type: string
20691           example: __INTERFACE-NAME__
20692         - name: interface-name
20693           in: path
20694           description: Name given to the interface
20695           required: true
20696           type: string
20697           example: __INTERFACE-NAME__
20698         - name: vlan-interface
20699           in: path
20700           description: String that identifies the interface
20701           required: true
20702           type: string
20703           example: __VLAN-INTERFACE__
20704         - name: l3-interface-ipv6-address
20705           in: path
20706           description: IP address
20707           required: true
20708           type: string
20709           example: __L3-INTERFACE-IPV6-ADDRESS__
20710         - name: body
20711           in: body
20712           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
20713           required: true
20714           schema:
20715             $ref: "#/definitions/l3-interface-ipv6-address-list"
20716     patch:
20717       tags:
20718         - Network
20719       summary: update an existing l3-interface-ipv6-address-list
20720       description: |
20721         Update an existing l3-interface-ipv6-address-list
20722         #
20723         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20724         The PUT operation will entirely replace an existing object.
20725         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.
20726         #
20727         Other differences between PUT and PATCH are:
20728         #
20729         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20730         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20731         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20732       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20733       consumes:
20734         - application/json
20735         - application/xml
20736       produces:
20737         - application/json
20738         - application/xml
20739       responses:
20740         "default":
20741           description: Response codes found in [response codes](https://wiki.onap.org/).
20742       parameters:
20743         - name: equipment-name
20744           in: path
20745           required: true
20746           type: string
20747           example: __EQUIPMENT-NAME__
20748         - name: interface-name
20749           in: path
20750           description: Name that identifies the physical interface
20751           required: true
20752           type: string
20753           example: __INTERFACE-NAME__
20754         - name: interface-name
20755           in: path
20756           description: Name given to the interface
20757           required: true
20758           type: string
20759           example: __INTERFACE-NAME__
20760         - name: vlan-interface
20761           in: path
20762           description: String that identifies the interface
20763           required: true
20764           type: string
20765           example: __VLAN-INTERFACE__
20766         - name: l3-interface-ipv6-address
20767           in: path
20768           description: IP address
20769           required: true
20770           type: string
20771           example: __L3-INTERFACE-IPV6-ADDRESS__
20772         - name: body
20773           in: body
20774           description: l3-interface-ipv6-address-list object that needs to be created or updated.
20775           required: true
20776           schema:
20777             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
20778     delete:
20779       tags:
20780         - Network
20781       summary: delete an existing l3-interface-ipv6-address-list
20782       description: delete an existing l3-interface-ipv6-address-list
20783       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
20784       consumes:
20785         - application/json
20786         - application/xml
20787       produces:
20788         - application/json
20789         - application/xml
20790       responses:
20791         "default":
20792           description: Response codes found in [response codes](https://wiki.onap.org/).
20793       parameters:
20794         - name: equipment-name
20795           in: path
20796           required: true
20797           type: string
20798           example: __EQUIPMENT-NAME__
20799         - name: interface-name
20800           in: path
20801           description: Name that identifies the physical interface
20802           required: true
20803           type: string
20804           example: __INTERFACE-NAME__
20805         - name: interface-name
20806           in: path
20807           description: Name given to the interface
20808           required: true
20809           type: string
20810           example: __INTERFACE-NAME__
20811         - name: vlan-interface
20812           in: path
20813           description: String that identifies the interface
20814           required: true
20815           type: string
20816           example: __VLAN-INTERFACE__
20817         - name: l3-interface-ipv6-address
20818           in: path
20819           description: IP address
20820           required: true
20821           type: string
20822           example: __L3-INTERFACE-IPV6-ADDRESS__
20823         - name: resource-version
20824           in: query
20825           description: resource-version for concurrency
20826           required: true
20827           type: string
20828   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
20829     get:
20830       tags:
20831         - Network
20832       summary: returns vlan
20833       description: returns vlan
20834       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20835       produces:
20836         - application/json
20837         - application/xml
20838       responses:
20839         "200":
20840           description: successful operation
20841           schema:
20842               $ref: "#/getDefinitions/vlan"
20843         "default":
20844           description: Response codes found in [response codes](https://wiki.onap.org/).
20845       parameters:
20846         - name: equipment-name
20847           in: path
20848           required: true
20849           type: string
20850           example: __EQUIPMENT-NAME__
20851         - name: interface-name
20852           in: path
20853           description: Name that identifies the physical interface
20854           required: true
20855           type: string
20856           example: __INTERFACE-NAME__
20857         - name: interface-name
20858           in: path
20859           description: Name given to the interface
20860           required: true
20861           type: string
20862           example: __INTERFACE-NAME__
20863         - name: vlan-interface
20864           in: path
20865           description: String that identifies the interface
20866           required: true
20867           type: string
20868           example: __VLAN-INTERFACE__
20869         - name: prov-status
20870           in: query
20871           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20872           required: false
20873           type: string
20874         - name: interface-id
20875           in: query
20876           description: ID of interface
20877           required: false
20878           type: string
20879         - name: macaddr
20880           in: query
20881           description: MAC address for the interface
20882           required: false
20883           type: string
20884         - name: network-name
20885           in: query
20886           description: Name of the network
20887           required: false
20888           type: string
20889         - name: vlan-id-inner
20890           in: query
20891           description: Inner VLAN tag
20892           required: false
20893           type: integer
20894           format: int64
20895         - name: vpn-id
20896           in: query
20897           description: This indicates the customers VPN ID associated with this vlan
20898           required: false
20899           type: string
20900     put:
20901       tags:
20902         - Network
20903       summary: create or update an existing vlan
20904       description: |
20905         Create or update an existing vlan.
20906         #
20907         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
20908       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20909       consumes:
20910         - application/json
20911         - application/xml
20912       produces:
20913         - application/json
20914         - application/xml
20915       responses:
20916         "default":
20917           description: Response codes found in [response codes](https://wiki.onap.org/).
20918       parameters:
20919         - name: equipment-name
20920           in: path
20921           required: true
20922           type: string
20923           example: __EQUIPMENT-NAME__
20924         - name: interface-name
20925           in: path
20926           description: Name that identifies the physical interface
20927           required: true
20928           type: string
20929           example: __INTERFACE-NAME__
20930         - name: interface-name
20931           in: path
20932           description: Name given to the interface
20933           required: true
20934           type: string
20935           example: __INTERFACE-NAME__
20936         - name: vlan-interface
20937           in: path
20938           description: String that identifies the interface
20939           required: true
20940           type: string
20941           example: __VLAN-INTERFACE__
20942         - name: body
20943           in: body
20944           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
20945           required: true
20946           schema:
20947             $ref: "#/definitions/vlan"
20948     patch:
20949       tags:
20950         - Network
20951       summary: update an existing vlan
20952       description: |
20953         Update an existing vlan
20954         #
20955         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20956         The PUT operation will entirely replace an existing object.
20957         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.
20958         #
20959         Other differences between PUT and PATCH are:
20960         #
20961         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20962         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20963         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20964       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
20965       consumes:
20966         - application/json
20967         - application/xml
20968       produces:
20969         - application/json
20970         - application/xml
20971       responses:
20972         "default":
20973           description: Response codes found in [response codes](https://wiki.onap.org/).
20974       parameters:
20975         - name: equipment-name
20976           in: path
20977           required: true
20978           type: string
20979           example: __EQUIPMENT-NAME__
20980         - name: interface-name
20981           in: path
20982           description: Name that identifies the physical interface
20983           required: true
20984           type: string
20985           example: __INTERFACE-NAME__
20986         - name: interface-name
20987           in: path
20988           description: Name given to the interface
20989           required: true
20990           type: string
20991           example: __INTERFACE-NAME__
20992         - name: vlan-interface
20993           in: path
20994           description: String that identifies the interface
20995           required: true
20996           type: string
20997           example: __VLAN-INTERFACE__
20998         - name: body
20999           in: body
21000           description: vlan object that needs to be created or updated.
21001           required: true
21002           schema:
21003             $ref: "#/patchDefinitions/vlan"
21004     delete:
21005       tags:
21006         - Network
21007       summary: delete an existing vlan
21008       description: delete an existing vlan
21009       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
21010       consumes:
21011         - application/json
21012         - application/xml
21013       produces:
21014         - application/json
21015         - application/xml
21016       responses:
21017         "default":
21018           description: Response codes found in [response codes](https://wiki.onap.org/).
21019       parameters:
21020         - name: equipment-name
21021           in: path
21022           required: true
21023           type: string
21024           example: __EQUIPMENT-NAME__
21025         - name: interface-name
21026           in: path
21027           description: Name that identifies the physical interface
21028           required: true
21029           type: string
21030           example: __INTERFACE-NAME__
21031         - name: interface-name
21032           in: path
21033           description: Name given to the interface
21034           required: true
21035           type: string
21036           example: __INTERFACE-NAME__
21037         - name: vlan-interface
21038           in: path
21039           description: String that identifies the interface
21040           required: true
21041           type: string
21042           example: __VLAN-INTERFACE__
21043         - name: resource-version
21044           in: query
21045           description: resource-version for concurrency
21046           required: true
21047           type: string
21048   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
21049     get:
21050       tags:
21051         - Network
21052       summary: returns vlans
21053       description: returns vlans
21054       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
21055       produces:
21056         - application/json
21057         - application/xml
21058       responses:
21059         "200":
21060           description: successful operation
21061           schema:
21062               $ref: "#/getDefinitions/vlans"
21063         "default":
21064           description: Response codes found in [response codes](https://wiki.onap.org/).
21065       parameters:
21066         - name: equipment-name
21067           in: path
21068           required: true
21069           type: string
21070           example: __EQUIPMENT-NAME__
21071         - name: interface-name
21072           in: path
21073           description: Name that identifies the physical interface
21074           required: true
21075           type: string
21076           example: __INTERFACE-NAME__
21077         - name: interface-name
21078           in: path
21079           description: Name given to the interface
21080           required: true
21081           type: string
21082           example: __INTERFACE-NAME__
21083         - name: prov-status
21084           in: query
21085           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21086           required: false
21087           type: string
21088         - name: interface-id
21089           in: query
21090           description: ID of interface
21091           required: false
21092           type: string
21093         - name: macaddr
21094           in: query
21095           description: MAC address for the interface
21096           required: false
21097           type: string
21098         - name: network-name
21099           in: query
21100           description: Name of the network
21101           required: false
21102           type: string
21103   /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:
21104     put:
21105       tags:
21106         - Network
21107       summary: see node definition for valid relationships
21108       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21109       consumes:
21110         - application/json
21111         - application/xml
21112       produces:
21113         - application/json
21114         - application/xml
21115       responses:
21116         "default":
21117           description: Response codes found in [response codes](https://wiki.onap.org/).
21118       parameters:
21119         - name: equipment-name
21120           in: path
21121           required: true
21122           type: string
21123           example: __EQUIPMENT-NAME__
21124         - name: interface-name
21125           in: path
21126           description: Name that identifies the physical interface
21127           required: true
21128           type: string
21129           example: __INTERFACE-NAME__
21130         - name: interface-name
21131           in: path
21132           description: Name given to the interface
21133           required: true
21134           type: string
21135           example: __INTERFACE-NAME__
21136         - name: pci-id
21137           in: path
21138           description: PCI ID used to identify the sriov-vf
21139           required: true
21140           type: string
21141           example: __PCI-ID__
21142         - name: body
21143           in: body
21144           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21145           required: true
21146           schema:
21147             $ref: "#/definitions/relationship"
21148     delete:
21149       tags:
21150         - Network
21151       summary: delete an existing relationship
21152       description: delete an existing relationship
21153       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
21154       consumes:
21155         - application/json
21156         - application/xml
21157       produces:
21158         - application/json
21159         - application/xml
21160       responses:
21161         "default":
21162           description: Response codes found in [response codes](https://wiki.onap.org/).
21163       parameters:
21164         - name: equipment-name
21165           in: path
21166           required: true
21167           type: string
21168           example: __EQUIPMENT-NAME__
21169         - name: interface-name
21170           in: path
21171           description: Name that identifies the physical interface
21172           required: true
21173           type: string
21174           example: __INTERFACE-NAME__
21175         - name: interface-name
21176           in: path
21177           description: Name given to the interface
21178           required: true
21179           type: string
21180           example: __INTERFACE-NAME__
21181         - name: pci-id
21182           in: path
21183           description: PCI ID used to identify the sriov-vf
21184           required: true
21185           type: string
21186           example: __PCI-ID__
21187   /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}:
21188     get:
21189       tags:
21190         - Network
21191       summary: returns sriov-vf
21192       description: returns sriov-vf
21193       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21194       produces:
21195         - application/json
21196         - application/xml
21197       responses:
21198         "200":
21199           description: successful operation
21200           schema:
21201               $ref: "#/getDefinitions/sriov-vf"
21202         "default":
21203           description: Response codes found in [response codes](https://wiki.onap.org/).
21204       parameters:
21205         - name: equipment-name
21206           in: path
21207           required: true
21208           type: string
21209           example: __EQUIPMENT-NAME__
21210         - name: interface-name
21211           in: path
21212           description: Name that identifies the physical interface
21213           required: true
21214           type: string
21215           example: __INTERFACE-NAME__
21216         - name: interface-name
21217           in: path
21218           description: Name given to the interface
21219           required: true
21220           type: string
21221           example: __INTERFACE-NAME__
21222         - name: pci-id
21223           in: path
21224           description: PCI ID used to identify the sriov-vf
21225           required: true
21226           type: string
21227           example: __PCI-ID__
21228         - name: prov-status
21229           in: query
21230           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21231           required: false
21232           type: string
21233         - name: interface-id
21234           in: query
21235           description: ID of interface
21236           required: false
21237           type: string
21238         - name: macaddr
21239           in: query
21240           description: MAC address for the interface
21241           required: false
21242           type: string
21243         - name: network-name
21244           in: query
21245           description: Name of the network
21246           required: false
21247           type: string
21248         - name: vf-vlan-filter
21249           in: query
21250           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
21251           required: false
21252           type: string
21253         - name: vf-mac-filter
21254           in: query
21255           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
21256           required: false
21257           type: string
21258         - name: vf-vlan-strip
21259           in: query
21260           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
21261           required: false
21262           type: boolean
21263         - name: neutron-network-id
21264           in: query
21265           description: Neutron network id of the interface
21266           required: false
21267           type: string
21268     put:
21269       tags:
21270         - Network
21271       summary: create or update an existing sriov-vf
21272       description: |
21273         Create or update an existing sriov-vf.
21274         #
21275         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
21276       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21277       consumes:
21278         - application/json
21279         - application/xml
21280       produces:
21281         - application/json
21282         - application/xml
21283       responses:
21284         "default":
21285           description: Response codes found in [response codes](https://wiki.onap.org/).
21286       parameters:
21287         - name: equipment-name
21288           in: path
21289           required: true
21290           type: string
21291           example: __EQUIPMENT-NAME__
21292         - name: interface-name
21293           in: path
21294           description: Name that identifies the physical interface
21295           required: true
21296           type: string
21297           example: __INTERFACE-NAME__
21298         - name: interface-name
21299           in: path
21300           description: Name given to the interface
21301           required: true
21302           type: string
21303           example: __INTERFACE-NAME__
21304         - name: pci-id
21305           in: path
21306           description: PCI ID used to identify the sriov-vf
21307           required: true
21308           type: string
21309           example: __PCI-ID__
21310         - name: body
21311           in: body
21312           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
21313           required: true
21314           schema:
21315             $ref: "#/definitions/sriov-vf"
21316     patch:
21317       tags:
21318         - Network
21319       summary: update an existing sriov-vf
21320       description: |
21321         Update an existing sriov-vf
21322         #
21323         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21324         The PUT operation will entirely replace an existing object.
21325         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.
21326         #
21327         Other differences between PUT and PATCH are:
21328         #
21329         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21330         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21331         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21332       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21333       consumes:
21334         - application/json
21335         - application/xml
21336       produces:
21337         - application/json
21338         - application/xml
21339       responses:
21340         "default":
21341           description: Response codes found in [response codes](https://wiki.onap.org/).
21342       parameters:
21343         - name: equipment-name
21344           in: path
21345           required: true
21346           type: string
21347           example: __EQUIPMENT-NAME__
21348         - name: interface-name
21349           in: path
21350           description: Name that identifies the physical interface
21351           required: true
21352           type: string
21353           example: __INTERFACE-NAME__
21354         - name: interface-name
21355           in: path
21356           description: Name given to the interface
21357           required: true
21358           type: string
21359           example: __INTERFACE-NAME__
21360         - name: pci-id
21361           in: path
21362           description: PCI ID used to identify the sriov-vf
21363           required: true
21364           type: string
21365           example: __PCI-ID__
21366         - name: body
21367           in: body
21368           description: sriov-vf object that needs to be created or updated.
21369           required: true
21370           schema:
21371             $ref: "#/patchDefinitions/sriov-vf"
21372     delete:
21373       tags:
21374         - Network
21375       summary: delete an existing sriov-vf
21376       description: delete an existing sriov-vf
21377       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
21378       consumes:
21379         - application/json
21380         - application/xml
21381       produces:
21382         - application/json
21383         - application/xml
21384       responses:
21385         "default":
21386           description: Response codes found in [response codes](https://wiki.onap.org/).
21387       parameters:
21388         - name: equipment-name
21389           in: path
21390           required: true
21391           type: string
21392           example: __EQUIPMENT-NAME__
21393         - name: interface-name
21394           in: path
21395           description: Name that identifies the physical interface
21396           required: true
21397           type: string
21398           example: __INTERFACE-NAME__
21399         - name: interface-name
21400           in: path
21401           description: Name given to the interface
21402           required: true
21403           type: string
21404           example: __INTERFACE-NAME__
21405         - name: pci-id
21406           in: path
21407           description: PCI ID used to identify the sriov-vf
21408           required: true
21409           type: string
21410           example: __PCI-ID__
21411         - name: resource-version
21412           in: query
21413           description: resource-version for concurrency
21414           required: true
21415           type: string
21416   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
21417     get:
21418       tags:
21419         - Network
21420       summary: returns sriov-vfs
21421       description: returns sriov-vfs
21422       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
21423       produces:
21424         - application/json
21425         - application/xml
21426       responses:
21427         "200":
21428           description: successful operation
21429           schema:
21430               $ref: "#/getDefinitions/sriov-vfs"
21431         "default":
21432           description: Response codes found in [response codes](https://wiki.onap.org/).
21433       parameters:
21434         - name: equipment-name
21435           in: path
21436           required: true
21437           type: string
21438           example: __EQUIPMENT-NAME__
21439         - name: interface-name
21440           in: path
21441           description: Name that identifies the physical interface
21442           required: true
21443           type: string
21444           example: __INTERFACE-NAME__
21445         - name: interface-name
21446           in: path
21447           description: Name given to the interface
21448           required: true
21449           type: string
21450           example: __INTERFACE-NAME__
21451         - name: prov-status
21452           in: query
21453           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21454           required: false
21455           type: string
21456         - name: interface-id
21457           in: query
21458           description: ID of interface
21459           required: false
21460           type: string
21461         - name: macaddr
21462           in: query
21463           description: MAC address for the interface
21464           required: false
21465           type: string
21466         - name: network-name
21467           in: query
21468           description: Name of the network
21469           required: false
21470           type: string
21471   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
21472     put:
21473       tags:
21474         - Network
21475       summary: see node definition for valid relationships
21476       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
21477       consumes:
21478         - application/json
21479         - application/xml
21480       produces:
21481         - application/json
21482         - application/xml
21483       responses:
21484         "default":
21485           description: Response codes found in [response codes](https://wiki.onap.org/).
21486       parameters:
21487         - name: equipment-name
21488           in: path
21489           required: true
21490           type: string
21491           example: __EQUIPMENT-NAME__
21492         - name: interface-name
21493           in: path
21494           description: Name that identifies the physical interface
21495           required: true
21496           type: string
21497           example: __INTERFACE-NAME__
21498         - name: interface-name
21499           in: path
21500           description: Name given to the interface
21501           required: true
21502           type: string
21503           example: __INTERFACE-NAME__
21504         - name: body
21505           in: body
21506           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
21507           required: true
21508           schema:
21509             $ref: "#/definitions/relationship"
21510     delete:
21511       tags:
21512         - Network
21513       summary: delete an existing relationship
21514       description: delete an existing relationship
21515       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
21516       consumes:
21517         - application/json
21518         - application/xml
21519       produces:
21520         - application/json
21521         - application/xml
21522       responses:
21523         "default":
21524           description: Response codes found in [response codes](https://wiki.onap.org/).
21525       parameters:
21526         - name: equipment-name
21527           in: path
21528           required: true
21529           type: string
21530           example: __EQUIPMENT-NAME__
21531         - name: interface-name
21532           in: path
21533           description: Name that identifies the physical interface
21534           required: true
21535           type: string
21536           example: __INTERFACE-NAME__
21537         - name: interface-name
21538           in: path
21539           description: Name given to the interface
21540           required: true
21541           type: string
21542           example: __INTERFACE-NAME__
21543   /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:
21544     put:
21545       tags:
21546         - Network
21547       summary: see node definition for valid relationships
21548       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21549       consumes:
21550         - application/json
21551         - application/xml
21552       produces:
21553         - application/json
21554         - application/xml
21555       responses:
21556         "default":
21557           description: Response codes found in [response codes](https://wiki.onap.org/).
21558       parameters:
21559         - name: equipment-name
21560           in: path
21561           required: true
21562           type: string
21563           example: __EQUIPMENT-NAME__
21564         - name: interface-name
21565           in: path
21566           description: Name that identifies the physical interface
21567           required: true
21568           type: string
21569           example: __INTERFACE-NAME__
21570         - name: interface-name
21571           in: path
21572           description: Name given to the interface
21573           required: true
21574           type: string
21575           example: __INTERFACE-NAME__
21576         - name: l3-interface-ipv4-address
21577           in: path
21578           description: IP address
21579           required: true
21580           type: string
21581           example: __L3-INTERFACE-IPV4-ADDRESS__
21582         - name: body
21583           in: body
21584           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21585           required: true
21586           schema:
21587             $ref: "#/definitions/relationship"
21588     delete:
21589       tags:
21590         - Network
21591       summary: delete an existing relationship
21592       description: delete an existing relationship
21593       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
21594       consumes:
21595         - application/json
21596         - application/xml
21597       produces:
21598         - application/json
21599         - application/xml
21600       responses:
21601         "default":
21602           description: Response codes found in [response codes](https://wiki.onap.org/).
21603       parameters:
21604         - name: equipment-name
21605           in: path
21606           required: true
21607           type: string
21608           example: __EQUIPMENT-NAME__
21609         - name: interface-name
21610           in: path
21611           description: Name that identifies the physical interface
21612           required: true
21613           type: string
21614           example: __INTERFACE-NAME__
21615         - name: interface-name
21616           in: path
21617           description: Name given to the interface
21618           required: true
21619           type: string
21620           example: __INTERFACE-NAME__
21621         - name: l3-interface-ipv4-address
21622           in: path
21623           description: IP address
21624           required: true
21625           type: string
21626           example: __L3-INTERFACE-IPV4-ADDRESS__
21627   /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}:
21628     get:
21629       tags:
21630         - Network
21631       summary: returns l3-interface-ipv4-address-list
21632       description: returns l3-interface-ipv4-address-list
21633       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21634       produces:
21635         - application/json
21636         - application/xml
21637       responses:
21638         "200":
21639           description: successful operation
21640           schema:
21641               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
21642         "default":
21643           description: Response codes found in [response codes](https://wiki.onap.org/).
21644       parameters:
21645         - name: equipment-name
21646           in: path
21647           required: true
21648           type: string
21649           example: __EQUIPMENT-NAME__
21650         - name: interface-name
21651           in: path
21652           description: Name that identifies the physical interface
21653           required: true
21654           type: string
21655           example: __INTERFACE-NAME__
21656         - name: interface-name
21657           in: path
21658           description: Name given to the interface
21659           required: true
21660           type: string
21661           example: __INTERFACE-NAME__
21662         - name: l3-interface-ipv4-address
21663           in: path
21664           description: IP address
21665           required: true
21666           type: string
21667           example: __L3-INTERFACE-IPV4-ADDRESS__
21668         - name: prov-status
21669           in: query
21670           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21671           required: false
21672           type: string
21673         - name: interface-id
21674           in: query
21675           description: ID of interface
21676           required: false
21677           type: string
21678         - name: macaddr
21679           in: query
21680           description: MAC address for the interface
21681           required: false
21682           type: string
21683         - name: network-name
21684           in: query
21685           description: Name of the network
21686           required: false
21687           type: string
21688         - name: vlan-id-inner
21689           in: query
21690           description: Inner VLAN tag
21691           required: false
21692           type: integer
21693           format: int64
21694         - name: neutron-network-id
21695           in: query
21696           description: Neutron network id of the interface that address belongs to
21697           required: false
21698           type: string
21699         - name: neutron-subnet-id
21700           in: query
21701           description: Neutron id of subnet that address belongs to
21702           required: false
21703           type: string
21704     put:
21705       tags:
21706         - Network
21707       summary: create or update an existing l3-interface-ipv4-address-list
21708       description: |
21709         Create or update an existing l3-interface-ipv4-address-list.
21710         #
21711         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
21712       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21713       consumes:
21714         - application/json
21715         - application/xml
21716       produces:
21717         - application/json
21718         - application/xml
21719       responses:
21720         "default":
21721           description: Response codes found in [response codes](https://wiki.onap.org/).
21722       parameters:
21723         - name: equipment-name
21724           in: path
21725           required: true
21726           type: string
21727           example: __EQUIPMENT-NAME__
21728         - name: interface-name
21729           in: path
21730           description: Name that identifies the physical interface
21731           required: true
21732           type: string
21733           example: __INTERFACE-NAME__
21734         - name: interface-name
21735           in: path
21736           description: Name given to the interface
21737           required: true
21738           type: string
21739           example: __INTERFACE-NAME__
21740         - name: l3-interface-ipv4-address
21741           in: path
21742           description: IP address
21743           required: true
21744           type: string
21745           example: __L3-INTERFACE-IPV4-ADDRESS__
21746         - name: body
21747           in: body
21748           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
21749           required: true
21750           schema:
21751             $ref: "#/definitions/l3-interface-ipv4-address-list"
21752     patch:
21753       tags:
21754         - Network
21755       summary: update an existing l3-interface-ipv4-address-list
21756       description: |
21757         Update an existing l3-interface-ipv4-address-list
21758         #
21759         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21760         The PUT operation will entirely replace an existing object.
21761         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.
21762         #
21763         Other differences between PUT and PATCH are:
21764         #
21765         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21766         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21767         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21768       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21769       consumes:
21770         - application/json
21771         - application/xml
21772       produces:
21773         - application/json
21774         - application/xml
21775       responses:
21776         "default":
21777           description: Response codes found in [response codes](https://wiki.onap.org/).
21778       parameters:
21779         - name: equipment-name
21780           in: path
21781           required: true
21782           type: string
21783           example: __EQUIPMENT-NAME__
21784         - name: interface-name
21785           in: path
21786           description: Name that identifies the physical interface
21787           required: true
21788           type: string
21789           example: __INTERFACE-NAME__
21790         - name: interface-name
21791           in: path
21792           description: Name given to the interface
21793           required: true
21794           type: string
21795           example: __INTERFACE-NAME__
21796         - name: l3-interface-ipv4-address
21797           in: path
21798           description: IP address
21799           required: true
21800           type: string
21801           example: __L3-INTERFACE-IPV4-ADDRESS__
21802         - name: body
21803           in: body
21804           description: l3-interface-ipv4-address-list object that needs to be created or updated.
21805           required: true
21806           schema:
21807             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
21808     delete:
21809       tags:
21810         - Network
21811       summary: delete an existing l3-interface-ipv4-address-list
21812       description: delete an existing l3-interface-ipv4-address-list
21813       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
21814       consumes:
21815         - application/json
21816         - application/xml
21817       produces:
21818         - application/json
21819         - application/xml
21820       responses:
21821         "default":
21822           description: Response codes found in [response codes](https://wiki.onap.org/).
21823       parameters:
21824         - name: equipment-name
21825           in: path
21826           required: true
21827           type: string
21828           example: __EQUIPMENT-NAME__
21829         - name: interface-name
21830           in: path
21831           description: Name that identifies the physical interface
21832           required: true
21833           type: string
21834           example: __INTERFACE-NAME__
21835         - name: interface-name
21836           in: path
21837           description: Name given to the interface
21838           required: true
21839           type: string
21840           example: __INTERFACE-NAME__
21841         - name: l3-interface-ipv4-address
21842           in: path
21843           description: IP address
21844           required: true
21845           type: string
21846           example: __L3-INTERFACE-IPV4-ADDRESS__
21847         - name: resource-version
21848           in: query
21849           description: resource-version for concurrency
21850           required: true
21851           type: string
21852   /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:
21853     put:
21854       tags:
21855         - Network
21856       summary: see node definition for valid relationships
21857       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21858       consumes:
21859         - application/json
21860         - application/xml
21861       produces:
21862         - application/json
21863         - application/xml
21864       responses:
21865         "default":
21866           description: Response codes found in [response codes](https://wiki.onap.org/).
21867       parameters:
21868         - name: equipment-name
21869           in: path
21870           required: true
21871           type: string
21872           example: __EQUIPMENT-NAME__
21873         - name: interface-name
21874           in: path
21875           description: Name that identifies the physical interface
21876           required: true
21877           type: string
21878           example: __INTERFACE-NAME__
21879         - name: interface-name
21880           in: path
21881           description: Name given to the interface
21882           required: true
21883           type: string
21884           example: __INTERFACE-NAME__
21885         - name: l3-interface-ipv6-address
21886           in: path
21887           description: IP address
21888           required: true
21889           type: string
21890           example: __L3-INTERFACE-IPV6-ADDRESS__
21891         - name: body
21892           in: body
21893           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
21894           required: true
21895           schema:
21896             $ref: "#/definitions/relationship"
21897     delete:
21898       tags:
21899         - Network
21900       summary: delete an existing relationship
21901       description: delete an existing relationship
21902       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
21903       consumes:
21904         - application/json
21905         - application/xml
21906       produces:
21907         - application/json
21908         - application/xml
21909       responses:
21910         "default":
21911           description: Response codes found in [response codes](https://wiki.onap.org/).
21912       parameters:
21913         - name: equipment-name
21914           in: path
21915           required: true
21916           type: string
21917           example: __EQUIPMENT-NAME__
21918         - name: interface-name
21919           in: path
21920           description: Name that identifies the physical interface
21921           required: true
21922           type: string
21923           example: __INTERFACE-NAME__
21924         - name: interface-name
21925           in: path
21926           description: Name given to the interface
21927           required: true
21928           type: string
21929           example: __INTERFACE-NAME__
21930         - name: l3-interface-ipv6-address
21931           in: path
21932           description: IP address
21933           required: true
21934           type: string
21935           example: __L3-INTERFACE-IPV6-ADDRESS__
21936   /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}:
21937     get:
21938       tags:
21939         - Network
21940       summary: returns l3-interface-ipv6-address-list
21941       description: returns l3-interface-ipv6-address-list
21942       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
21943       produces:
21944         - application/json
21945         - application/xml
21946       responses:
21947         "200":
21948           description: successful operation
21949           schema:
21950               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
21951         "default":
21952           description: Response codes found in [response codes](https://wiki.onap.org/).
21953       parameters:
21954         - name: equipment-name
21955           in: path
21956           required: true
21957           type: string
21958           example: __EQUIPMENT-NAME__
21959         - name: interface-name
21960           in: path
21961           description: Name that identifies the physical interface
21962           required: true
21963           type: string
21964           example: __INTERFACE-NAME__
21965         - name: interface-name
21966           in: path
21967           description: Name given to the interface
21968           required: true
21969           type: string
21970           example: __INTERFACE-NAME__
21971         - name: l3-interface-ipv6-address
21972           in: path
21973           description: IP address
21974           required: true
21975           type: string
21976           example: __L3-INTERFACE-IPV6-ADDRESS__
21977         - name: prov-status
21978           in: query
21979           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
21980           required: false
21981           type: string
21982         - name: interface-id
21983           in: query
21984           description: ID of interface
21985           required: false
21986           type: string
21987         - name: macaddr
21988           in: query
21989           description: MAC address for the interface
21990           required: false
21991           type: string
21992         - name: network-name
21993           in: query
21994           description: Name of the network
21995           required: false
21996           type: string
21997         - name: vlan-id-inner
21998           in: query
21999           description: Inner VLAN tag
22000           required: false
22001           type: integer
22002           format: int64
22003         - name: neutron-network-id
22004           in: query
22005           description: Neutron network id of the interface that address belongs to
22006           required: false
22007           type: string
22008         - name: neutron-subnet-id
22009           in: query
22010           description: Neutron id of subnet that address belongs to
22011           required: false
22012           type: string
22013     put:
22014       tags:
22015         - Network
22016       summary: create or update an existing l3-interface-ipv6-address-list
22017       description: |
22018         Create or update an existing l3-interface-ipv6-address-list.
22019         #
22020         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
22021       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22022       consumes:
22023         - application/json
22024         - application/xml
22025       produces:
22026         - application/json
22027         - application/xml
22028       responses:
22029         "default":
22030           description: Response codes found in [response codes](https://wiki.onap.org/).
22031       parameters:
22032         - name: equipment-name
22033           in: path
22034           required: true
22035           type: string
22036           example: __EQUIPMENT-NAME__
22037         - name: interface-name
22038           in: path
22039           description: Name that identifies the physical interface
22040           required: true
22041           type: string
22042           example: __INTERFACE-NAME__
22043         - name: interface-name
22044           in: path
22045           description: Name given to the interface
22046           required: true
22047           type: string
22048           example: __INTERFACE-NAME__
22049         - name: l3-interface-ipv6-address
22050           in: path
22051           description: IP address
22052           required: true
22053           type: string
22054           example: __L3-INTERFACE-IPV6-ADDRESS__
22055         - name: body
22056           in: body
22057           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
22058           required: true
22059           schema:
22060             $ref: "#/definitions/l3-interface-ipv6-address-list"
22061     patch:
22062       tags:
22063         - Network
22064       summary: update an existing l3-interface-ipv6-address-list
22065       description: |
22066         Update an existing l3-interface-ipv6-address-list
22067         #
22068         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22069         The PUT operation will entirely replace an existing object.
22070         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.
22071         #
22072         Other differences between PUT and PATCH are:
22073         #
22074         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22075         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22076         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22077       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22078       consumes:
22079         - application/json
22080         - application/xml
22081       produces:
22082         - application/json
22083         - application/xml
22084       responses:
22085         "default":
22086           description: Response codes found in [response codes](https://wiki.onap.org/).
22087       parameters:
22088         - name: equipment-name
22089           in: path
22090           required: true
22091           type: string
22092           example: __EQUIPMENT-NAME__
22093         - name: interface-name
22094           in: path
22095           description: Name that identifies the physical interface
22096           required: true
22097           type: string
22098           example: __INTERFACE-NAME__
22099         - name: interface-name
22100           in: path
22101           description: Name given to the interface
22102           required: true
22103           type: string
22104           example: __INTERFACE-NAME__
22105         - name: l3-interface-ipv6-address
22106           in: path
22107           description: IP address
22108           required: true
22109           type: string
22110           example: __L3-INTERFACE-IPV6-ADDRESS__
22111         - name: body
22112           in: body
22113           description: l3-interface-ipv6-address-list object that needs to be created or updated.
22114           required: true
22115           schema:
22116             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22117     delete:
22118       tags:
22119         - Network
22120       summary: delete an existing l3-interface-ipv6-address-list
22121       description: delete an existing l3-interface-ipv6-address-list
22122       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
22123       consumes:
22124         - application/json
22125         - application/xml
22126       produces:
22127         - application/json
22128         - application/xml
22129       responses:
22130         "default":
22131           description: Response codes found in [response codes](https://wiki.onap.org/).
22132       parameters:
22133         - name: equipment-name
22134           in: path
22135           required: true
22136           type: string
22137           example: __EQUIPMENT-NAME__
22138         - name: interface-name
22139           in: path
22140           description: Name that identifies the physical interface
22141           required: true
22142           type: string
22143           example: __INTERFACE-NAME__
22144         - name: interface-name
22145           in: path
22146           description: Name given to the interface
22147           required: true
22148           type: string
22149           example: __INTERFACE-NAME__
22150         - name: l3-interface-ipv6-address
22151           in: path
22152           description: IP address
22153           required: true
22154           type: string
22155           example: __L3-INTERFACE-IPV6-ADDRESS__
22156         - name: resource-version
22157           in: query
22158           description: resource-version for concurrency
22159           required: true
22160           type: string
22161   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
22162     get:
22163       tags:
22164         - Network
22165       summary: returns l-interface
22166       description: returns l-interface
22167       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22168       produces:
22169         - application/json
22170         - application/xml
22171       responses:
22172         "200":
22173           description: successful operation
22174           schema:
22175               $ref: "#/getDefinitions/l-interface"
22176         "default":
22177           description: Response codes found in [response codes](https://wiki.onap.org/).
22178       parameters:
22179         - name: equipment-name
22180           in: path
22181           required: true
22182           type: string
22183           example: __EQUIPMENT-NAME__
22184         - name: interface-name
22185           in: path
22186           description: Name that identifies the physical interface
22187           required: true
22188           type: string
22189           example: __INTERFACE-NAME__
22190         - name: interface-name
22191           in: path
22192           description: Name given to the interface
22193           required: true
22194           type: string
22195           example: __INTERFACE-NAME__
22196         - name: prov-status
22197           in: query
22198           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22199           required: false
22200           type: string
22201         - name: interface-id
22202           in: query
22203           description: ID of interface
22204           required: false
22205           type: string
22206         - name: macaddr
22207           in: query
22208           description: MAC address for the interface
22209           required: false
22210           type: string
22211         - name: network-name
22212           in: query
22213           description: Name of the network
22214           required: false
22215           type: string
22216     put:
22217       tags:
22218         - Network
22219       summary: create or update an existing l-interface
22220       description: |
22221         Create or update an existing l-interface.
22222         #
22223         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
22224       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22225       consumes:
22226         - application/json
22227         - application/xml
22228       produces:
22229         - application/json
22230         - application/xml
22231       responses:
22232         "default":
22233           description: Response codes found in [response codes](https://wiki.onap.org/).
22234       parameters:
22235         - name: equipment-name
22236           in: path
22237           required: true
22238           type: string
22239           example: __EQUIPMENT-NAME__
22240         - name: interface-name
22241           in: path
22242           description: Name that identifies the physical interface
22243           required: true
22244           type: string
22245           example: __INTERFACE-NAME__
22246         - name: interface-name
22247           in: path
22248           description: Name given to the interface
22249           required: true
22250           type: string
22251           example: __INTERFACE-NAME__
22252         - name: body
22253           in: body
22254           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
22255           required: true
22256           schema:
22257             $ref: "#/definitions/l-interface"
22258     patch:
22259       tags:
22260         - Network
22261       summary: update an existing l-interface
22262       description: |
22263         Update an existing l-interface
22264         #
22265         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22266         The PUT operation will entirely replace an existing object.
22267         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.
22268         #
22269         Other differences between PUT and PATCH are:
22270         #
22271         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22272         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22273         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22274       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22275       consumes:
22276         - application/json
22277         - application/xml
22278       produces:
22279         - application/json
22280         - application/xml
22281       responses:
22282         "default":
22283           description: Response codes found in [response codes](https://wiki.onap.org/).
22284       parameters:
22285         - name: equipment-name
22286           in: path
22287           required: true
22288           type: string
22289           example: __EQUIPMENT-NAME__
22290         - name: interface-name
22291           in: path
22292           description: Name that identifies the physical interface
22293           required: true
22294           type: string
22295           example: __INTERFACE-NAME__
22296         - name: interface-name
22297           in: path
22298           description: Name given to the interface
22299           required: true
22300           type: string
22301           example: __INTERFACE-NAME__
22302         - name: body
22303           in: body
22304           description: l-interface object that needs to be created or updated.
22305           required: true
22306           schema:
22307             $ref: "#/patchDefinitions/l-interface"
22308     delete:
22309       tags:
22310         - Network
22311       summary: delete an existing l-interface
22312       description: delete an existing l-interface
22313       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
22314       consumes:
22315         - application/json
22316         - application/xml
22317       produces:
22318         - application/json
22319         - application/xml
22320       responses:
22321         "default":
22322           description: Response codes found in [response codes](https://wiki.onap.org/).
22323       parameters:
22324         - name: equipment-name
22325           in: path
22326           required: true
22327           type: string
22328           example: __EQUIPMENT-NAME__
22329         - name: interface-name
22330           in: path
22331           description: Name that identifies the physical interface
22332           required: true
22333           type: string
22334           example: __INTERFACE-NAME__
22335         - name: interface-name
22336           in: path
22337           description: Name given to the interface
22338           required: true
22339           type: string
22340           example: __INTERFACE-NAME__
22341         - name: resource-version
22342           in: query
22343           description: resource-version for concurrency
22344           required: true
22345           type: string
22346   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
22347     get:
22348       tags:
22349         - Network
22350       summary: returns l-interfaces
22351       description: returns l-interfaces
22352       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
22353       produces:
22354         - application/json
22355         - application/xml
22356       responses:
22357         "200":
22358           description: successful operation
22359           schema:
22360               $ref: "#/getDefinitions/l-interfaces"
22361         "default":
22362           description: Response codes found in [response codes](https://wiki.onap.org/).
22363       parameters:
22364         - name: equipment-name
22365           in: path
22366           required: true
22367           type: string
22368           example: __EQUIPMENT-NAME__
22369         - name: interface-name
22370           in: path
22371           description: Name that identifies the physical interface
22372           required: true
22373           type: string
22374           example: __INTERFACE-NAME__
22375         - name: prov-status
22376           in: query
22377           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22378           required: false
22379           type: string
22380   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
22381     get:
22382       tags:
22383         - Network
22384       summary: returns p-interface
22385       description: returns p-interface
22386       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
22387       produces:
22388         - application/json
22389         - application/xml
22390       responses:
22391         "200":
22392           description: successful operation
22393           schema:
22394               $ref: "#/getDefinitions/p-interface"
22395         "default":
22396           description: Response codes found in [response codes](https://wiki.onap.org/).
22397       parameters:
22398         - name: equipment-name
22399           in: path
22400           required: true
22401           type: string
22402           example: __EQUIPMENT-NAME__
22403         - name: interface-name
22404           in: path
22405           description: Name that identifies the physical interface
22406           required: true
22407           type: string
22408           example: __INTERFACE-NAME__
22409         - name: prov-status
22410           in: query
22411           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22412           required: false
22413           type: string
22414     put:
22415       tags:
22416         - Network
22417       summary: create or update an existing p-interface
22418       description: |
22419         Create or update an existing p-interface.
22420         #
22421         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
22422       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
22423       consumes:
22424         - application/json
22425         - application/xml
22426       produces:
22427         - application/json
22428         - application/xml
22429       responses:
22430         "default":
22431           description: Response codes found in [response codes](https://wiki.onap.org/).
22432       parameters:
22433         - name: equipment-name
22434           in: path
22435           required: true
22436           type: string
22437           example: __EQUIPMENT-NAME__
22438         - name: interface-name
22439           in: path
22440           description: Name that identifies the physical interface
22441           required: true
22442           type: string
22443           example: __INTERFACE-NAME__
22444         - name: body
22445           in: body
22446           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPePInterfacesPInterface.json)
22447           required: true
22448           schema:
22449             $ref: "#/definitions/p-interface"
22450     patch:
22451       tags:
22452         - Network
22453       summary: update an existing p-interface
22454       description: |
22455         Update an existing p-interface
22456         #
22457         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22458         The PUT operation will entirely replace an existing object.
22459         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.
22460         #
22461         Other differences between PUT and PATCH are:
22462         #
22463         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22464         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22465         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22466       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
22467       consumes:
22468         - application/json
22469         - application/xml
22470       produces:
22471         - application/json
22472         - application/xml
22473       responses:
22474         "default":
22475           description: Response codes found in [response codes](https://wiki.onap.org/).
22476       parameters:
22477         - name: equipment-name
22478           in: path
22479           required: true
22480           type: string
22481           example: __EQUIPMENT-NAME__
22482         - name: interface-name
22483           in: path
22484           description: Name that identifies the physical interface
22485           required: true
22486           type: string
22487           example: __INTERFACE-NAME__
22488         - name: body
22489           in: body
22490           description: p-interface object that needs to be created or updated.
22491           required: true
22492           schema:
22493             $ref: "#/patchDefinitions/p-interface"
22494     delete:
22495       tags:
22496         - Network
22497       summary: delete an existing p-interface
22498       description: delete an existing p-interface
22499       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
22500       consumes:
22501         - application/json
22502         - application/xml
22503       produces:
22504         - application/json
22505         - application/xml
22506       responses:
22507         "default":
22508           description: Response codes found in [response codes](https://wiki.onap.org/).
22509       parameters:
22510         - name: equipment-name
22511           in: path
22512           required: true
22513           type: string
22514           example: __EQUIPMENT-NAME__
22515         - name: interface-name
22516           in: path
22517           description: Name that identifies the physical interface
22518           required: true
22519           type: string
22520           example: __INTERFACE-NAME__
22521         - name: resource-version
22522           in: query
22523           description: resource-version for concurrency
22524           required: true
22525           type: string
22526   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
22527     get:
22528       tags:
22529         - Network
22530       summary: returns p-interfaces
22531       description: returns p-interfaces
22532       operationId: getNetworkVplsPesVplsPePInterfaces
22533       produces:
22534         - application/json
22535         - application/xml
22536       responses:
22537         "200":
22538           description: successful operation
22539           schema:
22540               $ref: "#/getDefinitions/p-interfaces"
22541         "default":
22542           description: Response codes found in [response codes](https://wiki.onap.org/).
22543       parameters:
22544         - name: equipment-name
22545           in: path
22546           required: true
22547           type: string
22548           example: __EQUIPMENT-NAME__
22549         - name: prov-status
22550           in: query
22551           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22552           required: false
22553           type: string
22554   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
22555     put:
22556       tags:
22557         - Network
22558       summary: see node definition for valid relationships
22559       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
22560       consumes:
22561         - application/json
22562         - application/xml
22563       produces:
22564         - application/json
22565         - application/xml
22566       responses:
22567         "default":
22568           description: Response codes found in [response codes](https://wiki.onap.org/).
22569       parameters:
22570         - name: equipment-name
22571           in: path
22572           required: true
22573           type: string
22574           example: __EQUIPMENT-NAME__
22575         - name: interface-name
22576           in: path
22577           description: Name that identifies the link aggregate interface
22578           required: true
22579           type: string
22580           example: __INTERFACE-NAME__
22581         - name: body
22582           in: body
22583           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
22584           required: true
22585           schema:
22586             $ref: "#/definitions/relationship"
22587     delete:
22588       tags:
22589         - Network
22590       summary: delete an existing relationship
22591       description: delete an existing relationship
22592       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
22593       consumes:
22594         - application/json
22595         - application/xml
22596       produces:
22597         - application/json
22598         - application/xml
22599       responses:
22600         "default":
22601           description: Response codes found in [response codes](https://wiki.onap.org/).
22602       parameters:
22603         - name: equipment-name
22604           in: path
22605           required: true
22606           type: string
22607           example: __EQUIPMENT-NAME__
22608         - name: interface-name
22609           in: path
22610           description: Name that identifies the link aggregate interface
22611           required: true
22612           type: string
22613           example: __INTERFACE-NAME__
22614   /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:
22615     put:
22616       tags:
22617         - Network
22618       summary: see node definition for valid relationships
22619       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22620       consumes:
22621         - application/json
22622         - application/xml
22623       produces:
22624         - application/json
22625         - application/xml
22626       responses:
22627         "default":
22628           description: Response codes found in [response codes](https://wiki.onap.org/).
22629       parameters:
22630         - name: equipment-name
22631           in: path
22632           required: true
22633           type: string
22634           example: __EQUIPMENT-NAME__
22635         - name: interface-name
22636           in: path
22637           description: Name that identifies the link aggregate interface
22638           required: true
22639           type: string
22640           example: __INTERFACE-NAME__
22641         - name: interface-name
22642           in: path
22643           description: Name given to the interface
22644           required: true
22645           type: string
22646           example: __INTERFACE-NAME__
22647         - name: vlan-interface
22648           in: path
22649           description: String that identifies the interface
22650           required: true
22651           type: string
22652           example: __VLAN-INTERFACE__
22653         - name: body
22654           in: body
22655           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
22656           required: true
22657           schema:
22658             $ref: "#/definitions/relationship"
22659     delete:
22660       tags:
22661         - Network
22662       summary: delete an existing relationship
22663       description: delete an existing relationship
22664       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
22665       consumes:
22666         - application/json
22667         - application/xml
22668       produces:
22669         - application/json
22670         - application/xml
22671       responses:
22672         "default":
22673           description: Response codes found in [response codes](https://wiki.onap.org/).
22674       parameters:
22675         - name: equipment-name
22676           in: path
22677           required: true
22678           type: string
22679           example: __EQUIPMENT-NAME__
22680         - name: interface-name
22681           in: path
22682           description: Name that identifies the link aggregate interface
22683           required: true
22684           type: string
22685           example: __INTERFACE-NAME__
22686         - name: interface-name
22687           in: path
22688           description: Name given to the interface
22689           required: true
22690           type: string
22691           example: __INTERFACE-NAME__
22692         - name: vlan-interface
22693           in: path
22694           description: String that identifies the interface
22695           required: true
22696           type: string
22697           example: __VLAN-INTERFACE__
22698   /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:
22699     put:
22700       tags:
22701         - Network
22702       summary: see node definition for valid relationships
22703       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22704       consumes:
22705         - application/json
22706         - application/xml
22707       produces:
22708         - application/json
22709         - application/xml
22710       responses:
22711         "default":
22712           description: Response codes found in [response codes](https://wiki.onap.org/).
22713       parameters:
22714         - name: equipment-name
22715           in: path
22716           required: true
22717           type: string
22718           example: __EQUIPMENT-NAME__
22719         - name: interface-name
22720           in: path
22721           description: Name that identifies the link aggregate interface
22722           required: true
22723           type: string
22724           example: __INTERFACE-NAME__
22725         - name: interface-name
22726           in: path
22727           description: Name given to the interface
22728           required: true
22729           type: string
22730           example: __INTERFACE-NAME__
22731         - name: vlan-interface
22732           in: path
22733           description: String that identifies the interface
22734           required: true
22735           type: string
22736           example: __VLAN-INTERFACE__
22737         - name: l3-interface-ipv4-address
22738           in: path
22739           description: IP address
22740           required: true
22741           type: string
22742           example: __L3-INTERFACE-IPV4-ADDRESS__
22743         - name: body
22744           in: body
22745           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22746           required: true
22747           schema:
22748             $ref: "#/definitions/relationship"
22749     delete:
22750       tags:
22751         - Network
22752       summary: delete an existing relationship
22753       description: delete an existing relationship
22754       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22755       consumes:
22756         - application/json
22757         - application/xml
22758       produces:
22759         - application/json
22760         - application/xml
22761       responses:
22762         "default":
22763           description: Response codes found in [response codes](https://wiki.onap.org/).
22764       parameters:
22765         - name: equipment-name
22766           in: path
22767           required: true
22768           type: string
22769           example: __EQUIPMENT-NAME__
22770         - name: interface-name
22771           in: path
22772           description: Name that identifies the link aggregate interface
22773           required: true
22774           type: string
22775           example: __INTERFACE-NAME__
22776         - name: interface-name
22777           in: path
22778           description: Name given to the interface
22779           required: true
22780           type: string
22781           example: __INTERFACE-NAME__
22782         - name: vlan-interface
22783           in: path
22784           description: String that identifies the interface
22785           required: true
22786           type: string
22787           example: __VLAN-INTERFACE__
22788         - name: l3-interface-ipv4-address
22789           in: path
22790           description: IP address
22791           required: true
22792           type: string
22793           example: __L3-INTERFACE-IPV4-ADDRESS__
22794   /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}:
22795     get:
22796       tags:
22797         - Network
22798       summary: returns l3-interface-ipv4-address-list
22799       description: returns l3-interface-ipv4-address-list
22800       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22801       produces:
22802         - application/json
22803         - application/xml
22804       responses:
22805         "200":
22806           description: successful operation
22807           schema:
22808               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22809         "default":
22810           description: Response codes found in [response codes](https://wiki.onap.org/).
22811       parameters:
22812         - name: equipment-name
22813           in: path
22814           required: true
22815           type: string
22816           example: __EQUIPMENT-NAME__
22817         - name: interface-name
22818           in: path
22819           description: Name that identifies the link aggregate interface
22820           required: true
22821           type: string
22822           example: __INTERFACE-NAME__
22823         - name: interface-name
22824           in: path
22825           description: Name given to the interface
22826           required: true
22827           type: string
22828           example: __INTERFACE-NAME__
22829         - name: vlan-interface
22830           in: path
22831           description: String that identifies the interface
22832           required: true
22833           type: string
22834           example: __VLAN-INTERFACE__
22835         - name: l3-interface-ipv4-address
22836           in: path
22837           description: IP address
22838           required: true
22839           type: string
22840           example: __L3-INTERFACE-IPV4-ADDRESS__
22841         - name: prov-status
22842           in: query
22843           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22844           required: false
22845           type: string
22846         - name: interface-id
22847           in: query
22848           description: ID of interface
22849           required: false
22850           type: string
22851         - name: macaddr
22852           in: query
22853           description: MAC address for the interface
22854           required: false
22855           type: string
22856         - name: network-name
22857           in: query
22858           description: Name of the network
22859           required: false
22860           type: string
22861         - name: vlan-id-inner
22862           in: query
22863           description: Inner VLAN tag
22864           required: false
22865           type: integer
22866           format: int64
22867         - name: vpn-id
22868           in: query
22869           description: This indicates the customers VPN ID associated with this vlan
22870           required: false
22871           type: string
22872         - name: vlan-id-inner
22873           in: query
22874           description: Inner VLAN tag
22875           required: false
22876           type: integer
22877           format: int64
22878         - name: neutron-network-id
22879           in: query
22880           description: Neutron network id of the interface that address belongs to
22881           required: false
22882           type: string
22883         - name: neutron-subnet-id
22884           in: query
22885           description: Neutron id of subnet that address belongs to
22886           required: false
22887           type: string
22888     put:
22889       tags:
22890         - Network
22891       summary: create or update an existing l3-interface-ipv4-address-list
22892       description: |
22893         Create or update an existing l3-interface-ipv4-address-list.
22894         #
22895         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
22896       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22897       consumes:
22898         - application/json
22899         - application/xml
22900       produces:
22901         - application/json
22902         - application/xml
22903       responses:
22904         "default":
22905           description: Response codes found in [response codes](https://wiki.onap.org/).
22906       parameters:
22907         - name: equipment-name
22908           in: path
22909           required: true
22910           type: string
22911           example: __EQUIPMENT-NAME__
22912         - name: interface-name
22913           in: path
22914           description: Name that identifies the link aggregate interface
22915           required: true
22916           type: string
22917           example: __INTERFACE-NAME__
22918         - name: interface-name
22919           in: path
22920           description: Name given to the interface
22921           required: true
22922           type: string
22923           example: __INTERFACE-NAME__
22924         - name: vlan-interface
22925           in: path
22926           description: String that identifies the interface
22927           required: true
22928           type: string
22929           example: __VLAN-INTERFACE__
22930         - name: l3-interface-ipv4-address
22931           in: path
22932           description: IP address
22933           required: true
22934           type: string
22935           example: __L3-INTERFACE-IPV4-ADDRESS__
22936         - name: body
22937           in: body
22938           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22939           required: true
22940           schema:
22941             $ref: "#/definitions/l3-interface-ipv4-address-list"
22942     patch:
22943       tags:
22944         - Network
22945       summary: update an existing l3-interface-ipv4-address-list
22946       description: |
22947         Update an existing l3-interface-ipv4-address-list
22948         #
22949         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22950         The PUT operation will entirely replace an existing object.
22951         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.
22952         #
22953         Other differences between PUT and PATCH are:
22954         #
22955         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22956         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22957         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22958       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22959       consumes:
22960         - application/json
22961         - application/xml
22962       produces:
22963         - application/json
22964         - application/xml
22965       responses:
22966         "default":
22967           description: Response codes found in [response codes](https://wiki.onap.org/).
22968       parameters:
22969         - name: equipment-name
22970           in: path
22971           required: true
22972           type: string
22973           example: __EQUIPMENT-NAME__
22974         - name: interface-name
22975           in: path
22976           description: Name that identifies the link aggregate interface
22977           required: true
22978           type: string
22979           example: __INTERFACE-NAME__
22980         - name: interface-name
22981           in: path
22982           description: Name given to the interface
22983           required: true
22984           type: string
22985           example: __INTERFACE-NAME__
22986         - name: vlan-interface
22987           in: path
22988           description: String that identifies the interface
22989           required: true
22990           type: string
22991           example: __VLAN-INTERFACE__
22992         - name: l3-interface-ipv4-address
22993           in: path
22994           description: IP address
22995           required: true
22996           type: string
22997           example: __L3-INTERFACE-IPV4-ADDRESS__
22998         - name: body
22999           in: body
23000           description: l3-interface-ipv4-address-list object that needs to be created or updated.
23001           required: true
23002           schema:
23003             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23004     delete:
23005       tags:
23006         - Network
23007       summary: delete an existing l3-interface-ipv4-address-list
23008       description: delete an existing l3-interface-ipv4-address-list
23009       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
23010       consumes:
23011         - application/json
23012         - application/xml
23013       produces:
23014         - application/json
23015         - application/xml
23016       responses:
23017         "default":
23018           description: Response codes found in [response codes](https://wiki.onap.org/).
23019       parameters:
23020         - name: equipment-name
23021           in: path
23022           required: true
23023           type: string
23024           example: __EQUIPMENT-NAME__
23025         - name: interface-name
23026           in: path
23027           description: Name that identifies the link aggregate interface
23028           required: true
23029           type: string
23030           example: __INTERFACE-NAME__
23031         - name: interface-name
23032           in: path
23033           description: Name given to the interface
23034           required: true
23035           type: string
23036           example: __INTERFACE-NAME__
23037         - name: vlan-interface
23038           in: path
23039           description: String that identifies the interface
23040           required: true
23041           type: string
23042           example: __VLAN-INTERFACE__
23043         - name: l3-interface-ipv4-address
23044           in: path
23045           description: IP address
23046           required: true
23047           type: string
23048           example: __L3-INTERFACE-IPV4-ADDRESS__
23049         - name: resource-version
23050           in: query
23051           description: resource-version for concurrency
23052           required: true
23053           type: string
23054   /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:
23055     put:
23056       tags:
23057         - Network
23058       summary: see node definition for valid relationships
23059       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23060       consumes:
23061         - application/json
23062         - application/xml
23063       produces:
23064         - application/json
23065         - application/xml
23066       responses:
23067         "default":
23068           description: Response codes found in [response codes](https://wiki.onap.org/).
23069       parameters:
23070         - name: equipment-name
23071           in: path
23072           required: true
23073           type: string
23074           example: __EQUIPMENT-NAME__
23075         - name: interface-name
23076           in: path
23077           description: Name that identifies the link aggregate interface
23078           required: true
23079           type: string
23080           example: __INTERFACE-NAME__
23081         - name: interface-name
23082           in: path
23083           description: Name given to the interface
23084           required: true
23085           type: string
23086           example: __INTERFACE-NAME__
23087         - name: vlan-interface
23088           in: path
23089           description: String that identifies the interface
23090           required: true
23091           type: string
23092           example: __VLAN-INTERFACE__
23093         - name: l3-interface-ipv6-address
23094           in: path
23095           description: IP address
23096           required: true
23097           type: string
23098           example: __L3-INTERFACE-IPV6-ADDRESS__
23099         - name: body
23100           in: body
23101           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23102           required: true
23103           schema:
23104             $ref: "#/definitions/relationship"
23105     delete:
23106       tags:
23107         - Network
23108       summary: delete an existing relationship
23109       description: delete an existing relationship
23110       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
23111       consumes:
23112         - application/json
23113         - application/xml
23114       produces:
23115         - application/json
23116         - application/xml
23117       responses:
23118         "default":
23119           description: Response codes found in [response codes](https://wiki.onap.org/).
23120       parameters:
23121         - name: equipment-name
23122           in: path
23123           required: true
23124           type: string
23125           example: __EQUIPMENT-NAME__
23126         - name: interface-name
23127           in: path
23128           description: Name that identifies the link aggregate interface
23129           required: true
23130           type: string
23131           example: __INTERFACE-NAME__
23132         - name: interface-name
23133           in: path
23134           description: Name given to the interface
23135           required: true
23136           type: string
23137           example: __INTERFACE-NAME__
23138         - name: vlan-interface
23139           in: path
23140           description: String that identifies the interface
23141           required: true
23142           type: string
23143           example: __VLAN-INTERFACE__
23144         - name: l3-interface-ipv6-address
23145           in: path
23146           description: IP address
23147           required: true
23148           type: string
23149           example: __L3-INTERFACE-IPV6-ADDRESS__
23150   /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}:
23151     get:
23152       tags:
23153         - Network
23154       summary: returns l3-interface-ipv6-address-list
23155       description: returns l3-interface-ipv6-address-list
23156       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23157       produces:
23158         - application/json
23159         - application/xml
23160       responses:
23161         "200":
23162           description: successful operation
23163           schema:
23164               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
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 link aggregate 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: vlan-interface
23186           in: path
23187           description: String that identifies the interface
23188           required: true
23189           type: string
23190           example: __VLAN-INTERFACE__
23191         - name: l3-interface-ipv6-address
23192           in: path
23193           description: IP address
23194           required: true
23195           type: string
23196           example: __L3-INTERFACE-IPV6-ADDRESS__
23197         - name: prov-status
23198           in: query
23199           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23200           required: false
23201           type: string
23202         - name: interface-id
23203           in: query
23204           description: ID of interface
23205           required: false
23206           type: string
23207         - name: macaddr
23208           in: query
23209           description: MAC address for the interface
23210           required: false
23211           type: string
23212         - name: network-name
23213           in: query
23214           description: Name of the network
23215           required: false
23216           type: string
23217         - name: vlan-id-inner
23218           in: query
23219           description: Inner VLAN tag
23220           required: false
23221           type: integer
23222           format: int64
23223         - name: vpn-id
23224           in: query
23225           description: This indicates the customers VPN ID associated with this vlan
23226           required: false
23227           type: string
23228         - name: vlan-id-inner
23229           in: query
23230           description: Inner VLAN tag
23231           required: false
23232           type: integer
23233           format: int64
23234         - name: neutron-network-id
23235           in: query
23236           description: Neutron network id of the interface that address belongs to
23237           required: false
23238           type: string
23239         - name: neutron-subnet-id
23240           in: query
23241           description: Neutron id of subnet that address belongs to
23242           required: false
23243           type: string
23244     put:
23245       tags:
23246         - Network
23247       summary: create or update an existing l3-interface-ipv6-address-list
23248       description: |
23249         Create or update an existing l3-interface-ipv6-address-list.
23250         #
23251         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
23252       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23253       consumes:
23254         - application/json
23255         - application/xml
23256       produces:
23257         - application/json
23258         - application/xml
23259       responses:
23260         "default":
23261           description: Response codes found in [response codes](https://wiki.onap.org/).
23262       parameters:
23263         - name: equipment-name
23264           in: path
23265           required: true
23266           type: string
23267           example: __EQUIPMENT-NAME__
23268         - name: interface-name
23269           in: path
23270           description: Name that identifies the link aggregate interface
23271           required: true
23272           type: string
23273           example: __INTERFACE-NAME__
23274         - name: interface-name
23275           in: path
23276           description: Name given to the interface
23277           required: true
23278           type: string
23279           example: __INTERFACE-NAME__
23280         - name: vlan-interface
23281           in: path
23282           description: String that identifies the interface
23283           required: true
23284           type: string
23285           example: __VLAN-INTERFACE__
23286         - name: l3-interface-ipv6-address
23287           in: path
23288           description: IP address
23289           required: true
23290           type: string
23291           example: __L3-INTERFACE-IPV6-ADDRESS__
23292         - name: body
23293           in: body
23294           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
23295           required: true
23296           schema:
23297             $ref: "#/definitions/l3-interface-ipv6-address-list"
23298     patch:
23299       tags:
23300         - Network
23301       summary: update an existing l3-interface-ipv6-address-list
23302       description: |
23303         Update an existing l3-interface-ipv6-address-list
23304         #
23305         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23306         The PUT operation will entirely replace an existing object.
23307         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.
23308         #
23309         Other differences between PUT and PATCH are:
23310         #
23311         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23312         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23313         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23314       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23315       consumes:
23316         - application/json
23317         - application/xml
23318       produces:
23319         - application/json
23320         - application/xml
23321       responses:
23322         "default":
23323           description: Response codes found in [response codes](https://wiki.onap.org/).
23324       parameters:
23325         - name: equipment-name
23326           in: path
23327           required: true
23328           type: string
23329           example: __EQUIPMENT-NAME__
23330         - name: interface-name
23331           in: path
23332           description: Name that identifies the link aggregate interface
23333           required: true
23334           type: string
23335           example: __INTERFACE-NAME__
23336         - name: interface-name
23337           in: path
23338           description: Name given to the interface
23339           required: true
23340           type: string
23341           example: __INTERFACE-NAME__
23342         - name: vlan-interface
23343           in: path
23344           description: String that identifies the interface
23345           required: true
23346           type: string
23347           example: __VLAN-INTERFACE__
23348         - name: l3-interface-ipv6-address
23349           in: path
23350           description: IP address
23351           required: true
23352           type: string
23353           example: __L3-INTERFACE-IPV6-ADDRESS__
23354         - name: body
23355           in: body
23356           description: l3-interface-ipv6-address-list object that needs to be created or updated.
23357           required: true
23358           schema:
23359             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
23360     delete:
23361       tags:
23362         - Network
23363       summary: delete an existing l3-interface-ipv6-address-list
23364       description: delete an existing l3-interface-ipv6-address-list
23365       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
23366       consumes:
23367         - application/json
23368         - application/xml
23369       produces:
23370         - application/json
23371         - application/xml
23372       responses:
23373         "default":
23374           description: Response codes found in [response codes](https://wiki.onap.org/).
23375       parameters:
23376         - name: equipment-name
23377           in: path
23378           required: true
23379           type: string
23380           example: __EQUIPMENT-NAME__
23381         - name: interface-name
23382           in: path
23383           description: Name that identifies the link aggregate interface
23384           required: true
23385           type: string
23386           example: __INTERFACE-NAME__
23387         - name: interface-name
23388           in: path
23389           description: Name given to the interface
23390           required: true
23391           type: string
23392           example: __INTERFACE-NAME__
23393         - name: vlan-interface
23394           in: path
23395           description: String that identifies the interface
23396           required: true
23397           type: string
23398           example: __VLAN-INTERFACE__
23399         - name: l3-interface-ipv6-address
23400           in: path
23401           description: IP address
23402           required: true
23403           type: string
23404           example: __L3-INTERFACE-IPV6-ADDRESS__
23405         - name: resource-version
23406           in: query
23407           description: resource-version for concurrency
23408           required: true
23409           type: string
23410   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
23411     get:
23412       tags:
23413         - Network
23414       summary: returns vlan
23415       description: returns vlan
23416       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23417       produces:
23418         - application/json
23419         - application/xml
23420       responses:
23421         "200":
23422           description: successful operation
23423           schema:
23424               $ref: "#/getDefinitions/vlan"
23425         "default":
23426           description: Response codes found in [response codes](https://wiki.onap.org/).
23427       parameters:
23428         - name: equipment-name
23429           in: path
23430           required: true
23431           type: string
23432           example: __EQUIPMENT-NAME__
23433         - name: interface-name
23434           in: path
23435           description: Name that identifies the link aggregate interface
23436           required: true
23437           type: string
23438           example: __INTERFACE-NAME__
23439         - name: interface-name
23440           in: path
23441           description: Name given to the interface
23442           required: true
23443           type: string
23444           example: __INTERFACE-NAME__
23445         - name: vlan-interface
23446           in: path
23447           description: String that identifies the interface
23448           required: true
23449           type: string
23450           example: __VLAN-INTERFACE__
23451         - name: prov-status
23452           in: query
23453           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23454           required: false
23455           type: string
23456         - name: interface-id
23457           in: query
23458           description: ID of interface
23459           required: false
23460           type: string
23461         - name: macaddr
23462           in: query
23463           description: MAC address for the interface
23464           required: false
23465           type: string
23466         - name: network-name
23467           in: query
23468           description: Name of the network
23469           required: false
23470           type: string
23471         - name: vlan-id-inner
23472           in: query
23473           description: Inner VLAN tag
23474           required: false
23475           type: integer
23476           format: int64
23477         - name: vpn-id
23478           in: query
23479           description: This indicates the customers VPN ID associated with this vlan
23480           required: false
23481           type: string
23482     put:
23483       tags:
23484         - Network
23485       summary: create or update an existing vlan
23486       description: |
23487         Create or update an existing vlan.
23488         #
23489         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
23490       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23491       consumes:
23492         - application/json
23493         - application/xml
23494       produces:
23495         - application/json
23496         - application/xml
23497       responses:
23498         "default":
23499           description: Response codes found in [response codes](https://wiki.onap.org/).
23500       parameters:
23501         - name: equipment-name
23502           in: path
23503           required: true
23504           type: string
23505           example: __EQUIPMENT-NAME__
23506         - name: interface-name
23507           in: path
23508           description: Name that identifies the link aggregate interface
23509           required: true
23510           type: string
23511           example: __INTERFACE-NAME__
23512         - name: interface-name
23513           in: path
23514           description: Name given to the interface
23515           required: true
23516           type: string
23517           example: __INTERFACE-NAME__
23518         - name: vlan-interface
23519           in: path
23520           description: String that identifies the interface
23521           required: true
23522           type: string
23523           example: __VLAN-INTERFACE__
23524         - name: body
23525           in: body
23526           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
23527           required: true
23528           schema:
23529             $ref: "#/definitions/vlan"
23530     patch:
23531       tags:
23532         - Network
23533       summary: update an existing vlan
23534       description: |
23535         Update an existing vlan
23536         #
23537         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23538         The PUT operation will entirely replace an existing object.
23539         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.
23540         #
23541         Other differences between PUT and PATCH are:
23542         #
23543         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23544         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23545         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23546       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23547       consumes:
23548         - application/json
23549         - application/xml
23550       produces:
23551         - application/json
23552         - application/xml
23553       responses:
23554         "default":
23555           description: Response codes found in [response codes](https://wiki.onap.org/).
23556       parameters:
23557         - name: equipment-name
23558           in: path
23559           required: true
23560           type: string
23561           example: __EQUIPMENT-NAME__
23562         - name: interface-name
23563           in: path
23564           description: Name that identifies the link aggregate interface
23565           required: true
23566           type: string
23567           example: __INTERFACE-NAME__
23568         - name: interface-name
23569           in: path
23570           description: Name given to the interface
23571           required: true
23572           type: string
23573           example: __INTERFACE-NAME__
23574         - name: vlan-interface
23575           in: path
23576           description: String that identifies the interface
23577           required: true
23578           type: string
23579           example: __VLAN-INTERFACE__
23580         - name: body
23581           in: body
23582           description: vlan object that needs to be created or updated.
23583           required: true
23584           schema:
23585             $ref: "#/patchDefinitions/vlan"
23586     delete:
23587       tags:
23588         - Network
23589       summary: delete an existing vlan
23590       description: delete an existing vlan
23591       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
23592       consumes:
23593         - application/json
23594         - application/xml
23595       produces:
23596         - application/json
23597         - application/xml
23598       responses:
23599         "default":
23600           description: Response codes found in [response codes](https://wiki.onap.org/).
23601       parameters:
23602         - name: equipment-name
23603           in: path
23604           required: true
23605           type: string
23606           example: __EQUIPMENT-NAME__
23607         - name: interface-name
23608           in: path
23609           description: Name that identifies the link aggregate interface
23610           required: true
23611           type: string
23612           example: __INTERFACE-NAME__
23613         - name: interface-name
23614           in: path
23615           description: Name given to the interface
23616           required: true
23617           type: string
23618           example: __INTERFACE-NAME__
23619         - name: vlan-interface
23620           in: path
23621           description: String that identifies the interface
23622           required: true
23623           type: string
23624           example: __VLAN-INTERFACE__
23625         - name: resource-version
23626           in: query
23627           description: resource-version for concurrency
23628           required: true
23629           type: string
23630   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
23631     get:
23632       tags:
23633         - Network
23634       summary: returns vlans
23635       description: returns vlans
23636       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
23637       produces:
23638         - application/json
23639         - application/xml
23640       responses:
23641         "200":
23642           description: successful operation
23643           schema:
23644               $ref: "#/getDefinitions/vlans"
23645         "default":
23646           description: Response codes found in [response codes](https://wiki.onap.org/).
23647       parameters:
23648         - name: equipment-name
23649           in: path
23650           required: true
23651           type: string
23652           example: __EQUIPMENT-NAME__
23653         - name: interface-name
23654           in: path
23655           description: Name that identifies the link aggregate interface
23656           required: true
23657           type: string
23658           example: __INTERFACE-NAME__
23659         - name: interface-name
23660           in: path
23661           description: Name given to the interface
23662           required: true
23663           type: string
23664           example: __INTERFACE-NAME__
23665         - name: prov-status
23666           in: query
23667           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23668           required: false
23669           type: string
23670         - name: interface-id
23671           in: query
23672           description: ID of interface
23673           required: false
23674           type: string
23675         - name: macaddr
23676           in: query
23677           description: MAC address for the interface
23678           required: false
23679           type: string
23680         - name: network-name
23681           in: query
23682           description: Name of the network
23683           required: false
23684           type: string
23685   /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:
23686     put:
23687       tags:
23688         - Network
23689       summary: see node definition for valid relationships
23690       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23691       consumes:
23692         - application/json
23693         - application/xml
23694       produces:
23695         - application/json
23696         - application/xml
23697       responses:
23698         "default":
23699           description: Response codes found in [response codes](https://wiki.onap.org/).
23700       parameters:
23701         - name: equipment-name
23702           in: path
23703           required: true
23704           type: string
23705           example: __EQUIPMENT-NAME__
23706         - name: interface-name
23707           in: path
23708           description: Name that identifies the link aggregate interface
23709           required: true
23710           type: string
23711           example: __INTERFACE-NAME__
23712         - name: interface-name
23713           in: path
23714           description: Name given to the interface
23715           required: true
23716           type: string
23717           example: __INTERFACE-NAME__
23718         - name: pci-id
23719           in: path
23720           description: PCI ID used to identify the sriov-vf
23721           required: true
23722           type: string
23723           example: __PCI-ID__
23724         - name: body
23725           in: body
23726           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23727           required: true
23728           schema:
23729             $ref: "#/definitions/relationship"
23730     delete:
23731       tags:
23732         - Network
23733       summary: delete an existing relationship
23734       description: delete an existing relationship
23735       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23736       consumes:
23737         - application/json
23738         - application/xml
23739       produces:
23740         - application/json
23741         - application/xml
23742       responses:
23743         "default":
23744           description: Response codes found in [response codes](https://wiki.onap.org/).
23745       parameters:
23746         - name: equipment-name
23747           in: path
23748           required: true
23749           type: string
23750           example: __EQUIPMENT-NAME__
23751         - name: interface-name
23752           in: path
23753           description: Name that identifies the link aggregate interface
23754           required: true
23755           type: string
23756           example: __INTERFACE-NAME__
23757         - name: interface-name
23758           in: path
23759           description: Name given to the interface
23760           required: true
23761           type: string
23762           example: __INTERFACE-NAME__
23763         - name: pci-id
23764           in: path
23765           description: PCI ID used to identify the sriov-vf
23766           required: true
23767           type: string
23768           example: __PCI-ID__
23769   /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}:
23770     get:
23771       tags:
23772         - Network
23773       summary: returns sriov-vf
23774       description: returns sriov-vf
23775       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23776       produces:
23777         - application/json
23778         - application/xml
23779       responses:
23780         "200":
23781           description: successful operation
23782           schema:
23783               $ref: "#/getDefinitions/sriov-vf"
23784         "default":
23785           description: Response codes found in [response codes](https://wiki.onap.org/).
23786       parameters:
23787         - name: equipment-name
23788           in: path
23789           required: true
23790           type: string
23791           example: __EQUIPMENT-NAME__
23792         - name: interface-name
23793           in: path
23794           description: Name that identifies the link aggregate interface
23795           required: true
23796           type: string
23797           example: __INTERFACE-NAME__
23798         - name: interface-name
23799           in: path
23800           description: Name given to the interface
23801           required: true
23802           type: string
23803           example: __INTERFACE-NAME__
23804         - name: pci-id
23805           in: path
23806           description: PCI ID used to identify the sriov-vf
23807           required: true
23808           type: string
23809           example: __PCI-ID__
23810         - name: prov-status
23811           in: query
23812           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23813           required: false
23814           type: string
23815         - name: interface-id
23816           in: query
23817           description: ID of interface
23818           required: false
23819           type: string
23820         - name: macaddr
23821           in: query
23822           description: MAC address for the interface
23823           required: false
23824           type: string
23825         - name: network-name
23826           in: query
23827           description: Name of the network
23828           required: false
23829           type: string
23830         - name: vf-vlan-filter
23831           in: query
23832           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
23833           required: false
23834           type: string
23835         - name: vf-mac-filter
23836           in: query
23837           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
23838           required: false
23839           type: string
23840         - name: vf-vlan-strip
23841           in: query
23842           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
23843           required: false
23844           type: boolean
23845         - name: neutron-network-id
23846           in: query
23847           description: Neutron network id of the interface
23848           required: false
23849           type: string
23850     put:
23851       tags:
23852         - Network
23853       summary: create or update an existing sriov-vf
23854       description: |
23855         Create or update an existing sriov-vf.
23856         #
23857         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
23858       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23859       consumes:
23860         - application/json
23861         - application/xml
23862       produces:
23863         - application/json
23864         - application/xml
23865       responses:
23866         "default":
23867           description: Response codes found in [response codes](https://wiki.onap.org/).
23868       parameters:
23869         - name: equipment-name
23870           in: path
23871           required: true
23872           type: string
23873           example: __EQUIPMENT-NAME__
23874         - name: interface-name
23875           in: path
23876           description: Name that identifies the link aggregate interface
23877           required: true
23878           type: string
23879           example: __INTERFACE-NAME__
23880         - name: interface-name
23881           in: path
23882           description: Name given to the interface
23883           required: true
23884           type: string
23885           example: __INTERFACE-NAME__
23886         - name: pci-id
23887           in: path
23888           description: PCI ID used to identify the sriov-vf
23889           required: true
23890           type: string
23891           example: __PCI-ID__
23892         - name: body
23893           in: body
23894           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23895           required: true
23896           schema:
23897             $ref: "#/definitions/sriov-vf"
23898     patch:
23899       tags:
23900         - Network
23901       summary: update an existing sriov-vf
23902       description: |
23903         Update an existing sriov-vf
23904         #
23905         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23906         The PUT operation will entirely replace an existing object.
23907         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.
23908         #
23909         Other differences between PUT and PATCH are:
23910         #
23911         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23912         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23913         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23914       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23915       consumes:
23916         - application/json
23917         - application/xml
23918       produces:
23919         - application/json
23920         - application/xml
23921       responses:
23922         "default":
23923           description: Response codes found in [response codes](https://wiki.onap.org/).
23924       parameters:
23925         - name: equipment-name
23926           in: path
23927           required: true
23928           type: string
23929           example: __EQUIPMENT-NAME__
23930         - name: interface-name
23931           in: path
23932           description: Name that identifies the link aggregate interface
23933           required: true
23934           type: string
23935           example: __INTERFACE-NAME__
23936         - name: interface-name
23937           in: path
23938           description: Name given to the interface
23939           required: true
23940           type: string
23941           example: __INTERFACE-NAME__
23942         - name: pci-id
23943           in: path
23944           description: PCI ID used to identify the sriov-vf
23945           required: true
23946           type: string
23947           example: __PCI-ID__
23948         - name: body
23949           in: body
23950           description: sriov-vf object that needs to be created or updated.
23951           required: true
23952           schema:
23953             $ref: "#/patchDefinitions/sriov-vf"
23954     delete:
23955       tags:
23956         - Network
23957       summary: delete an existing sriov-vf
23958       description: delete an existing sriov-vf
23959       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23960       consumes:
23961         - application/json
23962         - application/xml
23963       produces:
23964         - application/json
23965         - application/xml
23966       responses:
23967         "default":
23968           description: Response codes found in [response codes](https://wiki.onap.org/).
23969       parameters:
23970         - name: equipment-name
23971           in: path
23972           required: true
23973           type: string
23974           example: __EQUIPMENT-NAME__
23975         - name: interface-name
23976           in: path
23977           description: Name that identifies the link aggregate interface
23978           required: true
23979           type: string
23980           example: __INTERFACE-NAME__
23981         - name: interface-name
23982           in: path
23983           description: Name given to the interface
23984           required: true
23985           type: string
23986           example: __INTERFACE-NAME__
23987         - name: pci-id
23988           in: path
23989           description: PCI ID used to identify the sriov-vf
23990           required: true
23991           type: string
23992           example: __PCI-ID__
23993         - name: resource-version
23994           in: query
23995           description: resource-version for concurrency
23996           required: true
23997           type: string
23998   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23999     get:
24000       tags:
24001         - Network
24002       summary: returns sriov-vfs
24003       description: returns sriov-vfs
24004       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
24005       produces:
24006         - application/json
24007         - application/xml
24008       responses:
24009         "200":
24010           description: successful operation
24011           schema:
24012               $ref: "#/getDefinitions/sriov-vfs"
24013         "default":
24014           description: Response codes found in [response codes](https://wiki.onap.org/).
24015       parameters:
24016         - name: equipment-name
24017           in: path
24018           required: true
24019           type: string
24020           example: __EQUIPMENT-NAME__
24021         - name: interface-name
24022           in: path
24023           description: Name that identifies the link aggregate interface
24024           required: true
24025           type: string
24026           example: __INTERFACE-NAME__
24027         - name: interface-name
24028           in: path
24029           description: Name given to the interface
24030           required: true
24031           type: string
24032           example: __INTERFACE-NAME__
24033         - name: prov-status
24034           in: query
24035           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24036           required: false
24037           type: string
24038         - name: interface-id
24039           in: query
24040           description: ID of interface
24041           required: false
24042           type: string
24043         - name: macaddr
24044           in: query
24045           description: MAC address for the interface
24046           required: false
24047           type: string
24048         - name: network-name
24049           in: query
24050           description: Name of the network
24051           required: false
24052           type: string
24053   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
24054     put:
24055       tags:
24056         - Network
24057       summary: see node definition for valid relationships
24058       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
24059       consumes:
24060         - application/json
24061         - application/xml
24062       produces:
24063         - application/json
24064         - application/xml
24065       responses:
24066         "default":
24067           description: Response codes found in [response codes](https://wiki.onap.org/).
24068       parameters:
24069         - name: equipment-name
24070           in: path
24071           required: true
24072           type: string
24073           example: __EQUIPMENT-NAME__
24074         - name: interface-name
24075           in: path
24076           description: Name that identifies the link aggregate interface
24077           required: true
24078           type: string
24079           example: __INTERFACE-NAME__
24080         - name: interface-name
24081           in: path
24082           description: Name given to the interface
24083           required: true
24084           type: string
24085           example: __INTERFACE-NAME__
24086         - name: body
24087           in: body
24088           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
24089           required: true
24090           schema:
24091             $ref: "#/definitions/relationship"
24092     delete:
24093       tags:
24094         - Network
24095       summary: delete an existing relationship
24096       description: delete an existing relationship
24097       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
24098       consumes:
24099         - application/json
24100         - application/xml
24101       produces:
24102         - application/json
24103         - application/xml
24104       responses:
24105         "default":
24106           description: Response codes found in [response codes](https://wiki.onap.org/).
24107       parameters:
24108         - name: equipment-name
24109           in: path
24110           required: true
24111           type: string
24112           example: __EQUIPMENT-NAME__
24113         - name: interface-name
24114           in: path
24115           description: Name that identifies the link aggregate interface
24116           required: true
24117           type: string
24118           example: __INTERFACE-NAME__
24119         - name: interface-name
24120           in: path
24121           description: Name given to the interface
24122           required: true
24123           type: string
24124           example: __INTERFACE-NAME__
24125   /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:
24126     put:
24127       tags:
24128         - Network
24129       summary: see node definition for valid relationships
24130       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24131       consumes:
24132         - application/json
24133         - application/xml
24134       produces:
24135         - application/json
24136         - application/xml
24137       responses:
24138         "default":
24139           description: Response codes found in [response codes](https://wiki.onap.org/).
24140       parameters:
24141         - name: equipment-name
24142           in: path
24143           required: true
24144           type: string
24145           example: __EQUIPMENT-NAME__
24146         - name: interface-name
24147           in: path
24148           description: Name that identifies the link aggregate interface
24149           required: true
24150           type: string
24151           example: __INTERFACE-NAME__
24152         - name: interface-name
24153           in: path
24154           description: Name given to the interface
24155           required: true
24156           type: string
24157           example: __INTERFACE-NAME__
24158         - name: l3-interface-ipv4-address
24159           in: path
24160           description: IP address
24161           required: true
24162           type: string
24163           example: __L3-INTERFACE-IPV4-ADDRESS__
24164         - name: body
24165           in: body
24166           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24167           required: true
24168           schema:
24169             $ref: "#/definitions/relationship"
24170     delete:
24171       tags:
24172         - Network
24173       summary: delete an existing relationship
24174       description: delete an existing relationship
24175       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
24176       consumes:
24177         - application/json
24178         - application/xml
24179       produces:
24180         - application/json
24181         - application/xml
24182       responses:
24183         "default":
24184           description: Response codes found in [response codes](https://wiki.onap.org/).
24185       parameters:
24186         - name: equipment-name
24187           in: path
24188           required: true
24189           type: string
24190           example: __EQUIPMENT-NAME__
24191         - name: interface-name
24192           in: path
24193           description: Name that identifies the link aggregate interface
24194           required: true
24195           type: string
24196           example: __INTERFACE-NAME__
24197         - name: interface-name
24198           in: path
24199           description: Name given to the interface
24200           required: true
24201           type: string
24202           example: __INTERFACE-NAME__
24203         - name: l3-interface-ipv4-address
24204           in: path
24205           description: IP address
24206           required: true
24207           type: string
24208           example: __L3-INTERFACE-IPV4-ADDRESS__
24209   /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}:
24210     get:
24211       tags:
24212         - Network
24213       summary: returns l3-interface-ipv4-address-list
24214       description: returns l3-interface-ipv4-address-list
24215       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24216       produces:
24217         - application/json
24218         - application/xml
24219       responses:
24220         "200":
24221           description: successful operation
24222           schema:
24223               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24224         "default":
24225           description: Response codes found in [response codes](https://wiki.onap.org/).
24226       parameters:
24227         - name: equipment-name
24228           in: path
24229           required: true
24230           type: string
24231           example: __EQUIPMENT-NAME__
24232         - name: interface-name
24233           in: path
24234           description: Name that identifies the link aggregate interface
24235           required: true
24236           type: string
24237           example: __INTERFACE-NAME__
24238         - name: interface-name
24239           in: path
24240           description: Name given to the interface
24241           required: true
24242           type: string
24243           example: __INTERFACE-NAME__
24244         - name: l3-interface-ipv4-address
24245           in: path
24246           description: IP address
24247           required: true
24248           type: string
24249           example: __L3-INTERFACE-IPV4-ADDRESS__
24250         - name: prov-status
24251           in: query
24252           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24253           required: false
24254           type: string
24255         - name: interface-id
24256           in: query
24257           description: ID of interface
24258           required: false
24259           type: string
24260         - name: macaddr
24261           in: query
24262           description: MAC address for the interface
24263           required: false
24264           type: string
24265         - name: network-name
24266           in: query
24267           description: Name of the network
24268           required: false
24269           type: string
24270         - name: vlan-id-inner
24271           in: query
24272           description: Inner VLAN tag
24273           required: false
24274           type: integer
24275           format: int64
24276         - name: neutron-network-id
24277           in: query
24278           description: Neutron network id of the interface that address belongs to
24279           required: false
24280           type: string
24281         - name: neutron-subnet-id
24282           in: query
24283           description: Neutron id of subnet that address belongs to
24284           required: false
24285           type: string
24286     put:
24287       tags:
24288         - Network
24289       summary: create or update an existing l3-interface-ipv4-address-list
24290       description: |
24291         Create or update an existing l3-interface-ipv4-address-list.
24292         #
24293         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
24294       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24295       consumes:
24296         - application/json
24297         - application/xml
24298       produces:
24299         - application/json
24300         - application/xml
24301       responses:
24302         "default":
24303           description: Response codes found in [response codes](https://wiki.onap.org/).
24304       parameters:
24305         - name: equipment-name
24306           in: path
24307           required: true
24308           type: string
24309           example: __EQUIPMENT-NAME__
24310         - name: interface-name
24311           in: path
24312           description: Name that identifies the link aggregate interface
24313           required: true
24314           type: string
24315           example: __INTERFACE-NAME__
24316         - name: interface-name
24317           in: path
24318           description: Name given to the interface
24319           required: true
24320           type: string
24321           example: __INTERFACE-NAME__
24322         - name: l3-interface-ipv4-address
24323           in: path
24324           description: IP address
24325           required: true
24326           type: string
24327           example: __L3-INTERFACE-IPV4-ADDRESS__
24328         - name: body
24329           in: body
24330           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
24331           required: true
24332           schema:
24333             $ref: "#/definitions/l3-interface-ipv4-address-list"
24334     patch:
24335       tags:
24336         - Network
24337       summary: update an existing l3-interface-ipv4-address-list
24338       description: |
24339         Update an existing l3-interface-ipv4-address-list
24340         #
24341         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24342         The PUT operation will entirely replace an existing object.
24343         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.
24344         #
24345         Other differences between PUT and PATCH are:
24346         #
24347         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24348         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24349         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24350       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24351       consumes:
24352         - application/json
24353         - application/xml
24354       produces:
24355         - application/json
24356         - application/xml
24357       responses:
24358         "default":
24359           description: Response codes found in [response codes](https://wiki.onap.org/).
24360       parameters:
24361         - name: equipment-name
24362           in: path
24363           required: true
24364           type: string
24365           example: __EQUIPMENT-NAME__
24366         - name: interface-name
24367           in: path
24368           description: Name that identifies the link aggregate interface
24369           required: true
24370           type: string
24371           example: __INTERFACE-NAME__
24372         - name: interface-name
24373           in: path
24374           description: Name given to the interface
24375           required: true
24376           type: string
24377           example: __INTERFACE-NAME__
24378         - name: l3-interface-ipv4-address
24379           in: path
24380           description: IP address
24381           required: true
24382           type: string
24383           example: __L3-INTERFACE-IPV4-ADDRESS__
24384         - name: body
24385           in: body
24386           description: l3-interface-ipv4-address-list object that needs to be created or updated.
24387           required: true
24388           schema:
24389             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24390     delete:
24391       tags:
24392         - Network
24393       summary: delete an existing l3-interface-ipv4-address-list
24394       description: delete an existing l3-interface-ipv4-address-list
24395       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
24396       consumes:
24397         - application/json
24398         - application/xml
24399       produces:
24400         - application/json
24401         - application/xml
24402       responses:
24403         "default":
24404           description: Response codes found in [response codes](https://wiki.onap.org/).
24405       parameters:
24406         - name: equipment-name
24407           in: path
24408           required: true
24409           type: string
24410           example: __EQUIPMENT-NAME__
24411         - name: interface-name
24412           in: path
24413           description: Name that identifies the link aggregate interface
24414           required: true
24415           type: string
24416           example: __INTERFACE-NAME__
24417         - name: interface-name
24418           in: path
24419           description: Name given to the interface
24420           required: true
24421           type: string
24422           example: __INTERFACE-NAME__
24423         - name: l3-interface-ipv4-address
24424           in: path
24425           description: IP address
24426           required: true
24427           type: string
24428           example: __L3-INTERFACE-IPV4-ADDRESS__
24429         - name: resource-version
24430           in: query
24431           description: resource-version for concurrency
24432           required: true
24433           type: string
24434   /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:
24435     put:
24436       tags:
24437         - Network
24438       summary: see node definition for valid relationships
24439       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24440       consumes:
24441         - application/json
24442         - application/xml
24443       produces:
24444         - application/json
24445         - application/xml
24446       responses:
24447         "default":
24448           description: Response codes found in [response codes](https://wiki.onap.org/).
24449       parameters:
24450         - name: equipment-name
24451           in: path
24452           required: true
24453           type: string
24454           example: __EQUIPMENT-NAME__
24455         - name: interface-name
24456           in: path
24457           description: Name that identifies the link aggregate interface
24458           required: true
24459           type: string
24460           example: __INTERFACE-NAME__
24461         - name: interface-name
24462           in: path
24463           description: Name given to the interface
24464           required: true
24465           type: string
24466           example: __INTERFACE-NAME__
24467         - name: l3-interface-ipv6-address
24468           in: path
24469           description: IP address
24470           required: true
24471           type: string
24472           example: __L3-INTERFACE-IPV6-ADDRESS__
24473         - name: body
24474           in: body
24475           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24476           required: true
24477           schema:
24478             $ref: "#/definitions/relationship"
24479     delete:
24480       tags:
24481         - Network
24482       summary: delete an existing relationship
24483       description: delete an existing relationship
24484       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
24485       consumes:
24486         - application/json
24487         - application/xml
24488       produces:
24489         - application/json
24490         - application/xml
24491       responses:
24492         "default":
24493           description: Response codes found in [response codes](https://wiki.onap.org/).
24494       parameters:
24495         - name: equipment-name
24496           in: path
24497           required: true
24498           type: string
24499           example: __EQUIPMENT-NAME__
24500         - name: interface-name
24501           in: path
24502           description: Name that identifies the link aggregate interface
24503           required: true
24504           type: string
24505           example: __INTERFACE-NAME__
24506         - name: interface-name
24507           in: path
24508           description: Name given to the interface
24509           required: true
24510           type: string
24511           example: __INTERFACE-NAME__
24512         - name: l3-interface-ipv6-address
24513           in: path
24514           description: IP address
24515           required: true
24516           type: string
24517           example: __L3-INTERFACE-IPV6-ADDRESS__
24518   /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}:
24519     get:
24520       tags:
24521         - Network
24522       summary: returns l3-interface-ipv6-address-list
24523       description: returns l3-interface-ipv6-address-list
24524       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24525       produces:
24526         - application/json
24527         - application/xml
24528       responses:
24529         "200":
24530           description: successful operation
24531           schema:
24532               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24533         "default":
24534           description: Response codes found in [response codes](https://wiki.onap.org/).
24535       parameters:
24536         - name: equipment-name
24537           in: path
24538           required: true
24539           type: string
24540           example: __EQUIPMENT-NAME__
24541         - name: interface-name
24542           in: path
24543           description: Name that identifies the link aggregate interface
24544           required: true
24545           type: string
24546           example: __INTERFACE-NAME__
24547         - name: interface-name
24548           in: path
24549           description: Name given to the interface
24550           required: true
24551           type: string
24552           example: __INTERFACE-NAME__
24553         - name: l3-interface-ipv6-address
24554           in: path
24555           description: IP address
24556           required: true
24557           type: string
24558           example: __L3-INTERFACE-IPV6-ADDRESS__
24559         - name: prov-status
24560           in: query
24561           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24562           required: false
24563           type: string
24564         - name: interface-id
24565           in: query
24566           description: ID of interface
24567           required: false
24568           type: string
24569         - name: macaddr
24570           in: query
24571           description: MAC address for the interface
24572           required: false
24573           type: string
24574         - name: network-name
24575           in: query
24576           description: Name of the network
24577           required: false
24578           type: string
24579         - name: vlan-id-inner
24580           in: query
24581           description: Inner VLAN tag
24582           required: false
24583           type: integer
24584           format: int64
24585         - name: neutron-network-id
24586           in: query
24587           description: Neutron network id of the interface that address belongs to
24588           required: false
24589           type: string
24590         - name: neutron-subnet-id
24591           in: query
24592           description: Neutron id of subnet that address belongs to
24593           required: false
24594           type: string
24595     put:
24596       tags:
24597         - Network
24598       summary: create or update an existing l3-interface-ipv6-address-list
24599       description: |
24600         Create or update an existing l3-interface-ipv6-address-list.
24601         #
24602         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
24603       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24604       consumes:
24605         - application/json
24606         - application/xml
24607       produces:
24608         - application/json
24609         - application/xml
24610       responses:
24611         "default":
24612           description: Response codes found in [response codes](https://wiki.onap.org/).
24613       parameters:
24614         - name: equipment-name
24615           in: path
24616           required: true
24617           type: string
24618           example: __EQUIPMENT-NAME__
24619         - name: interface-name
24620           in: path
24621           description: Name that identifies the link aggregate interface
24622           required: true
24623           type: string
24624           example: __INTERFACE-NAME__
24625         - name: interface-name
24626           in: path
24627           description: Name given to the interface
24628           required: true
24629           type: string
24630           example: __INTERFACE-NAME__
24631         - name: l3-interface-ipv6-address
24632           in: path
24633           description: IP address
24634           required: true
24635           type: string
24636           example: __L3-INTERFACE-IPV6-ADDRESS__
24637         - name: body
24638           in: body
24639           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
24640           required: true
24641           schema:
24642             $ref: "#/definitions/l3-interface-ipv6-address-list"
24643     patch:
24644       tags:
24645         - Network
24646       summary: update an existing l3-interface-ipv6-address-list
24647       description: |
24648         Update an existing l3-interface-ipv6-address-list
24649         #
24650         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24651         The PUT operation will entirely replace an existing object.
24652         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.
24653         #
24654         Other differences between PUT and PATCH are:
24655         #
24656         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24657         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24658         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24659       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24660       consumes:
24661         - application/json
24662         - application/xml
24663       produces:
24664         - application/json
24665         - application/xml
24666       responses:
24667         "default":
24668           description: Response codes found in [response codes](https://wiki.onap.org/).
24669       parameters:
24670         - name: equipment-name
24671           in: path
24672           required: true
24673           type: string
24674           example: __EQUIPMENT-NAME__
24675         - name: interface-name
24676           in: path
24677           description: Name that identifies the link aggregate interface
24678           required: true
24679           type: string
24680           example: __INTERFACE-NAME__
24681         - name: interface-name
24682           in: path
24683           description: Name given to the interface
24684           required: true
24685           type: string
24686           example: __INTERFACE-NAME__
24687         - name: l3-interface-ipv6-address
24688           in: path
24689           description: IP address
24690           required: true
24691           type: string
24692           example: __L3-INTERFACE-IPV6-ADDRESS__
24693         - name: body
24694           in: body
24695           description: l3-interface-ipv6-address-list object that needs to be created or updated.
24696           required: true
24697           schema:
24698             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24699     delete:
24700       tags:
24701         - Network
24702       summary: delete an existing l3-interface-ipv6-address-list
24703       description: delete an existing l3-interface-ipv6-address-list
24704       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24705       consumes:
24706         - application/json
24707         - application/xml
24708       produces:
24709         - application/json
24710         - application/xml
24711       responses:
24712         "default":
24713           description: Response codes found in [response codes](https://wiki.onap.org/).
24714       parameters:
24715         - name: equipment-name
24716           in: path
24717           required: true
24718           type: string
24719           example: __EQUIPMENT-NAME__
24720         - name: interface-name
24721           in: path
24722           description: Name that identifies the link aggregate interface
24723           required: true
24724           type: string
24725           example: __INTERFACE-NAME__
24726         - name: interface-name
24727           in: path
24728           description: Name given to the interface
24729           required: true
24730           type: string
24731           example: __INTERFACE-NAME__
24732         - name: l3-interface-ipv6-address
24733           in: path
24734           description: IP address
24735           required: true
24736           type: string
24737           example: __L3-INTERFACE-IPV6-ADDRESS__
24738         - name: resource-version
24739           in: query
24740           description: resource-version for concurrency
24741           required: true
24742           type: string
24743   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
24744     get:
24745       tags:
24746         - Network
24747       summary: returns l-interface
24748       description: returns l-interface
24749       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24750       produces:
24751         - application/json
24752         - application/xml
24753       responses:
24754         "200":
24755           description: successful operation
24756           schema:
24757               $ref: "#/getDefinitions/l-interface"
24758         "default":
24759           description: Response codes found in [response codes](https://wiki.onap.org/).
24760       parameters:
24761         - name: equipment-name
24762           in: path
24763           required: true
24764           type: string
24765           example: __EQUIPMENT-NAME__
24766         - name: interface-name
24767           in: path
24768           description: Name that identifies the link aggregate interface
24769           required: true
24770           type: string
24771           example: __INTERFACE-NAME__
24772         - name: interface-name
24773           in: path
24774           description: Name given to the interface
24775           required: true
24776           type: string
24777           example: __INTERFACE-NAME__
24778         - name: prov-status
24779           in: query
24780           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24781           required: false
24782           type: string
24783         - name: interface-id
24784           in: query
24785           description: ID of interface
24786           required: false
24787           type: string
24788         - name: macaddr
24789           in: query
24790           description: MAC address for the interface
24791           required: false
24792           type: string
24793         - name: network-name
24794           in: query
24795           description: Name of the network
24796           required: false
24797           type: string
24798     put:
24799       tags:
24800         - Network
24801       summary: create or update an existing l-interface
24802       description: |
24803         Create or update an existing l-interface.
24804         #
24805         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
24806       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24807       consumes:
24808         - application/json
24809         - application/xml
24810       produces:
24811         - application/json
24812         - application/xml
24813       responses:
24814         "default":
24815           description: Response codes found in [response codes](https://wiki.onap.org/).
24816       parameters:
24817         - name: equipment-name
24818           in: path
24819           required: true
24820           type: string
24821           example: __EQUIPMENT-NAME__
24822         - name: interface-name
24823           in: path
24824           description: Name that identifies the link aggregate interface
24825           required: true
24826           type: string
24827           example: __INTERFACE-NAME__
24828         - name: interface-name
24829           in: path
24830           description: Name given to the interface
24831           required: true
24832           type: string
24833           example: __INTERFACE-NAME__
24834         - name: body
24835           in: body
24836           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
24837           required: true
24838           schema:
24839             $ref: "#/definitions/l-interface"
24840     patch:
24841       tags:
24842         - Network
24843       summary: update an existing l-interface
24844       description: |
24845         Update an existing l-interface
24846         #
24847         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24848         The PUT operation will entirely replace an existing object.
24849         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.
24850         #
24851         Other differences between PUT and PATCH are:
24852         #
24853         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24854         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24855         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24856       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24857       consumes:
24858         - application/json
24859         - application/xml
24860       produces:
24861         - application/json
24862         - application/xml
24863       responses:
24864         "default":
24865           description: Response codes found in [response codes](https://wiki.onap.org/).
24866       parameters:
24867         - name: equipment-name
24868           in: path
24869           required: true
24870           type: string
24871           example: __EQUIPMENT-NAME__
24872         - name: interface-name
24873           in: path
24874           description: Name that identifies the link aggregate interface
24875           required: true
24876           type: string
24877           example: __INTERFACE-NAME__
24878         - name: interface-name
24879           in: path
24880           description: Name given to the interface
24881           required: true
24882           type: string
24883           example: __INTERFACE-NAME__
24884         - name: body
24885           in: body
24886           description: l-interface object that needs to be created or updated.
24887           required: true
24888           schema:
24889             $ref: "#/patchDefinitions/l-interface"
24890     delete:
24891       tags:
24892         - Network
24893       summary: delete an existing l-interface
24894       description: delete an existing l-interface
24895       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
24896       consumes:
24897         - application/json
24898         - application/xml
24899       produces:
24900         - application/json
24901         - application/xml
24902       responses:
24903         "default":
24904           description: Response codes found in [response codes](https://wiki.onap.org/).
24905       parameters:
24906         - name: equipment-name
24907           in: path
24908           required: true
24909           type: string
24910           example: __EQUIPMENT-NAME__
24911         - name: interface-name
24912           in: path
24913           description: Name that identifies the link aggregate interface
24914           required: true
24915           type: string
24916           example: __INTERFACE-NAME__
24917         - name: interface-name
24918           in: path
24919           description: Name given to the interface
24920           required: true
24921           type: string
24922           example: __INTERFACE-NAME__
24923         - name: resource-version
24924           in: query
24925           description: resource-version for concurrency
24926           required: true
24927           type: string
24928   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
24929     get:
24930       tags:
24931         - Network
24932       summary: returns l-interfaces
24933       description: returns l-interfaces
24934       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
24935       produces:
24936         - application/json
24937         - application/xml
24938       responses:
24939         "200":
24940           description: successful operation
24941           schema:
24942               $ref: "#/getDefinitions/l-interfaces"
24943         "default":
24944           description: Response codes found in [response codes](https://wiki.onap.org/).
24945       parameters:
24946         - name: equipment-name
24947           in: path
24948           required: true
24949           type: string
24950           example: __EQUIPMENT-NAME__
24951         - name: interface-name
24952           in: path
24953           description: Name that identifies the link aggregate interface
24954           required: true
24955           type: string
24956           example: __INTERFACE-NAME__
24957         - name: prov-status
24958           in: query
24959           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24960           required: false
24961           type: string
24962   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
24963     get:
24964       tags:
24965         - Network
24966       summary: returns lag-interface
24967       description: returns lag-interface
24968       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
24969       produces:
24970         - application/json
24971         - application/xml
24972       responses:
24973         "200":
24974           description: successful operation
24975           schema:
24976               $ref: "#/getDefinitions/lag-interface"
24977         "default":
24978           description: Response codes found in [response codes](https://wiki.onap.org/).
24979       parameters:
24980         - name: equipment-name
24981           in: path
24982           required: true
24983           type: string
24984           example: __EQUIPMENT-NAME__
24985         - name: interface-name
24986           in: path
24987           description: Name that identifies the link aggregate interface
24988           required: true
24989           type: string
24990           example: __INTERFACE-NAME__
24991         - name: prov-status
24992           in: query
24993           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24994           required: false
24995           type: string
24996     put:
24997       tags:
24998         - Network
24999       summary: create or update an existing lag-interface
25000       description: |
25001         Create or update an existing lag-interface.
25002         #
25003         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
25004       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
25005       consumes:
25006         - application/json
25007         - application/xml
25008       produces:
25009         - application/json
25010         - application/xml
25011       responses:
25012         "default":
25013           description: Response codes found in [response codes](https://wiki.onap.org/).
25014       parameters:
25015         - name: equipment-name
25016           in: path
25017           required: true
25018           type: string
25019           example: __EQUIPMENT-NAME__
25020         - name: interface-name
25021           in: path
25022           description: Name that identifies the link aggregate interface
25023           required: true
25024           type: string
25025           example: __INTERFACE-NAME__
25026         - name: body
25027           in: body
25028           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
25029           required: true
25030           schema:
25031             $ref: "#/definitions/lag-interface"
25032     patch:
25033       tags:
25034         - Network
25035       summary: update an existing lag-interface
25036       description: |
25037         Update an existing lag-interface
25038         #
25039         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25040         The PUT operation will entirely replace an existing object.
25041         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.
25042         #
25043         Other differences between PUT and PATCH are:
25044         #
25045         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25046         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25047         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25048       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
25049       consumes:
25050         - application/json
25051         - application/xml
25052       produces:
25053         - application/json
25054         - application/xml
25055       responses:
25056         "default":
25057           description: Response codes found in [response codes](https://wiki.onap.org/).
25058       parameters:
25059         - name: equipment-name
25060           in: path
25061           required: true
25062           type: string
25063           example: __EQUIPMENT-NAME__
25064         - name: interface-name
25065           in: path
25066           description: Name that identifies the link aggregate interface
25067           required: true
25068           type: string
25069           example: __INTERFACE-NAME__
25070         - name: body
25071           in: body
25072           description: lag-interface object that needs to be created or updated.
25073           required: true
25074           schema:
25075             $ref: "#/patchDefinitions/lag-interface"
25076     delete:
25077       tags:
25078         - Network
25079       summary: delete an existing lag-interface
25080       description: delete an existing lag-interface
25081       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
25082       consumes:
25083         - application/json
25084         - application/xml
25085       produces:
25086         - application/json
25087         - application/xml
25088       responses:
25089         "default":
25090           description: Response codes found in [response codes](https://wiki.onap.org/).
25091       parameters:
25092         - name: equipment-name
25093           in: path
25094           required: true
25095           type: string
25096           example: __EQUIPMENT-NAME__
25097         - name: interface-name
25098           in: path
25099           description: Name that identifies the link aggregate interface
25100           required: true
25101           type: string
25102           example: __INTERFACE-NAME__
25103         - name: resource-version
25104           in: query
25105           description: resource-version for concurrency
25106           required: true
25107           type: string
25108   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
25109     get:
25110       tags:
25111         - Network
25112       summary: returns lag-interfaces
25113       description: returns lag-interfaces
25114       operationId: getNetworkVplsPesVplsPeLagInterfaces
25115       produces:
25116         - application/json
25117         - application/xml
25118       responses:
25119         "200":
25120           description: successful operation
25121           schema:
25122               $ref: "#/getDefinitions/lag-interfaces"
25123         "default":
25124           description: Response codes found in [response codes](https://wiki.onap.org/).
25125       parameters:
25126         - name: equipment-name
25127           in: path
25128           required: true
25129           type: string
25130           example: __EQUIPMENT-NAME__
25131         - name: prov-status
25132           in: query
25133           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25134           required: false
25135           type: string
25136   /network/vpls-pes/vpls-pe/{equipment-name}:
25137     get:
25138       tags:
25139         - Network
25140       summary: returns vpls-pe
25141       description: returns vpls-pe
25142       operationId: getNetworkVplsPesVplsPe
25143       produces:
25144         - application/json
25145         - application/xml
25146       responses:
25147         "200":
25148           description: successful operation
25149           schema:
25150               $ref: "#/getDefinitions/vpls-pe"
25151         "default":
25152           description: Response codes found in [response codes](https://wiki.onap.org/).
25153       parameters:
25154         - name: equipment-name
25155           in: path
25156           required: true
25157           type: string
25158           example: __EQUIPMENT-NAME__
25159         - name: prov-status
25160           in: query
25161           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25162           required: false
25163           type: string
25164     put:
25165       tags:
25166         - Network
25167       summary: create or update an existing vpls-pe
25168       description: |
25169         Create or update an existing vpls-pe.
25170         #
25171         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
25172       operationId: createOrUpdateNetworkVplsPesVplsPe
25173       consumes:
25174         - application/json
25175         - application/xml
25176       produces:
25177         - application/json
25178         - application/xml
25179       responses:
25180         "default":
25181           description: Response codes found in [response codes](https://wiki.onap.org/).
25182       parameters:
25183         - name: equipment-name
25184           in: path
25185           required: true
25186           type: string
25187           example: __EQUIPMENT-NAME__
25188         - name: body
25189           in: body
25190           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVplsPesVplsPe.json)
25191           required: true
25192           schema:
25193             $ref: "#/definitions/vpls-pe"
25194     patch:
25195       tags:
25196         - Network
25197       summary: update an existing vpls-pe
25198       description: |
25199         Update an existing vpls-pe
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: UpdateNetworkVplsPesVplsPe
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: body
25227           in: body
25228           description: vpls-pe object that needs to be created or updated.
25229           required: true
25230           schema:
25231             $ref: "#/patchDefinitions/vpls-pe"
25232     delete:
25233       tags:
25234         - Network
25235       summary: delete an existing vpls-pe
25236       description: delete an existing vpls-pe
25237       operationId: deleteNetworkVplsPesVplsPe
25238       consumes:
25239         - application/json
25240         - application/xml
25241       produces:
25242         - application/json
25243         - application/xml
25244       responses:
25245         "default":
25246           description: Response codes found in [response codes](https://wiki.onap.org/).
25247       parameters:
25248         - name: equipment-name
25249           in: path
25250           required: true
25251           type: string
25252           example: __EQUIPMENT-NAME__
25253         - name: resource-version
25254           in: query
25255           description: resource-version for concurrency
25256           required: true
25257           type: string
25258   /network/vpls-pes:
25259     get:
25260       tags:
25261         - Network
25262       summary: returns vpls-pes
25263       description: returns vpls-pes
25264       operationId: getNetworkVplsPes
25265       produces:
25266         - application/json
25267         - application/xml
25268       responses:
25269         "200":
25270           description: successful operation
25271           schema:
25272               $ref: "#/getDefinitions/vpls-pes"
25273         "default":
25274           description: Response codes found in [response codes](https://wiki.onap.org/).
25275   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
25276     put:
25277       tags:
25278         - Network
25279       summary: see node definition for valid relationships
25280       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
25281       consumes:
25282         - application/json
25283         - application/xml
25284       produces:
25285         - application/json
25286         - application/xml
25287       responses:
25288         "default":
25289           description: Response codes found in [response codes](https://wiki.onap.org/).
25290       parameters:
25291         - name: multicast-configuration-id
25292           in: path
25293           description: Unique id of multicast configuration.
25294           required: true
25295           type: string
25296           example: __MULTICAST-CONFIGURATION-ID__
25297         - name: body
25298           in: body
25299           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
25300           required: true
25301           schema:
25302             $ref: "#/definitions/relationship"
25303     delete:
25304       tags:
25305         - Network
25306       summary: delete an existing relationship
25307       description: delete an existing relationship
25308       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
25309       consumes:
25310         - application/json
25311         - application/xml
25312       produces:
25313         - application/json
25314         - application/xml
25315       responses:
25316         "default":
25317           description: Response codes found in [response codes](https://wiki.onap.org/).
25318       parameters:
25319         - name: multicast-configuration-id
25320           in: path
25321           description: Unique id of multicast configuration.
25322           required: true
25323           type: string
25324           example: __MULTICAST-CONFIGURATION-ID__
25325   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
25326     get:
25327       tags:
25328         - Network
25329       summary: returns multicast-configuration
25330       description: returns multicast-configuration
25331       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
25332       produces:
25333         - application/json
25334         - application/xml
25335       responses:
25336         "200":
25337           description: successful operation
25338           schema:
25339               $ref: "#/getDefinitions/multicast-configuration"
25340         "default":
25341           description: Response codes found in [response codes](https://wiki.onap.org/).
25342       parameters:
25343         - name: multicast-configuration-id
25344           in: path
25345           description: Unique id of multicast configuration.
25346           required: true
25347           type: string
25348           example: __MULTICAST-CONFIGURATION-ID__
25349     put:
25350       tags:
25351         - Network
25352       summary: create or update an existing multicast-configuration
25353       description: |
25354         Create or update an existing multicast-configuration.
25355         #
25356         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
25357       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
25358       consumes:
25359         - application/json
25360         - application/xml
25361       produces:
25362         - application/json
25363         - application/xml
25364       responses:
25365         "default":
25366           description: Response codes found in [response codes](https://wiki.onap.org/).
25367       parameters:
25368         - name: multicast-configuration-id
25369           in: path
25370           description: Unique id of multicast configuration.
25371           required: true
25372           type: string
25373           example: __MULTICAST-CONFIGURATION-ID__
25374         - name: body
25375           in: body
25376           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkMulticastConfigurationsMulticastConfiguration.json)
25377           required: true
25378           schema:
25379             $ref: "#/definitions/multicast-configuration"
25380     patch:
25381       tags:
25382         - Network
25383       summary: update an existing multicast-configuration
25384       description: |
25385         Update an existing multicast-configuration
25386         #
25387         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25388         The PUT operation will entirely replace an existing object.
25389         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.
25390         #
25391         Other differences between PUT and PATCH are:
25392         #
25393         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25394         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25395         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25396       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
25397       consumes:
25398         - application/json
25399         - application/xml
25400       produces:
25401         - application/json
25402         - application/xml
25403       responses:
25404         "default":
25405           description: Response codes found in [response codes](https://wiki.onap.org/).
25406       parameters:
25407         - name: multicast-configuration-id
25408           in: path
25409           description: Unique id of multicast configuration.
25410           required: true
25411           type: string
25412           example: __MULTICAST-CONFIGURATION-ID__
25413         - name: body
25414           in: body
25415           description: multicast-configuration object that needs to be created or updated.
25416           required: true
25417           schema:
25418             $ref: "#/patchDefinitions/multicast-configuration"
25419     delete:
25420       tags:
25421         - Network
25422       summary: delete an existing multicast-configuration
25423       description: delete an existing multicast-configuration
25424       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
25425       consumes:
25426         - application/json
25427         - application/xml
25428       produces:
25429         - application/json
25430         - application/xml
25431       responses:
25432         "default":
25433           description: Response codes found in [response codes](https://wiki.onap.org/).
25434       parameters:
25435         - name: multicast-configuration-id
25436           in: path
25437           description: Unique id of multicast configuration.
25438           required: true
25439           type: string
25440           example: __MULTICAST-CONFIGURATION-ID__
25441         - name: resource-version
25442           in: query
25443           description: resource-version for concurrency
25444           required: true
25445           type: string
25446   /network/multicast-configurations:
25447     get:
25448       tags:
25449         - Network
25450       summary: returns multicast-configurations
25451       description: returns multicast-configurations
25452       operationId: getNetworkMulticastConfigurations
25453       produces:
25454         - application/json
25455         - application/xml
25456       responses:
25457         "200":
25458           description: successful operation
25459           schema:
25460               $ref: "#/getDefinitions/multicast-configurations"
25461         "default":
25462           description: Response codes found in [response codes](https://wiki.onap.org/).
25463   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
25464     put:
25465       tags:
25466         - Network
25467       summary: see node definition for valid relationships
25468       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
25469       consumes:
25470         - application/json
25471         - application/xml
25472       produces:
25473         - application/json
25474         - application/xml
25475       responses:
25476         "default":
25477           description: Response codes found in [response codes](https://wiki.onap.org/).
25478       parameters:
25479         - name: vnf-id
25480           in: path
25481           description: Unique id of VNF.  This is unique across the graph.
25482           required: true
25483           type: string
25484           example: __VNF-ID__
25485         - name: interface-id
25486           in: path
25487           description: Unique ID of the interface
25488           required: true
25489           type: string
25490           example: __INTERFACE-ID__
25491         - name: cvlan-tag
25492           in: path
25493           description: See mis-na-virtualization-platform.yang
25494           required: true
25495           type: integer
25496           format: int64
25497           example: __CVLAN-TAG__
25498         - name: body
25499           in: body
25500           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
25501           required: true
25502           schema:
25503             $ref: "#/definitions/relationship"
25504     delete:
25505       tags:
25506         - Network
25507       summary: delete an existing relationship
25508       description: delete an existing relationship
25509       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
25510       consumes:
25511         - application/json
25512         - application/xml
25513       produces:
25514         - application/json
25515         - application/xml
25516       responses:
25517         "default":
25518           description: Response codes found in [response codes](https://wiki.onap.org/).
25519       parameters:
25520         - name: vnf-id
25521           in: path
25522           description: Unique id of VNF.  This is unique across the graph.
25523           required: true
25524           type: string
25525           example: __VNF-ID__
25526         - name: interface-id
25527           in: path
25528           description: Unique ID of the interface
25529           required: true
25530           type: string
25531           example: __INTERFACE-ID__
25532         - name: cvlan-tag
25533           in: path
25534           description: See mis-na-virtualization-platform.yang
25535           required: true
25536           type: integer
25537           format: int64
25538           example: __CVLAN-TAG__
25539   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
25540     get:
25541       tags:
25542         - Network
25543       summary: returns cvlan-tag-entry
25544       description: returns cvlan-tag-entry
25545       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25546       produces:
25547         - application/json
25548         - application/xml
25549       responses:
25550         "200":
25551           description: successful operation
25552           schema:
25553               $ref: "#/getDefinitions/cvlan-tag-entry"
25554         "default":
25555           description: Response codes found in [response codes](https://wiki.onap.org/).
25556       parameters:
25557         - name: vnf-id
25558           in: path
25559           description: Unique id of VNF.  This is unique across the graph.
25560           required: true
25561           type: string
25562           example: __VNF-ID__
25563         - name: interface-id
25564           in: path
25565           description: Unique ID of the interface
25566           required: true
25567           type: string
25568           example: __INTERFACE-ID__
25569         - name: cvlan-tag
25570           in: path
25571           description: See mis-na-virtualization-platform.yang
25572           required: true
25573           type: integer
25574           format: int64
25575           example: __CVLAN-TAG__
25576         - name: vnf-name
25577           in: query
25578           description: Name of VNF.
25579           required: false
25580           type: string
25581         - name: vnf-name2
25582           in: query
25583           description: Alternate name of VNF.
25584           required: false
25585           type: string
25586         - name: vnf-type
25587           in: query
25588           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
25589           required: false
25590           type: string
25591         - name: service-id
25592           in: query
25593           description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
25594           required: false
25595           type: string
25596         - name: regional-resource-zone
25597           in: query
25598           description: Regional way of organizing pservers, source of truth should define values
25599           required: false
25600           type: string
25601         - name: prov-status
25602           in: query
25603           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25604           required: false
25605           type: string
25606         - name: heat-stack-id
25607           in: query
25608           description: Heat stack id corresponding to this instance, managed by MSO
25609           required: false
25610           type: string
25611         - name: vpe-id
25612           in: query
25613           description: Unique ID of VPE connected to this VCE.
25614           required: false
25615           type: string
25616         - name: port-group-id
25617           in: query
25618           description: Unique ID for port group in vmware
25619           required: false
25620           type: string
25621         - name: switch-name
25622           in: query
25623           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
25624           required: false
25625           type: string
25626         - name: heat-stack-id
25627           in: query
25628           description: Heat stack id corresponding to this instance, managed by MSO
25629           required: false
25630           type: string
25631     put:
25632       tags:
25633         - Network
25634       summary: create or update an existing cvlan-tag-entry
25635       description: |
25636         Create or update an existing cvlan-tag-entry.
25637         #
25638         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
25639       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25640       consumes:
25641         - application/json
25642         - application/xml
25643       produces:
25644         - application/json
25645         - application/xml
25646       responses:
25647         "default":
25648           description: Response codes found in [response codes](https://wiki.onap.org/).
25649       parameters:
25650         - name: vnf-id
25651           in: path
25652           description: Unique id of VNF.  This is unique across the graph.
25653           required: true
25654           type: string
25655           example: __VNF-ID__
25656         - name: interface-id
25657           in: path
25658           description: Unique ID of the interface
25659           required: true
25660           type: string
25661           example: __INTERFACE-ID__
25662         - name: cvlan-tag
25663           in: path
25664           description: See mis-na-virtualization-platform.yang
25665           required: true
25666           type: integer
25667           format: int64
25668           example: __CVLAN-TAG__
25669         - name: body
25670           in: body
25671           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
25672           required: true
25673           schema:
25674             $ref: "#/definitions/cvlan-tag-entry"
25675     patch:
25676       tags:
25677         - Network
25678       summary: update an existing cvlan-tag-entry
25679       description: |
25680         Update an existing cvlan-tag-entry
25681         #
25682         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25683         The PUT operation will entirely replace an existing object.
25684         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.
25685         #
25686         Other differences between PUT and PATCH are:
25687         #
25688         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25689         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25690         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25691       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25692       consumes:
25693         - application/json
25694         - application/xml
25695       produces:
25696         - application/json
25697         - application/xml
25698       responses:
25699         "default":
25700           description: Response codes found in [response codes](https://wiki.onap.org/).
25701       parameters:
25702         - name: vnf-id
25703           in: path
25704           description: Unique id of VNF.  This is unique across the graph.
25705           required: true
25706           type: string
25707           example: __VNF-ID__
25708         - name: interface-id
25709           in: path
25710           description: Unique ID of the interface
25711           required: true
25712           type: string
25713           example: __INTERFACE-ID__
25714         - name: cvlan-tag
25715           in: path
25716           description: See mis-na-virtualization-platform.yang
25717           required: true
25718           type: integer
25719           format: int64
25720           example: __CVLAN-TAG__
25721         - name: body
25722           in: body
25723           description: cvlan-tag-entry object that needs to be created or updated.
25724           required: true
25725           schema:
25726             $ref: "#/patchDefinitions/cvlan-tag-entry"
25727     delete:
25728       tags:
25729         - Network
25730       summary: delete an existing cvlan-tag-entry
25731       description: delete an existing cvlan-tag-entry
25732       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
25733       consumes:
25734         - application/json
25735         - application/xml
25736       produces:
25737         - application/json
25738         - application/xml
25739       responses:
25740         "default":
25741           description: Response codes found in [response codes](https://wiki.onap.org/).
25742       parameters:
25743         - name: vnf-id
25744           in: path
25745           description: Unique id of VNF.  This is unique across the graph.
25746           required: true
25747           type: string
25748           example: __VNF-ID__
25749         - name: interface-id
25750           in: path
25751           description: Unique ID of the interface
25752           required: true
25753           type: string
25754           example: __INTERFACE-ID__
25755         - name: cvlan-tag
25756           in: path
25757           description: See mis-na-virtualization-platform.yang
25758           required: true
25759           type: integer
25760           format: int64
25761           example: __CVLAN-TAG__
25762         - name: resource-version
25763           in: query
25764           description: resource-version for concurrency
25765           required: true
25766           type: string
25767   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
25768     get:
25769       tags:
25770         - Network
25771       summary: returns cvlan-tags
25772       description: returns cvlan-tags
25773       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
25774       produces:
25775         - application/json
25776         - application/xml
25777       responses:
25778         "200":
25779           description: successful operation
25780           schema:
25781               $ref: "#/getDefinitions/cvlan-tags"
25782         "default":
25783           description: Response codes found in [response codes](https://wiki.onap.org/).
25784       parameters:
25785         - name: vnf-id
25786           in: path
25787           description: Unique id of VNF.  This is unique across the graph.
25788           required: true
25789           type: string
25790           example: __VNF-ID__
25791         - name: interface-id
25792           in: path
25793           description: Unique ID of the interface
25794           required: true
25795           type: string
25796           example: __INTERFACE-ID__
25797         - name: vnf-name
25798           in: query
25799           description: Name of VNF.
25800           required: false
25801           type: string
25802         - name: vnf-name2
25803           in: query
25804           description: Alternate name of VNF.
25805           required: false
25806           type: string
25807         - name: vnf-type
25808           in: query
25809           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
25810           required: false
25811           type: string
25812         - name: service-id
25813           in: query
25814           description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
25815           required: false
25816           type: string
25817         - name: regional-resource-zone
25818           in: query
25819           description: Regional way of organizing pservers, source of truth should define values
25820           required: false
25821           type: string
25822         - name: prov-status
25823           in: query
25824           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25825           required: false
25826           type: string
25827         - name: heat-stack-id
25828           in: query
25829           description: Heat stack id corresponding to this instance, managed by MSO
25830           required: false
25831           type: string
25832         - name: vpe-id
25833           in: query
25834           description: Unique ID of VPE connected to this VCE.
25835           required: false
25836           type: string
25837         - name: port-group-id
25838           in: query
25839           description: Unique ID for port group in vmware
25840           required: false
25841           type: string
25842         - name: switch-name
25843           in: query
25844           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
25845           required: false
25846           type: string
25847         - name: heat-stack-id
25848           in: query
25849           description: Heat stack id corresponding to this instance, managed by MSO
25850           required: false
25851           type: string
25852   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
25853     put:
25854       tags:
25855         - Network
25856       summary: see node definition for valid relationships
25857       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
25858       consumes:
25859         - application/json
25860         - application/xml
25861       produces:
25862         - application/json
25863         - application/xml
25864       responses:
25865         "default":
25866           description: Response codes found in [response codes](https://wiki.onap.org/).
25867       parameters:
25868         - name: vnf-id
25869           in: path
25870           description: Unique id of VNF.  This is unique across the graph.
25871           required: true
25872           type: string
25873           example: __VNF-ID__
25874         - name: interface-id
25875           in: path
25876           description: Unique ID of the interface
25877           required: true
25878           type: string
25879           example: __INTERFACE-ID__
25880         - name: body
25881           in: body
25882           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
25883           required: true
25884           schema:
25885             $ref: "#/definitions/relationship"
25886     delete:
25887       tags:
25888         - Network
25889       summary: delete an existing relationship
25890       description: delete an existing relationship
25891       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
25892       consumes:
25893         - application/json
25894         - application/xml
25895       produces:
25896         - application/json
25897         - application/xml
25898       responses:
25899         "default":
25900           description: Response codes found in [response codes](https://wiki.onap.org/).
25901       parameters:
25902         - name: vnf-id
25903           in: path
25904           description: Unique id of VNF.  This is unique across the graph.
25905           required: true
25906           type: string
25907           example: __VNF-ID__
25908         - name: interface-id
25909           in: path
25910           description: Unique ID of the interface
25911           required: true
25912           type: string
25913           example: __INTERFACE-ID__
25914   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
25915     get:
25916       tags:
25917         - Network
25918       summary: returns port-group
25919       description: returns port-group
25920       operationId: getNetworkVcesVcePortGroupsPortGroup
25921       produces:
25922         - application/json
25923         - application/xml
25924       responses:
25925         "200":
25926           description: successful operation
25927           schema:
25928               $ref: "#/getDefinitions/port-group"
25929         "default":
25930           description: Response codes found in [response codes](https://wiki.onap.org/).
25931       parameters:
25932         - name: vnf-id
25933           in: path
25934           description: Unique id of VNF.  This is unique across the graph.
25935           required: true
25936           type: string
25937           example: __VNF-ID__
25938         - name: interface-id
25939           in: path
25940           description: Unique ID of the interface
25941           required: true
25942           type: string
25943           example: __INTERFACE-ID__
25944         - name: vnf-name
25945           in: query
25946           description: Name of VNF.
25947           required: false
25948           type: string
25949         - name: vnf-name2
25950           in: query
25951           description: Alternate name of VNF.
25952           required: false
25953           type: string
25954         - name: vnf-type
25955           in: query
25956           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
25957           required: false
25958           type: string
25959         - name: service-id
25960           in: query
25961           description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
25962           required: false
25963           type: string
25964         - name: regional-resource-zone
25965           in: query
25966           description: Regional way of organizing pservers, source of truth should define values
25967           required: false
25968           type: string
25969         - name: prov-status
25970           in: query
25971           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25972           required: false
25973           type: string
25974         - name: heat-stack-id
25975           in: query
25976           description: Heat stack id corresponding to this instance, managed by MSO
25977           required: false
25978           type: string
25979         - name: vpe-id
25980           in: query
25981           description: Unique ID of VPE connected to this VCE.
25982           required: false
25983           type: string
25984         - name: port-group-id
25985           in: query
25986           description: Unique ID for port group in vmware
25987           required: false
25988           type: string
25989         - name: switch-name
25990           in: query
25991           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
25992           required: false
25993           type: string
25994         - name: heat-stack-id
25995           in: query
25996           description: Heat stack id corresponding to this instance, managed by MSO
25997           required: false
25998           type: string
25999     put:
26000       tags:
26001         - Network
26002       summary: create or update an existing port-group
26003       description: |
26004         Create or update an existing port-group.
26005         #
26006         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
26007       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
26008       consumes:
26009         - application/json
26010         - application/xml
26011       produces:
26012         - application/json
26013         - application/xml
26014       responses:
26015         "default":
26016           description: Response codes found in [response codes](https://wiki.onap.org/).
26017       parameters:
26018         - name: vnf-id
26019           in: path
26020           description: Unique id of VNF.  This is unique across the graph.
26021           required: true
26022           type: string
26023           example: __VNF-ID__
26024         - name: interface-id
26025           in: path
26026           description: Unique ID of the interface
26027           required: true
26028           type: string
26029           example: __INTERFACE-ID__
26030         - name: body
26031           in: body
26032           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVcePortGroupsPortGroup.json)
26033           required: true
26034           schema:
26035             $ref: "#/definitions/port-group"
26036     patch:
26037       tags:
26038         - Network
26039       summary: update an existing port-group
26040       description: |
26041         Update an existing port-group
26042         #
26043         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26044         The PUT operation will entirely replace an existing object.
26045         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.
26046         #
26047         Other differences between PUT and PATCH are:
26048         #
26049         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26050         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26051         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26052       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
26053       consumes:
26054         - application/json
26055         - application/xml
26056       produces:
26057         - application/json
26058         - application/xml
26059       responses:
26060         "default":
26061           description: Response codes found in [response codes](https://wiki.onap.org/).
26062       parameters:
26063         - name: vnf-id
26064           in: path
26065           description: Unique id of VNF.  This is unique across the graph.
26066           required: true
26067           type: string
26068           example: __VNF-ID__
26069         - name: interface-id
26070           in: path
26071           description: Unique ID of the interface
26072           required: true
26073           type: string
26074           example: __INTERFACE-ID__
26075         - name: body
26076           in: body
26077           description: port-group object that needs to be created or updated.
26078           required: true
26079           schema:
26080             $ref: "#/patchDefinitions/port-group"
26081     delete:
26082       tags:
26083         - Network
26084       summary: delete an existing port-group
26085       description: delete an existing port-group
26086       operationId: deleteNetworkVcesVcePortGroupsPortGroup
26087       consumes:
26088         - application/json
26089         - application/xml
26090       produces:
26091         - application/json
26092         - application/xml
26093       responses:
26094         "default":
26095           description: Response codes found in [response codes](https://wiki.onap.org/).
26096       parameters:
26097         - name: vnf-id
26098           in: path
26099           description: Unique id of VNF.  This is unique across the graph.
26100           required: true
26101           type: string
26102           example: __VNF-ID__
26103         - name: interface-id
26104           in: path
26105           description: Unique ID of the interface
26106           required: true
26107           type: string
26108           example: __INTERFACE-ID__
26109         - name: resource-version
26110           in: query
26111           description: resource-version for concurrency
26112           required: true
26113           type: string
26114   /network/vces/vce/{vnf-id}/port-groups:
26115     get:
26116       tags:
26117         - Network
26118       summary: returns port-groups
26119       description: returns port-groups
26120       operationId: getNetworkVcesVcePortGroups
26121       produces:
26122         - application/json
26123         - application/xml
26124       responses:
26125         "200":
26126           description: successful operation
26127           schema:
26128               $ref: "#/getDefinitions/port-groups"
26129         "default":
26130           description: Response codes found in [response codes](https://wiki.onap.org/).
26131       parameters:
26132         - name: vnf-id
26133           in: path
26134           description: Unique id of VNF.  This is unique across the graph.
26135           required: true
26136           type: string
26137           example: __VNF-ID__
26138         - name: vnf-name
26139           in: query
26140           description: Name of VNF.
26141           required: false
26142           type: string
26143         - name: vnf-name2
26144           in: query
26145           description: Alternate name of VNF.
26146           required: false
26147           type: string
26148         - name: vnf-type
26149           in: query
26150           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
26151           required: false
26152           type: string
26153         - name: service-id
26154           in: query
26155           description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
26156           required: false
26157           type: string
26158         - name: regional-resource-zone
26159           in: query
26160           description: Regional way of organizing pservers, source of truth should define values
26161           required: false
26162           type: string
26163         - name: prov-status
26164           in: query
26165           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26166           required: false
26167           type: string
26168         - name: heat-stack-id
26169           in: query
26170           description: Heat stack id corresponding to this instance, managed by MSO
26171           required: false
26172           type: string
26173         - name: vpe-id
26174           in: query
26175           description: Unique ID of VPE connected to this VCE.
26176           required: false
26177           type: string
26178   /network/vces/vce/{vnf-id}/relationship-list/relationship:
26179     put:
26180       tags:
26181         - Network
26182       summary: see node definition for valid relationships
26183       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
26184       consumes:
26185         - application/json
26186         - application/xml
26187       produces:
26188         - application/json
26189         - application/xml
26190       responses:
26191         "default":
26192           description: Response codes found in [response codes](https://wiki.onap.org/).
26193       parameters:
26194         - name: vnf-id
26195           in: path
26196           description: Unique id of VNF.  This is unique across the graph.
26197           required: true
26198           type: string
26199           example: __VNF-ID__
26200         - name: body
26201           in: body
26202           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
26203           required: true
26204           schema:
26205             $ref: "#/definitions/relationship"
26206     delete:
26207       tags:
26208         - Network
26209       summary: delete an existing relationship
26210       description: delete an existing relationship
26211       operationId: deleteNetworkVcesVceRelationshipListRelationship
26212       consumes:
26213         - application/json
26214         - application/xml
26215       produces:
26216         - application/json
26217         - application/xml
26218       responses:
26219         "default":
26220           description: Response codes found in [response codes](https://wiki.onap.org/).
26221       parameters:
26222         - name: vnf-id
26223           in: path
26224           description: Unique id of VNF.  This is unique across the graph.
26225           required: true
26226           type: string
26227           example: __VNF-ID__
26228   /network/vces/vce/{vnf-id}:
26229     get:
26230       tags:
26231         - Network
26232       summary: returns vce
26233       description: returns vce
26234       operationId: getNetworkVcesVce
26235       produces:
26236         - application/json
26237         - application/xml
26238       responses:
26239         "200":
26240           description: successful operation
26241           schema:
26242               $ref: "#/getDefinitions/vce"
26243         "default":
26244           description: Response codes found in [response codes](https://wiki.onap.org/).
26245       parameters:
26246         - name: vnf-id
26247           in: path
26248           description: Unique id of VNF.  This is unique across the graph.
26249           required: true
26250           type: string
26251           example: __VNF-ID__
26252         - name: vnf-name
26253           in: query
26254           description: Name of VNF.
26255           required: false
26256           type: string
26257         - name: vnf-name2
26258           in: query
26259           description: Alternate name of VNF.
26260           required: false
26261           type: string
26262         - name: vnf-type
26263           in: query
26264           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
26265           required: false
26266           type: string
26267         - name: service-id
26268           in: query
26269           description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
26270           required: false
26271           type: string
26272         - name: regional-resource-zone
26273           in: query
26274           description: Regional way of organizing pservers, source of truth should define values
26275           required: false
26276           type: string
26277         - name: prov-status
26278           in: query
26279           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26280           required: false
26281           type: string
26282         - name: heat-stack-id
26283           in: query
26284           description: Heat stack id corresponding to this instance, managed by MSO
26285           required: false
26286           type: string
26287         - name: vpe-id
26288           in: query
26289           description: Unique ID of VPE connected to this VCE.
26290           required: false
26291           type: string
26292     put:
26293       tags:
26294         - Network
26295       summary: create or update an existing vce
26296       description: |
26297         Create or update an existing vce.
26298         #
26299         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
26300       operationId: createOrUpdateNetworkVcesVce
26301       consumes:
26302         - application/json
26303         - application/xml
26304       produces:
26305         - application/json
26306         - application/xml
26307       responses:
26308         "default":
26309           description: Response codes found in [response codes](https://wiki.onap.org/).
26310       parameters:
26311         - name: vnf-id
26312           in: path
26313           description: Unique id of VNF.  This is unique across the graph.
26314           required: true
26315           type: string
26316           example: __VNF-ID__
26317         - name: body
26318           in: body
26319           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVcesVce.json)
26320           required: true
26321           schema:
26322             $ref: "#/definitions/vce"
26323     patch:
26324       tags:
26325         - Network
26326       summary: update an existing vce
26327       description: |
26328         Update an existing vce
26329         #
26330         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26331         The PUT operation will entirely replace an existing object.
26332         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.
26333         #
26334         Other differences between PUT and PATCH are:
26335         #
26336         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26337         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26338         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26339       operationId: UpdateNetworkVcesVce
26340       consumes:
26341         - application/json
26342         - application/xml
26343       produces:
26344         - application/json
26345         - application/xml
26346       responses:
26347         "default":
26348           description: Response codes found in [response codes](https://wiki.onap.org/).
26349       parameters:
26350         - name: vnf-id
26351           in: path
26352           description: Unique id of VNF.  This is unique across the graph.
26353           required: true
26354           type: string
26355           example: __VNF-ID__
26356         - name: body
26357           in: body
26358           description: vce object that needs to be created or updated.
26359           required: true
26360           schema:
26361             $ref: "#/patchDefinitions/vce"
26362     delete:
26363       tags:
26364         - Network
26365       summary: delete an existing vce
26366       description: delete an existing vce
26367       operationId: deleteNetworkVcesVce
26368       consumes:
26369         - application/json
26370         - application/xml
26371       produces:
26372         - application/json
26373         - application/xml
26374       responses:
26375         "default":
26376           description: Response codes found in [response codes](https://wiki.onap.org/).
26377       parameters:
26378         - name: vnf-id
26379           in: path
26380           description: Unique id of VNF.  This is unique across the graph.
26381           required: true
26382           type: string
26383           example: __VNF-ID__
26384         - name: resource-version
26385           in: query
26386           description: resource-version for concurrency
26387           required: true
26388           type: string
26389   /network/vces:
26390     get:
26391       tags:
26392         - Network
26393       summary: returns vces
26394       description: returns vces
26395       operationId: getNetworkVces
26396       produces:
26397         - application/json
26398         - application/xml
26399       responses:
26400         "200":
26401           description: successful operation
26402           schema:
26403               $ref: "#/getDefinitions/vces"
26404         "default":
26405           description: Response codes found in [response codes](https://wiki.onap.org/).
26406   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
26407     put:
26408       tags:
26409         - Network
26410       summary: see node definition for valid relationships
26411       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
26412       consumes:
26413         - application/json
26414         - application/xml
26415       produces:
26416         - application/json
26417         - application/xml
26418       responses:
26419         "default":
26420           description: Response codes found in [response codes](https://wiki.onap.org/).
26421       parameters:
26422         - name: vnfc-name
26423           in: path
26424           description: Unique ID of vnfc.
26425           required: true
26426           type: string
26427           example: __VNFC-NAME__
26428         - name: body
26429           in: body
26430           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
26431           required: true
26432           schema:
26433             $ref: "#/definitions/relationship"
26434     delete:
26435       tags:
26436         - Network
26437       summary: delete an existing relationship
26438       description: delete an existing relationship
26439       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
26440       consumes:
26441         - application/json
26442         - application/xml
26443       produces:
26444         - application/json
26445         - application/xml
26446       responses:
26447         "default":
26448           description: Response codes found in [response codes](https://wiki.onap.org/).
26449       parameters:
26450         - name: vnfc-name
26451           in: path
26452           description: Unique ID of vnfc.
26453           required: true
26454           type: string
26455           example: __VNFC-NAME__
26456   /network/vnfcs/vnfc/{vnfc-name}:
26457     get:
26458       tags:
26459         - Network
26460       summary: returns vnfc
26461       description: returns vnfc
26462       operationId: getNetworkVnfcsVnfc
26463       produces:
26464         - application/json
26465         - application/xml
26466       responses:
26467         "200":
26468           description: successful operation
26469           schema:
26470               $ref: "#/getDefinitions/vnfc"
26471         "default":
26472           description: Response codes found in [response codes](https://wiki.onap.org/).
26473       parameters:
26474         - name: vnfc-name
26475           in: path
26476           description: Unique ID of vnfc.
26477           required: true
26478           type: string
26479           example: __VNFC-NAME__
26480         - name: vnfc-function-code
26481           in: query
26482           description: function code
26483           required: false
26484           type: string
26485         - name: vnfc-type
26486           in: query
26487           description: type
26488           required: false
26489           type: string
26490         - name: prov-status
26491           in: query
26492           description: prov status of this vnfc
26493           required: false
26494           type: string
26495         - name: ipaddress-v4-oam-vip
26496           in: query
26497           description: Oam V4 vip address of this vnfc
26498           required: false
26499           type: string
26500         - name: in-maint
26501           in: query
26502           required: false
26503           type: boolean
26504         - name: is-closed-loop-disabled
26505           in: query
26506           required: false
26507           type: boolean
26508         - name: group-notation
26509           in: query
26510           description: Group notation of VNFC
26511           required: false
26512           type: string
26513     put:
26514       tags:
26515         - Network
26516       summary: create or update an existing vnfc
26517       description: |
26518         Create or update an existing vnfc.
26519         #
26520         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
26521       operationId: createOrUpdateNetworkVnfcsVnfc
26522       consumes:
26523         - application/json
26524         - application/xml
26525       produces:
26526         - application/json
26527         - application/xml
26528       responses:
26529         "default":
26530           description: Response codes found in [response codes](https://wiki.onap.org/).
26531       parameters:
26532         - name: vnfc-name
26533           in: path
26534           description: Unique ID of vnfc.
26535           required: true
26536           type: string
26537           example: __VNFC-NAME__
26538         - name: body
26539           in: body
26540           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkVnfcsVnfc.json)
26541           required: true
26542           schema:
26543             $ref: "#/definitions/vnfc"
26544     patch:
26545       tags:
26546         - Network
26547       summary: update an existing vnfc
26548       description: |
26549         Update an existing vnfc
26550         #
26551         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26552         The PUT operation will entirely replace an existing object.
26553         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.
26554         #
26555         Other differences between PUT and PATCH are:
26556         #
26557         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26558         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26559         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26560       operationId: UpdateNetworkVnfcsVnfc
26561       consumes:
26562         - application/json
26563         - application/xml
26564       produces:
26565         - application/json
26566         - application/xml
26567       responses:
26568         "default":
26569           description: Response codes found in [response codes](https://wiki.onap.org/).
26570       parameters:
26571         - name: vnfc-name
26572           in: path
26573           description: Unique ID of vnfc.
26574           required: true
26575           type: string
26576           example: __VNFC-NAME__
26577         - name: body
26578           in: body
26579           description: vnfc object that needs to be created or updated.
26580           required: true
26581           schema:
26582             $ref: "#/patchDefinitions/vnfc"
26583     delete:
26584       tags:
26585         - Network
26586       summary: delete an existing vnfc
26587       description: delete an existing vnfc
26588       operationId: deleteNetworkVnfcsVnfc
26589       consumes:
26590         - application/json
26591         - application/xml
26592       produces:
26593         - application/json
26594         - application/xml
26595       responses:
26596         "default":
26597           description: Response codes found in [response codes](https://wiki.onap.org/).
26598       parameters:
26599         - name: vnfc-name
26600           in: path
26601           description: Unique ID of vnfc.
26602           required: true
26603           type: string
26604           example: __VNFC-NAME__
26605         - name: resource-version
26606           in: query
26607           description: resource-version for concurrency
26608           required: true
26609           type: string
26610   /network/vnfcs:
26611     get:
26612       tags:
26613         - Network
26614       summary: returns vnfcs
26615       description: returns vnfcs
26616       operationId: getNetworkVnfcs
26617       produces:
26618         - application/json
26619         - application/xml
26620       responses:
26621         "200":
26622           description: successful operation
26623           schema:
26624               $ref: "#/getDefinitions/vnfcs"
26625         "default":
26626           description: Response codes found in [response codes](https://wiki.onap.org/).
26627   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
26628     put:
26629       tags:
26630         - Network
26631       summary: see node definition for valid relationships
26632       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26633       consumes:
26634         - application/json
26635         - application/xml
26636       produces:
26637         - application/json
26638         - application/xml
26639       responses:
26640         "default":
26641           description: Response codes found in [response codes](https://wiki.onap.org/).
26642       parameters:
26643         - name: network-id
26644           in: path
26645           description: Network ID, should be uuid. Unique across A&AI.
26646           required: true
26647           type: string
26648           example: __NETWORK-ID__
26649         - name: subnet-id
26650           in: path
26651           description: Subnet ID, should be UUID.
26652           required: true
26653           type: string
26654           example: __SUBNET-ID__
26655         - name: body
26656           in: body
26657           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26658           required: true
26659           schema:
26660             $ref: "#/definitions/relationship"
26661     delete:
26662       tags:
26663         - Network
26664       summary: delete an existing relationship
26665       description: delete an existing relationship
26666       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
26667       consumes:
26668         - application/json
26669         - application/xml
26670       produces:
26671         - application/json
26672         - application/xml
26673       responses:
26674         "default":
26675           description: Response codes found in [response codes](https://wiki.onap.org/).
26676       parameters:
26677         - name: network-id
26678           in: path
26679           description: Network ID, should be uuid. Unique across A&AI.
26680           required: true
26681           type: string
26682           example: __NETWORK-ID__
26683         - name: subnet-id
26684           in: path
26685           description: Subnet ID, should be UUID.
26686           required: true
26687           type: string
26688           example: __SUBNET-ID__
26689   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
26690     get:
26691       tags:
26692         - Network
26693       summary: returns subnet
26694       description: returns subnet
26695       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
26696       produces:
26697         - application/json
26698         - application/xml
26699       responses:
26700         "200":
26701           description: successful operation
26702           schema:
26703               $ref: "#/getDefinitions/subnet"
26704         "default":
26705           description: Response codes found in [response codes](https://wiki.onap.org/).
26706       parameters:
26707         - name: network-id
26708           in: path
26709           description: Network ID, should be uuid. Unique across A&AI.
26710           required: true
26711           type: string
26712           example: __NETWORK-ID__
26713         - name: subnet-id
26714           in: path
26715           description: Subnet ID, should be UUID.
26716           required: true
26717           type: string
26718           example: __SUBNET-ID__
26719         - name: network-name
26720           in: query
26721           description: Name of the network, governed by some naming convention..
26722           required: false
26723           type: string
26724         - name: service-id
26725           in: query
26726           description: Unique identifier of service from ASDC
26727           required: false
26728           type: string
26729         - name: heat-stack-id
26730           in: query
26731           description: Heat stack id corresponding to this instance, managed by MSO
26732           required: false
26733           type: string
26734         - name: contrail-network-fqdn
26735           in: query
26736           description: Contrail FQDN for the network
26737           required: false
26738           type: string
26739         - name: persona-model-id
26740           in: query
26741           description: the ASDC model id for this resource or service model.
26742           required: false
26743           type: string
26744         - name: persona-model-version
26745           in: query
26746           description: the ASDC model version for this resource or service model.
26747           required: false
26748           type: string
26749         - name: widget-model-id
26750           in: query
26751           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
26752           required: false
26753           type: string
26754         - name: widget-model-version
26755           in: query
26756           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
26757           required: false
26758           type: string
26759         - name: subnet-name
26760           in: query
26761           description: Name associated with the subnet.
26762           required: false
26763           type: string
26764     put:
26765       tags:
26766         - Network
26767       summary: create or update an existing subnet
26768       description: |
26769         Create or update an existing subnet.
26770         #
26771         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
26772       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26773       consumes:
26774         - application/json
26775         - application/xml
26776       produces:
26777         - application/json
26778         - application/xml
26779       responses:
26780         "default":
26781           description: Response codes found in [response codes](https://wiki.onap.org/).
26782       parameters:
26783         - name: network-id
26784           in: path
26785           description: Network ID, should be uuid. Unique across A&AI.
26786           required: true
26787           type: string
26788           example: __NETWORK-ID__
26789         - name: subnet-id
26790           in: path
26791           description: Subnet ID, should be UUID.
26792           required: true
26793           type: string
26794           example: __SUBNET-ID__
26795         - name: body
26796           in: body
26797           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
26798           required: true
26799           schema:
26800             $ref: "#/definitions/subnet"
26801     patch:
26802       tags:
26803         - Network
26804       summary: update an existing subnet
26805       description: |
26806         Update an existing subnet
26807         #
26808         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26809         The PUT operation will entirely replace an existing object.
26810         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.
26811         #
26812         Other differences between PUT and PATCH are:
26813         #
26814         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26815         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26816         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26817       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
26818       consumes:
26819         - application/json
26820         - application/xml
26821       produces:
26822         - application/json
26823         - application/xml
26824       responses:
26825         "default":
26826           description: Response codes found in [response codes](https://wiki.onap.org/).
26827       parameters:
26828         - name: network-id
26829           in: path
26830           description: Network ID, should be uuid. Unique across A&AI.
26831           required: true
26832           type: string
26833           example: __NETWORK-ID__
26834         - name: subnet-id
26835           in: path
26836           description: Subnet ID, should be UUID.
26837           required: true
26838           type: string
26839           example: __SUBNET-ID__
26840         - name: body
26841           in: body
26842           description: subnet object that needs to be created or updated.
26843           required: true
26844           schema:
26845             $ref: "#/patchDefinitions/subnet"
26846     delete:
26847       tags:
26848         - Network
26849       summary: delete an existing subnet
26850       description: delete an existing subnet
26851       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
26852       consumes:
26853         - application/json
26854         - application/xml
26855       produces:
26856         - application/json
26857         - application/xml
26858       responses:
26859         "default":
26860           description: Response codes found in [response codes](https://wiki.onap.org/).
26861       parameters:
26862         - name: network-id
26863           in: path
26864           description: Network ID, should be uuid. Unique across A&AI.
26865           required: true
26866           type: string
26867           example: __NETWORK-ID__
26868         - name: subnet-id
26869           in: path
26870           description: Subnet ID, should be UUID.
26871           required: true
26872           type: string
26873           example: __SUBNET-ID__
26874         - name: resource-version
26875           in: query
26876           description: resource-version for concurrency
26877           required: true
26878           type: string
26879   /network/l3-networks/l3-network/{network-id}/subnets:
26880     get:
26881       tags:
26882         - Network
26883       summary: returns subnets
26884       description: returns subnets
26885       operationId: getNetworkL3NetworksL3NetworkSubnets
26886       produces:
26887         - application/json
26888         - application/xml
26889       responses:
26890         "200":
26891           description: successful operation
26892           schema:
26893               $ref: "#/getDefinitions/subnets"
26894         "default":
26895           description: Response codes found in [response codes](https://wiki.onap.org/).
26896       parameters:
26897         - name: network-id
26898           in: path
26899           description: Network ID, should be uuid. Unique across A&AI.
26900           required: true
26901           type: string
26902           example: __NETWORK-ID__
26903         - name: network-name
26904           in: query
26905           description: Name of the network, governed by some naming convention..
26906           required: false
26907           type: string
26908         - name: service-id
26909           in: query
26910           description: Unique identifier of service from ASDC
26911           required: false
26912           type: string
26913         - name: heat-stack-id
26914           in: query
26915           description: Heat stack id corresponding to this instance, managed by MSO
26916           required: false
26917           type: string
26918         - name: contrail-network-fqdn
26919           in: query
26920           description: Contrail FQDN for the network
26921           required: false
26922           type: string
26923         - name: persona-model-id
26924           in: query
26925           description: the ASDC model id for this resource or service model.
26926           required: false
26927           type: string
26928         - name: persona-model-version
26929           in: query
26930           description: the ASDC model version for this resource or service model.
26931           required: false
26932           type: string
26933         - name: widget-model-id
26934           in: query
26935           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
26936           required: false
26937           type: string
26938         - name: widget-model-version
26939           in: query
26940           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
26941           required: false
26942           type: string
26943   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
26944     put:
26945       tags:
26946         - Network
26947       summary: see node definition for valid relationships
26948       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26949       consumes:
26950         - application/json
26951         - application/xml
26952       produces:
26953         - application/json
26954         - application/xml
26955       responses:
26956         "default":
26957           description: Response codes found in [response codes](https://wiki.onap.org/).
26958       parameters:
26959         - name: network-id
26960           in: path
26961           description: Network ID, should be uuid. Unique across A&AI.
26962           required: true
26963           type: string
26964           example: __NETWORK-ID__
26965         - name: vlan-id-inner
26966           in: path
26967           description: id.
26968           required: true
26969           type: integer
26970           format: int64
26971           example: __VLAN-ID-INNER__
26972         - name: body
26973           in: body
26974           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
26975           required: true
26976           schema:
26977             $ref: "#/definitions/relationship"
26978     delete:
26979       tags:
26980         - Network
26981       summary: delete an existing relationship
26982       description: delete an existing relationship
26983       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
26984       consumes:
26985         - application/json
26986         - application/xml
26987       produces:
26988         - application/json
26989         - application/xml
26990       responses:
26991         "default":
26992           description: Response codes found in [response codes](https://wiki.onap.org/).
26993       parameters:
26994         - name: network-id
26995           in: path
26996           description: Network ID, should be uuid. Unique across A&AI.
26997           required: true
26998           type: string
26999           example: __NETWORK-ID__
27000         - name: vlan-id-inner
27001           in: path
27002           description: id.
27003           required: true
27004           type: integer
27005           format: int64
27006           example: __VLAN-ID-INNER__
27007   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
27008     get:
27009       tags:
27010         - Network
27011       summary: returns ctag-assignment
27012       description: returns ctag-assignment
27013       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27014       produces:
27015         - application/json
27016         - application/xml
27017       responses:
27018         "200":
27019           description: successful operation
27020           schema:
27021               $ref: "#/getDefinitions/ctag-assignment"
27022         "default":
27023           description: Response codes found in [response codes](https://wiki.onap.org/).
27024       parameters:
27025         - name: network-id
27026           in: path
27027           description: Network ID, should be uuid. Unique across A&AI.
27028           required: true
27029           type: string
27030           example: __NETWORK-ID__
27031         - name: vlan-id-inner
27032           in: path
27033           description: id.
27034           required: true
27035           type: integer
27036           format: int64
27037           example: __VLAN-ID-INNER__
27038         - name: network-name
27039           in: query
27040           description: Name of the network, governed by some naming convention..
27041           required: false
27042           type: string
27043         - name: service-id
27044           in: query
27045           description: Unique identifier of service from ASDC
27046           required: false
27047           type: string
27048         - name: heat-stack-id
27049           in: query
27050           description: Heat stack id corresponding to this instance, managed by MSO
27051           required: false
27052           type: string
27053         - name: contrail-network-fqdn
27054           in: query
27055           description: Contrail FQDN for the network
27056           required: false
27057           type: string
27058         - name: persona-model-id
27059           in: query
27060           description: the ASDC model id for this resource or service model.
27061           required: false
27062           type: string
27063         - name: persona-model-version
27064           in: query
27065           description: the ASDC model version for this resource or service model.
27066           required: false
27067           type: string
27068         - name: widget-model-id
27069           in: query
27070           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27071           required: false
27072           type: string
27073         - name: widget-model-version
27074           in: query
27075           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27076           required: false
27077           type: string
27078     put:
27079       tags:
27080         - Network
27081       summary: create or update an existing ctag-assignment
27082       description: |
27083         Create or update an existing ctag-assignment.
27084         #
27085         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
27086       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27087       consumes:
27088         - application/json
27089         - application/xml
27090       produces:
27091         - application/json
27092         - application/xml
27093       responses:
27094         "default":
27095           description: Response codes found in [response codes](https://wiki.onap.org/).
27096       parameters:
27097         - name: network-id
27098           in: path
27099           description: Network ID, should be uuid. Unique across A&AI.
27100           required: true
27101           type: string
27102           example: __NETWORK-ID__
27103         - name: vlan-id-inner
27104           in: path
27105           description: id.
27106           required: true
27107           type: integer
27108           format: int64
27109           example: __VLAN-ID-INNER__
27110         - name: body
27111           in: body
27112           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
27113           required: true
27114           schema:
27115             $ref: "#/definitions/ctag-assignment"
27116     patch:
27117       tags:
27118         - Network
27119       summary: update an existing ctag-assignment
27120       description: |
27121         Update an existing ctag-assignment
27122         #
27123         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27124         The PUT operation will entirely replace an existing object.
27125         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.
27126         #
27127         Other differences between PUT and PATCH are:
27128         #
27129         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27130         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27131         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27132       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27133       consumes:
27134         - application/json
27135         - application/xml
27136       produces:
27137         - application/json
27138         - application/xml
27139       responses:
27140         "default":
27141           description: Response codes found in [response codes](https://wiki.onap.org/).
27142       parameters:
27143         - name: network-id
27144           in: path
27145           description: Network ID, should be uuid. Unique across A&AI.
27146           required: true
27147           type: string
27148           example: __NETWORK-ID__
27149         - name: vlan-id-inner
27150           in: path
27151           description: id.
27152           required: true
27153           type: integer
27154           format: int64
27155           example: __VLAN-ID-INNER__
27156         - name: body
27157           in: body
27158           description: ctag-assignment object that needs to be created or updated.
27159           required: true
27160           schema:
27161             $ref: "#/patchDefinitions/ctag-assignment"
27162     delete:
27163       tags:
27164         - Network
27165       summary: delete an existing ctag-assignment
27166       description: delete an existing ctag-assignment
27167       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
27168       consumes:
27169         - application/json
27170         - application/xml
27171       produces:
27172         - application/json
27173         - application/xml
27174       responses:
27175         "default":
27176           description: Response codes found in [response codes](https://wiki.onap.org/).
27177       parameters:
27178         - name: network-id
27179           in: path
27180           description: Network ID, should be uuid. Unique across A&AI.
27181           required: true
27182           type: string
27183           example: __NETWORK-ID__
27184         - name: vlan-id-inner
27185           in: path
27186           description: id.
27187           required: true
27188           type: integer
27189           format: int64
27190           example: __VLAN-ID-INNER__
27191         - name: resource-version
27192           in: query
27193           description: resource-version for concurrency
27194           required: true
27195           type: string
27196   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
27197     get:
27198       tags:
27199         - Network
27200       summary: returns ctag-assignments
27201       description: returns ctag-assignments
27202       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
27203       produces:
27204         - application/json
27205         - application/xml
27206       responses:
27207         "200":
27208           description: successful operation
27209           schema:
27210               $ref: "#/getDefinitions/ctag-assignments"
27211         "default":
27212           description: Response codes found in [response codes](https://wiki.onap.org/).
27213       parameters:
27214         - name: network-id
27215           in: path
27216           description: Network ID, should be uuid. Unique across A&AI.
27217           required: true
27218           type: string
27219           example: __NETWORK-ID__
27220         - name: network-name
27221           in: query
27222           description: Name of the network, governed by some naming convention..
27223           required: false
27224           type: string
27225         - name: service-id
27226           in: query
27227           description: Unique identifier of service from ASDC
27228           required: false
27229           type: string
27230         - name: heat-stack-id
27231           in: query
27232           description: Heat stack id corresponding to this instance, managed by MSO
27233           required: false
27234           type: string
27235         - name: contrail-network-fqdn
27236           in: query
27237           description: Contrail FQDN for the network
27238           required: false
27239           type: string
27240         - name: persona-model-id
27241           in: query
27242           description: the ASDC model id for this resource or service model.
27243           required: false
27244           type: string
27245         - name: persona-model-version
27246           in: query
27247           description: the ASDC model version for this resource or service model.
27248           required: false
27249           type: string
27250         - name: widget-model-id
27251           in: query
27252           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27253           required: false
27254           type: string
27255         - name: widget-model-version
27256           in: query
27257           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27258           required: false
27259           type: string
27260   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
27261     put:
27262       tags:
27263         - Network
27264       summary: see node definition for valid relationships
27265       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
27266       consumes:
27267         - application/json
27268         - application/xml
27269       produces:
27270         - application/json
27271         - application/xml
27272       responses:
27273         "default":
27274           description: Response codes found in [response codes](https://wiki.onap.org/).
27275       parameters:
27276         - name: network-id
27277           in: path
27278           description: Network ID, should be uuid. Unique across A&AI.
27279           required: true
27280           type: string
27281           example: __NETWORK-ID__
27282         - name: segmentation-id
27283           in: path
27284           description: Route Table Reference id, UUID assigned to this instance.
27285           required: true
27286           type: string
27287           example: __SEGMENTATION-ID__
27288         - name: body
27289           in: body
27290           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
27291           required: true
27292           schema:
27293             $ref: "#/definitions/relationship"
27294     delete:
27295       tags:
27296         - Network
27297       summary: delete an existing relationship
27298       description: delete an existing relationship
27299       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
27300       consumes:
27301         - application/json
27302         - application/xml
27303       produces:
27304         - application/json
27305         - application/xml
27306       responses:
27307         "default":
27308           description: Response codes found in [response codes](https://wiki.onap.org/).
27309       parameters:
27310         - name: network-id
27311           in: path
27312           description: Network ID, should be uuid. Unique across A&AI.
27313           required: true
27314           type: string
27315           example: __NETWORK-ID__
27316         - name: segmentation-id
27317           in: path
27318           description: Route Table Reference id, UUID assigned to this instance.
27319           required: true
27320           type: string
27321           example: __SEGMENTATION-ID__
27322   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
27323     get:
27324       tags:
27325         - Network
27326       summary: returns segmentation-assignment
27327       description: returns segmentation-assignment
27328       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27329       produces:
27330         - application/json
27331         - application/xml
27332       responses:
27333         "200":
27334           description: successful operation
27335           schema:
27336               $ref: "#/getDefinitions/segmentation-assignment"
27337         "default":
27338           description: Response codes found in [response codes](https://wiki.onap.org/).
27339       parameters:
27340         - name: network-id
27341           in: path
27342           description: Network ID, should be uuid. Unique across A&AI.
27343           required: true
27344           type: string
27345           example: __NETWORK-ID__
27346         - name: segmentation-id
27347           in: path
27348           description: Route Table Reference id, UUID assigned to this instance.
27349           required: true
27350           type: string
27351           example: __SEGMENTATION-ID__
27352         - name: network-name
27353           in: query
27354           description: Name of the network, governed by some naming convention..
27355           required: false
27356           type: string
27357         - name: service-id
27358           in: query
27359           description: Unique identifier of service from ASDC
27360           required: false
27361           type: string
27362         - name: heat-stack-id
27363           in: query
27364           description: Heat stack id corresponding to this instance, managed by MSO
27365           required: false
27366           type: string
27367         - name: contrail-network-fqdn
27368           in: query
27369           description: Contrail FQDN for the network
27370           required: false
27371           type: string
27372         - name: persona-model-id
27373           in: query
27374           description: the ASDC model id for this resource or service model.
27375           required: false
27376           type: string
27377         - name: persona-model-version
27378           in: query
27379           description: the ASDC model version for this resource or service model.
27380           required: false
27381           type: string
27382         - name: widget-model-id
27383           in: query
27384           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27385           required: false
27386           type: string
27387         - name: widget-model-version
27388           in: query
27389           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27390           required: false
27391           type: string
27392     put:
27393       tags:
27394         - Network
27395       summary: create or update an existing segmentation-assignment
27396       description: |
27397         Create or update an existing segmentation-assignment.
27398         #
27399         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
27400       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27401       consumes:
27402         - application/json
27403         - application/xml
27404       produces:
27405         - application/json
27406         - application/xml
27407       responses:
27408         "default":
27409           description: Response codes found in [response codes](https://wiki.onap.org/).
27410       parameters:
27411         - name: network-id
27412           in: path
27413           description: Network ID, should be uuid. Unique across A&AI.
27414           required: true
27415           type: string
27416           example: __NETWORK-ID__
27417         - name: segmentation-id
27418           in: path
27419           description: Route Table Reference id, UUID assigned to this instance.
27420           required: true
27421           type: string
27422           example: __SEGMENTATION-ID__
27423         - name: body
27424           in: body
27425           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
27426           required: true
27427           schema:
27428             $ref: "#/definitions/segmentation-assignment"
27429     patch:
27430       tags:
27431         - Network
27432       summary: update an existing segmentation-assignment
27433       description: |
27434         Update an existing segmentation-assignment
27435         #
27436         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27437         The PUT operation will entirely replace an existing object.
27438         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.
27439         #
27440         Other differences between PUT and PATCH are:
27441         #
27442         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27443         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27444         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27445       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27446       consumes:
27447         - application/json
27448         - application/xml
27449       produces:
27450         - application/json
27451         - application/xml
27452       responses:
27453         "default":
27454           description: Response codes found in [response codes](https://wiki.onap.org/).
27455       parameters:
27456         - name: network-id
27457           in: path
27458           description: Network ID, should be uuid. Unique across A&AI.
27459           required: true
27460           type: string
27461           example: __NETWORK-ID__
27462         - name: segmentation-id
27463           in: path
27464           description: Route Table Reference id, UUID assigned to this instance.
27465           required: true
27466           type: string
27467           example: __SEGMENTATION-ID__
27468         - name: body
27469           in: body
27470           description: segmentation-assignment object that needs to be created or updated.
27471           required: true
27472           schema:
27473             $ref: "#/patchDefinitions/segmentation-assignment"
27474     delete:
27475       tags:
27476         - Network
27477       summary: delete an existing segmentation-assignment
27478       description: delete an existing segmentation-assignment
27479       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
27480       consumes:
27481         - application/json
27482         - application/xml
27483       produces:
27484         - application/json
27485         - application/xml
27486       responses:
27487         "default":
27488           description: Response codes found in [response codes](https://wiki.onap.org/).
27489       parameters:
27490         - name: network-id
27491           in: path
27492           description: Network ID, should be uuid. Unique across A&AI.
27493           required: true
27494           type: string
27495           example: __NETWORK-ID__
27496         - name: segmentation-id
27497           in: path
27498           description: Route Table Reference id, UUID assigned to this instance.
27499           required: true
27500           type: string
27501           example: __SEGMENTATION-ID__
27502         - name: resource-version
27503           in: query
27504           description: resource-version for concurrency
27505           required: true
27506           type: string
27507   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
27508     get:
27509       tags:
27510         - Network
27511       summary: returns segmentation-assignments
27512       description: returns segmentation-assignments
27513       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
27514       produces:
27515         - application/json
27516         - application/xml
27517       responses:
27518         "200":
27519           description: successful operation
27520           schema:
27521               $ref: "#/getDefinitions/segmentation-assignments"
27522         "default":
27523           description: Response codes found in [response codes](https://wiki.onap.org/).
27524       parameters:
27525         - name: network-id
27526           in: path
27527           description: Network ID, should be uuid. Unique across A&AI.
27528           required: true
27529           type: string
27530           example: __NETWORK-ID__
27531         - name: network-name
27532           in: query
27533           description: Name of the network, governed by some naming convention..
27534           required: false
27535           type: string
27536         - name: service-id
27537           in: query
27538           description: Unique identifier of service from ASDC
27539           required: false
27540           type: string
27541         - name: heat-stack-id
27542           in: query
27543           description: Heat stack id corresponding to this instance, managed by MSO
27544           required: false
27545           type: string
27546         - name: contrail-network-fqdn
27547           in: query
27548           description: Contrail FQDN for the network
27549           required: false
27550           type: string
27551         - name: persona-model-id
27552           in: query
27553           description: the ASDC model id for this resource or service model.
27554           required: false
27555           type: string
27556         - name: persona-model-version
27557           in: query
27558           description: the ASDC model version for this resource or service model.
27559           required: false
27560           type: string
27561         - name: widget-model-id
27562           in: query
27563           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27564           required: false
27565           type: string
27566         - name: widget-model-version
27567           in: query
27568           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27569           required: false
27570           type: string
27571   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
27572     put:
27573       tags:
27574         - Network
27575       summary: see node definition for valid relationships
27576       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
27577       consumes:
27578         - application/json
27579         - application/xml
27580       produces:
27581         - application/json
27582         - application/xml
27583       responses:
27584         "default":
27585           description: Response codes found in [response codes](https://wiki.onap.org/).
27586       parameters:
27587         - name: network-id
27588           in: path
27589           description: Network ID, should be uuid. Unique across A&AI.
27590           required: true
27591           type: string
27592           example: __NETWORK-ID__
27593         - name: body
27594           in: body
27595           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
27596           required: true
27597           schema:
27598             $ref: "#/definitions/relationship"
27599     delete:
27600       tags:
27601         - Network
27602       summary: delete an existing relationship
27603       description: delete an existing relationship
27604       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
27605       consumes:
27606         - application/json
27607         - application/xml
27608       produces:
27609         - application/json
27610         - application/xml
27611       responses:
27612         "default":
27613           description: Response codes found in [response codes](https://wiki.onap.org/).
27614       parameters:
27615         - name: network-id
27616           in: path
27617           description: Network ID, should be uuid. Unique across A&AI.
27618           required: true
27619           type: string
27620           example: __NETWORK-ID__
27621   /network/l3-networks/l3-network/{network-id}:
27622     get:
27623       tags:
27624         - Network
27625       summary: returns l3-network
27626       description: returns l3-network
27627       operationId: getNetworkL3NetworksL3Network
27628       produces:
27629         - application/json
27630         - application/xml
27631       responses:
27632         "200":
27633           description: successful operation
27634           schema:
27635               $ref: "#/getDefinitions/l3-network"
27636         "default":
27637           description: Response codes found in [response codes](https://wiki.onap.org/).
27638       parameters:
27639         - name: network-id
27640           in: path
27641           description: Network ID, should be uuid. Unique across A&AI.
27642           required: true
27643           type: string
27644           example: __NETWORK-ID__
27645         - name: network-name
27646           in: query
27647           description: Name of the network, governed by some naming convention..
27648           required: false
27649           type: string
27650         - name: service-id
27651           in: query
27652           description: Unique identifier of service from ASDC
27653           required: false
27654           type: string
27655         - name: heat-stack-id
27656           in: query
27657           description: Heat stack id corresponding to this instance, managed by MSO
27658           required: false
27659           type: string
27660         - name: contrail-network-fqdn
27661           in: query
27662           description: Contrail FQDN for the network
27663           required: false
27664           type: string
27665         - name: persona-model-id
27666           in: query
27667           description: the ASDC model id for this resource or service model.
27668           required: false
27669           type: string
27670         - name: persona-model-version
27671           in: query
27672           description: the ASDC model version for this resource or service model.
27673           required: false
27674           type: string
27675         - name: widget-model-id
27676           in: query
27677           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
27678           required: false
27679           type: string
27680         - name: widget-model-version
27681           in: query
27682           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
27683           required: false
27684           type: string
27685     put:
27686       tags:
27687         - Network
27688       summary: create or update an existing l3-network
27689       description: |
27690         Create or update an existing l3-network.
27691         #
27692         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
27693       operationId: createOrUpdateNetworkL3NetworksL3Network
27694       consumes:
27695         - application/json
27696         - application/xml
27697       produces:
27698         - application/json
27699         - application/xml
27700       responses:
27701         "default":
27702           description: Response codes found in [response codes](https://wiki.onap.org/).
27703       parameters:
27704         - name: network-id
27705           in: path
27706           description: Network ID, should be uuid. Unique across A&AI.
27707           required: true
27708           type: string
27709           example: __NETWORK-ID__
27710         - name: body
27711           in: body
27712           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkL3NetworksL3Network.json)
27713           required: true
27714           schema:
27715             $ref: "#/definitions/l3-network"
27716     patch:
27717       tags:
27718         - Network
27719       summary: update an existing l3-network
27720       description: |
27721         Update an existing l3-network
27722         #
27723         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27724         The PUT operation will entirely replace an existing object.
27725         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.
27726         #
27727         Other differences between PUT and PATCH are:
27728         #
27729         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27730         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27731         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27732       operationId: UpdateNetworkL3NetworksL3Network
27733       consumes:
27734         - application/json
27735         - application/xml
27736       produces:
27737         - application/json
27738         - application/xml
27739       responses:
27740         "default":
27741           description: Response codes found in [response codes](https://wiki.onap.org/).
27742       parameters:
27743         - name: network-id
27744           in: path
27745           description: Network ID, should be uuid. Unique across A&AI.
27746           required: true
27747           type: string
27748           example: __NETWORK-ID__
27749         - name: body
27750           in: body
27751           description: l3-network object that needs to be created or updated.
27752           required: true
27753           schema:
27754             $ref: "#/patchDefinitions/l3-network"
27755     delete:
27756       tags:
27757         - Network
27758       summary: delete an existing l3-network
27759       description: delete an existing l3-network
27760       operationId: deleteNetworkL3NetworksL3Network
27761       consumes:
27762         - application/json
27763         - application/xml
27764       produces:
27765         - application/json
27766         - application/xml
27767       responses:
27768         "default":
27769           description: Response codes found in [response codes](https://wiki.onap.org/).
27770       parameters:
27771         - name: network-id
27772           in: path
27773           description: Network ID, should be uuid. Unique across A&AI.
27774           required: true
27775           type: string
27776           example: __NETWORK-ID__
27777         - name: resource-version
27778           in: query
27779           description: resource-version for concurrency
27780           required: true
27781           type: string
27782   /network/l3-networks:
27783     get:
27784       tags:
27785         - Network
27786       summary: returns l3-networks
27787       description: returns l3-networks
27788       operationId: getNetworkL3Networks
27789       produces:
27790         - application/json
27791         - application/xml
27792       responses:
27793         "200":
27794           description: successful operation
27795           schema:
27796               $ref: "#/getDefinitions/l3-networks"
27797         "default":
27798           description: Response codes found in [response codes](https://wiki.onap.org/).
27799   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
27800     put:
27801       tags:
27802         - Network
27803       summary: see node definition for valid relationships
27804       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27805       consumes:
27806         - application/json
27807         - application/xml
27808       produces:
27809         - application/json
27810         - application/xml
27811       responses:
27812         "default":
27813           description: Response codes found in [response codes](https://wiki.onap.org/).
27814       parameters:
27815         - name: network-policy-id
27816           in: path
27817           description: UUID representing unique key to this instance
27818           required: true
27819           type: string
27820           example: __NETWORK-POLICY-ID__
27821         - name: body
27822           in: body
27823           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
27824           required: true
27825           schema:
27826             $ref: "#/definitions/relationship"
27827     delete:
27828       tags:
27829         - Network
27830       summary: delete an existing relationship
27831       description: delete an existing relationship
27832       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
27833       consumes:
27834         - application/json
27835         - application/xml
27836       produces:
27837         - application/json
27838         - application/xml
27839       responses:
27840         "default":
27841           description: Response codes found in [response codes](https://wiki.onap.org/).
27842       parameters:
27843         - name: network-policy-id
27844           in: path
27845           description: UUID representing unique key to this instance
27846           required: true
27847           type: string
27848           example: __NETWORK-POLICY-ID__
27849   /network/network-policies/network-policy/{network-policy-id}:
27850     get:
27851       tags:
27852         - Network
27853       summary: returns network-policy
27854       description: returns network-policy
27855       operationId: getNetworkNetworkPoliciesNetworkPolicy
27856       produces:
27857         - application/json
27858         - application/xml
27859       responses:
27860         "200":
27861           description: successful operation
27862           schema:
27863               $ref: "#/getDefinitions/network-policy"
27864         "default":
27865           description: Response codes found in [response codes](https://wiki.onap.org/).
27866       parameters:
27867         - name: network-policy-id
27868           in: path
27869           description: UUID representing unique key to this instance
27870           required: true
27871           type: string
27872           example: __NETWORK-POLICY-ID__
27873         - name: network-policy-fqdn
27874           in: query
27875           description: Contrail FQDN for the policy
27876           required: false
27877           type: string
27878     put:
27879       tags:
27880         - Network
27881       summary: create or update an existing network-policy
27882       description: |
27883         Create or update an existing network-policy.
27884         #
27885         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
27886       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
27887       consumes:
27888         - application/json
27889         - application/xml
27890       produces:
27891         - application/json
27892         - application/xml
27893       responses:
27894         "default":
27895           description: Response codes found in [response codes](https://wiki.onap.org/).
27896       parameters:
27897         - name: network-policy-id
27898           in: path
27899           description: UUID representing unique key to this instance
27900           required: true
27901           type: string
27902           example: __NETWORK-POLICY-ID__
27903         - name: body
27904           in: body
27905           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNetworkPoliciesNetworkPolicy.json)
27906           required: true
27907           schema:
27908             $ref: "#/definitions/network-policy"
27909     patch:
27910       tags:
27911         - Network
27912       summary: update an existing network-policy
27913       description: |
27914         Update an existing network-policy
27915         #
27916         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27917         The PUT operation will entirely replace an existing object.
27918         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.
27919         #
27920         Other differences between PUT and PATCH are:
27921         #
27922         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27923         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27924         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27925       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
27926       consumes:
27927         - application/json
27928         - application/xml
27929       produces:
27930         - application/json
27931         - application/xml
27932       responses:
27933         "default":
27934           description: Response codes found in [response codes](https://wiki.onap.org/).
27935       parameters:
27936         - name: network-policy-id
27937           in: path
27938           description: UUID representing unique key to this instance
27939           required: true
27940           type: string
27941           example: __NETWORK-POLICY-ID__
27942         - name: body
27943           in: body
27944           description: network-policy object that needs to be created or updated.
27945           required: true
27946           schema:
27947             $ref: "#/patchDefinitions/network-policy"
27948     delete:
27949       tags:
27950         - Network
27951       summary: delete an existing network-policy
27952       description: delete an existing network-policy
27953       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
27954       consumes:
27955         - application/json
27956         - application/xml
27957       produces:
27958         - application/json
27959         - application/xml
27960       responses:
27961         "default":
27962           description: Response codes found in [response codes](https://wiki.onap.org/).
27963       parameters:
27964         - name: network-policy-id
27965           in: path
27966           description: UUID representing unique key to this instance
27967           required: true
27968           type: string
27969           example: __NETWORK-POLICY-ID__
27970         - name: resource-version
27971           in: query
27972           description: resource-version for concurrency
27973           required: true
27974           type: string
27975   /network/network-policies:
27976     get:
27977       tags:
27978         - Network
27979       summary: returns network-policies
27980       description: returns network-policies
27981       operationId: getNetworkNetworkPolicies
27982       produces:
27983         - application/json
27984         - application/xml
27985       responses:
27986         "200":
27987           description: successful operation
27988           schema:
27989               $ref: "#/getDefinitions/network-policies"
27990         "default":
27991           description: Response codes found in [response codes](https://wiki.onap.org/).
27992   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
27993     put:
27994       tags:
27995         - Network
27996       summary: see node definition for valid relationships
27997       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
27998       consumes:
27999         - application/json
28000         - application/xml
28001       produces:
28002         - application/json
28003         - application/xml
28004       responses:
28005         "default":
28006           description: Response codes found in [response codes](https://wiki.onap.org/).
28007       parameters:
28008         - name: vnf-id
28009           in: path
28010           description: Unique id of VNF.  This is unique across the graph.
28011           required: true
28012           type: string
28013           example: __VNF-ID__
28014         - name: body
28015           in: body
28016           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
28017           required: true
28018           schema:
28019             $ref: "#/definitions/relationship"
28020     delete:
28021       tags:
28022         - Network
28023       summary: delete an existing relationship
28024       description: delete an existing relationship
28025       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
28026       consumes:
28027         - application/json
28028         - application/xml
28029       produces:
28030         - application/json
28031         - application/xml
28032       responses:
28033         "default":
28034           description: Response codes found in [response codes](https://wiki.onap.org/).
28035       parameters:
28036         - name: vnf-id
28037           in: path
28038           description: Unique id of VNF.  This is unique across the graph.
28039           required: true
28040           type: string
28041           example: __VNF-ID__
28042   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
28043     put:
28044       tags:
28045         - Network
28046       summary: see node definition for valid relationships
28047       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
28048       consumes:
28049         - application/json
28050         - application/xml
28051       produces:
28052         - application/json
28053         - application/xml
28054       responses:
28055         "default":
28056           description: Response codes found in [response codes](https://wiki.onap.org/).
28057       parameters:
28058         - name: vnf-id
28059           in: path
28060           description: Unique id of VNF.  This is unique across the graph.
28061           required: true
28062           type: string
28063           example: __VNF-ID__
28064         - name: interface-name
28065           in: path
28066           description: Name given to the interface
28067           required: true
28068           type: string
28069           example: __INTERFACE-NAME__
28070         - name: vlan-interface
28071           in: path
28072           description: String that identifies the interface
28073           required: true
28074           type: string
28075           example: __VLAN-INTERFACE__
28076         - name: body
28077           in: body
28078           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
28079           required: true
28080           schema:
28081             $ref: "#/definitions/relationship"
28082     delete:
28083       tags:
28084         - Network
28085       summary: delete an existing relationship
28086       description: delete an existing relationship
28087       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
28088       consumes:
28089         - application/json
28090         - application/xml
28091       produces:
28092         - application/json
28093         - application/xml
28094       responses:
28095         "default":
28096           description: Response codes found in [response codes](https://wiki.onap.org/).
28097       parameters:
28098         - name: vnf-id
28099           in: path
28100           description: Unique id of VNF.  This is unique across the graph.
28101           required: true
28102           type: string
28103           example: __VNF-ID__
28104         - name: interface-name
28105           in: path
28106           description: Name given to the interface
28107           required: true
28108           type: string
28109           example: __INTERFACE-NAME__
28110         - name: vlan-interface
28111           in: path
28112           description: String that identifies the interface
28113           required: true
28114           type: string
28115           example: __VLAN-INTERFACE__
28116   /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:
28117     put:
28118       tags:
28119         - Network
28120       summary: see node definition for valid relationships
28121       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
28122       consumes:
28123         - application/json
28124         - application/xml
28125       produces:
28126         - application/json
28127         - application/xml
28128       responses:
28129         "default":
28130           description: Response codes found in [response codes](https://wiki.onap.org/).
28131       parameters:
28132         - name: vnf-id
28133           in: path
28134           description: Unique id of VNF.  This is unique across the graph.
28135           required: true
28136           type: string
28137           example: __VNF-ID__
28138         - name: interface-name
28139           in: path
28140           description: Name given to the interface
28141           required: true
28142           type: string
28143           example: __INTERFACE-NAME__
28144         - name: vlan-interface
28145           in: path
28146           description: String that identifies the interface
28147           required: true
28148           type: string
28149           example: __VLAN-INTERFACE__
28150         - name: l3-interface-ipv4-address
28151           in: path
28152           description: IP address
28153           required: true
28154           type: string
28155           example: __L3-INTERFACE-IPV4-ADDRESS__
28156         - name: body
28157           in: body
28158           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28159           required: true
28160           schema:
28161             $ref: "#/definitions/relationship"
28162     delete:
28163       tags:
28164         - Network
28165       summary: delete an existing relationship
28166       description: delete an existing relationship
28167       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
28168       consumes:
28169         - application/json
28170         - application/xml
28171       produces:
28172         - application/json
28173         - application/xml
28174       responses:
28175         "default":
28176           description: Response codes found in [response codes](https://wiki.onap.org/).
28177       parameters:
28178         - name: vnf-id
28179           in: path
28180           description: Unique id of VNF.  This is unique across the graph.
28181           required: true
28182           type: string
28183           example: __VNF-ID__
28184         - name: interface-name
28185           in: path
28186           description: Name given to the interface
28187           required: true
28188           type: string
28189           example: __INTERFACE-NAME__
28190         - name: vlan-interface
28191           in: path
28192           description: String that identifies the interface
28193           required: true
28194           type: string
28195           example: __VLAN-INTERFACE__
28196         - name: l3-interface-ipv4-address
28197           in: path
28198           description: IP address
28199           required: true
28200           type: string
28201           example: __L3-INTERFACE-IPV4-ADDRESS__
28202   /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}:
28203     get:
28204       tags:
28205         - Network
28206       summary: returns l3-interface-ipv4-address-list
28207       description: returns l3-interface-ipv4-address-list
28208       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28209       produces:
28210         - application/json
28211         - application/xml
28212       responses:
28213         "200":
28214           description: successful operation
28215           schema:
28216               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28217         "default":
28218           description: Response codes found in [response codes](https://wiki.onap.org/).
28219       parameters:
28220         - name: vnf-id
28221           in: path
28222           description: Unique id of VNF.  This is unique across the graph.
28223           required: true
28224           type: string
28225           example: __VNF-ID__
28226         - name: interface-name
28227           in: path
28228           description: Name given to the interface
28229           required: true
28230           type: string
28231           example: __INTERFACE-NAME__
28232         - name: vlan-interface
28233           in: path
28234           description: String that identifies the interface
28235           required: true
28236           type: string
28237           example: __VLAN-INTERFACE__
28238         - name: l3-interface-ipv4-address
28239           in: path
28240           description: IP address
28241           required: true
28242           type: string
28243           example: __L3-INTERFACE-IPV4-ADDRESS__
28244         - name: vnf-name
28245           in: query
28246           description: Name of VNF.
28247           required: false
28248           type: string
28249         - name: vnf-name2
28250           in: query
28251           description: Alternate name of VNF.
28252           required: false
28253           type: string
28254         - name: vnf-type
28255           in: query
28256           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
28257           required: false
28258           type: string
28259         - name: service-id
28260           in: query
28261           description: Unique identifier of service from ASDC
28262           required: false
28263           type: string
28264         - name: regional-resource-zone
28265           in: query
28266           description: Regional way of organizing pservers, source of truth should define values
28267           required: false
28268           type: string
28269         - name: prov-status
28270           in: query
28271           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28272           required: false
28273           type: string
28274         - name: heat-stack-id
28275           in: query
28276           description: Heat stack id corresponding to this instance, managed by MSO
28277           required: false
28278           type: string
28279         - name: in-maint
28280           in: query
28281           required: false
28282           type: boolean
28283         - name: is-closed-loop-disabled
28284           in: query
28285           required: false
28286           type: boolean
28287         - name: persona-model-id
28288           in: query
28289           description: the ASDC model id for this resource or service model.
28290           required: false
28291           type: string
28292         - name: persona-model-version
28293           in: query
28294           description: the ASDC model version for this resource or service model.
28295           required: false
28296           type: string
28297         - name: widget-model-id
28298           in: query
28299           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
28300           required: false
28301           type: string
28302         - name: widget-model-version
28303           in: query
28304           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
28305           required: false
28306           type: string
28307         - name: interface-id
28308           in: query
28309           description: ID of interface
28310           required: false
28311           type: string
28312         - name: macaddr
28313           in: query
28314           description: MAC address for the interface
28315           required: false
28316           type: string
28317         - name: network-name
28318           in: query
28319           description: Name of the network
28320           required: false
28321           type: string
28322         - name: vlan-id-inner
28323           in: query
28324           description: Inner VLAN tag
28325           required: false
28326           type: integer
28327           format: int64
28328         - name: vpn-id
28329           in: query
28330           description: This indicates the customers VPN ID associated with this vlan
28331           required: false
28332           type: string
28333         - name: vlan-id-inner
28334           in: query
28335           description: Inner VLAN tag
28336           required: false
28337           type: integer
28338           format: int64
28339         - name: neutron-network-id
28340           in: query
28341           description: Neutron network id of the interface that address belongs to
28342           required: false
28343           type: string
28344         - name: neutron-subnet-id
28345           in: query
28346           description: Neutron id of subnet that address belongs to
28347           required: false
28348           type: string
28349     put:
28350       tags:
28351         - Network
28352       summary: create or update an existing l3-interface-ipv4-address-list
28353       description: |
28354         Create or update an existing l3-interface-ipv4-address-list.
28355         #
28356         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
28357       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28358       consumes:
28359         - application/json
28360         - application/xml
28361       produces:
28362         - application/json
28363         - application/xml
28364       responses:
28365         "default":
28366           description: Response codes found in [response codes](https://wiki.onap.org/).
28367       parameters:
28368         - name: vnf-id
28369           in: path
28370           description: Unique id of VNF.  This is unique across the graph.
28371           required: true
28372           type: string
28373           example: __VNF-ID__
28374         - name: interface-name
28375           in: path
28376           description: Name given to the interface
28377           required: true
28378           type: string
28379           example: __INTERFACE-NAME__
28380         - name: vlan-interface
28381           in: path
28382           description: String that identifies the interface
28383           required: true
28384           type: string
28385           example: __VLAN-INTERFACE__
28386         - name: l3-interface-ipv4-address
28387           in: path
28388           description: IP address
28389           required: true
28390           type: string
28391           example: __L3-INTERFACE-IPV4-ADDRESS__
28392         - name: body
28393           in: body
28394           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
28395           required: true
28396           schema:
28397             $ref: "#/definitions/l3-interface-ipv4-address-list"
28398     patch:
28399       tags:
28400         - Network
28401       summary: update an existing l3-interface-ipv4-address-list
28402       description: |
28403         Update an existing l3-interface-ipv4-address-list
28404         #
28405         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28406         The PUT operation will entirely replace an existing object.
28407         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.
28408         #
28409         Other differences between PUT and PATCH are:
28410         #
28411         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28412         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28413         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28414       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28415       consumes:
28416         - application/json
28417         - application/xml
28418       produces:
28419         - application/json
28420         - application/xml
28421       responses:
28422         "default":
28423           description: Response codes found in [response codes](https://wiki.onap.org/).
28424       parameters:
28425         - name: vnf-id
28426           in: path
28427           description: Unique id of VNF.  This is unique across the graph.
28428           required: true
28429           type: string
28430           example: __VNF-ID__
28431         - name: interface-name
28432           in: path
28433           description: Name given to the interface
28434           required: true
28435           type: string
28436           example: __INTERFACE-NAME__
28437         - name: vlan-interface
28438           in: path
28439           description: String that identifies the interface
28440           required: true
28441           type: string
28442           example: __VLAN-INTERFACE__
28443         - name: l3-interface-ipv4-address
28444           in: path
28445           description: IP address
28446           required: true
28447           type: string
28448           example: __L3-INTERFACE-IPV4-ADDRESS__
28449         - name: body
28450           in: body
28451           description: l3-interface-ipv4-address-list object that needs to be created or updated.
28452           required: true
28453           schema:
28454             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28455     delete:
28456       tags:
28457         - Network
28458       summary: delete an existing l3-interface-ipv4-address-list
28459       description: delete an existing l3-interface-ipv4-address-list
28460       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
28461       consumes:
28462         - application/json
28463         - application/xml
28464       produces:
28465         - application/json
28466         - application/xml
28467       responses:
28468         "default":
28469           description: Response codes found in [response codes](https://wiki.onap.org/).
28470       parameters:
28471         - name: vnf-id
28472           in: path
28473           description: Unique id of VNF.  This is unique across the graph.
28474           required: true
28475           type: string
28476           example: __VNF-ID__
28477         - name: interface-name
28478           in: path
28479           description: Name given to the interface
28480           required: true
28481           type: string
28482           example: __INTERFACE-NAME__
28483         - name: vlan-interface
28484           in: path
28485           description: String that identifies the interface
28486           required: true
28487           type: string
28488           example: __VLAN-INTERFACE__
28489         - name: l3-interface-ipv4-address
28490           in: path
28491           description: IP address
28492           required: true
28493           type: string
28494           example: __L3-INTERFACE-IPV4-ADDRESS__
28495         - name: resource-version
28496           in: query
28497           description: resource-version for concurrency
28498           required: true
28499           type: string
28500   /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:
28501     put:
28502       tags:
28503         - Network
28504       summary: see node definition for valid relationships
28505       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28506       consumes:
28507         - application/json
28508         - application/xml
28509       produces:
28510         - application/json
28511         - application/xml
28512       responses:
28513         "default":
28514           description: Response codes found in [response codes](https://wiki.onap.org/).
28515       parameters:
28516         - name: vnf-id
28517           in: path
28518           description: Unique id of VNF.  This is unique across the graph.
28519           required: true
28520           type: string
28521           example: __VNF-ID__
28522         - name: interface-name
28523           in: path
28524           description: Name given to the interface
28525           required: true
28526           type: string
28527           example: __INTERFACE-NAME__
28528         - name: vlan-interface
28529           in: path
28530           description: String that identifies the interface
28531           required: true
28532           type: string
28533           example: __VLAN-INTERFACE__
28534         - name: l3-interface-ipv6-address
28535           in: path
28536           description: IP address
28537           required: true
28538           type: string
28539           example: __L3-INTERFACE-IPV6-ADDRESS__
28540         - name: body
28541           in: body
28542           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28543           required: true
28544           schema:
28545             $ref: "#/definitions/relationship"
28546     delete:
28547       tags:
28548         - Network
28549       summary: delete an existing relationship
28550       description: delete an existing relationship
28551       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
28552       consumes:
28553         - application/json
28554         - application/xml
28555       produces:
28556         - application/json
28557         - application/xml
28558       responses:
28559         "default":
28560           description: Response codes found in [response codes](https://wiki.onap.org/).
28561       parameters:
28562         - name: vnf-id
28563           in: path
28564           description: Unique id of VNF.  This is unique across the graph.
28565           required: true
28566           type: string
28567           example: __VNF-ID__
28568         - name: interface-name
28569           in: path
28570           description: Name given to the interface
28571           required: true
28572           type: string
28573           example: __INTERFACE-NAME__
28574         - name: vlan-interface
28575           in: path
28576           description: String that identifies the interface
28577           required: true
28578           type: string
28579           example: __VLAN-INTERFACE__
28580         - name: l3-interface-ipv6-address
28581           in: path
28582           description: IP address
28583           required: true
28584           type: string
28585           example: __L3-INTERFACE-IPV6-ADDRESS__
28586   /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}:
28587     get:
28588       tags:
28589         - Network
28590       summary: returns l3-interface-ipv6-address-list
28591       description: returns l3-interface-ipv6-address-list
28592       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28593       produces:
28594         - application/json
28595         - application/xml
28596       responses:
28597         "200":
28598           description: successful operation
28599           schema:
28600               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28601         "default":
28602           description: Response codes found in [response codes](https://wiki.onap.org/).
28603       parameters:
28604         - name: vnf-id
28605           in: path
28606           description: Unique id of VNF.  This is unique across the graph.
28607           required: true
28608           type: string
28609           example: __VNF-ID__
28610         - name: interface-name
28611           in: path
28612           description: Name given to the interface
28613           required: true
28614           type: string
28615           example: __INTERFACE-NAME__
28616         - name: vlan-interface
28617           in: path
28618           description: String that identifies the interface
28619           required: true
28620           type: string
28621           example: __VLAN-INTERFACE__
28622         - name: l3-interface-ipv6-address
28623           in: path
28624           description: IP address
28625           required: true
28626           type: string
28627           example: __L3-INTERFACE-IPV6-ADDRESS__
28628         - name: vnf-name
28629           in: query
28630           description: Name of VNF.
28631           required: false
28632           type: string
28633         - name: vnf-name2
28634           in: query
28635           description: Alternate name of VNF.
28636           required: false
28637           type: string
28638         - name: vnf-type
28639           in: query
28640           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
28641           required: false
28642           type: string
28643         - name: service-id
28644           in: query
28645           description: Unique identifier of service from ASDC
28646           required: false
28647           type: string
28648         - name: regional-resource-zone
28649           in: query
28650           description: Regional way of organizing pservers, source of truth should define values
28651           required: false
28652           type: string
28653         - name: prov-status
28654           in: query
28655           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28656           required: false
28657           type: string
28658         - name: heat-stack-id
28659           in: query
28660           description: Heat stack id corresponding to this instance, managed by MSO
28661           required: false
28662           type: string
28663         - name: in-maint
28664           in: query
28665           required: false
28666           type: boolean
28667         - name: is-closed-loop-disabled
28668           in: query
28669           required: false
28670           type: boolean
28671         - name: persona-model-id
28672           in: query
28673           description: the ASDC model id for this resource or service model.
28674           required: false
28675           type: string
28676         - name: persona-model-version
28677           in: query
28678           description: the ASDC model version for this resource or service model.
28679           required: false
28680           type: string
28681         - name: widget-model-id
28682           in: query
28683           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
28684           required: false
28685           type: string
28686         - name: widget-model-version
28687           in: query
28688           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
28689           required: false
28690           type: string
28691         - name: interface-id
28692           in: query
28693           description: ID of interface
28694           required: false
28695           type: string
28696         - name: macaddr
28697           in: query
28698           description: MAC address for the interface
28699           required: false
28700           type: string
28701         - name: network-name
28702           in: query
28703           description: Name of the network
28704           required: false
28705           type: string
28706         - name: vlan-id-inner
28707           in: query
28708           description: Inner VLAN tag
28709           required: false
28710           type: integer
28711           format: int64
28712         - name: vpn-id
28713           in: query
28714           description: This indicates the customers VPN ID associated with this vlan
28715           required: false
28716           type: string
28717         - name: vlan-id-inner
28718           in: query
28719           description: Inner VLAN tag
28720           required: false
28721           type: integer
28722           format: int64
28723         - name: neutron-network-id
28724           in: query
28725           description: Neutron network id of the interface that address belongs to
28726           required: false
28727           type: string
28728         - name: neutron-subnet-id
28729           in: query
28730           description: Neutron id of subnet that address belongs to
28731           required: false
28732           type: string
28733     put:
28734       tags:
28735         - Network
28736       summary: create or update an existing l3-interface-ipv6-address-list
28737       description: |
28738         Create or update an existing l3-interface-ipv6-address-list.
28739         #
28740         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
28741       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28742       consumes:
28743         - application/json
28744         - application/xml
28745       produces:
28746         - application/json
28747         - application/xml
28748       responses:
28749         "default":
28750           description: Response codes found in [response codes](https://wiki.onap.org/).
28751       parameters:
28752         - name: vnf-id
28753           in: path
28754           description: Unique id of VNF.  This is unique across the graph.
28755           required: true
28756           type: string
28757           example: __VNF-ID__
28758         - name: interface-name
28759           in: path
28760           description: Name given to the interface
28761           required: true
28762           type: string
28763           example: __INTERFACE-NAME__
28764         - name: vlan-interface
28765           in: path
28766           description: String that identifies the interface
28767           required: true
28768           type: string
28769           example: __VLAN-INTERFACE__
28770         - name: l3-interface-ipv6-address
28771           in: path
28772           description: IP address
28773           required: true
28774           type: string
28775           example: __L3-INTERFACE-IPV6-ADDRESS__
28776         - name: body
28777           in: body
28778           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
28779           required: true
28780           schema:
28781             $ref: "#/definitions/l3-interface-ipv6-address-list"
28782     patch:
28783       tags:
28784         - Network
28785       summary: update an existing l3-interface-ipv6-address-list
28786       description: |
28787         Update an existing l3-interface-ipv6-address-list
28788         #
28789         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28790         The PUT operation will entirely replace an existing object.
28791         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.
28792         #
28793         Other differences between PUT and PATCH are:
28794         #
28795         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28796         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28797         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28798       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28799       consumes:
28800         - application/json
28801         - application/xml
28802       produces:
28803         - application/json
28804         - application/xml
28805       responses:
28806         "default":
28807           description: Response codes found in [response codes](https://wiki.onap.org/).
28808       parameters:
28809         - name: vnf-id
28810           in: path
28811           description: Unique id of VNF.  This is unique across the graph.
28812           required: true
28813           type: string
28814           example: __VNF-ID__
28815         - name: interface-name
28816           in: path
28817           description: Name given to the interface
28818           required: true
28819           type: string
28820           example: __INTERFACE-NAME__
28821         - name: vlan-interface
28822           in: path
28823           description: String that identifies the interface
28824           required: true
28825           type: string
28826           example: __VLAN-INTERFACE__
28827         - name: l3-interface-ipv6-address
28828           in: path
28829           description: IP address
28830           required: true
28831           type: string
28832           example: __L3-INTERFACE-IPV6-ADDRESS__
28833         - name: body
28834           in: body
28835           description: l3-interface-ipv6-address-list object that needs to be created or updated.
28836           required: true
28837           schema:
28838             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
28839     delete:
28840       tags:
28841         - Network
28842       summary: delete an existing l3-interface-ipv6-address-list
28843       description: delete an existing l3-interface-ipv6-address-list
28844       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
28845       consumes:
28846         - application/json
28847         - application/xml
28848       produces:
28849         - application/json
28850         - application/xml
28851       responses:
28852         "default":
28853           description: Response codes found in [response codes](https://wiki.onap.org/).
28854       parameters:
28855         - name: vnf-id
28856           in: path
28857           description: Unique id of VNF.  This is unique across the graph.
28858           required: true
28859           type: string
28860           example: __VNF-ID__
28861         - name: interface-name
28862           in: path
28863           description: Name given to the interface
28864           required: true
28865           type: string
28866           example: __INTERFACE-NAME__
28867         - name: vlan-interface
28868           in: path
28869           description: String that identifies the interface
28870           required: true
28871           type: string
28872           example: __VLAN-INTERFACE__
28873         - name: l3-interface-ipv6-address
28874           in: path
28875           description: IP address
28876           required: true
28877           type: string
28878           example: __L3-INTERFACE-IPV6-ADDRESS__
28879         - name: resource-version
28880           in: query
28881           description: resource-version for concurrency
28882           required: true
28883           type: string
28884   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
28885     get:
28886       tags:
28887         - Network
28888       summary: returns vlan
28889       description: returns vlan
28890       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
28891       produces:
28892         - application/json
28893         - application/xml
28894       responses:
28895         "200":
28896           description: successful operation
28897           schema:
28898               $ref: "#/getDefinitions/vlan"
28899         "default":
28900           description: Response codes found in [response codes](https://wiki.onap.org/).
28901       parameters:
28902         - name: vnf-id
28903           in: path
28904           description: Unique id of VNF.  This is unique across the graph.
28905           required: true
28906           type: string
28907           example: __VNF-ID__
28908         - name: interface-name
28909           in: path
28910           description: Name given to the interface
28911           required: true
28912           type: string
28913           example: __INTERFACE-NAME__
28914         - name: vlan-interface
28915           in: path
28916           description: String that identifies the interface
28917           required: true
28918           type: string
28919           example: __VLAN-INTERFACE__
28920         - name: vnf-name
28921           in: query
28922           description: Name of VNF.
28923           required: false
28924           type: string
28925         - name: vnf-name2
28926           in: query
28927           description: Alternate name of VNF.
28928           required: false
28929           type: string
28930         - name: vnf-type
28931           in: query
28932           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
28933           required: false
28934           type: string
28935         - name: service-id
28936           in: query
28937           description: Unique identifier of service from ASDC
28938           required: false
28939           type: string
28940         - name: regional-resource-zone
28941           in: query
28942           description: Regional way of organizing pservers, source of truth should define values
28943           required: false
28944           type: string
28945         - name: prov-status
28946           in: query
28947           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28948           required: false
28949           type: string
28950         - name: heat-stack-id
28951           in: query
28952           description: Heat stack id corresponding to this instance, managed by MSO
28953           required: false
28954           type: string
28955         - name: in-maint
28956           in: query
28957           required: false
28958           type: boolean
28959         - name: is-closed-loop-disabled
28960           in: query
28961           required: false
28962           type: boolean
28963         - name: persona-model-id
28964           in: query
28965           description: the ASDC model id for this resource or service model.
28966           required: false
28967           type: string
28968         - name: persona-model-version
28969           in: query
28970           description: the ASDC model version for this resource or service model.
28971           required: false
28972           type: string
28973         - name: widget-model-id
28974           in: query
28975           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
28976           required: false
28977           type: string
28978         - name: widget-model-version
28979           in: query
28980           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
28981           required: false
28982           type: string
28983         - name: interface-id
28984           in: query
28985           description: ID of interface
28986           required: false
28987           type: string
28988         - name: macaddr
28989           in: query
28990           description: MAC address for the interface
28991           required: false
28992           type: string
28993         - name: network-name
28994           in: query
28995           description: Name of the network
28996           required: false
28997           type: string
28998         - name: vlan-id-inner
28999           in: query
29000           description: Inner VLAN tag
29001           required: false
29002           type: integer
29003           format: int64
29004         - name: vpn-id
29005           in: query
29006           description: This indicates the customers VPN ID associated with this vlan
29007           required: false
29008           type: string
29009     put:
29010       tags:
29011         - Network
29012       summary: create or update an existing vlan
29013       description: |
29014         Create or update an existing vlan.
29015         #
29016         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
29017       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
29018       consumes:
29019         - application/json
29020         - application/xml
29021       produces:
29022         - application/json
29023         - application/xml
29024       responses:
29025         "default":
29026           description: Response codes found in [response codes](https://wiki.onap.org/).
29027       parameters:
29028         - name: vnf-id
29029           in: path
29030           description: Unique id of VNF.  This is unique across the graph.
29031           required: true
29032           type: string
29033           example: __VNF-ID__
29034         - name: interface-name
29035           in: path
29036           description: Name given to the interface
29037           required: true
29038           type: string
29039           example: __INTERFACE-NAME__
29040         - name: vlan-interface
29041           in: path
29042           description: String that identifies the interface
29043           required: true
29044           type: string
29045           example: __VLAN-INTERFACE__
29046         - name: body
29047           in: body
29048           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
29049           required: true
29050           schema:
29051             $ref: "#/definitions/vlan"
29052     patch:
29053       tags:
29054         - Network
29055       summary: update an existing vlan
29056       description: |
29057         Update an existing vlan
29058         #
29059         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29060         The PUT operation will entirely replace an existing object.
29061         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.
29062         #
29063         Other differences between PUT and PATCH are:
29064         #
29065         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29066         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29067         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29068       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
29069       consumes:
29070         - application/json
29071         - application/xml
29072       produces:
29073         - application/json
29074         - application/xml
29075       responses:
29076         "default":
29077           description: Response codes found in [response codes](https://wiki.onap.org/).
29078       parameters:
29079         - name: vnf-id
29080           in: path
29081           description: Unique id of VNF.  This is unique across the graph.
29082           required: true
29083           type: string
29084           example: __VNF-ID__
29085         - name: interface-name
29086           in: path
29087           description: Name given to the interface
29088           required: true
29089           type: string
29090           example: __INTERFACE-NAME__
29091         - name: vlan-interface
29092           in: path
29093           description: String that identifies the interface
29094           required: true
29095           type: string
29096           example: __VLAN-INTERFACE__
29097         - name: body
29098           in: body
29099           description: vlan object that needs to be created or updated.
29100           required: true
29101           schema:
29102             $ref: "#/patchDefinitions/vlan"
29103     delete:
29104       tags:
29105         - Network
29106       summary: delete an existing vlan
29107       description: delete an existing vlan
29108       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
29109       consumes:
29110         - application/json
29111         - application/xml
29112       produces:
29113         - application/json
29114         - application/xml
29115       responses:
29116         "default":
29117           description: Response codes found in [response codes](https://wiki.onap.org/).
29118       parameters:
29119         - name: vnf-id
29120           in: path
29121           description: Unique id of VNF.  This is unique across the graph.
29122           required: true
29123           type: string
29124           example: __VNF-ID__
29125         - name: interface-name
29126           in: path
29127           description: Name given to the interface
29128           required: true
29129           type: string
29130           example: __INTERFACE-NAME__
29131         - name: vlan-interface
29132           in: path
29133           description: String that identifies the interface
29134           required: true
29135           type: string
29136           example: __VLAN-INTERFACE__
29137         - name: resource-version
29138           in: query
29139           description: resource-version for concurrency
29140           required: true
29141           type: string
29142   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
29143     get:
29144       tags:
29145         - Network
29146       summary: returns vlans
29147       description: returns vlans
29148       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
29149       produces:
29150         - application/json
29151         - application/xml
29152       responses:
29153         "200":
29154           description: successful operation
29155           schema:
29156               $ref: "#/getDefinitions/vlans"
29157         "default":
29158           description: Response codes found in [response codes](https://wiki.onap.org/).
29159       parameters:
29160         - name: vnf-id
29161           in: path
29162           description: Unique id of VNF.  This is unique across the graph.
29163           required: true
29164           type: string
29165           example: __VNF-ID__
29166         - name: interface-name
29167           in: path
29168           description: Name given to the interface
29169           required: true
29170           type: string
29171           example: __INTERFACE-NAME__
29172         - name: vnf-name
29173           in: query
29174           description: Name of VNF.
29175           required: false
29176           type: string
29177         - name: vnf-name2
29178           in: query
29179           description: Alternate name of VNF.
29180           required: false
29181           type: string
29182         - name: vnf-type
29183           in: query
29184           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
29185           required: false
29186           type: string
29187         - name: service-id
29188           in: query
29189           description: Unique identifier of service from ASDC
29190           required: false
29191           type: string
29192         - name: regional-resource-zone
29193           in: query
29194           description: Regional way of organizing pservers, source of truth should define values
29195           required: false
29196           type: string
29197         - name: prov-status
29198           in: query
29199           description: Trigger for operational monitoring of this resource by Service Assurance systems.
29200           required: false
29201           type: string
29202         - name: heat-stack-id
29203           in: query
29204           description: Heat stack id corresponding to this instance, managed by MSO
29205           required: false
29206           type: string
29207         - name: in-maint
29208           in: query
29209           required: false
29210           type: boolean
29211         - name: is-closed-loop-disabled
29212           in: query
29213           required: false
29214           type: boolean
29215         - name: persona-model-id
29216           in: query
29217           description: the ASDC model id for this resource or service model.
29218           required: false
29219           type: string
29220         - name: persona-model-version
29221           in: query
29222           description: the ASDC model version for this resource or service model.
29223           required: false
29224           type: string
29225         - name: widget-model-id
29226           in: query
29227           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29228           required: false
29229           type: string
29230         - name: widget-model-version
29231           in: query
29232           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29233           required: false
29234           type: string
29235         - name: interface-id
29236           in: query
29237           description: ID of interface
29238           required: false
29239           type: string
29240         - name: macaddr
29241           in: query
29242           description: MAC address for the interface
29243           required: false
29244           type: string
29245         - name: network-name
29246           in: query
29247           description: Name of the network
29248           required: false
29249           type: string
29250   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
29251     put:
29252       tags:
29253         - Network
29254       summary: see node definition for valid relationships
29255       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
29256       consumes:
29257         - application/json
29258         - application/xml
29259       produces:
29260         - application/json
29261         - application/xml
29262       responses:
29263         "default":
29264           description: Response codes found in [response codes](https://wiki.onap.org/).
29265       parameters:
29266         - name: vnf-id
29267           in: path
29268           description: Unique id of VNF.  This is unique across the graph.
29269           required: true
29270           type: string
29271           example: __VNF-ID__
29272         - name: interface-name
29273           in: path
29274           description: Name given to the interface
29275           required: true
29276           type: string
29277           example: __INTERFACE-NAME__
29278         - name: pci-id
29279           in: path
29280           description: PCI ID used to identify the sriov-vf
29281           required: true
29282           type: string
29283           example: __PCI-ID__
29284         - name: body
29285           in: body
29286           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
29287           required: true
29288           schema:
29289             $ref: "#/definitions/relationship"
29290     delete:
29291       tags:
29292         - Network
29293       summary: delete an existing relationship
29294       description: delete an existing relationship
29295       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
29296       consumes:
29297         - application/json
29298         - application/xml
29299       produces:
29300         - application/json
29301         - application/xml
29302       responses:
29303         "default":
29304           description: Response codes found in [response codes](https://wiki.onap.org/).
29305       parameters:
29306         - name: vnf-id
29307           in: path
29308           description: Unique id of VNF.  This is unique across the graph.
29309           required: true
29310           type: string
29311           example: __VNF-ID__
29312         - name: interface-name
29313           in: path
29314           description: Name given to the interface
29315           required: true
29316           type: string
29317           example: __INTERFACE-NAME__
29318         - name: pci-id
29319           in: path
29320           description: PCI ID used to identify the sriov-vf
29321           required: true
29322           type: string
29323           example: __PCI-ID__
29324   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
29325     get:
29326       tags:
29327         - Network
29328       summary: returns sriov-vf
29329       description: returns sriov-vf
29330       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29331       produces:
29332         - application/json
29333         - application/xml
29334       responses:
29335         "200":
29336           description: successful operation
29337           schema:
29338               $ref: "#/getDefinitions/sriov-vf"
29339         "default":
29340           description: Response codes found in [response codes](https://wiki.onap.org/).
29341       parameters:
29342         - name: vnf-id
29343           in: path
29344           description: Unique id of VNF.  This is unique across the graph.
29345           required: true
29346           type: string
29347           example: __VNF-ID__
29348         - name: interface-name
29349           in: path
29350           description: Name given to the interface
29351           required: true
29352           type: string
29353           example: __INTERFACE-NAME__
29354         - name: pci-id
29355           in: path
29356           description: PCI ID used to identify the sriov-vf
29357           required: true
29358           type: string
29359           example: __PCI-ID__
29360         - name: vnf-name
29361           in: query
29362           description: Name of VNF.
29363           required: false
29364           type: string
29365         - name: vnf-name2
29366           in: query
29367           description: Alternate name of VNF.
29368           required: false
29369           type: string
29370         - name: vnf-type
29371           in: query
29372           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
29373           required: false
29374           type: string
29375         - name: service-id
29376           in: query
29377           description: Unique identifier of service from ASDC
29378           required: false
29379           type: string
29380         - name: regional-resource-zone
29381           in: query
29382           description: Regional way of organizing pservers, source of truth should define values
29383           required: false
29384           type: string
29385         - name: prov-status
29386           in: query
29387           description: Trigger for operational monitoring of this resource by Service Assurance systems.
29388           required: false
29389           type: string
29390         - name: heat-stack-id
29391           in: query
29392           description: Heat stack id corresponding to this instance, managed by MSO
29393           required: false
29394           type: string
29395         - name: in-maint
29396           in: query
29397           required: false
29398           type: boolean
29399         - name: is-closed-loop-disabled
29400           in: query
29401           required: false
29402           type: boolean
29403         - name: persona-model-id
29404           in: query
29405           description: the ASDC model id for this resource or service model.
29406           required: false
29407           type: string
29408         - name: persona-model-version
29409           in: query
29410           description: the ASDC model version for this resource or service model.
29411           required: false
29412           type: string
29413         - name: widget-model-id
29414           in: query
29415           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29416           required: false
29417           type: string
29418         - name: widget-model-version
29419           in: query
29420           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29421           required: false
29422           type: string
29423         - name: interface-id
29424           in: query
29425           description: ID of interface
29426           required: false
29427           type: string
29428         - name: macaddr
29429           in: query
29430           description: MAC address for the interface
29431           required: false
29432           type: string
29433         - name: network-name
29434           in: query
29435           description: Name of the network
29436           required: false
29437           type: string
29438         - name: vf-vlan-filter
29439           in: query
29440           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
29441           required: false
29442           type: string
29443         - name: vf-mac-filter
29444           in: query
29445           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
29446           required: false
29447           type: string
29448         - name: vf-vlan-strip
29449           in: query
29450           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
29451           required: false
29452           type: boolean
29453         - name: neutron-network-id
29454           in: query
29455           description: Neutron network id of the interface
29456           required: false
29457           type: string
29458     put:
29459       tags:
29460         - Network
29461       summary: create or update an existing sriov-vf
29462       description: |
29463         Create or update an existing sriov-vf.
29464         #
29465         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
29466       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29467       consumes:
29468         - application/json
29469         - application/xml
29470       produces:
29471         - application/json
29472         - application/xml
29473       responses:
29474         "default":
29475           description: Response codes found in [response codes](https://wiki.onap.org/).
29476       parameters:
29477         - name: vnf-id
29478           in: path
29479           description: Unique id of VNF.  This is unique across the graph.
29480           required: true
29481           type: string
29482           example: __VNF-ID__
29483         - name: interface-name
29484           in: path
29485           description: Name given to the interface
29486           required: true
29487           type: string
29488           example: __INTERFACE-NAME__
29489         - name: pci-id
29490           in: path
29491           description: PCI ID used to identify the sriov-vf
29492           required: true
29493           type: string
29494           example: __PCI-ID__
29495         - name: body
29496           in: body
29497           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
29498           required: true
29499           schema:
29500             $ref: "#/definitions/sriov-vf"
29501     patch:
29502       tags:
29503         - Network
29504       summary: update an existing sriov-vf
29505       description: |
29506         Update an existing sriov-vf
29507         #
29508         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29509         The PUT operation will entirely replace an existing object.
29510         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.
29511         #
29512         Other differences between PUT and PATCH are:
29513         #
29514         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29515         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29516         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29517       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29518       consumes:
29519         - application/json
29520         - application/xml
29521       produces:
29522         - application/json
29523         - application/xml
29524       responses:
29525         "default":
29526           description: Response codes found in [response codes](https://wiki.onap.org/).
29527       parameters:
29528         - name: vnf-id
29529           in: path
29530           description: Unique id of VNF.  This is unique across the graph.
29531           required: true
29532           type: string
29533           example: __VNF-ID__
29534         - name: interface-name
29535           in: path
29536           description: Name given to the interface
29537           required: true
29538           type: string
29539           example: __INTERFACE-NAME__
29540         - name: pci-id
29541           in: path
29542           description: PCI ID used to identify the sriov-vf
29543           required: true
29544           type: string
29545           example: __PCI-ID__
29546         - name: body
29547           in: body
29548           description: sriov-vf object that needs to be created or updated.
29549           required: true
29550           schema:
29551             $ref: "#/patchDefinitions/sriov-vf"
29552     delete:
29553       tags:
29554         - Network
29555       summary: delete an existing sriov-vf
29556       description: delete an existing sriov-vf
29557       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
29558       consumes:
29559         - application/json
29560         - application/xml
29561       produces:
29562         - application/json
29563         - application/xml
29564       responses:
29565         "default":
29566           description: Response codes found in [response codes](https://wiki.onap.org/).
29567       parameters:
29568         - name: vnf-id
29569           in: path
29570           description: Unique id of VNF.  This is unique across the graph.
29571           required: true
29572           type: string
29573           example: __VNF-ID__
29574         - name: interface-name
29575           in: path
29576           description: Name given to the interface
29577           required: true
29578           type: string
29579           example: __INTERFACE-NAME__
29580         - name: pci-id
29581           in: path
29582           description: PCI ID used to identify the sriov-vf
29583           required: true
29584           type: string
29585           example: __PCI-ID__
29586         - name: resource-version
29587           in: query
29588           description: resource-version for concurrency
29589           required: true
29590           type: string
29591   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
29592     get:
29593       tags:
29594         - Network
29595       summary: returns sriov-vfs
29596       description: returns sriov-vfs
29597       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
29598       produces:
29599         - application/json
29600         - application/xml
29601       responses:
29602         "200":
29603           description: successful operation
29604           schema:
29605               $ref: "#/getDefinitions/sriov-vfs"
29606         "default":
29607           description: Response codes found in [response codes](https://wiki.onap.org/).
29608       parameters:
29609         - name: vnf-id
29610           in: path
29611           description: Unique id of VNF.  This is unique across the graph.
29612           required: true
29613           type: string
29614           example: __VNF-ID__
29615         - name: interface-name
29616           in: path
29617           description: Name given to the interface
29618           required: true
29619           type: string
29620           example: __INTERFACE-NAME__
29621         - name: vnf-name
29622           in: query
29623           description: Name of VNF.
29624           required: false
29625           type: string
29626         - name: vnf-name2
29627           in: query
29628           description: Alternate name of VNF.
29629           required: false
29630           type: string
29631         - name: vnf-type
29632           in: query
29633           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
29634           required: false
29635           type: string
29636         - name: service-id
29637           in: query
29638           description: Unique identifier of service from ASDC
29639           required: false
29640           type: string
29641         - name: regional-resource-zone
29642           in: query
29643           description: Regional way of organizing pservers, source of truth should define values
29644           required: false
29645           type: string
29646         - name: prov-status
29647           in: query
29648           description: Trigger for operational monitoring of this resource by Service Assurance systems.
29649           required: false
29650           type: string
29651         - name: heat-stack-id
29652           in: query
29653           description: Heat stack id corresponding to this instance, managed by MSO
29654           required: false
29655           type: string
29656         - name: in-maint
29657           in: query
29658           required: false
29659           type: boolean
29660         - name: is-closed-loop-disabled
29661           in: query
29662           required: false
29663           type: boolean
29664         - name: persona-model-id
29665           in: query
29666           description: the ASDC model id for this resource or service model.
29667           required: false
29668           type: string
29669         - name: persona-model-version
29670           in: query
29671           description: the ASDC model version for this resource or service model.
29672           required: false
29673           type: string
29674         - name: widget-model-id
29675           in: query
29676           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29677           required: false
29678           type: string
29679         - name: widget-model-version
29680           in: query
29681           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29682           required: false
29683           type: string
29684         - name: interface-id
29685           in: query
29686           description: ID of interface
29687           required: false
29688           type: string
29689         - name: macaddr
29690           in: query
29691           description: MAC address for the interface
29692           required: false
29693           type: string
29694         - name: network-name
29695           in: query
29696           description: Name of the network
29697           required: false
29698           type: string
29699   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
29700     put:
29701       tags:
29702         - Network
29703       summary: see node definition for valid relationships
29704       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
29705       consumes:
29706         - application/json
29707         - application/xml
29708       produces:
29709         - application/json
29710         - application/xml
29711       responses:
29712         "default":
29713           description: Response codes found in [response codes](https://wiki.onap.org/).
29714       parameters:
29715         - name: vnf-id
29716           in: path
29717           description: Unique id of VNF.  This is unique across the graph.
29718           required: true
29719           type: string
29720           example: __VNF-ID__
29721         - name: interface-name
29722           in: path
29723           description: Name given to the interface
29724           required: true
29725           type: string
29726           example: __INTERFACE-NAME__
29727         - name: body
29728           in: body
29729           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
29730           required: true
29731           schema:
29732             $ref: "#/definitions/relationship"
29733     delete:
29734       tags:
29735         - Network
29736       summary: delete an existing relationship
29737       description: delete an existing relationship
29738       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
29739       consumes:
29740         - application/json
29741         - application/xml
29742       produces:
29743         - application/json
29744         - application/xml
29745       responses:
29746         "default":
29747           description: Response codes found in [response codes](https://wiki.onap.org/).
29748       parameters:
29749         - name: vnf-id
29750           in: path
29751           description: Unique id of VNF.  This is unique across the graph.
29752           required: true
29753           type: string
29754           example: __VNF-ID__
29755         - name: interface-name
29756           in: path
29757           description: Name given to the interface
29758           required: true
29759           type: string
29760           example: __INTERFACE-NAME__
29761   /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:
29762     put:
29763       tags:
29764         - Network
29765       summary: see node definition for valid relationships
29766       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29767       consumes:
29768         - application/json
29769         - application/xml
29770       produces:
29771         - application/json
29772         - application/xml
29773       responses:
29774         "default":
29775           description: Response codes found in [response codes](https://wiki.onap.org/).
29776       parameters:
29777         - name: vnf-id
29778           in: path
29779           description: Unique id of VNF.  This is unique across the graph.
29780           required: true
29781           type: string
29782           example: __VNF-ID__
29783         - name: interface-name
29784           in: path
29785           description: Name given to the interface
29786           required: true
29787           type: string
29788           example: __INTERFACE-NAME__
29789         - name: l3-interface-ipv4-address
29790           in: path
29791           description: IP address
29792           required: true
29793           type: string
29794           example: __L3-INTERFACE-IPV4-ADDRESS__
29795         - name: body
29796           in: body
29797           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
29798           required: true
29799           schema:
29800             $ref: "#/definitions/relationship"
29801     delete:
29802       tags:
29803         - Network
29804       summary: delete an existing relationship
29805       description: delete an existing relationship
29806       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
29807       consumes:
29808         - application/json
29809         - application/xml
29810       produces:
29811         - application/json
29812         - application/xml
29813       responses:
29814         "default":
29815           description: Response codes found in [response codes](https://wiki.onap.org/).
29816       parameters:
29817         - name: vnf-id
29818           in: path
29819           description: Unique id of VNF.  This is unique across the graph.
29820           required: true
29821           type: string
29822           example: __VNF-ID__
29823         - name: interface-name
29824           in: path
29825           description: Name given to the interface
29826           required: true
29827           type: string
29828           example: __INTERFACE-NAME__
29829         - name: l3-interface-ipv4-address
29830           in: path
29831           description: IP address
29832           required: true
29833           type: string
29834           example: __L3-INTERFACE-IPV4-ADDRESS__
29835   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
29836     get:
29837       tags:
29838         - Network
29839       summary: returns l3-interface-ipv4-address-list
29840       description: returns l3-interface-ipv4-address-list
29841       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
29842       produces:
29843         - application/json
29844         - application/xml
29845       responses:
29846         "200":
29847           description: successful operation
29848           schema:
29849               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
29850         "default":
29851           description: Response codes found in [response codes](https://wiki.onap.org/).
29852       parameters:
29853         - name: vnf-id
29854           in: path
29855           description: Unique id of VNF.  This is unique across the graph.
29856           required: true
29857           type: string
29858           example: __VNF-ID__
29859         - name: interface-name
29860           in: path
29861           description: Name given to the interface
29862           required: true
29863           type: string
29864           example: __INTERFACE-NAME__
29865         - name: l3-interface-ipv4-address
29866           in: path
29867           description: IP address
29868           required: true
29869           type: string
29870           example: __L3-INTERFACE-IPV4-ADDRESS__
29871         - name: vnf-name
29872           in: query
29873           description: Name of VNF.
29874           required: false
29875           type: string
29876         - name: vnf-name2
29877           in: query
29878           description: Alternate name of VNF.
29879           required: false
29880           type: string
29881         - name: vnf-type
29882           in: query
29883           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
29884           required: false
29885           type: string
29886         - name: service-id
29887           in: query
29888           description: Unique identifier of service from ASDC
29889           required: false
29890           type: string
29891         - name: regional-resource-zone
29892           in: query
29893           description: Regional way of organizing pservers, source of truth should define values
29894           required: false
29895           type: string
29896         - name: prov-status
29897           in: query
29898           description: Trigger for operational monitoring of this resource by Service Assurance systems.
29899           required: false
29900           type: string
29901         - name: heat-stack-id
29902           in: query
29903           description: Heat stack id corresponding to this instance, managed by MSO
29904           required: false
29905           type: string
29906         - name: in-maint
29907           in: query
29908           required: false
29909           type: boolean
29910         - name: is-closed-loop-disabled
29911           in: query
29912           required: false
29913           type: boolean
29914         - name: persona-model-id
29915           in: query
29916           description: the ASDC model id for this resource or service model.
29917           required: false
29918           type: string
29919         - name: persona-model-version
29920           in: query
29921           description: the ASDC model version for this resource or service model.
29922           required: false
29923           type: string
29924         - name: widget-model-id
29925           in: query
29926           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29927           required: false
29928           type: string
29929         - name: widget-model-version
29930           in: query
29931           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29932           required: false
29933           type: string
29934         - name: interface-id
29935           in: query
29936           description: ID of interface
29937           required: false
29938           type: string
29939         - name: macaddr
29940           in: query
29941           description: MAC address for the interface
29942           required: false
29943           type: string
29944         - name: network-name
29945           in: query
29946           description: Name of the network
29947           required: false
29948           type: string
29949         - name: vlan-id-inner
29950           in: query
29951           description: Inner VLAN tag
29952           required: false
29953           type: integer
29954           format: int64
29955         - name: neutron-network-id
29956           in: query
29957           description: Neutron network id of the interface that address belongs to
29958           required: false
29959           type: string
29960         - name: neutron-subnet-id
29961           in: query
29962           description: Neutron id of subnet that address belongs to
29963           required: false
29964           type: string
29965     put:
29966       tags:
29967         - Network
29968       summary: create or update an existing l3-interface-ipv4-address-list
29969       description: |
29970         Create or update an existing l3-interface-ipv4-address-list.
29971         #
29972         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
29973       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
29974       consumes:
29975         - application/json
29976         - application/xml
29977       produces:
29978         - application/json
29979         - application/xml
29980       responses:
29981         "default":
29982           description: Response codes found in [response codes](https://wiki.onap.org/).
29983       parameters:
29984         - name: vnf-id
29985           in: path
29986           description: Unique id of VNF.  This is unique across the graph.
29987           required: true
29988           type: string
29989           example: __VNF-ID__
29990         - name: interface-name
29991           in: path
29992           description: Name given to the interface
29993           required: true
29994           type: string
29995           example: __INTERFACE-NAME__
29996         - name: l3-interface-ipv4-address
29997           in: path
29998           description: IP address
29999           required: true
30000           type: string
30001           example: __L3-INTERFACE-IPV4-ADDRESS__
30002         - name: body
30003           in: body
30004           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
30005           required: true
30006           schema:
30007             $ref: "#/definitions/l3-interface-ipv4-address-list"
30008     patch:
30009       tags:
30010         - Network
30011       summary: update an existing l3-interface-ipv4-address-list
30012       description: |
30013         Update an existing l3-interface-ipv4-address-list
30014         #
30015         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30016         The PUT operation will entirely replace an existing object.
30017         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.
30018         #
30019         Other differences between PUT and PATCH are:
30020         #
30021         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30022         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30023         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30024       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
30025       consumes:
30026         - application/json
30027         - application/xml
30028       produces:
30029         - application/json
30030         - application/xml
30031       responses:
30032         "default":
30033           description: Response codes found in [response codes](https://wiki.onap.org/).
30034       parameters:
30035         - name: vnf-id
30036           in: path
30037           description: Unique id of VNF.  This is unique across the graph.
30038           required: true
30039           type: string
30040           example: __VNF-ID__
30041         - name: interface-name
30042           in: path
30043           description: Name given to the interface
30044           required: true
30045           type: string
30046           example: __INTERFACE-NAME__
30047         - name: l3-interface-ipv4-address
30048           in: path
30049           description: IP address
30050           required: true
30051           type: string
30052           example: __L3-INTERFACE-IPV4-ADDRESS__
30053         - name: body
30054           in: body
30055           description: l3-interface-ipv4-address-list object that needs to be created or updated.
30056           required: true
30057           schema:
30058             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
30059     delete:
30060       tags:
30061         - Network
30062       summary: delete an existing l3-interface-ipv4-address-list
30063       description: delete an existing l3-interface-ipv4-address-list
30064       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
30065       consumes:
30066         - application/json
30067         - application/xml
30068       produces:
30069         - application/json
30070         - application/xml
30071       responses:
30072         "default":
30073           description: Response codes found in [response codes](https://wiki.onap.org/).
30074       parameters:
30075         - name: vnf-id
30076           in: path
30077           description: Unique id of VNF.  This is unique across the graph.
30078           required: true
30079           type: string
30080           example: __VNF-ID__
30081         - name: interface-name
30082           in: path
30083           description: Name given to the interface
30084           required: true
30085           type: string
30086           example: __INTERFACE-NAME__
30087         - name: l3-interface-ipv4-address
30088           in: path
30089           description: IP address
30090           required: true
30091           type: string
30092           example: __L3-INTERFACE-IPV4-ADDRESS__
30093         - name: resource-version
30094           in: query
30095           description: resource-version for concurrency
30096           required: true
30097           type: string
30098   /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:
30099     put:
30100       tags:
30101         - Network
30102       summary: see node definition for valid relationships
30103       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30104       consumes:
30105         - application/json
30106         - application/xml
30107       produces:
30108         - application/json
30109         - application/xml
30110       responses:
30111         "default":
30112           description: Response codes found in [response codes](https://wiki.onap.org/).
30113       parameters:
30114         - name: vnf-id
30115           in: path
30116           description: Unique id of VNF.  This is unique across the graph.
30117           required: true
30118           type: string
30119           example: __VNF-ID__
30120         - name: interface-name
30121           in: path
30122           description: Name given to the interface
30123           required: true
30124           type: string
30125           example: __INTERFACE-NAME__
30126         - name: l3-interface-ipv6-address
30127           in: path
30128           description: IP address
30129           required: true
30130           type: string
30131           example: __L3-INTERFACE-IPV6-ADDRESS__
30132         - name: body
30133           in: body
30134           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30135           required: true
30136           schema:
30137             $ref: "#/definitions/relationship"
30138     delete:
30139       tags:
30140         - Network
30141       summary: delete an existing relationship
30142       description: delete an existing relationship
30143       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
30144       consumes:
30145         - application/json
30146         - application/xml
30147       produces:
30148         - application/json
30149         - application/xml
30150       responses:
30151         "default":
30152           description: Response codes found in [response codes](https://wiki.onap.org/).
30153       parameters:
30154         - name: vnf-id
30155           in: path
30156           description: Unique id of VNF.  This is unique across the graph.
30157           required: true
30158           type: string
30159           example: __VNF-ID__
30160         - name: interface-name
30161           in: path
30162           description: Name given to the interface
30163           required: true
30164           type: string
30165           example: __INTERFACE-NAME__
30166         - name: l3-interface-ipv6-address
30167           in: path
30168           description: IP address
30169           required: true
30170           type: string
30171           example: __L3-INTERFACE-IPV6-ADDRESS__
30172   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
30173     get:
30174       tags:
30175         - Network
30176       summary: returns l3-interface-ipv6-address-list
30177       description: returns l3-interface-ipv6-address-list
30178       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30179       produces:
30180         - application/json
30181         - application/xml
30182       responses:
30183         "200":
30184           description: successful operation
30185           schema:
30186               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
30187         "default":
30188           description: Response codes found in [response codes](https://wiki.onap.org/).
30189       parameters:
30190         - name: vnf-id
30191           in: path
30192           description: Unique id of VNF.  This is unique across the graph.
30193           required: true
30194           type: string
30195           example: __VNF-ID__
30196         - name: interface-name
30197           in: path
30198           description: Name given to the interface
30199           required: true
30200           type: string
30201           example: __INTERFACE-NAME__
30202         - name: l3-interface-ipv6-address
30203           in: path
30204           description: IP address
30205           required: true
30206           type: string
30207           example: __L3-INTERFACE-IPV6-ADDRESS__
30208         - name: vnf-name
30209           in: query
30210           description: Name of VNF.
30211           required: false
30212           type: string
30213         - name: vnf-name2
30214           in: query
30215           description: Alternate name of VNF.
30216           required: false
30217           type: string
30218         - name: vnf-type
30219           in: query
30220           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
30221           required: false
30222           type: string
30223         - name: service-id
30224           in: query
30225           description: Unique identifier of service from ASDC
30226           required: false
30227           type: string
30228         - name: regional-resource-zone
30229           in: query
30230           description: Regional way of organizing pservers, source of truth should define values
30231           required: false
30232           type: string
30233         - name: prov-status
30234           in: query
30235           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30236           required: false
30237           type: string
30238         - name: heat-stack-id
30239           in: query
30240           description: Heat stack id corresponding to this instance, managed by MSO
30241           required: false
30242           type: string
30243         - name: in-maint
30244           in: query
30245           required: false
30246           type: boolean
30247         - name: is-closed-loop-disabled
30248           in: query
30249           required: false
30250           type: boolean
30251         - name: persona-model-id
30252           in: query
30253           description: the ASDC model id for this resource or service model.
30254           required: false
30255           type: string
30256         - name: persona-model-version
30257           in: query
30258           description: the ASDC model version for this resource or service model.
30259           required: false
30260           type: string
30261         - name: widget-model-id
30262           in: query
30263           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30264           required: false
30265           type: string
30266         - name: widget-model-version
30267           in: query
30268           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30269           required: false
30270           type: string
30271         - name: interface-id
30272           in: query
30273           description: ID of interface
30274           required: false
30275           type: string
30276         - name: macaddr
30277           in: query
30278           description: MAC address for the interface
30279           required: false
30280           type: string
30281         - name: network-name
30282           in: query
30283           description: Name of the network
30284           required: false
30285           type: string
30286         - name: vlan-id-inner
30287           in: query
30288           description: Inner VLAN tag
30289           required: false
30290           type: integer
30291           format: int64
30292         - name: neutron-network-id
30293           in: query
30294           description: Neutron network id of the interface that address belongs to
30295           required: false
30296           type: string
30297         - name: neutron-subnet-id
30298           in: query
30299           description: Neutron id of subnet that address belongs to
30300           required: false
30301           type: string
30302     put:
30303       tags:
30304         - Network
30305       summary: create or update an existing l3-interface-ipv6-address-list
30306       description: |
30307         Create or update an existing l3-interface-ipv6-address-list.
30308         #
30309         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
30310       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30311       consumes:
30312         - application/json
30313         - application/xml
30314       produces:
30315         - application/json
30316         - application/xml
30317       responses:
30318         "default":
30319           description: Response codes found in [response codes](https://wiki.onap.org/).
30320       parameters:
30321         - name: vnf-id
30322           in: path
30323           description: Unique id of VNF.  This is unique across the graph.
30324           required: true
30325           type: string
30326           example: __VNF-ID__
30327         - name: interface-name
30328           in: path
30329           description: Name given to the interface
30330           required: true
30331           type: string
30332           example: __INTERFACE-NAME__
30333         - name: l3-interface-ipv6-address
30334           in: path
30335           description: IP address
30336           required: true
30337           type: string
30338           example: __L3-INTERFACE-IPV6-ADDRESS__
30339         - name: body
30340           in: body
30341           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
30342           required: true
30343           schema:
30344             $ref: "#/definitions/l3-interface-ipv6-address-list"
30345     patch:
30346       tags:
30347         - Network
30348       summary: update an existing l3-interface-ipv6-address-list
30349       description: |
30350         Update an existing l3-interface-ipv6-address-list
30351         #
30352         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30353         The PUT operation will entirely replace an existing object.
30354         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.
30355         #
30356         Other differences between PUT and PATCH are:
30357         #
30358         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30359         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30360         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30361       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30362       consumes:
30363         - application/json
30364         - application/xml
30365       produces:
30366         - application/json
30367         - application/xml
30368       responses:
30369         "default":
30370           description: Response codes found in [response codes](https://wiki.onap.org/).
30371       parameters:
30372         - name: vnf-id
30373           in: path
30374           description: Unique id of VNF.  This is unique across the graph.
30375           required: true
30376           type: string
30377           example: __VNF-ID__
30378         - name: interface-name
30379           in: path
30380           description: Name given to the interface
30381           required: true
30382           type: string
30383           example: __INTERFACE-NAME__
30384         - name: l3-interface-ipv6-address
30385           in: path
30386           description: IP address
30387           required: true
30388           type: string
30389           example: __L3-INTERFACE-IPV6-ADDRESS__
30390         - name: body
30391           in: body
30392           description: l3-interface-ipv6-address-list object that needs to be created or updated.
30393           required: true
30394           schema:
30395             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
30396     delete:
30397       tags:
30398         - Network
30399       summary: delete an existing l3-interface-ipv6-address-list
30400       description: delete an existing l3-interface-ipv6-address-list
30401       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
30402       consumes:
30403         - application/json
30404         - application/xml
30405       produces:
30406         - application/json
30407         - application/xml
30408       responses:
30409         "default":
30410           description: Response codes found in [response codes](https://wiki.onap.org/).
30411       parameters:
30412         - name: vnf-id
30413           in: path
30414           description: Unique id of VNF.  This is unique across the graph.
30415           required: true
30416           type: string
30417           example: __VNF-ID__
30418         - name: interface-name
30419           in: path
30420           description: Name given to the interface
30421           required: true
30422           type: string
30423           example: __INTERFACE-NAME__
30424         - name: l3-interface-ipv6-address
30425           in: path
30426           description: IP address
30427           required: true
30428           type: string
30429           example: __L3-INTERFACE-IPV6-ADDRESS__
30430         - name: resource-version
30431           in: query
30432           description: resource-version for concurrency
30433           required: true
30434           type: string
30435   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
30436     get:
30437       tags:
30438         - Network
30439       summary: returns l-interface
30440       description: returns l-interface
30441       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
30442       produces:
30443         - application/json
30444         - application/xml
30445       responses:
30446         "200":
30447           description: successful operation
30448           schema:
30449               $ref: "#/getDefinitions/l-interface"
30450         "default":
30451           description: Response codes found in [response codes](https://wiki.onap.org/).
30452       parameters:
30453         - name: vnf-id
30454           in: path
30455           description: Unique id of VNF.  This is unique across the graph.
30456           required: true
30457           type: string
30458           example: __VNF-ID__
30459         - name: interface-name
30460           in: path
30461           description: Name given to the interface
30462           required: true
30463           type: string
30464           example: __INTERFACE-NAME__
30465         - name: vnf-name
30466           in: query
30467           description: Name of VNF.
30468           required: false
30469           type: string
30470         - name: vnf-name2
30471           in: query
30472           description: Alternate name of VNF.
30473           required: false
30474           type: string
30475         - name: vnf-type
30476           in: query
30477           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
30478           required: false
30479           type: string
30480         - name: service-id
30481           in: query
30482           description: Unique identifier of service from ASDC
30483           required: false
30484           type: string
30485         - name: regional-resource-zone
30486           in: query
30487           description: Regional way of organizing pservers, source of truth should define values
30488           required: false
30489           type: string
30490         - name: prov-status
30491           in: query
30492           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30493           required: false
30494           type: string
30495         - name: heat-stack-id
30496           in: query
30497           description: Heat stack id corresponding to this instance, managed by MSO
30498           required: false
30499           type: string
30500         - name: in-maint
30501           in: query
30502           required: false
30503           type: boolean
30504         - name: is-closed-loop-disabled
30505           in: query
30506           required: false
30507           type: boolean
30508         - name: persona-model-id
30509           in: query
30510           description: the ASDC model id for this resource or service model.
30511           required: false
30512           type: string
30513         - name: persona-model-version
30514           in: query
30515           description: the ASDC model version for this resource or service model.
30516           required: false
30517           type: string
30518         - name: widget-model-id
30519           in: query
30520           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30521           required: false
30522           type: string
30523         - name: widget-model-version
30524           in: query
30525           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30526           required: false
30527           type: string
30528         - name: interface-id
30529           in: query
30530           description: ID of interface
30531           required: false
30532           type: string
30533         - name: macaddr
30534           in: query
30535           description: MAC address for the interface
30536           required: false
30537           type: string
30538         - name: network-name
30539           in: query
30540           description: Name of the network
30541           required: false
30542           type: string
30543     put:
30544       tags:
30545         - Network
30546       summary: create or update an existing l-interface
30547       description: |
30548         Create or update an existing l-interface.
30549         #
30550         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
30551       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
30552       consumes:
30553         - application/json
30554         - application/xml
30555       produces:
30556         - application/json
30557         - application/xml
30558       responses:
30559         "default":
30560           description: Response codes found in [response codes](https://wiki.onap.org/).
30561       parameters:
30562         - name: vnf-id
30563           in: path
30564           description: Unique id of VNF.  This is unique across the graph.
30565           required: true
30566           type: string
30567           example: __VNF-ID__
30568         - name: interface-name
30569           in: path
30570           description: Name given to the interface
30571           required: true
30572           type: string
30573           example: __INTERFACE-NAME__
30574         - name: body
30575           in: body
30576           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
30577           required: true
30578           schema:
30579             $ref: "#/definitions/l-interface"
30580     patch:
30581       tags:
30582         - Network
30583       summary: update an existing l-interface
30584       description: |
30585         Update an existing l-interface
30586         #
30587         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30588         The PUT operation will entirely replace an existing object.
30589         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.
30590         #
30591         Other differences between PUT and PATCH are:
30592         #
30593         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30594         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30595         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30596       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
30597       consumes:
30598         - application/json
30599         - application/xml
30600       produces:
30601         - application/json
30602         - application/xml
30603       responses:
30604         "default":
30605           description: Response codes found in [response codes](https://wiki.onap.org/).
30606       parameters:
30607         - name: vnf-id
30608           in: path
30609           description: Unique id of VNF.  This is unique across the graph.
30610           required: true
30611           type: string
30612           example: __VNF-ID__
30613         - name: interface-name
30614           in: path
30615           description: Name given to the interface
30616           required: true
30617           type: string
30618           example: __INTERFACE-NAME__
30619         - name: body
30620           in: body
30621           description: l-interface object that needs to be created or updated.
30622           required: true
30623           schema:
30624             $ref: "#/patchDefinitions/l-interface"
30625     delete:
30626       tags:
30627         - Network
30628       summary: delete an existing l-interface
30629       description: delete an existing l-interface
30630       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
30631       consumes:
30632         - application/json
30633         - application/xml
30634       produces:
30635         - application/json
30636         - application/xml
30637       responses:
30638         "default":
30639           description: Response codes found in [response codes](https://wiki.onap.org/).
30640       parameters:
30641         - name: vnf-id
30642           in: path
30643           description: Unique id of VNF.  This is unique across the graph.
30644           required: true
30645           type: string
30646           example: __VNF-ID__
30647         - name: interface-name
30648           in: path
30649           description: Name given to the interface
30650           required: true
30651           type: string
30652           example: __INTERFACE-NAME__
30653         - name: resource-version
30654           in: query
30655           description: resource-version for concurrency
30656           required: true
30657           type: string
30658   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
30659     get:
30660       tags:
30661         - Network
30662       summary: returns l-interfaces
30663       description: returns l-interfaces
30664       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
30665       produces:
30666         - application/json
30667         - application/xml
30668       responses:
30669         "200":
30670           description: successful operation
30671           schema:
30672               $ref: "#/getDefinitions/l-interfaces"
30673         "default":
30674           description: Response codes found in [response codes](https://wiki.onap.org/).
30675       parameters:
30676         - name: vnf-id
30677           in: path
30678           description: Unique id of VNF.  This is unique across the graph.
30679           required: true
30680           type: string
30681           example: __VNF-ID__
30682         - name: vnf-name
30683           in: query
30684           description: Name of VNF.
30685           required: false
30686           type: string
30687         - name: vnf-name2
30688           in: query
30689           description: Alternate name of VNF.
30690           required: false
30691           type: string
30692         - name: vnf-type
30693           in: query
30694           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
30695           required: false
30696           type: string
30697         - name: service-id
30698           in: query
30699           description: Unique identifier of service from ASDC
30700           required: false
30701           type: string
30702         - name: regional-resource-zone
30703           in: query
30704           description: Regional way of organizing pservers, source of truth should define values
30705           required: false
30706           type: string
30707         - name: prov-status
30708           in: query
30709           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30710           required: false
30711           type: string
30712         - name: heat-stack-id
30713           in: query
30714           description: Heat stack id corresponding to this instance, managed by MSO
30715           required: false
30716           type: string
30717         - name: in-maint
30718           in: query
30719           required: false
30720           type: boolean
30721         - name: is-closed-loop-disabled
30722           in: query
30723           required: false
30724           type: boolean
30725         - name: persona-model-id
30726           in: query
30727           description: the ASDC model id for this resource or service model.
30728           required: false
30729           type: string
30730         - name: persona-model-version
30731           in: query
30732           description: the ASDC model version for this resource or service model.
30733           required: false
30734           type: string
30735         - name: widget-model-id
30736           in: query
30737           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30738           required: false
30739           type: string
30740         - name: widget-model-version
30741           in: query
30742           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30743           required: false
30744           type: string
30745   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
30746     put:
30747       tags:
30748         - Network
30749       summary: see node definition for valid relationships
30750       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
30751       consumes:
30752         - application/json
30753         - application/xml
30754       produces:
30755         - application/json
30756         - application/xml
30757       responses:
30758         "default":
30759           description: Response codes found in [response codes](https://wiki.onap.org/).
30760       parameters:
30761         - name: vnf-id
30762           in: path
30763           description: Unique id of VNF.  This is unique across the graph.
30764           required: true
30765           type: string
30766           example: __VNF-ID__
30767         - name: interface-name
30768           in: path
30769           description: Name that identifies the link aggregate interface
30770           required: true
30771           type: string
30772           example: __INTERFACE-NAME__
30773         - name: body
30774           in: body
30775           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
30776           required: true
30777           schema:
30778             $ref: "#/definitions/relationship"
30779     delete:
30780       tags:
30781         - Network
30782       summary: delete an existing relationship
30783       description: delete an existing relationship
30784       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
30785       consumes:
30786         - application/json
30787         - application/xml
30788       produces:
30789         - application/json
30790         - application/xml
30791       responses:
30792         "default":
30793           description: Response codes found in [response codes](https://wiki.onap.org/).
30794       parameters:
30795         - name: vnf-id
30796           in: path
30797           description: Unique id of VNF.  This is unique across the graph.
30798           required: true
30799           type: string
30800           example: __VNF-ID__
30801         - name: interface-name
30802           in: path
30803           description: Name that identifies the link aggregate interface
30804           required: true
30805           type: string
30806           example: __INTERFACE-NAME__
30807   /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:
30808     put:
30809       tags:
30810         - Network
30811       summary: see node definition for valid relationships
30812       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30813       consumes:
30814         - application/json
30815         - application/xml
30816       produces:
30817         - application/json
30818         - application/xml
30819       responses:
30820         "default":
30821           description: Response codes found in [response codes](https://wiki.onap.org/).
30822       parameters:
30823         - name: vnf-id
30824           in: path
30825           description: Unique id of VNF.  This is unique across the graph.
30826           required: true
30827           type: string
30828           example: __VNF-ID__
30829         - name: interface-name
30830           in: path
30831           description: Name that identifies the link aggregate interface
30832           required: true
30833           type: string
30834           example: __INTERFACE-NAME__
30835         - name: interface-name
30836           in: path
30837           description: Name given to the interface
30838           required: true
30839           type: string
30840           example: __INTERFACE-NAME__
30841         - name: vlan-interface
30842           in: path
30843           description: String that identifies the interface
30844           required: true
30845           type: string
30846           example: __VLAN-INTERFACE__
30847         - name: body
30848           in: body
30849           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
30850           required: true
30851           schema:
30852             $ref: "#/definitions/relationship"
30853     delete:
30854       tags:
30855         - Network
30856       summary: delete an existing relationship
30857       description: delete an existing relationship
30858       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30859       consumes:
30860         - application/json
30861         - application/xml
30862       produces:
30863         - application/json
30864         - application/xml
30865       responses:
30866         "default":
30867           description: Response codes found in [response codes](https://wiki.onap.org/).
30868       parameters:
30869         - name: vnf-id
30870           in: path
30871           description: Unique id of VNF.  This is unique across the graph.
30872           required: true
30873           type: string
30874           example: __VNF-ID__
30875         - name: interface-name
30876           in: path
30877           description: Name that identifies the link aggregate interface
30878           required: true
30879           type: string
30880           example: __INTERFACE-NAME__
30881         - name: interface-name
30882           in: path
30883           description: Name given to the interface
30884           required: true
30885           type: string
30886           example: __INTERFACE-NAME__
30887         - name: vlan-interface
30888           in: path
30889           description: String that identifies the interface
30890           required: true
30891           type: string
30892           example: __VLAN-INTERFACE__
30893   /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:
30894     put:
30895       tags:
30896         - Network
30897       summary: see node definition for valid relationships
30898       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30899       consumes:
30900         - application/json
30901         - application/xml
30902       produces:
30903         - application/json
30904         - application/xml
30905       responses:
30906         "default":
30907           description: Response codes found in [response codes](https://wiki.onap.org/).
30908       parameters:
30909         - name: vnf-id
30910           in: path
30911           description: Unique id of VNF.  This is unique across the graph.
30912           required: true
30913           type: string
30914           example: __VNF-ID__
30915         - name: interface-name
30916           in: path
30917           description: Name that identifies the link aggregate interface
30918           required: true
30919           type: string
30920           example: __INTERFACE-NAME__
30921         - name: interface-name
30922           in: path
30923           description: Name given to the interface
30924           required: true
30925           type: string
30926           example: __INTERFACE-NAME__
30927         - name: vlan-interface
30928           in: path
30929           description: String that identifies the interface
30930           required: true
30931           type: string
30932           example: __VLAN-INTERFACE__
30933         - name: l3-interface-ipv4-address
30934           in: path
30935           description: IP address
30936           required: true
30937           type: string
30938           example: __L3-INTERFACE-IPV4-ADDRESS__
30939         - name: body
30940           in: body
30941           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30942           required: true
30943           schema:
30944             $ref: "#/definitions/relationship"
30945     delete:
30946       tags:
30947         - Network
30948       summary: delete an existing relationship
30949       description: delete an existing relationship
30950       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30951       consumes:
30952         - application/json
30953         - application/xml
30954       produces:
30955         - application/json
30956         - application/xml
30957       responses:
30958         "default":
30959           description: Response codes found in [response codes](https://wiki.onap.org/).
30960       parameters:
30961         - name: vnf-id
30962           in: path
30963           description: Unique id of VNF.  This is unique across the graph.
30964           required: true
30965           type: string
30966           example: __VNF-ID__
30967         - name: interface-name
30968           in: path
30969           description: Name that identifies the link aggregate interface
30970           required: true
30971           type: string
30972           example: __INTERFACE-NAME__
30973         - name: interface-name
30974           in: path
30975           description: Name given to the interface
30976           required: true
30977           type: string
30978           example: __INTERFACE-NAME__
30979         - name: vlan-interface
30980           in: path
30981           description: String that identifies the interface
30982           required: true
30983           type: string
30984           example: __VLAN-INTERFACE__
30985         - name: l3-interface-ipv4-address
30986           in: path
30987           description: IP address
30988           required: true
30989           type: string
30990           example: __L3-INTERFACE-IPV4-ADDRESS__
30991   /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}:
30992     get:
30993       tags:
30994         - Network
30995       summary: returns l3-interface-ipv4-address-list
30996       description: returns l3-interface-ipv4-address-list
30997       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30998       produces:
30999         - application/json
31000         - application/xml
31001       responses:
31002         "200":
31003           description: successful operation
31004           schema:
31005               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31006         "default":
31007           description: Response codes found in [response codes](https://wiki.onap.org/).
31008       parameters:
31009         - name: vnf-id
31010           in: path
31011           description: Unique id of VNF.  This is unique across the graph.
31012           required: true
31013           type: string
31014           example: __VNF-ID__
31015         - name: interface-name
31016           in: path
31017           description: Name that identifies the link aggregate interface
31018           required: true
31019           type: string
31020           example: __INTERFACE-NAME__
31021         - name: interface-name
31022           in: path
31023           description: Name given to the interface
31024           required: true
31025           type: string
31026           example: __INTERFACE-NAME__
31027         - name: vlan-interface
31028           in: path
31029           description: String that identifies the interface
31030           required: true
31031           type: string
31032           example: __VLAN-INTERFACE__
31033         - name: l3-interface-ipv4-address
31034           in: path
31035           description: IP address
31036           required: true
31037           type: string
31038           example: __L3-INTERFACE-IPV4-ADDRESS__
31039         - name: vnf-name
31040           in: query
31041           description: Name of VNF.
31042           required: false
31043           type: string
31044         - name: vnf-name2
31045           in: query
31046           description: Alternate name of VNF.
31047           required: false
31048           type: string
31049         - name: vnf-type
31050           in: query
31051           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
31052           required: false
31053           type: string
31054         - name: service-id
31055           in: query
31056           description: Unique identifier of service from ASDC
31057           required: false
31058           type: string
31059         - name: regional-resource-zone
31060           in: query
31061           description: Regional way of organizing pservers, source of truth should define values
31062           required: false
31063           type: string
31064         - name: prov-status
31065           in: query
31066           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31067           required: false
31068           type: string
31069         - name: heat-stack-id
31070           in: query
31071           description: Heat stack id corresponding to this instance, managed by MSO
31072           required: false
31073           type: string
31074         - name: in-maint
31075           in: query
31076           required: false
31077           type: boolean
31078         - name: is-closed-loop-disabled
31079           in: query
31080           required: false
31081           type: boolean
31082         - name: persona-model-id
31083           in: query
31084           description: the ASDC model id for this resource or service model.
31085           required: false
31086           type: string
31087         - name: persona-model-version
31088           in: query
31089           description: the ASDC model version for this resource or service model.
31090           required: false
31091           type: string
31092         - name: widget-model-id
31093           in: query
31094           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31095           required: false
31096           type: string
31097         - name: widget-model-version
31098           in: query
31099           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31100           required: false
31101           type: string
31102         - name: interface-id
31103           in: query
31104           description: ID of interface
31105           required: false
31106           type: string
31107         - name: macaddr
31108           in: query
31109           description: MAC address for the interface
31110           required: false
31111           type: string
31112         - name: network-name
31113           in: query
31114           description: Name of the network
31115           required: false
31116           type: string
31117         - name: vlan-id-inner
31118           in: query
31119           description: Inner VLAN tag
31120           required: false
31121           type: integer
31122           format: int64
31123         - name: vpn-id
31124           in: query
31125           description: This indicates the customers VPN ID associated with this vlan
31126           required: false
31127           type: string
31128         - name: vlan-id-inner
31129           in: query
31130           description: Inner VLAN tag
31131           required: false
31132           type: integer
31133           format: int64
31134         - name: neutron-network-id
31135           in: query
31136           description: Neutron network id of the interface that address belongs to
31137           required: false
31138           type: string
31139         - name: neutron-subnet-id
31140           in: query
31141           description: Neutron id of subnet that address belongs to
31142           required: false
31143           type: string
31144     put:
31145       tags:
31146         - Network
31147       summary: create or update an existing l3-interface-ipv4-address-list
31148       description: |
31149         Create or update an existing l3-interface-ipv4-address-list.
31150         #
31151         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
31152       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31153       consumes:
31154         - application/json
31155         - application/xml
31156       produces:
31157         - application/json
31158         - application/xml
31159       responses:
31160         "default":
31161           description: Response codes found in [response codes](https://wiki.onap.org/).
31162       parameters:
31163         - name: vnf-id
31164           in: path
31165           description: Unique id of VNF.  This is unique across the graph.
31166           required: true
31167           type: string
31168           example: __VNF-ID__
31169         - name: interface-name
31170           in: path
31171           description: Name that identifies the link aggregate interface
31172           required: true
31173           type: string
31174           example: __INTERFACE-NAME__
31175         - name: interface-name
31176           in: path
31177           description: Name given to the interface
31178           required: true
31179           type: string
31180           example: __INTERFACE-NAME__
31181         - name: vlan-interface
31182           in: path
31183           description: String that identifies the interface
31184           required: true
31185           type: string
31186           example: __VLAN-INTERFACE__
31187         - name: l3-interface-ipv4-address
31188           in: path
31189           description: IP address
31190           required: true
31191           type: string
31192           example: __L3-INTERFACE-IPV4-ADDRESS__
31193         - name: body
31194           in: body
31195           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31196           required: true
31197           schema:
31198             $ref: "#/definitions/l3-interface-ipv4-address-list"
31199     patch:
31200       tags:
31201         - Network
31202       summary: update an existing l3-interface-ipv4-address-list
31203       description: |
31204         Update an existing l3-interface-ipv4-address-list
31205         #
31206         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31207         The PUT operation will entirely replace an existing object.
31208         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.
31209         #
31210         Other differences between PUT and PATCH are:
31211         #
31212         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31213         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31214         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31215       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31216       consumes:
31217         - application/json
31218         - application/xml
31219       produces:
31220         - application/json
31221         - application/xml
31222       responses:
31223         "default":
31224           description: Response codes found in [response codes](https://wiki.onap.org/).
31225       parameters:
31226         - name: vnf-id
31227           in: path
31228           description: Unique id of VNF.  This is unique across the graph.
31229           required: true
31230           type: string
31231           example: __VNF-ID__
31232         - name: interface-name
31233           in: path
31234           description: Name that identifies the link aggregate interface
31235           required: true
31236           type: string
31237           example: __INTERFACE-NAME__
31238         - name: interface-name
31239           in: path
31240           description: Name given to the interface
31241           required: true
31242           type: string
31243           example: __INTERFACE-NAME__
31244         - name: vlan-interface
31245           in: path
31246           description: String that identifies the interface
31247           required: true
31248           type: string
31249           example: __VLAN-INTERFACE__
31250         - name: l3-interface-ipv4-address
31251           in: path
31252           description: IP address
31253           required: true
31254           type: string
31255           example: __L3-INTERFACE-IPV4-ADDRESS__
31256         - name: body
31257           in: body
31258           description: l3-interface-ipv4-address-list object that needs to be created or updated.
31259           required: true
31260           schema:
31261             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31262     delete:
31263       tags:
31264         - Network
31265       summary: delete an existing l3-interface-ipv4-address-list
31266       description: delete an existing l3-interface-ipv4-address-list
31267       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31268       consumes:
31269         - application/json
31270         - application/xml
31271       produces:
31272         - application/json
31273         - application/xml
31274       responses:
31275         "default":
31276           description: Response codes found in [response codes](https://wiki.onap.org/).
31277       parameters:
31278         - name: vnf-id
31279           in: path
31280           description: Unique id of VNF.  This is unique across the graph.
31281           required: true
31282           type: string
31283           example: __VNF-ID__
31284         - name: interface-name
31285           in: path
31286           description: Name that identifies the link aggregate interface
31287           required: true
31288           type: string
31289           example: __INTERFACE-NAME__
31290         - name: interface-name
31291           in: path
31292           description: Name given to the interface
31293           required: true
31294           type: string
31295           example: __INTERFACE-NAME__
31296         - name: vlan-interface
31297           in: path
31298           description: String that identifies the interface
31299           required: true
31300           type: string
31301           example: __VLAN-INTERFACE__
31302         - name: l3-interface-ipv4-address
31303           in: path
31304           description: IP address
31305           required: true
31306           type: string
31307           example: __L3-INTERFACE-IPV4-ADDRESS__
31308         - name: resource-version
31309           in: query
31310           description: resource-version for concurrency
31311           required: true
31312           type: string
31313   /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:
31314     put:
31315       tags:
31316         - Network
31317       summary: see node definition for valid relationships
31318       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31319       consumes:
31320         - application/json
31321         - application/xml
31322       produces:
31323         - application/json
31324         - application/xml
31325       responses:
31326         "default":
31327           description: Response codes found in [response codes](https://wiki.onap.org/).
31328       parameters:
31329         - name: vnf-id
31330           in: path
31331           description: Unique id of VNF.  This is unique across the graph.
31332           required: true
31333           type: string
31334           example: __VNF-ID__
31335         - name: interface-name
31336           in: path
31337           description: Name that identifies the link aggregate interface
31338           required: true
31339           type: string
31340           example: __INTERFACE-NAME__
31341         - name: interface-name
31342           in: path
31343           description: Name given to the interface
31344           required: true
31345           type: string
31346           example: __INTERFACE-NAME__
31347         - name: vlan-interface
31348           in: path
31349           description: String that identifies the interface
31350           required: true
31351           type: string
31352           example: __VLAN-INTERFACE__
31353         - name: l3-interface-ipv6-address
31354           in: path
31355           description: IP address
31356           required: true
31357           type: string
31358           example: __L3-INTERFACE-IPV6-ADDRESS__
31359         - name: body
31360           in: body
31361           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31362           required: true
31363           schema:
31364             $ref: "#/definitions/relationship"
31365     delete:
31366       tags:
31367         - Network
31368       summary: delete an existing relationship
31369       description: delete an existing relationship
31370       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31371       consumes:
31372         - application/json
31373         - application/xml
31374       produces:
31375         - application/json
31376         - application/xml
31377       responses:
31378         "default":
31379           description: Response codes found in [response codes](https://wiki.onap.org/).
31380       parameters:
31381         - name: vnf-id
31382           in: path
31383           description: Unique id of VNF.  This is unique across the graph.
31384           required: true
31385           type: string
31386           example: __VNF-ID__
31387         - name: interface-name
31388           in: path
31389           description: Name that identifies the link aggregate interface
31390           required: true
31391           type: string
31392           example: __INTERFACE-NAME__
31393         - name: interface-name
31394           in: path
31395           description: Name given to the interface
31396           required: true
31397           type: string
31398           example: __INTERFACE-NAME__
31399         - name: vlan-interface
31400           in: path
31401           description: String that identifies the interface
31402           required: true
31403           type: string
31404           example: __VLAN-INTERFACE__
31405         - name: l3-interface-ipv6-address
31406           in: path
31407           description: IP address
31408           required: true
31409           type: string
31410           example: __L3-INTERFACE-IPV6-ADDRESS__
31411   /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}:
31412     get:
31413       tags:
31414         - Network
31415       summary: returns l3-interface-ipv6-address-list
31416       description: returns l3-interface-ipv6-address-list
31417       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31418       produces:
31419         - application/json
31420         - application/xml
31421       responses:
31422         "200":
31423           description: successful operation
31424           schema:
31425               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31426         "default":
31427           description: Response codes found in [response codes](https://wiki.onap.org/).
31428       parameters:
31429         - name: vnf-id
31430           in: path
31431           description: Unique id of VNF.  This is unique across the graph.
31432           required: true
31433           type: string
31434           example: __VNF-ID__
31435         - name: interface-name
31436           in: path
31437           description: Name that identifies the link aggregate interface
31438           required: true
31439           type: string
31440           example: __INTERFACE-NAME__
31441         - name: interface-name
31442           in: path
31443           description: Name given to the interface
31444           required: true
31445           type: string
31446           example: __INTERFACE-NAME__
31447         - name: vlan-interface
31448           in: path
31449           description: String that identifies the interface
31450           required: true
31451           type: string
31452           example: __VLAN-INTERFACE__
31453         - name: l3-interface-ipv6-address
31454           in: path
31455           description: IP address
31456           required: true
31457           type: string
31458           example: __L3-INTERFACE-IPV6-ADDRESS__
31459         - name: vnf-name
31460           in: query
31461           description: Name of VNF.
31462           required: false
31463           type: string
31464         - name: vnf-name2
31465           in: query
31466           description: Alternate name of VNF.
31467           required: false
31468           type: string
31469         - name: vnf-type
31470           in: query
31471           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
31472           required: false
31473           type: string
31474         - name: service-id
31475           in: query
31476           description: Unique identifier of service from ASDC
31477           required: false
31478           type: string
31479         - name: regional-resource-zone
31480           in: query
31481           description: Regional way of organizing pservers, source of truth should define values
31482           required: false
31483           type: string
31484         - name: prov-status
31485           in: query
31486           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31487           required: false
31488           type: string
31489         - name: heat-stack-id
31490           in: query
31491           description: Heat stack id corresponding to this instance, managed by MSO
31492           required: false
31493           type: string
31494         - name: in-maint
31495           in: query
31496           required: false
31497           type: boolean
31498         - name: is-closed-loop-disabled
31499           in: query
31500           required: false
31501           type: boolean
31502         - name: persona-model-id
31503           in: query
31504           description: the ASDC model id for this resource or service model.
31505           required: false
31506           type: string
31507         - name: persona-model-version
31508           in: query
31509           description: the ASDC model version for this resource or service model.
31510           required: false
31511           type: string
31512         - name: widget-model-id
31513           in: query
31514           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31515           required: false
31516           type: string
31517         - name: widget-model-version
31518           in: query
31519           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31520           required: false
31521           type: string
31522         - name: interface-id
31523           in: query
31524           description: ID of interface
31525           required: false
31526           type: string
31527         - name: macaddr
31528           in: query
31529           description: MAC address for the interface
31530           required: false
31531           type: string
31532         - name: network-name
31533           in: query
31534           description: Name of the network
31535           required: false
31536           type: string
31537         - name: vlan-id-inner
31538           in: query
31539           description: Inner VLAN tag
31540           required: false
31541           type: integer
31542           format: int64
31543         - name: vpn-id
31544           in: query
31545           description: This indicates the customers VPN ID associated with this vlan
31546           required: false
31547           type: string
31548         - name: vlan-id-inner
31549           in: query
31550           description: Inner VLAN tag
31551           required: false
31552           type: integer
31553           format: int64
31554         - name: neutron-network-id
31555           in: query
31556           description: Neutron network id of the interface that address belongs to
31557           required: false
31558           type: string
31559         - name: neutron-subnet-id
31560           in: query
31561           description: Neutron id of subnet that address belongs to
31562           required: false
31563           type: string
31564     put:
31565       tags:
31566         - Network
31567       summary: create or update an existing l3-interface-ipv6-address-list
31568       description: |
31569         Create or update an existing l3-interface-ipv6-address-list.
31570         #
31571         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
31572       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31573       consumes:
31574         - application/json
31575         - application/xml
31576       produces:
31577         - application/json
31578         - application/xml
31579       responses:
31580         "default":
31581           description: Response codes found in [response codes](https://wiki.onap.org/).
31582       parameters:
31583         - name: vnf-id
31584           in: path
31585           description: Unique id of VNF.  This is unique across the graph.
31586           required: true
31587           type: string
31588           example: __VNF-ID__
31589         - name: interface-name
31590           in: path
31591           description: Name that identifies the link aggregate interface
31592           required: true
31593           type: string
31594           example: __INTERFACE-NAME__
31595         - name: interface-name
31596           in: path
31597           description: Name given to the interface
31598           required: true
31599           type: string
31600           example: __INTERFACE-NAME__
31601         - name: vlan-interface
31602           in: path
31603           description: String that identifies the interface
31604           required: true
31605           type: string
31606           example: __VLAN-INTERFACE__
31607         - name: l3-interface-ipv6-address
31608           in: path
31609           description: IP address
31610           required: true
31611           type: string
31612           example: __L3-INTERFACE-IPV6-ADDRESS__
31613         - name: body
31614           in: body
31615           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31616           required: true
31617           schema:
31618             $ref: "#/definitions/l3-interface-ipv6-address-list"
31619     patch:
31620       tags:
31621         - Network
31622       summary: update an existing l3-interface-ipv6-address-list
31623       description: |
31624         Update an existing l3-interface-ipv6-address-list
31625         #
31626         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31627         The PUT operation will entirely replace an existing object.
31628         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.
31629         #
31630         Other differences between PUT and PATCH are:
31631         #
31632         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31633         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31634         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31635       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31636       consumes:
31637         - application/json
31638         - application/xml
31639       produces:
31640         - application/json
31641         - application/xml
31642       responses:
31643         "default":
31644           description: Response codes found in [response codes](https://wiki.onap.org/).
31645       parameters:
31646         - name: vnf-id
31647           in: path
31648           description: Unique id of VNF.  This is unique across the graph.
31649           required: true
31650           type: string
31651           example: __VNF-ID__
31652         - name: interface-name
31653           in: path
31654           description: Name that identifies the link aggregate interface
31655           required: true
31656           type: string
31657           example: __INTERFACE-NAME__
31658         - name: interface-name
31659           in: path
31660           description: Name given to the interface
31661           required: true
31662           type: string
31663           example: __INTERFACE-NAME__
31664         - name: vlan-interface
31665           in: path
31666           description: String that identifies the interface
31667           required: true
31668           type: string
31669           example: __VLAN-INTERFACE__
31670         - name: l3-interface-ipv6-address
31671           in: path
31672           description: IP address
31673           required: true
31674           type: string
31675           example: __L3-INTERFACE-IPV6-ADDRESS__
31676         - name: body
31677           in: body
31678           description: l3-interface-ipv6-address-list object that needs to be created or updated.
31679           required: true
31680           schema:
31681             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31682     delete:
31683       tags:
31684         - Network
31685       summary: delete an existing l3-interface-ipv6-address-list
31686       description: delete an existing l3-interface-ipv6-address-list
31687       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31688       consumes:
31689         - application/json
31690         - application/xml
31691       produces:
31692         - application/json
31693         - application/xml
31694       responses:
31695         "default":
31696           description: Response codes found in [response codes](https://wiki.onap.org/).
31697       parameters:
31698         - name: vnf-id
31699           in: path
31700           description: Unique id of VNF.  This is unique across the graph.
31701           required: true
31702           type: string
31703           example: __VNF-ID__
31704         - name: interface-name
31705           in: path
31706           description: Name that identifies the link aggregate interface
31707           required: true
31708           type: string
31709           example: __INTERFACE-NAME__
31710         - name: interface-name
31711           in: path
31712           description: Name given to the interface
31713           required: true
31714           type: string
31715           example: __INTERFACE-NAME__
31716         - name: vlan-interface
31717           in: path
31718           description: String that identifies the interface
31719           required: true
31720           type: string
31721           example: __VLAN-INTERFACE__
31722         - name: l3-interface-ipv6-address
31723           in: path
31724           description: IP address
31725           required: true
31726           type: string
31727           example: __L3-INTERFACE-IPV6-ADDRESS__
31728         - name: resource-version
31729           in: query
31730           description: resource-version for concurrency
31731           required: true
31732           type: string
31733   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31734     get:
31735       tags:
31736         - Network
31737       summary: returns vlan
31738       description: returns vlan
31739       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31740       produces:
31741         - application/json
31742         - application/xml
31743       responses:
31744         "200":
31745           description: successful operation
31746           schema:
31747               $ref: "#/getDefinitions/vlan"
31748         "default":
31749           description: Response codes found in [response codes](https://wiki.onap.org/).
31750       parameters:
31751         - name: vnf-id
31752           in: path
31753           description: Unique id of VNF.  This is unique across the graph.
31754           required: true
31755           type: string
31756           example: __VNF-ID__
31757         - name: interface-name
31758           in: path
31759           description: Name that identifies the link aggregate interface
31760           required: true
31761           type: string
31762           example: __INTERFACE-NAME__
31763         - name: interface-name
31764           in: path
31765           description: Name given to the interface
31766           required: true
31767           type: string
31768           example: __INTERFACE-NAME__
31769         - name: vlan-interface
31770           in: path
31771           description: String that identifies the interface
31772           required: true
31773           type: string
31774           example: __VLAN-INTERFACE__
31775         - name: vnf-name
31776           in: query
31777           description: Name of VNF.
31778           required: false
31779           type: string
31780         - name: vnf-name2
31781           in: query
31782           description: Alternate name of VNF.
31783           required: false
31784           type: string
31785         - name: vnf-type
31786           in: query
31787           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
31788           required: false
31789           type: string
31790         - name: service-id
31791           in: query
31792           description: Unique identifier of service from ASDC
31793           required: false
31794           type: string
31795         - name: regional-resource-zone
31796           in: query
31797           description: Regional way of organizing pservers, source of truth should define values
31798           required: false
31799           type: string
31800         - name: prov-status
31801           in: query
31802           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31803           required: false
31804           type: string
31805         - name: heat-stack-id
31806           in: query
31807           description: Heat stack id corresponding to this instance, managed by MSO
31808           required: false
31809           type: string
31810         - name: in-maint
31811           in: query
31812           required: false
31813           type: boolean
31814         - name: is-closed-loop-disabled
31815           in: query
31816           required: false
31817           type: boolean
31818         - name: persona-model-id
31819           in: query
31820           description: the ASDC model id for this resource or service model.
31821           required: false
31822           type: string
31823         - name: persona-model-version
31824           in: query
31825           description: the ASDC model version for this resource or service model.
31826           required: false
31827           type: string
31828         - name: widget-model-id
31829           in: query
31830           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31831           required: false
31832           type: string
31833         - name: widget-model-version
31834           in: query
31835           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31836           required: false
31837           type: string
31838         - name: interface-id
31839           in: query
31840           description: ID of interface
31841           required: false
31842           type: string
31843         - name: macaddr
31844           in: query
31845           description: MAC address for the interface
31846           required: false
31847           type: string
31848         - name: network-name
31849           in: query
31850           description: Name of the network
31851           required: false
31852           type: string
31853         - name: vlan-id-inner
31854           in: query
31855           description: Inner VLAN tag
31856           required: false
31857           type: integer
31858           format: int64
31859         - name: vpn-id
31860           in: query
31861           description: This indicates the customers VPN ID associated with this vlan
31862           required: false
31863           type: string
31864     put:
31865       tags:
31866         - Network
31867       summary: create or update an existing vlan
31868       description: |
31869         Create or update an existing vlan.
31870         #
31871         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
31872       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31873       consumes:
31874         - application/json
31875         - application/xml
31876       produces:
31877         - application/json
31878         - application/xml
31879       responses:
31880         "default":
31881           description: Response codes found in [response codes](https://wiki.onap.org/).
31882       parameters:
31883         - name: vnf-id
31884           in: path
31885           description: Unique id of VNF.  This is unique across the graph.
31886           required: true
31887           type: string
31888           example: __VNF-ID__
31889         - name: interface-name
31890           in: path
31891           description: Name that identifies the link aggregate interface
31892           required: true
31893           type: string
31894           example: __INTERFACE-NAME__
31895         - name: interface-name
31896           in: path
31897           description: Name given to the interface
31898           required: true
31899           type: string
31900           example: __INTERFACE-NAME__
31901         - name: vlan-interface
31902           in: path
31903           description: String that identifies the interface
31904           required: true
31905           type: string
31906           example: __VLAN-INTERFACE__
31907         - name: body
31908           in: body
31909           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
31910           required: true
31911           schema:
31912             $ref: "#/definitions/vlan"
31913     patch:
31914       tags:
31915         - Network
31916       summary: update an existing vlan
31917       description: |
31918         Update an existing vlan
31919         #
31920         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31921         The PUT operation will entirely replace an existing object.
31922         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.
31923         #
31924         Other differences between PUT and PATCH are:
31925         #
31926         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31927         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31928         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31929       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31930       consumes:
31931         - application/json
31932         - application/xml
31933       produces:
31934         - application/json
31935         - application/xml
31936       responses:
31937         "default":
31938           description: Response codes found in [response codes](https://wiki.onap.org/).
31939       parameters:
31940         - name: vnf-id
31941           in: path
31942           description: Unique id of VNF.  This is unique across the graph.
31943           required: true
31944           type: string
31945           example: __VNF-ID__
31946         - name: interface-name
31947           in: path
31948           description: Name that identifies the link aggregate interface
31949           required: true
31950           type: string
31951           example: __INTERFACE-NAME__
31952         - name: interface-name
31953           in: path
31954           description: Name given to the interface
31955           required: true
31956           type: string
31957           example: __INTERFACE-NAME__
31958         - name: vlan-interface
31959           in: path
31960           description: String that identifies the interface
31961           required: true
31962           type: string
31963           example: __VLAN-INTERFACE__
31964         - name: body
31965           in: body
31966           description: vlan object that needs to be created or updated.
31967           required: true
31968           schema:
31969             $ref: "#/patchDefinitions/vlan"
31970     delete:
31971       tags:
31972         - Network
31973       summary: delete an existing vlan
31974       description: delete an existing vlan
31975       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
31976       consumes:
31977         - application/json
31978         - application/xml
31979       produces:
31980         - application/json
31981         - application/xml
31982       responses:
31983         "default":
31984           description: Response codes found in [response codes](https://wiki.onap.org/).
31985       parameters:
31986         - name: vnf-id
31987           in: path
31988           description: Unique id of VNF.  This is unique across the graph.
31989           required: true
31990           type: string
31991           example: __VNF-ID__
31992         - name: interface-name
31993           in: path
31994           description: Name that identifies the link aggregate interface
31995           required: true
31996           type: string
31997           example: __INTERFACE-NAME__
31998         - name: interface-name
31999           in: path
32000           description: Name given to the interface
32001           required: true
32002           type: string
32003           example: __INTERFACE-NAME__
32004         - name: vlan-interface
32005           in: path
32006           description: String that identifies the interface
32007           required: true
32008           type: string
32009           example: __VLAN-INTERFACE__
32010         - name: resource-version
32011           in: query
32012           description: resource-version for concurrency
32013           required: true
32014           type: string
32015   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
32016     get:
32017       tags:
32018         - Network
32019       summary: returns vlans
32020       description: returns vlans
32021       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
32022       produces:
32023         - application/json
32024         - application/xml
32025       responses:
32026         "200":
32027           description: successful operation
32028           schema:
32029               $ref: "#/getDefinitions/vlans"
32030         "default":
32031           description: Response codes found in [response codes](https://wiki.onap.org/).
32032       parameters:
32033         - name: vnf-id
32034           in: path
32035           description: Unique id of VNF.  This is unique across the graph.
32036           required: true
32037           type: string
32038           example: __VNF-ID__
32039         - name: interface-name
32040           in: path
32041           description: Name that identifies the link aggregate interface
32042           required: true
32043           type: string
32044           example: __INTERFACE-NAME__
32045         - name: interface-name
32046           in: path
32047           description: Name given to the interface
32048           required: true
32049           type: string
32050           example: __INTERFACE-NAME__
32051         - name: vnf-name
32052           in: query
32053           description: Name of VNF.
32054           required: false
32055           type: string
32056         - name: vnf-name2
32057           in: query
32058           description: Alternate name of VNF.
32059           required: false
32060           type: string
32061         - name: vnf-type
32062           in: query
32063           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
32064           required: false
32065           type: string
32066         - name: service-id
32067           in: query
32068           description: Unique identifier of service from ASDC
32069           required: false
32070           type: string
32071         - name: regional-resource-zone
32072           in: query
32073           description: Regional way of organizing pservers, source of truth should define values
32074           required: false
32075           type: string
32076         - name: prov-status
32077           in: query
32078           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32079           required: false
32080           type: string
32081         - name: heat-stack-id
32082           in: query
32083           description: Heat stack id corresponding to this instance, managed by MSO
32084           required: false
32085           type: string
32086         - name: in-maint
32087           in: query
32088           required: false
32089           type: boolean
32090         - name: is-closed-loop-disabled
32091           in: query
32092           required: false
32093           type: boolean
32094         - name: persona-model-id
32095           in: query
32096           description: the ASDC model id for this resource or service model.
32097           required: false
32098           type: string
32099         - name: persona-model-version
32100           in: query
32101           description: the ASDC model version for this resource or service model.
32102           required: false
32103           type: string
32104         - name: widget-model-id
32105           in: query
32106           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32107           required: false
32108           type: string
32109         - name: widget-model-version
32110           in: query
32111           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32112           required: false
32113           type: string
32114         - name: interface-id
32115           in: query
32116           description: ID of interface
32117           required: false
32118           type: string
32119         - name: macaddr
32120           in: query
32121           description: MAC address for the interface
32122           required: false
32123           type: string
32124         - name: network-name
32125           in: query
32126           description: Name of the network
32127           required: false
32128           type: string
32129   /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:
32130     put:
32131       tags:
32132         - Network
32133       summary: see node definition for valid relationships
32134       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32135       consumes:
32136         - application/json
32137         - application/xml
32138       produces:
32139         - application/json
32140         - application/xml
32141       responses:
32142         "default":
32143           description: Response codes found in [response codes](https://wiki.onap.org/).
32144       parameters:
32145         - name: vnf-id
32146           in: path
32147           description: Unique id of VNF.  This is unique across the graph.
32148           required: true
32149           type: string
32150           example: __VNF-ID__
32151         - name: interface-name
32152           in: path
32153           description: Name that identifies the link aggregate interface
32154           required: true
32155           type: string
32156           example: __INTERFACE-NAME__
32157         - name: interface-name
32158           in: path
32159           description: Name given to the interface
32160           required: true
32161           type: string
32162           example: __INTERFACE-NAME__
32163         - name: pci-id
32164           in: path
32165           description: PCI ID used to identify the sriov-vf
32166           required: true
32167           type: string
32168           example: __PCI-ID__
32169         - name: body
32170           in: body
32171           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
32172           required: true
32173           schema:
32174             $ref: "#/definitions/relationship"
32175     delete:
32176       tags:
32177         - Network
32178       summary: delete an existing relationship
32179       description: delete an existing relationship
32180       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32181       consumes:
32182         - application/json
32183         - application/xml
32184       produces:
32185         - application/json
32186         - application/xml
32187       responses:
32188         "default":
32189           description: Response codes found in [response codes](https://wiki.onap.org/).
32190       parameters:
32191         - name: vnf-id
32192           in: path
32193           description: Unique id of VNF.  This is unique across the graph.
32194           required: true
32195           type: string
32196           example: __VNF-ID__
32197         - name: interface-name
32198           in: path
32199           description: Name that identifies the link aggregate interface
32200           required: true
32201           type: string
32202           example: __INTERFACE-NAME__
32203         - name: interface-name
32204           in: path
32205           description: Name given to the interface
32206           required: true
32207           type: string
32208           example: __INTERFACE-NAME__
32209         - name: pci-id
32210           in: path
32211           description: PCI ID used to identify the sriov-vf
32212           required: true
32213           type: string
32214           example: __PCI-ID__
32215   /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}:
32216     get:
32217       tags:
32218         - Network
32219       summary: returns sriov-vf
32220       description: returns sriov-vf
32221       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32222       produces:
32223         - application/json
32224         - application/xml
32225       responses:
32226         "200":
32227           description: successful operation
32228           schema:
32229               $ref: "#/getDefinitions/sriov-vf"
32230         "default":
32231           description: Response codes found in [response codes](https://wiki.onap.org/).
32232       parameters:
32233         - name: vnf-id
32234           in: path
32235           description: Unique id of VNF.  This is unique across the graph.
32236           required: true
32237           type: string
32238           example: __VNF-ID__
32239         - name: interface-name
32240           in: path
32241           description: Name that identifies the link aggregate interface
32242           required: true
32243           type: string
32244           example: __INTERFACE-NAME__
32245         - name: interface-name
32246           in: path
32247           description: Name given to the interface
32248           required: true
32249           type: string
32250           example: __INTERFACE-NAME__
32251         - name: pci-id
32252           in: path
32253           description: PCI ID used to identify the sriov-vf
32254           required: true
32255           type: string
32256           example: __PCI-ID__
32257         - name: vnf-name
32258           in: query
32259           description: Name of VNF.
32260           required: false
32261           type: string
32262         - name: vnf-name2
32263           in: query
32264           description: Alternate name of VNF.
32265           required: false
32266           type: string
32267         - name: vnf-type
32268           in: query
32269           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
32270           required: false
32271           type: string
32272         - name: service-id
32273           in: query
32274           description: Unique identifier of service from ASDC
32275           required: false
32276           type: string
32277         - name: regional-resource-zone
32278           in: query
32279           description: Regional way of organizing pservers, source of truth should define values
32280           required: false
32281           type: string
32282         - name: prov-status
32283           in: query
32284           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32285           required: false
32286           type: string
32287         - name: heat-stack-id
32288           in: query
32289           description: Heat stack id corresponding to this instance, managed by MSO
32290           required: false
32291           type: string
32292         - name: in-maint
32293           in: query
32294           required: false
32295           type: boolean
32296         - name: is-closed-loop-disabled
32297           in: query
32298           required: false
32299           type: boolean
32300         - name: persona-model-id
32301           in: query
32302           description: the ASDC model id for this resource or service model.
32303           required: false
32304           type: string
32305         - name: persona-model-version
32306           in: query
32307           description: the ASDC model version for this resource or service model.
32308           required: false
32309           type: string
32310         - name: widget-model-id
32311           in: query
32312           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32313           required: false
32314           type: string
32315         - name: widget-model-version
32316           in: query
32317           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32318           required: false
32319           type: string
32320         - name: interface-id
32321           in: query
32322           description: ID of interface
32323           required: false
32324           type: string
32325         - name: macaddr
32326           in: query
32327           description: MAC address for the interface
32328           required: false
32329           type: string
32330         - name: network-name
32331           in: query
32332           description: Name of the network
32333           required: false
32334           type: string
32335         - name: vf-vlan-filter
32336           in: query
32337           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
32338           required: false
32339           type: string
32340         - name: vf-mac-filter
32341           in: query
32342           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
32343           required: false
32344           type: string
32345         - name: vf-vlan-strip
32346           in: query
32347           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
32348           required: false
32349           type: boolean
32350         - name: neutron-network-id
32351           in: query
32352           description: Neutron network id of the interface
32353           required: false
32354           type: string
32355     put:
32356       tags:
32357         - Network
32358       summary: create or update an existing sriov-vf
32359       description: |
32360         Create or update an existing sriov-vf.
32361         #
32362         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
32363       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32364       consumes:
32365         - application/json
32366         - application/xml
32367       produces:
32368         - application/json
32369         - application/xml
32370       responses:
32371         "default":
32372           description: Response codes found in [response codes](https://wiki.onap.org/).
32373       parameters:
32374         - name: vnf-id
32375           in: path
32376           description: Unique id of VNF.  This is unique across the graph.
32377           required: true
32378           type: string
32379           example: __VNF-ID__
32380         - name: interface-name
32381           in: path
32382           description: Name that identifies the link aggregate interface
32383           required: true
32384           type: string
32385           example: __INTERFACE-NAME__
32386         - name: interface-name
32387           in: path
32388           description: Name given to the interface
32389           required: true
32390           type: string
32391           example: __INTERFACE-NAME__
32392         - name: pci-id
32393           in: path
32394           description: PCI ID used to identify the sriov-vf
32395           required: true
32396           type: string
32397           example: __PCI-ID__
32398         - name: body
32399           in: body
32400           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
32401           required: true
32402           schema:
32403             $ref: "#/definitions/sriov-vf"
32404     patch:
32405       tags:
32406         - Network
32407       summary: update an existing sriov-vf
32408       description: |
32409         Update an existing sriov-vf
32410         #
32411         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32412         The PUT operation will entirely replace an existing object.
32413         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.
32414         #
32415         Other differences between PUT and PATCH are:
32416         #
32417         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32418         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32419         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32420       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32421       consumes:
32422         - application/json
32423         - application/xml
32424       produces:
32425         - application/json
32426         - application/xml
32427       responses:
32428         "default":
32429           description: Response codes found in [response codes](https://wiki.onap.org/).
32430       parameters:
32431         - name: vnf-id
32432           in: path
32433           description: Unique id of VNF.  This is unique across the graph.
32434           required: true
32435           type: string
32436           example: __VNF-ID__
32437         - name: interface-name
32438           in: path
32439           description: Name that identifies the link aggregate interface
32440           required: true
32441           type: string
32442           example: __INTERFACE-NAME__
32443         - name: interface-name
32444           in: path
32445           description: Name given to the interface
32446           required: true
32447           type: string
32448           example: __INTERFACE-NAME__
32449         - name: pci-id
32450           in: path
32451           description: PCI ID used to identify the sriov-vf
32452           required: true
32453           type: string
32454           example: __PCI-ID__
32455         - name: body
32456           in: body
32457           description: sriov-vf object that needs to be created or updated.
32458           required: true
32459           schema:
32460             $ref: "#/patchDefinitions/sriov-vf"
32461     delete:
32462       tags:
32463         - Network
32464       summary: delete an existing sriov-vf
32465       description: delete an existing sriov-vf
32466       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
32467       consumes:
32468         - application/json
32469         - application/xml
32470       produces:
32471         - application/json
32472         - application/xml
32473       responses:
32474         "default":
32475           description: Response codes found in [response codes](https://wiki.onap.org/).
32476       parameters:
32477         - name: vnf-id
32478           in: path
32479           description: Unique id of VNF.  This is unique across the graph.
32480           required: true
32481           type: string
32482           example: __VNF-ID__
32483         - name: interface-name
32484           in: path
32485           description: Name that identifies the link aggregate interface
32486           required: true
32487           type: string
32488           example: __INTERFACE-NAME__
32489         - name: interface-name
32490           in: path
32491           description: Name given to the interface
32492           required: true
32493           type: string
32494           example: __INTERFACE-NAME__
32495         - name: pci-id
32496           in: path
32497           description: PCI ID used to identify the sriov-vf
32498           required: true
32499           type: string
32500           example: __PCI-ID__
32501         - name: resource-version
32502           in: query
32503           description: resource-version for concurrency
32504           required: true
32505           type: string
32506   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32507     get:
32508       tags:
32509         - Network
32510       summary: returns sriov-vfs
32511       description: returns sriov-vfs
32512       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
32513       produces:
32514         - application/json
32515         - application/xml
32516       responses:
32517         "200":
32518           description: successful operation
32519           schema:
32520               $ref: "#/getDefinitions/sriov-vfs"
32521         "default":
32522           description: Response codes found in [response codes](https://wiki.onap.org/).
32523       parameters:
32524         - name: vnf-id
32525           in: path
32526           description: Unique id of VNF.  This is unique across the graph.
32527           required: true
32528           type: string
32529           example: __VNF-ID__
32530         - name: interface-name
32531           in: path
32532           description: Name that identifies the link aggregate interface
32533           required: true
32534           type: string
32535           example: __INTERFACE-NAME__
32536         - name: interface-name
32537           in: path
32538           description: Name given to the interface
32539           required: true
32540           type: string
32541           example: __INTERFACE-NAME__
32542         - name: vnf-name
32543           in: query
32544           description: Name of VNF.
32545           required: false
32546           type: string
32547         - name: vnf-name2
32548           in: query
32549           description: Alternate name of VNF.
32550           required: false
32551           type: string
32552         - name: vnf-type
32553           in: query
32554           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
32555           required: false
32556           type: string
32557         - name: service-id
32558           in: query
32559           description: Unique identifier of service from ASDC
32560           required: false
32561           type: string
32562         - name: regional-resource-zone
32563           in: query
32564           description: Regional way of organizing pservers, source of truth should define values
32565           required: false
32566           type: string
32567         - name: prov-status
32568           in: query
32569           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32570           required: false
32571           type: string
32572         - name: heat-stack-id
32573           in: query
32574           description: Heat stack id corresponding to this instance, managed by MSO
32575           required: false
32576           type: string
32577         - name: in-maint
32578           in: query
32579           required: false
32580           type: boolean
32581         - name: is-closed-loop-disabled
32582           in: query
32583           required: false
32584           type: boolean
32585         - name: persona-model-id
32586           in: query
32587           description: the ASDC model id for this resource or service model.
32588           required: false
32589           type: string
32590         - name: persona-model-version
32591           in: query
32592           description: the ASDC model version for this resource or service model.
32593           required: false
32594           type: string
32595         - name: widget-model-id
32596           in: query
32597           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32598           required: false
32599           type: string
32600         - name: widget-model-version
32601           in: query
32602           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32603           required: false
32604           type: string
32605         - name: interface-id
32606           in: query
32607           description: ID of interface
32608           required: false
32609           type: string
32610         - name: macaddr
32611           in: query
32612           description: MAC address for the interface
32613           required: false
32614           type: string
32615         - name: network-name
32616           in: query
32617           description: Name of the network
32618           required: false
32619           type: string
32620   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32621     put:
32622       tags:
32623         - Network
32624       summary: see node definition for valid relationships
32625       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
32626       consumes:
32627         - application/json
32628         - application/xml
32629       produces:
32630         - application/json
32631         - application/xml
32632       responses:
32633         "default":
32634           description: Response codes found in [response codes](https://wiki.onap.org/).
32635       parameters:
32636         - name: vnf-id
32637           in: path
32638           description: Unique id of VNF.  This is unique across the graph.
32639           required: true
32640           type: string
32641           example: __VNF-ID__
32642         - name: interface-name
32643           in: path
32644           description: Name that identifies the link aggregate interface
32645           required: true
32646           type: string
32647           example: __INTERFACE-NAME__
32648         - name: interface-name
32649           in: path
32650           description: Name given to the interface
32651           required: true
32652           type: string
32653           example: __INTERFACE-NAME__
32654         - name: body
32655           in: body
32656           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
32657           required: true
32658           schema:
32659             $ref: "#/definitions/relationship"
32660     delete:
32661       tags:
32662         - Network
32663       summary: delete an existing relationship
32664       description: delete an existing relationship
32665       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
32666       consumes:
32667         - application/json
32668         - application/xml
32669       produces:
32670         - application/json
32671         - application/xml
32672       responses:
32673         "default":
32674           description: Response codes found in [response codes](https://wiki.onap.org/).
32675       parameters:
32676         - name: vnf-id
32677           in: path
32678           description: Unique id of VNF.  This is unique across the graph.
32679           required: true
32680           type: string
32681           example: __VNF-ID__
32682         - name: interface-name
32683           in: path
32684           description: Name that identifies the link aggregate interface
32685           required: true
32686           type: string
32687           example: __INTERFACE-NAME__
32688         - name: interface-name
32689           in: path
32690           description: Name given to the interface
32691           required: true
32692           type: string
32693           example: __INTERFACE-NAME__
32694   /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:
32695     put:
32696       tags:
32697         - Network
32698       summary: see node definition for valid relationships
32699       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32700       consumes:
32701         - application/json
32702         - application/xml
32703       produces:
32704         - application/json
32705         - application/xml
32706       responses:
32707         "default":
32708           description: Response codes found in [response codes](https://wiki.onap.org/).
32709       parameters:
32710         - name: vnf-id
32711           in: path
32712           description: Unique id of VNF.  This is unique across the graph.
32713           required: true
32714           type: string
32715           example: __VNF-ID__
32716         - name: interface-name
32717           in: path
32718           description: Name that identifies the link aggregate interface
32719           required: true
32720           type: string
32721           example: __INTERFACE-NAME__
32722         - name: interface-name
32723           in: path
32724           description: Name given to the interface
32725           required: true
32726           type: string
32727           example: __INTERFACE-NAME__
32728         - name: l3-interface-ipv4-address
32729           in: path
32730           description: IP address
32731           required: true
32732           type: string
32733           example: __L3-INTERFACE-IPV4-ADDRESS__
32734         - name: body
32735           in: body
32736           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32737           required: true
32738           schema:
32739             $ref: "#/definitions/relationship"
32740     delete:
32741       tags:
32742         - Network
32743       summary: delete an existing relationship
32744       description: delete an existing relationship
32745       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32746       consumes:
32747         - application/json
32748         - application/xml
32749       produces:
32750         - application/json
32751         - application/xml
32752       responses:
32753         "default":
32754           description: Response codes found in [response codes](https://wiki.onap.org/).
32755       parameters:
32756         - name: vnf-id
32757           in: path
32758           description: Unique id of VNF.  This is unique across the graph.
32759           required: true
32760           type: string
32761           example: __VNF-ID__
32762         - name: interface-name
32763           in: path
32764           description: Name that identifies the link aggregate interface
32765           required: true
32766           type: string
32767           example: __INTERFACE-NAME__
32768         - name: interface-name
32769           in: path
32770           description: Name given to the interface
32771           required: true
32772           type: string
32773           example: __INTERFACE-NAME__
32774         - name: l3-interface-ipv4-address
32775           in: path
32776           description: IP address
32777           required: true
32778           type: string
32779           example: __L3-INTERFACE-IPV4-ADDRESS__
32780   /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}:
32781     get:
32782       tags:
32783         - Network
32784       summary: returns l3-interface-ipv4-address-list
32785       description: returns l3-interface-ipv4-address-list
32786       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
32787       produces:
32788         - application/json
32789         - application/xml
32790       responses:
32791         "200":
32792           description: successful operation
32793           schema:
32794               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32795         "default":
32796           description: Response codes found in [response codes](https://wiki.onap.org/).
32797       parameters:
32798         - name: vnf-id
32799           in: path
32800           description: Unique id of VNF.  This is unique across the graph.
32801           required: true
32802           type: string
32803           example: __VNF-ID__
32804         - name: interface-name
32805           in: path
32806           description: Name that identifies the link aggregate interface
32807           required: true
32808           type: string
32809           example: __INTERFACE-NAME__
32810         - name: interface-name
32811           in: path
32812           description: Name given to the interface
32813           required: true
32814           type: string
32815           example: __INTERFACE-NAME__
32816         - name: l3-interface-ipv4-address
32817           in: path
32818           description: IP address
32819           required: true
32820           type: string
32821           example: __L3-INTERFACE-IPV4-ADDRESS__
32822         - name: vnf-name
32823           in: query
32824           description: Name of VNF.
32825           required: false
32826           type: string
32827         - name: vnf-name2
32828           in: query
32829           description: Alternate name of VNF.
32830           required: false
32831           type: string
32832         - name: vnf-type
32833           in: query
32834           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
32835           required: false
32836           type: string
32837         - name: service-id
32838           in: query
32839           description: Unique identifier of service from ASDC
32840           required: false
32841           type: string
32842         - name: regional-resource-zone
32843           in: query
32844           description: Regional way of organizing pservers, source of truth should define values
32845           required: false
32846           type: string
32847         - name: prov-status
32848           in: query
32849           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32850           required: false
32851           type: string
32852         - name: heat-stack-id
32853           in: query
32854           description: Heat stack id corresponding to this instance, managed by MSO
32855           required: false
32856           type: string
32857         - name: in-maint
32858           in: query
32859           required: false
32860           type: boolean
32861         - name: is-closed-loop-disabled
32862           in: query
32863           required: false
32864           type: boolean
32865         - name: persona-model-id
32866           in: query
32867           description: the ASDC model id for this resource or service model.
32868           required: false
32869           type: string
32870         - name: persona-model-version
32871           in: query
32872           description: the ASDC model version for this resource or service model.
32873           required: false
32874           type: string
32875         - name: widget-model-id
32876           in: query
32877           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32878           required: false
32879           type: string
32880         - name: widget-model-version
32881           in: query
32882           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32883           required: false
32884           type: string
32885         - name: interface-id
32886           in: query
32887           description: ID of interface
32888           required: false
32889           type: string
32890         - name: macaddr
32891           in: query
32892           description: MAC address for the interface
32893           required: false
32894           type: string
32895         - name: network-name
32896           in: query
32897           description: Name of the network
32898           required: false
32899           type: string
32900         - name: vlan-id-inner
32901           in: query
32902           description: Inner VLAN tag
32903           required: false
32904           type: integer
32905           format: int64
32906         - name: neutron-network-id
32907           in: query
32908           description: Neutron network id of the interface that address belongs to
32909           required: false
32910           type: string
32911         - name: neutron-subnet-id
32912           in: query
32913           description: Neutron id of subnet that address belongs to
32914           required: false
32915           type: string
32916     put:
32917       tags:
32918         - Network
32919       summary: create or update an existing l3-interface-ipv4-address-list
32920       description: |
32921         Create or update an existing l3-interface-ipv4-address-list.
32922         #
32923         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
32924       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
32925       consumes:
32926         - application/json
32927         - application/xml
32928       produces:
32929         - application/json
32930         - application/xml
32931       responses:
32932         "default":
32933           description: Response codes found in [response codes](https://wiki.onap.org/).
32934       parameters:
32935         - name: vnf-id
32936           in: path
32937           description: Unique id of VNF.  This is unique across the graph.
32938           required: true
32939           type: string
32940           example: __VNF-ID__
32941         - name: interface-name
32942           in: path
32943           description: Name that identifies the link aggregate interface
32944           required: true
32945           type: string
32946           example: __INTERFACE-NAME__
32947         - name: interface-name
32948           in: path
32949           description: Name given to the interface
32950           required: true
32951           type: string
32952           example: __INTERFACE-NAME__
32953         - name: l3-interface-ipv4-address
32954           in: path
32955           description: IP address
32956           required: true
32957           type: string
32958           example: __L3-INTERFACE-IPV4-ADDRESS__
32959         - name: body
32960           in: body
32961           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32962           required: true
32963           schema:
32964             $ref: "#/definitions/l3-interface-ipv4-address-list"
32965     patch:
32966       tags:
32967         - Network
32968       summary: update an existing l3-interface-ipv4-address-list
32969       description: |
32970         Update an existing l3-interface-ipv4-address-list
32971         #
32972         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32973         The PUT operation will entirely replace an existing object.
32974         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.
32975         #
32976         Other differences between PUT and PATCH are:
32977         #
32978         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32979         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32980         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32981       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
32982       consumes:
32983         - application/json
32984         - application/xml
32985       produces:
32986         - application/json
32987         - application/xml
32988       responses:
32989         "default":
32990           description: Response codes found in [response codes](https://wiki.onap.org/).
32991       parameters:
32992         - name: vnf-id
32993           in: path
32994           description: Unique id of VNF.  This is unique across the graph.
32995           required: true
32996           type: string
32997           example: __VNF-ID__
32998         - name: interface-name
32999           in: path
33000           description: Name that identifies the link aggregate interface
33001           required: true
33002           type: string
33003           example: __INTERFACE-NAME__
33004         - name: interface-name
33005           in: path
33006           description: Name given to the interface
33007           required: true
33008           type: string
33009           example: __INTERFACE-NAME__
33010         - name: l3-interface-ipv4-address
33011           in: path
33012           description: IP address
33013           required: true
33014           type: string
33015           example: __L3-INTERFACE-IPV4-ADDRESS__
33016         - name: body
33017           in: body
33018           description: l3-interface-ipv4-address-list object that needs to be created or updated.
33019           required: true
33020           schema:
33021             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
33022     delete:
33023       tags:
33024         - Network
33025       summary: delete an existing l3-interface-ipv4-address-list
33026       description: delete an existing l3-interface-ipv4-address-list
33027       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
33028       consumes:
33029         - application/json
33030         - application/xml
33031       produces:
33032         - application/json
33033         - application/xml
33034       responses:
33035         "default":
33036           description: Response codes found in [response codes](https://wiki.onap.org/).
33037       parameters:
33038         - name: vnf-id
33039           in: path
33040           description: Unique id of VNF.  This is unique across the graph.
33041           required: true
33042           type: string
33043           example: __VNF-ID__
33044         - name: interface-name
33045           in: path
33046           description: Name that identifies the link aggregate interface
33047           required: true
33048           type: string
33049           example: __INTERFACE-NAME__
33050         - name: interface-name
33051           in: path
33052           description: Name given to the interface
33053           required: true
33054           type: string
33055           example: __INTERFACE-NAME__
33056         - name: l3-interface-ipv4-address
33057           in: path
33058           description: IP address
33059           required: true
33060           type: string
33061           example: __L3-INTERFACE-IPV4-ADDRESS__
33062         - name: resource-version
33063           in: query
33064           description: resource-version for concurrency
33065           required: true
33066           type: string
33067   /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:
33068     put:
33069       tags:
33070         - Network
33071       summary: see node definition for valid relationships
33072       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33073       consumes:
33074         - application/json
33075         - application/xml
33076       produces:
33077         - application/json
33078         - application/xml
33079       responses:
33080         "default":
33081           description: Response codes found in [response codes](https://wiki.onap.org/).
33082       parameters:
33083         - name: vnf-id
33084           in: path
33085           description: Unique id of VNF.  This is unique across the graph.
33086           required: true
33087           type: string
33088           example: __VNF-ID__
33089         - name: interface-name
33090           in: path
33091           description: Name that identifies the link aggregate interface
33092           required: true
33093           type: string
33094           example: __INTERFACE-NAME__
33095         - name: interface-name
33096           in: path
33097           description: Name given to the interface
33098           required: true
33099           type: string
33100           example: __INTERFACE-NAME__
33101         - name: l3-interface-ipv6-address
33102           in: path
33103           description: IP address
33104           required: true
33105           type: string
33106           example: __L3-INTERFACE-IPV6-ADDRESS__
33107         - name: body
33108           in: body
33109           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33110           required: true
33111           schema:
33112             $ref: "#/definitions/relationship"
33113     delete:
33114       tags:
33115         - Network
33116       summary: delete an existing relationship
33117       description: delete an existing relationship
33118       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33119       consumes:
33120         - application/json
33121         - application/xml
33122       produces:
33123         - application/json
33124         - application/xml
33125       responses:
33126         "default":
33127           description: Response codes found in [response codes](https://wiki.onap.org/).
33128       parameters:
33129         - name: vnf-id
33130           in: path
33131           description: Unique id of VNF.  This is unique across the graph.
33132           required: true
33133           type: string
33134           example: __VNF-ID__
33135         - name: interface-name
33136           in: path
33137           description: Name that identifies the link aggregate interface
33138           required: true
33139           type: string
33140           example: __INTERFACE-NAME__
33141         - name: interface-name
33142           in: path
33143           description: Name given to the interface
33144           required: true
33145           type: string
33146           example: __INTERFACE-NAME__
33147         - name: l3-interface-ipv6-address
33148           in: path
33149           description: IP address
33150           required: true
33151           type: string
33152           example: __L3-INTERFACE-IPV6-ADDRESS__
33153   /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}:
33154     get:
33155       tags:
33156         - Network
33157       summary: returns l3-interface-ipv6-address-list
33158       description: returns l3-interface-ipv6-address-list
33159       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33160       produces:
33161         - application/json
33162         - application/xml
33163       responses:
33164         "200":
33165           description: successful operation
33166           schema:
33167               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33168         "default":
33169           description: Response codes found in [response codes](https://wiki.onap.org/).
33170       parameters:
33171         - name: vnf-id
33172           in: path
33173           description: Unique id of VNF.  This is unique across the graph.
33174           required: true
33175           type: string
33176           example: __VNF-ID__
33177         - name: interface-name
33178           in: path
33179           description: Name that identifies the link aggregate interface
33180           required: true
33181           type: string
33182           example: __INTERFACE-NAME__
33183         - name: interface-name
33184           in: path
33185           description: Name given to the interface
33186           required: true
33187           type: string
33188           example: __INTERFACE-NAME__
33189         - name: l3-interface-ipv6-address
33190           in: path
33191           description: IP address
33192           required: true
33193           type: string
33194           example: __L3-INTERFACE-IPV6-ADDRESS__
33195         - name: vnf-name
33196           in: query
33197           description: Name of VNF.
33198           required: false
33199           type: string
33200         - name: vnf-name2
33201           in: query
33202           description: Alternate name of VNF.
33203           required: false
33204           type: string
33205         - name: vnf-type
33206           in: query
33207           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
33208           required: false
33209           type: string
33210         - name: service-id
33211           in: query
33212           description: Unique identifier of service from ASDC
33213           required: false
33214           type: string
33215         - name: regional-resource-zone
33216           in: query
33217           description: Regional way of organizing pservers, source of truth should define values
33218           required: false
33219           type: string
33220         - name: prov-status
33221           in: query
33222           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33223           required: false
33224           type: string
33225         - name: heat-stack-id
33226           in: query
33227           description: Heat stack id corresponding to this instance, managed by MSO
33228           required: false
33229           type: string
33230         - name: in-maint
33231           in: query
33232           required: false
33233           type: boolean
33234         - name: is-closed-loop-disabled
33235           in: query
33236           required: false
33237           type: boolean
33238         - name: persona-model-id
33239           in: query
33240           description: the ASDC model id for this resource or service model.
33241           required: false
33242           type: string
33243         - name: persona-model-version
33244           in: query
33245           description: the ASDC model version for this resource or service model.
33246           required: false
33247           type: string
33248         - name: widget-model-id
33249           in: query
33250           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33251           required: false
33252           type: string
33253         - name: widget-model-version
33254           in: query
33255           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33256           required: false
33257           type: string
33258         - name: interface-id
33259           in: query
33260           description: ID of interface
33261           required: false
33262           type: string
33263         - name: macaddr
33264           in: query
33265           description: MAC address for the interface
33266           required: false
33267           type: string
33268         - name: network-name
33269           in: query
33270           description: Name of the network
33271           required: false
33272           type: string
33273         - name: vlan-id-inner
33274           in: query
33275           description: Inner VLAN tag
33276           required: false
33277           type: integer
33278           format: int64
33279         - name: neutron-network-id
33280           in: query
33281           description: Neutron network id of the interface that address belongs to
33282           required: false
33283           type: string
33284         - name: neutron-subnet-id
33285           in: query
33286           description: Neutron id of subnet that address belongs to
33287           required: false
33288           type: string
33289     put:
33290       tags:
33291         - Network
33292       summary: create or update an existing l3-interface-ipv6-address-list
33293       description: |
33294         Create or update an existing l3-interface-ipv6-address-list.
33295         #
33296         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
33297       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33298       consumes:
33299         - application/json
33300         - application/xml
33301       produces:
33302         - application/json
33303         - application/xml
33304       responses:
33305         "default":
33306           description: Response codes found in [response codes](https://wiki.onap.org/).
33307       parameters:
33308         - name: vnf-id
33309           in: path
33310           description: Unique id of VNF.  This is unique across the graph.
33311           required: true
33312           type: string
33313           example: __VNF-ID__
33314         - name: interface-name
33315           in: path
33316           description: Name that identifies the link aggregate interface
33317           required: true
33318           type: string
33319           example: __INTERFACE-NAME__
33320         - name: interface-name
33321           in: path
33322           description: Name given to the interface
33323           required: true
33324           type: string
33325           example: __INTERFACE-NAME__
33326         - name: l3-interface-ipv6-address
33327           in: path
33328           description: IP address
33329           required: true
33330           type: string
33331           example: __L3-INTERFACE-IPV6-ADDRESS__
33332         - name: body
33333           in: body
33334           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33335           required: true
33336           schema:
33337             $ref: "#/definitions/l3-interface-ipv6-address-list"
33338     patch:
33339       tags:
33340         - Network
33341       summary: update an existing l3-interface-ipv6-address-list
33342       description: |
33343         Update an existing l3-interface-ipv6-address-list
33344         #
33345         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33346         The PUT operation will entirely replace an existing object.
33347         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.
33348         #
33349         Other differences between PUT and PATCH are:
33350         #
33351         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33352         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33353         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33354       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33355       consumes:
33356         - application/json
33357         - application/xml
33358       produces:
33359         - application/json
33360         - application/xml
33361       responses:
33362         "default":
33363           description: Response codes found in [response codes](https://wiki.onap.org/).
33364       parameters:
33365         - name: vnf-id
33366           in: path
33367           description: Unique id of VNF.  This is unique across the graph.
33368           required: true
33369           type: string
33370           example: __VNF-ID__
33371         - name: interface-name
33372           in: path
33373           description: Name that identifies the link aggregate interface
33374           required: true
33375           type: string
33376           example: __INTERFACE-NAME__
33377         - name: interface-name
33378           in: path
33379           description: Name given to the interface
33380           required: true
33381           type: string
33382           example: __INTERFACE-NAME__
33383         - name: l3-interface-ipv6-address
33384           in: path
33385           description: IP address
33386           required: true
33387           type: string
33388           example: __L3-INTERFACE-IPV6-ADDRESS__
33389         - name: body
33390           in: body
33391           description: l3-interface-ipv6-address-list object that needs to be created or updated.
33392           required: true
33393           schema:
33394             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33395     delete:
33396       tags:
33397         - Network
33398       summary: delete an existing l3-interface-ipv6-address-list
33399       description: delete an existing l3-interface-ipv6-address-list
33400       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
33401       consumes:
33402         - application/json
33403         - application/xml
33404       produces:
33405         - application/json
33406         - application/xml
33407       responses:
33408         "default":
33409           description: Response codes found in [response codes](https://wiki.onap.org/).
33410       parameters:
33411         - name: vnf-id
33412           in: path
33413           description: Unique id of VNF.  This is unique across the graph.
33414           required: true
33415           type: string
33416           example: __VNF-ID__
33417         - name: interface-name
33418           in: path
33419           description: Name that identifies the link aggregate interface
33420           required: true
33421           type: string
33422           example: __INTERFACE-NAME__
33423         - name: interface-name
33424           in: path
33425           description: Name given to the interface
33426           required: true
33427           type: string
33428           example: __INTERFACE-NAME__
33429         - name: l3-interface-ipv6-address
33430           in: path
33431           description: IP address
33432           required: true
33433           type: string
33434           example: __L3-INTERFACE-IPV6-ADDRESS__
33435         - name: resource-version
33436           in: query
33437           description: resource-version for concurrency
33438           required: true
33439           type: string
33440   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
33441     get:
33442       tags:
33443         - Network
33444       summary: returns l-interface
33445       description: returns l-interface
33446       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33447       produces:
33448         - application/json
33449         - application/xml
33450       responses:
33451         "200":
33452           description: successful operation
33453           schema:
33454               $ref: "#/getDefinitions/l-interface"
33455         "default":
33456           description: Response codes found in [response codes](https://wiki.onap.org/).
33457       parameters:
33458         - name: vnf-id
33459           in: path
33460           description: Unique id of VNF.  This is unique across the graph.
33461           required: true
33462           type: string
33463           example: __VNF-ID__
33464         - name: interface-name
33465           in: path
33466           description: Name that identifies the link aggregate interface
33467           required: true
33468           type: string
33469           example: __INTERFACE-NAME__
33470         - name: interface-name
33471           in: path
33472           description: Name given to the interface
33473           required: true
33474           type: string
33475           example: __INTERFACE-NAME__
33476         - name: vnf-name
33477           in: query
33478           description: Name of VNF.
33479           required: false
33480           type: string
33481         - name: vnf-name2
33482           in: query
33483           description: Alternate name of VNF.
33484           required: false
33485           type: string
33486         - name: vnf-type
33487           in: query
33488           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
33489           required: false
33490           type: string
33491         - name: service-id
33492           in: query
33493           description: Unique identifier of service from ASDC
33494           required: false
33495           type: string
33496         - name: regional-resource-zone
33497           in: query
33498           description: Regional way of organizing pservers, source of truth should define values
33499           required: false
33500           type: string
33501         - name: prov-status
33502           in: query
33503           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33504           required: false
33505           type: string
33506         - name: heat-stack-id
33507           in: query
33508           description: Heat stack id corresponding to this instance, managed by MSO
33509           required: false
33510           type: string
33511         - name: in-maint
33512           in: query
33513           required: false
33514           type: boolean
33515         - name: is-closed-loop-disabled
33516           in: query
33517           required: false
33518           type: boolean
33519         - name: persona-model-id
33520           in: query
33521           description: the ASDC model id for this resource or service model.
33522           required: false
33523           type: string
33524         - name: persona-model-version
33525           in: query
33526           description: the ASDC model version for this resource or service model.
33527           required: false
33528           type: string
33529         - name: widget-model-id
33530           in: query
33531           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33532           required: false
33533           type: string
33534         - name: widget-model-version
33535           in: query
33536           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33537           required: false
33538           type: string
33539         - name: interface-id
33540           in: query
33541           description: ID of interface
33542           required: false
33543           type: string
33544         - name: macaddr
33545           in: query
33546           description: MAC address for the interface
33547           required: false
33548           type: string
33549         - name: network-name
33550           in: query
33551           description: Name of the network
33552           required: false
33553           type: string
33554     put:
33555       tags:
33556         - Network
33557       summary: create or update an existing l-interface
33558       description: |
33559         Create or update an existing l-interface.
33560         #
33561         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
33562       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33563       consumes:
33564         - application/json
33565         - application/xml
33566       produces:
33567         - application/json
33568         - application/xml
33569       responses:
33570         "default":
33571           description: Response codes found in [response codes](https://wiki.onap.org/).
33572       parameters:
33573         - name: vnf-id
33574           in: path
33575           description: Unique id of VNF.  This is unique across the graph.
33576           required: true
33577           type: string
33578           example: __VNF-ID__
33579         - name: interface-name
33580           in: path
33581           description: Name that identifies the link aggregate interface
33582           required: true
33583           type: string
33584           example: __INTERFACE-NAME__
33585         - name: interface-name
33586           in: path
33587           description: Name given to the interface
33588           required: true
33589           type: string
33590           example: __INTERFACE-NAME__
33591         - name: body
33592           in: body
33593           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
33594           required: true
33595           schema:
33596             $ref: "#/definitions/l-interface"
33597     patch:
33598       tags:
33599         - Network
33600       summary: update an existing l-interface
33601       description: |
33602         Update an existing l-interface
33603         #
33604         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33605         The PUT operation will entirely replace an existing object.
33606         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.
33607         #
33608         Other differences between PUT and PATCH are:
33609         #
33610         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33611         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33612         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33613       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33614       consumes:
33615         - application/json
33616         - application/xml
33617       produces:
33618         - application/json
33619         - application/xml
33620       responses:
33621         "default":
33622           description: Response codes found in [response codes](https://wiki.onap.org/).
33623       parameters:
33624         - name: vnf-id
33625           in: path
33626           description: Unique id of VNF.  This is unique across the graph.
33627           required: true
33628           type: string
33629           example: __VNF-ID__
33630         - name: interface-name
33631           in: path
33632           description: Name that identifies the link aggregate interface
33633           required: true
33634           type: string
33635           example: __INTERFACE-NAME__
33636         - name: interface-name
33637           in: path
33638           description: Name given to the interface
33639           required: true
33640           type: string
33641           example: __INTERFACE-NAME__
33642         - name: body
33643           in: body
33644           description: l-interface object that needs to be created or updated.
33645           required: true
33646           schema:
33647             $ref: "#/patchDefinitions/l-interface"
33648     delete:
33649       tags:
33650         - Network
33651       summary: delete an existing l-interface
33652       description: delete an existing l-interface
33653       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
33654       consumes:
33655         - application/json
33656         - application/xml
33657       produces:
33658         - application/json
33659         - application/xml
33660       responses:
33661         "default":
33662           description: Response codes found in [response codes](https://wiki.onap.org/).
33663       parameters:
33664         - name: vnf-id
33665           in: path
33666           description: Unique id of VNF.  This is unique across the graph.
33667           required: true
33668           type: string
33669           example: __VNF-ID__
33670         - name: interface-name
33671           in: path
33672           description: Name that identifies the link aggregate interface
33673           required: true
33674           type: string
33675           example: __INTERFACE-NAME__
33676         - name: interface-name
33677           in: path
33678           description: Name given to the interface
33679           required: true
33680           type: string
33681           example: __INTERFACE-NAME__
33682         - name: resource-version
33683           in: query
33684           description: resource-version for concurrency
33685           required: true
33686           type: string
33687   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
33688     get:
33689       tags:
33690         - Network
33691       summary: returns l-interfaces
33692       description: returns l-interfaces
33693       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
33694       produces:
33695         - application/json
33696         - application/xml
33697       responses:
33698         "200":
33699           description: successful operation
33700           schema:
33701               $ref: "#/getDefinitions/l-interfaces"
33702         "default":
33703           description: Response codes found in [response codes](https://wiki.onap.org/).
33704       parameters:
33705         - name: vnf-id
33706           in: path
33707           description: Unique id of VNF.  This is unique across the graph.
33708           required: true
33709           type: string
33710           example: __VNF-ID__
33711         - name: interface-name
33712           in: path
33713           description: Name that identifies the link aggregate interface
33714           required: true
33715           type: string
33716           example: __INTERFACE-NAME__
33717         - name: vnf-name
33718           in: query
33719           description: Name of VNF.
33720           required: false
33721           type: string
33722         - name: vnf-name2
33723           in: query
33724           description: Alternate name of VNF.
33725           required: false
33726           type: string
33727         - name: vnf-type
33728           in: query
33729           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
33730           required: false
33731           type: string
33732         - name: service-id
33733           in: query
33734           description: Unique identifier of service from ASDC
33735           required: false
33736           type: string
33737         - name: regional-resource-zone
33738           in: query
33739           description: Regional way of organizing pservers, source of truth should define values
33740           required: false
33741           type: string
33742         - name: prov-status
33743           in: query
33744           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33745           required: false
33746           type: string
33747         - name: heat-stack-id
33748           in: query
33749           description: Heat stack id corresponding to this instance, managed by MSO
33750           required: false
33751           type: string
33752         - name: in-maint
33753           in: query
33754           required: false
33755           type: boolean
33756         - name: is-closed-loop-disabled
33757           in: query
33758           required: false
33759           type: boolean
33760         - name: persona-model-id
33761           in: query
33762           description: the ASDC model id for this resource or service model.
33763           required: false
33764           type: string
33765         - name: persona-model-version
33766           in: query
33767           description: the ASDC model version for this resource or service model.
33768           required: false
33769           type: string
33770         - name: widget-model-id
33771           in: query
33772           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33773           required: false
33774           type: string
33775         - name: widget-model-version
33776           in: query
33777           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33778           required: false
33779           type: string
33780   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
33781     get:
33782       tags:
33783         - Network
33784       summary: returns lag-interface
33785       description: returns lag-interface
33786       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33787       produces:
33788         - application/json
33789         - application/xml
33790       responses:
33791         "200":
33792           description: successful operation
33793           schema:
33794               $ref: "#/getDefinitions/lag-interface"
33795         "default":
33796           description: Response codes found in [response codes](https://wiki.onap.org/).
33797       parameters:
33798         - name: vnf-id
33799           in: path
33800           description: Unique id of VNF.  This is unique across the graph.
33801           required: true
33802           type: string
33803           example: __VNF-ID__
33804         - name: interface-name
33805           in: path
33806           description: Name that identifies the link aggregate interface
33807           required: true
33808           type: string
33809           example: __INTERFACE-NAME__
33810         - name: vnf-name
33811           in: query
33812           description: Name of VNF.
33813           required: false
33814           type: string
33815         - name: vnf-name2
33816           in: query
33817           description: Alternate name of VNF.
33818           required: false
33819           type: string
33820         - name: vnf-type
33821           in: query
33822           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
33823           required: false
33824           type: string
33825         - name: service-id
33826           in: query
33827           description: Unique identifier of service from ASDC
33828           required: false
33829           type: string
33830         - name: regional-resource-zone
33831           in: query
33832           description: Regional way of organizing pservers, source of truth should define values
33833           required: false
33834           type: string
33835         - name: prov-status
33836           in: query
33837           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33838           required: false
33839           type: string
33840         - name: heat-stack-id
33841           in: query
33842           description: Heat stack id corresponding to this instance, managed by MSO
33843           required: false
33844           type: string
33845         - name: in-maint
33846           in: query
33847           required: false
33848           type: boolean
33849         - name: is-closed-loop-disabled
33850           in: query
33851           required: false
33852           type: boolean
33853         - name: persona-model-id
33854           in: query
33855           description: the ASDC model id for this resource or service model.
33856           required: false
33857           type: string
33858         - name: persona-model-version
33859           in: query
33860           description: the ASDC model version for this resource or service model.
33861           required: false
33862           type: string
33863         - name: widget-model-id
33864           in: query
33865           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33866           required: false
33867           type: string
33868         - name: widget-model-version
33869           in: query
33870           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33871           required: false
33872           type: string
33873     put:
33874       tags:
33875         - Network
33876       summary: create or update an existing lag-interface
33877       description: |
33878         Create or update an existing lag-interface.
33879         #
33880         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
33881       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33882       consumes:
33883         - application/json
33884         - application/xml
33885       produces:
33886         - application/json
33887         - application/xml
33888       responses:
33889         "default":
33890           description: Response codes found in [response codes](https://wiki.onap.org/).
33891       parameters:
33892         - name: vnf-id
33893           in: path
33894           description: Unique id of VNF.  This is unique across the graph.
33895           required: true
33896           type: string
33897           example: __VNF-ID__
33898         - name: interface-name
33899           in: path
33900           description: Name that identifies the link aggregate interface
33901           required: true
33902           type: string
33903           example: __INTERFACE-NAME__
33904         - name: body
33905           in: body
33906           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33907           required: true
33908           schema:
33909             $ref: "#/definitions/lag-interface"
33910     patch:
33911       tags:
33912         - Network
33913       summary: update an existing lag-interface
33914       description: |
33915         Update an existing lag-interface
33916         #
33917         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33918         The PUT operation will entirely replace an existing object.
33919         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.
33920         #
33921         Other differences between PUT and PATCH are:
33922         #
33923         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33924         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33925         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33926       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33927       consumes:
33928         - application/json
33929         - application/xml
33930       produces:
33931         - application/json
33932         - application/xml
33933       responses:
33934         "default":
33935           description: Response codes found in [response codes](https://wiki.onap.org/).
33936       parameters:
33937         - name: vnf-id
33938           in: path
33939           description: Unique id of VNF.  This is unique across the graph.
33940           required: true
33941           type: string
33942           example: __VNF-ID__
33943         - name: interface-name
33944           in: path
33945           description: Name that identifies the link aggregate interface
33946           required: true
33947           type: string
33948           example: __INTERFACE-NAME__
33949         - name: body
33950           in: body
33951           description: lag-interface object that needs to be created or updated.
33952           required: true
33953           schema:
33954             $ref: "#/patchDefinitions/lag-interface"
33955     delete:
33956       tags:
33957         - Network
33958       summary: delete an existing lag-interface
33959       description: delete an existing lag-interface
33960       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
33961       consumes:
33962         - application/json
33963         - application/xml
33964       produces:
33965         - application/json
33966         - application/xml
33967       responses:
33968         "default":
33969           description: Response codes found in [response codes](https://wiki.onap.org/).
33970       parameters:
33971         - name: vnf-id
33972           in: path
33973           description: Unique id of VNF.  This is unique across the graph.
33974           required: true
33975           type: string
33976           example: __VNF-ID__
33977         - name: interface-name
33978           in: path
33979           description: Name that identifies the link aggregate interface
33980           required: true
33981           type: string
33982           example: __INTERFACE-NAME__
33983         - name: resource-version
33984           in: query
33985           description: resource-version for concurrency
33986           required: true
33987           type: string
33988   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
33989     get:
33990       tags:
33991         - Network
33992       summary: returns lag-interfaces
33993       description: returns lag-interfaces
33994       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
33995       produces:
33996         - application/json
33997         - application/xml
33998       responses:
33999         "200":
34000           description: successful operation
34001           schema:
34002               $ref: "#/getDefinitions/lag-interfaces"
34003         "default":
34004           description: Response codes found in [response codes](https://wiki.onap.org/).
34005       parameters:
34006         - name: vnf-id
34007           in: path
34008           description: Unique id of VNF.  This is unique across the graph.
34009           required: true
34010           type: string
34011           example: __VNF-ID__
34012         - name: vnf-name
34013           in: query
34014           description: Name of VNF.
34015           required: false
34016           type: string
34017         - name: vnf-name2
34018           in: query
34019           description: Alternate name of VNF.
34020           required: false
34021           type: string
34022         - name: vnf-type
34023           in: query
34024           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
34025           required: false
34026           type: string
34027         - name: service-id
34028           in: query
34029           description: Unique identifier of service from ASDC
34030           required: false
34031           type: string
34032         - name: regional-resource-zone
34033           in: query
34034           description: Regional way of organizing pservers, source of truth should define values
34035           required: false
34036           type: string
34037         - name: prov-status
34038           in: query
34039           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34040           required: false
34041           type: string
34042         - name: heat-stack-id
34043           in: query
34044           description: Heat stack id corresponding to this instance, managed by MSO
34045           required: false
34046           type: string
34047         - name: in-maint
34048           in: query
34049           required: false
34050           type: boolean
34051         - name: is-closed-loop-disabled
34052           in: query
34053           required: false
34054           type: boolean
34055         - name: persona-model-id
34056           in: query
34057           description: the ASDC model id for this resource or service model.
34058           required: false
34059           type: string
34060         - name: persona-model-version
34061           in: query
34062           description: the ASDC model version for this resource or service model.
34063           required: false
34064           type: string
34065         - name: widget-model-id
34066           in: query
34067           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34068           required: false
34069           type: string
34070         - name: widget-model-version
34071           in: query
34072           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34073           required: false
34074           type: string
34075   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
34076     put:
34077       tags:
34078         - Network
34079       summary: see node definition for valid relationships
34080       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34081       consumes:
34082         - application/json
34083         - application/xml
34084       produces:
34085         - application/json
34086         - application/xml
34087       responses:
34088         "default":
34089           description: Response codes found in [response codes](https://wiki.onap.org/).
34090       parameters:
34091         - name: vnf-id
34092           in: path
34093           description: Unique id of VNF.  This is unique across the graph.
34094           required: true
34095           type: string
34096           example: __VNF-ID__
34097         - name: vf-module-id
34098           in: path
34099           description: Unique ID of vf-module.
34100           required: true
34101           type: string
34102           example: __VF-MODULE-ID__
34103         - name: body
34104           in: body
34105           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34106           required: true
34107           schema:
34108             $ref: "#/definitions/relationship"
34109     delete:
34110       tags:
34111         - Network
34112       summary: delete an existing relationship
34113       description: delete an existing relationship
34114       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
34115       consumes:
34116         - application/json
34117         - application/xml
34118       produces:
34119         - application/json
34120         - application/xml
34121       responses:
34122         "default":
34123           description: Response codes found in [response codes](https://wiki.onap.org/).
34124       parameters:
34125         - name: vnf-id
34126           in: path
34127           description: Unique id of VNF.  This is unique across the graph.
34128           required: true
34129           type: string
34130           example: __VNF-ID__
34131         - name: vf-module-id
34132           in: path
34133           description: Unique ID of vf-module.
34134           required: true
34135           type: string
34136           example: __VF-MODULE-ID__
34137   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
34138     get:
34139       tags:
34140         - Network
34141       summary: returns vf-module
34142       description: returns vf-module
34143       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
34144       produces:
34145         - application/json
34146         - application/xml
34147       responses:
34148         "200":
34149           description: successful operation
34150           schema:
34151               $ref: "#/getDefinitions/vf-module"
34152         "default":
34153           description: Response codes found in [response codes](https://wiki.onap.org/).
34154       parameters:
34155         - name: vnf-id
34156           in: path
34157           description: Unique id of VNF.  This is unique across the graph.
34158           required: true
34159           type: string
34160           example: __VNF-ID__
34161         - name: vf-module-id
34162           in: path
34163           description: Unique ID of vf-module.
34164           required: true
34165           type: string
34166           example: __VF-MODULE-ID__
34167         - name: vnf-name
34168           in: query
34169           description: Name of VNF.
34170           required: false
34171           type: string
34172         - name: vnf-name2
34173           in: query
34174           description: Alternate name of VNF.
34175           required: false
34176           type: string
34177         - name: vnf-type
34178           in: query
34179           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
34180           required: false
34181           type: string
34182         - name: service-id
34183           in: query
34184           description: Unique identifier of service from ASDC
34185           required: false
34186           type: string
34187         - name: regional-resource-zone
34188           in: query
34189           description: Regional way of organizing pservers, source of truth should define values
34190           required: false
34191           type: string
34192         - name: prov-status
34193           in: query
34194           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34195           required: false
34196           type: string
34197         - name: heat-stack-id
34198           in: query
34199           description: Heat stack id corresponding to this instance, managed by MSO
34200           required: false
34201           type: string
34202         - name: in-maint
34203           in: query
34204           required: false
34205           type: boolean
34206         - name: is-closed-loop-disabled
34207           in: query
34208           required: false
34209           type: boolean
34210         - name: persona-model-id
34211           in: query
34212           description: the ASDC model id for this resource or service model.
34213           required: false
34214           type: string
34215         - name: persona-model-version
34216           in: query
34217           description: the ASDC model version for this resource or service model.
34218           required: false
34219           type: string
34220         - name: widget-model-id
34221           in: query
34222           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34223           required: false
34224           type: string
34225         - name: widget-model-version
34226           in: query
34227           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34228           required: false
34229           type: string
34230         - name: vf-module-name
34231           in: query
34232           description: Name of vf-module
34233           required: false
34234           type: string
34235         - name: heat-stack-id
34236           in: query
34237           description: Heat stack id corresponding to this instance.
34238           required: false
34239           type: string
34240         - name: persona-model-id
34241           in: query
34242           description: the ASDC model id for this resource or service model.
34243           required: false
34244           type: string
34245         - name: persona-model-version
34246           in: query
34247           description: the ASDC model version for this resource or service model.
34248           required: false
34249           type: string
34250         - name: widget-model-id
34251           in: query
34252           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34253           required: false
34254           type: string
34255         - name: widget-model-version
34256           in: query
34257           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34258           required: false
34259           type: string
34260         - name: contrail-service-instance-fqdn
34261           in: query
34262           description: the Contrail unique ID for a service-instance
34263           required: false
34264           type: string
34265     put:
34266       tags:
34267         - Network
34268       summary: create or update an existing vf-module
34269       description: |
34270         Create or update an existing vf-module.
34271         #
34272         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
34273       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34274       consumes:
34275         - application/json
34276         - application/xml
34277       produces:
34278         - application/json
34279         - application/xml
34280       responses:
34281         "default":
34282           description: Response codes found in [response codes](https://wiki.onap.org/).
34283       parameters:
34284         - name: vnf-id
34285           in: path
34286           description: Unique id of VNF.  This is unique across the graph.
34287           required: true
34288           type: string
34289           example: __VNF-ID__
34290         - name: vf-module-id
34291           in: path
34292           description: Unique ID of vf-module.
34293           required: true
34294           type: string
34295           example: __VF-MODULE-ID__
34296         - name: body
34297           in: body
34298           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
34299           required: true
34300           schema:
34301             $ref: "#/definitions/vf-module"
34302     patch:
34303       tags:
34304         - Network
34305       summary: update an existing vf-module
34306       description: |
34307         Update an existing vf-module
34308         #
34309         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34310         The PUT operation will entirely replace an existing object.
34311         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.
34312         #
34313         Other differences between PUT and PATCH are:
34314         #
34315         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34316         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34317         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34318       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
34319       consumes:
34320         - application/json
34321         - application/xml
34322       produces:
34323         - application/json
34324         - application/xml
34325       responses:
34326         "default":
34327           description: Response codes found in [response codes](https://wiki.onap.org/).
34328       parameters:
34329         - name: vnf-id
34330           in: path
34331           description: Unique id of VNF.  This is unique across the graph.
34332           required: true
34333           type: string
34334           example: __VNF-ID__
34335         - name: vf-module-id
34336           in: path
34337           description: Unique ID of vf-module.
34338           required: true
34339           type: string
34340           example: __VF-MODULE-ID__
34341         - name: body
34342           in: body
34343           description: vf-module object that needs to be created or updated.
34344           required: true
34345           schema:
34346             $ref: "#/patchDefinitions/vf-module"
34347     delete:
34348       tags:
34349         - Network
34350       summary: delete an existing vf-module
34351       description: delete an existing vf-module
34352       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
34353       consumes:
34354         - application/json
34355         - application/xml
34356       produces:
34357         - application/json
34358         - application/xml
34359       responses:
34360         "default":
34361           description: Response codes found in [response codes](https://wiki.onap.org/).
34362       parameters:
34363         - name: vnf-id
34364           in: path
34365           description: Unique id of VNF.  This is unique across the graph.
34366           required: true
34367           type: string
34368           example: __VNF-ID__
34369         - name: vf-module-id
34370           in: path
34371           description: Unique ID of vf-module.
34372           required: true
34373           type: string
34374           example: __VF-MODULE-ID__
34375         - name: resource-version
34376           in: query
34377           description: resource-version for concurrency
34378           required: true
34379           type: string
34380   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
34381     get:
34382       tags:
34383         - Network
34384       summary: returns vf-modules
34385       description: returns vf-modules
34386       operationId: getNetworkGenericVnfsGenericVnfVfModules
34387       produces:
34388         - application/json
34389         - application/xml
34390       responses:
34391         "200":
34392           description: successful operation
34393           schema:
34394               $ref: "#/getDefinitions/vf-modules"
34395         "default":
34396           description: Response codes found in [response codes](https://wiki.onap.org/).
34397       parameters:
34398         - name: vnf-id
34399           in: path
34400           description: Unique id of VNF.  This is unique across the graph.
34401           required: true
34402           type: string
34403           example: __VNF-ID__
34404         - name: vnf-name
34405           in: query
34406           description: Name of VNF.
34407           required: false
34408           type: string
34409         - name: vnf-name2
34410           in: query
34411           description: Alternate name of VNF.
34412           required: false
34413           type: string
34414         - name: vnf-type
34415           in: query
34416           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
34417           required: false
34418           type: string
34419         - name: service-id
34420           in: query
34421           description: Unique identifier of service from ASDC
34422           required: false
34423           type: string
34424         - name: regional-resource-zone
34425           in: query
34426           description: Regional way of organizing pservers, source of truth should define values
34427           required: false
34428           type: string
34429         - name: prov-status
34430           in: query
34431           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34432           required: false
34433           type: string
34434         - name: heat-stack-id
34435           in: query
34436           description: Heat stack id corresponding to this instance, managed by MSO
34437           required: false
34438           type: string
34439         - name: in-maint
34440           in: query
34441           required: false
34442           type: boolean
34443         - name: is-closed-loop-disabled
34444           in: query
34445           required: false
34446           type: boolean
34447         - name: persona-model-id
34448           in: query
34449           description: the ASDC model id for this resource or service model.
34450           required: false
34451           type: string
34452         - name: persona-model-version
34453           in: query
34454           description: the ASDC model version for this resource or service model.
34455           required: false
34456           type: string
34457         - name: widget-model-id
34458           in: query
34459           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34460           required: false
34461           type: string
34462         - name: widget-model-version
34463           in: query
34464           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34465           required: false
34466           type: string
34467   /network/generic-vnfs/generic-vnf/{vnf-id}:
34468     get:
34469       tags:
34470         - Network
34471       summary: returns generic-vnf
34472       description: returns generic-vnf
34473       operationId: getNetworkGenericVnfsGenericVnf
34474       produces:
34475         - application/json
34476         - application/xml
34477       responses:
34478         "200":
34479           description: successful operation
34480           schema:
34481               $ref: "#/getDefinitions/generic-vnf"
34482         "default":
34483           description: Response codes found in [response codes](https://wiki.onap.org/).
34484       parameters:
34485         - name: vnf-id
34486           in: path
34487           description: Unique id of VNF.  This is unique across the graph.
34488           required: true
34489           type: string
34490           example: __VNF-ID__
34491         - name: vnf-name
34492           in: query
34493           description: Name of VNF.
34494           required: false
34495           type: string
34496         - name: vnf-name2
34497           in: query
34498           description: Alternate name of VNF.
34499           required: false
34500           type: string
34501         - name: vnf-type
34502           in: query
34503           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
34504           required: false
34505           type: string
34506         - name: service-id
34507           in: query
34508           description: Unique identifier of service from ASDC
34509           required: false
34510           type: string
34511         - name: regional-resource-zone
34512           in: query
34513           description: Regional way of organizing pservers, source of truth should define values
34514           required: false
34515           type: string
34516         - name: prov-status
34517           in: query
34518           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34519           required: false
34520           type: string
34521         - name: heat-stack-id
34522           in: query
34523           description: Heat stack id corresponding to this instance, managed by MSO
34524           required: false
34525           type: string
34526         - name: in-maint
34527           in: query
34528           required: false
34529           type: boolean
34530         - name: is-closed-loop-disabled
34531           in: query
34532           required: false
34533           type: boolean
34534         - name: persona-model-id
34535           in: query
34536           description: the ASDC model id for this resource or service model.
34537           required: false
34538           type: string
34539         - name: persona-model-version
34540           in: query
34541           description: the ASDC model version for this resource or service model.
34542           required: false
34543           type: string
34544         - name: widget-model-id
34545           in: query
34546           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34547           required: false
34548           type: string
34549         - name: widget-model-version
34550           in: query
34551           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34552           required: false
34553           type: string
34554     put:
34555       tags:
34556         - Network
34557       summary: create or update an existing generic-vnf
34558       description: |
34559         Create or update an existing generic-vnf.
34560         #
34561         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
34562       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
34563       consumes:
34564         - application/json
34565         - application/xml
34566       produces:
34567         - application/json
34568         - application/xml
34569       responses:
34570         "default":
34571           description: Response codes found in [response codes](https://wiki.onap.org/).
34572       parameters:
34573         - name: vnf-id
34574           in: path
34575           description: Unique id of VNF.  This is unique across the graph.
34576           required: true
34577           type: string
34578           example: __VNF-ID__
34579         - name: body
34580           in: body
34581           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkGenericVnfsGenericVnf.json)
34582           required: true
34583           schema:
34584             $ref: "#/definitions/generic-vnf"
34585     patch:
34586       tags:
34587         - Network
34588       summary: update an existing generic-vnf
34589       description: |
34590         Update an existing generic-vnf
34591         #
34592         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34593         The PUT operation will entirely replace an existing object.
34594         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.
34595         #
34596         Other differences between PUT and PATCH are:
34597         #
34598         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34599         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34600         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34601       operationId: UpdateNetworkGenericVnfsGenericVnf
34602       consumes:
34603         - application/json
34604         - application/xml
34605       produces:
34606         - application/json
34607         - application/xml
34608       responses:
34609         "default":
34610           description: Response codes found in [response codes](https://wiki.onap.org/).
34611       parameters:
34612         - name: vnf-id
34613           in: path
34614           description: Unique id of VNF.  This is unique across the graph.
34615           required: true
34616           type: string
34617           example: __VNF-ID__
34618         - name: body
34619           in: body
34620           description: generic-vnf object that needs to be created or updated.
34621           required: true
34622           schema:
34623             $ref: "#/patchDefinitions/generic-vnf"
34624     delete:
34625       tags:
34626         - Network
34627       summary: delete an existing generic-vnf
34628       description: delete an existing generic-vnf
34629       operationId: deleteNetworkGenericVnfsGenericVnf
34630       consumes:
34631         - application/json
34632         - application/xml
34633       produces:
34634         - application/json
34635         - application/xml
34636       responses:
34637         "default":
34638           description: Response codes found in [response codes](https://wiki.onap.org/).
34639       parameters:
34640         - name: vnf-id
34641           in: path
34642           description: Unique id of VNF.  This is unique across the graph.
34643           required: true
34644           type: string
34645           example: __VNF-ID__
34646         - name: resource-version
34647           in: query
34648           description: resource-version for concurrency
34649           required: true
34650           type: string
34651   /network/generic-vnfs:
34652     get:
34653       tags:
34654         - Network
34655       summary: returns generic-vnfs
34656       description: returns generic-vnfs
34657       operationId: getNetworkGenericVnfs
34658       produces:
34659         - application/json
34660         - application/xml
34661       responses:
34662         "200":
34663           description: successful operation
34664           schema:
34665               $ref: "#/getDefinitions/generic-vnfs"
34666         "default":
34667           description: Response codes found in [response codes](https://wiki.onap.org/).
34668   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
34669     put:
34670       tags:
34671         - Network
34672       summary: see node definition for valid relationships
34673       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
34674       consumes:
34675         - application/json
34676         - application/xml
34677       produces:
34678         - application/json
34679         - application/xml
34680       responses:
34681         "default":
34682           description: Response codes found in [response codes](https://wiki.onap.org/).
34683       parameters:
34684         - name: link-name
34685           in: path
34686           description: Alphabetical concatenation of lag-interface names
34687           required: true
34688           type: string
34689           example: __LINK-NAME__
34690         - name: body
34691           in: body
34692           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
34693           required: true
34694           schema:
34695             $ref: "#/definitions/relationship"
34696     delete:
34697       tags:
34698         - Network
34699       summary: delete an existing relationship
34700       description: delete an existing relationship
34701       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
34702       consumes:
34703         - application/json
34704         - application/xml
34705       produces:
34706         - application/json
34707         - application/xml
34708       responses:
34709         "default":
34710           description: Response codes found in [response codes](https://wiki.onap.org/).
34711       parameters:
34712         - name: link-name
34713           in: path
34714           description: Alphabetical concatenation of lag-interface names
34715           required: true
34716           type: string
34717           example: __LINK-NAME__
34718   /network/lag-links/lag-link/{link-name}:
34719     get:
34720       tags:
34721         - Network
34722       summary: returns lag-link
34723       description: returns lag-link
34724       operationId: getNetworkLagLinksLagLink
34725       produces:
34726         - application/json
34727         - application/xml
34728       responses:
34729         "200":
34730           description: successful operation
34731           schema:
34732               $ref: "#/getDefinitions/lag-link"
34733         "default":
34734           description: Response codes found in [response codes](https://wiki.onap.org/).
34735       parameters:
34736         - name: link-name
34737           in: path
34738           description: Alphabetical concatenation of lag-interface names
34739           required: true
34740           type: string
34741           example: __LINK-NAME__
34742     put:
34743       tags:
34744         - Network
34745       summary: create or update an existing lag-link
34746       description: |
34747         Create or update an existing lag-link.
34748         #
34749         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
34750       operationId: createOrUpdateNetworkLagLinksLagLink
34751       consumes:
34752         - application/json
34753         - application/xml
34754       produces:
34755         - application/json
34756         - application/xml
34757       responses:
34758         "default":
34759           description: Response codes found in [response codes](https://wiki.onap.org/).
34760       parameters:
34761         - name: link-name
34762           in: path
34763           description: Alphabetical concatenation of lag-interface names
34764           required: true
34765           type: string
34766           example: __LINK-NAME__
34767         - name: body
34768           in: body
34769           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkLagLinksLagLink.json)
34770           required: true
34771           schema:
34772             $ref: "#/definitions/lag-link"
34773     patch:
34774       tags:
34775         - Network
34776       summary: update an existing lag-link
34777       description: |
34778         Update an existing lag-link
34779         #
34780         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34781         The PUT operation will entirely replace an existing object.
34782         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.
34783         #
34784         Other differences between PUT and PATCH are:
34785         #
34786         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34787         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34788         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34789       operationId: UpdateNetworkLagLinksLagLink
34790       consumes:
34791         - application/json
34792         - application/xml
34793       produces:
34794         - application/json
34795         - application/xml
34796       responses:
34797         "default":
34798           description: Response codes found in [response codes](https://wiki.onap.org/).
34799       parameters:
34800         - name: link-name
34801           in: path
34802           description: Alphabetical concatenation of lag-interface names
34803           required: true
34804           type: string
34805           example: __LINK-NAME__
34806         - name: body
34807           in: body
34808           description: lag-link object that needs to be created or updated.
34809           required: true
34810           schema:
34811             $ref: "#/patchDefinitions/lag-link"
34812     delete:
34813       tags:
34814         - Network
34815       summary: delete an existing lag-link
34816       description: delete an existing lag-link
34817       operationId: deleteNetworkLagLinksLagLink
34818       consumes:
34819         - application/json
34820         - application/xml
34821       produces:
34822         - application/json
34823         - application/xml
34824       responses:
34825         "default":
34826           description: Response codes found in [response codes](https://wiki.onap.org/).
34827       parameters:
34828         - name: link-name
34829           in: path
34830           description: Alphabetical concatenation of lag-interface names
34831           required: true
34832           type: string
34833           example: __LINK-NAME__
34834         - name: resource-version
34835           in: query
34836           description: resource-version for concurrency
34837           required: true
34838           type: string
34839   /network/lag-links:
34840     get:
34841       tags:
34842         - Network
34843       summary: returns lag-links
34844       description: returns lag-links
34845       operationId: getNetworkLagLinks
34846       produces:
34847         - application/json
34848         - application/xml
34849       responses:
34850         "200":
34851           description: successful operation
34852           schema:
34853               $ref: "#/getDefinitions/lag-links"
34854         "default":
34855           description: Response codes found in [response codes](https://wiki.onap.org/).
34856   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
34857     put:
34858       tags:
34859         - Network
34860       summary: see node definition for valid relationships
34861       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
34862       consumes:
34863         - application/json
34864         - application/xml
34865       produces:
34866         - application/json
34867         - application/xml
34868       responses:
34869         "default":
34870           description: Response codes found in [response codes](https://wiki.onap.org/).
34871       parameters:
34872         - name: vnf-id2
34873           in: path
34874           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34875           required: true
34876           type: string
34877           example: __VNF-ID2__
34878         - name: body
34879           in: body
34880           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
34881           required: true
34882           schema:
34883             $ref: "#/definitions/relationship"
34884     delete:
34885       tags:
34886         - Network
34887       summary: delete an existing relationship
34888       description: delete an existing relationship
34889       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
34890       consumes:
34891         - application/json
34892         - application/xml
34893       produces:
34894         - application/json
34895         - application/xml
34896       responses:
34897         "default":
34898           description: Response codes found in [response codes](https://wiki.onap.org/).
34899       parameters:
34900         - name: vnf-id2
34901           in: path
34902           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34903           required: true
34904           type: string
34905           example: __VNF-ID2__
34906   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34907     put:
34908       tags:
34909         - Network
34910       summary: see node definition for valid relationships
34911       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34912       consumes:
34913         - application/json
34914         - application/xml
34915       produces:
34916         - application/json
34917         - application/xml
34918       responses:
34919         "default":
34920           description: Response codes found in [response codes](https://wiki.onap.org/).
34921       parameters:
34922         - name: vnf-id2
34923           in: path
34924           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34925           required: true
34926           type: string
34927           example: __VNF-ID2__
34928         - name: interface-name
34929           in: path
34930           description: Name given to the interface
34931           required: true
34932           type: string
34933           example: __INTERFACE-NAME__
34934         - name: vlan-interface
34935           in: path
34936           description: String that identifies the interface
34937           required: true
34938           type: string
34939           example: __VLAN-INTERFACE__
34940         - name: body
34941           in: body
34942           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
34943           required: true
34944           schema:
34945             $ref: "#/definitions/relationship"
34946     delete:
34947       tags:
34948         - Network
34949       summary: delete an existing relationship
34950       description: delete an existing relationship
34951       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34952       consumes:
34953         - application/json
34954         - application/xml
34955       produces:
34956         - application/json
34957         - application/xml
34958       responses:
34959         "default":
34960           description: Response codes found in [response codes](https://wiki.onap.org/).
34961       parameters:
34962         - name: vnf-id2
34963           in: path
34964           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34965           required: true
34966           type: string
34967           example: __VNF-ID2__
34968         - name: interface-name
34969           in: path
34970           description: Name given to the interface
34971           required: true
34972           type: string
34973           example: __INTERFACE-NAME__
34974         - name: vlan-interface
34975           in: path
34976           description: String that identifies the interface
34977           required: true
34978           type: string
34979           example: __VLAN-INTERFACE__
34980   /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:
34981     put:
34982       tags:
34983         - Network
34984       summary: see node definition for valid relationships
34985       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34986       consumes:
34987         - application/json
34988         - application/xml
34989       produces:
34990         - application/json
34991         - application/xml
34992       responses:
34993         "default":
34994           description: Response codes found in [response codes](https://wiki.onap.org/).
34995       parameters:
34996         - name: vnf-id2
34997           in: path
34998           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
34999           required: true
35000           type: string
35001           example: __VNF-ID2__
35002         - name: interface-name
35003           in: path
35004           description: Name given to the interface
35005           required: true
35006           type: string
35007           example: __INTERFACE-NAME__
35008         - name: vlan-interface
35009           in: path
35010           description: String that identifies the interface
35011           required: true
35012           type: string
35013           example: __VLAN-INTERFACE__
35014         - name: l3-interface-ipv4-address
35015           in: path
35016           description: IP address
35017           required: true
35018           type: string
35019           example: __L3-INTERFACE-IPV4-ADDRESS__
35020         - name: body
35021           in: body
35022           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35023           required: true
35024           schema:
35025             $ref: "#/definitions/relationship"
35026     delete:
35027       tags:
35028         - Network
35029       summary: delete an existing relationship
35030       description: delete an existing relationship
35031       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
35032       consumes:
35033         - application/json
35034         - application/xml
35035       produces:
35036         - application/json
35037         - application/xml
35038       responses:
35039         "default":
35040           description: Response codes found in [response codes](https://wiki.onap.org/).
35041       parameters:
35042         - name: vnf-id2
35043           in: path
35044           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35045           required: true
35046           type: string
35047           example: __VNF-ID2__
35048         - name: interface-name
35049           in: path
35050           description: Name given to the interface
35051           required: true
35052           type: string
35053           example: __INTERFACE-NAME__
35054         - name: vlan-interface
35055           in: path
35056           description: String that identifies the interface
35057           required: true
35058           type: string
35059           example: __VLAN-INTERFACE__
35060         - name: l3-interface-ipv4-address
35061           in: path
35062           description: IP address
35063           required: true
35064           type: string
35065           example: __L3-INTERFACE-IPV4-ADDRESS__
35066   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
35067     get:
35068       tags:
35069         - Network
35070       summary: returns l3-interface-ipv4-address-list
35071       description: returns l3-interface-ipv4-address-list
35072       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35073       produces:
35074         - application/json
35075         - application/xml
35076       responses:
35077         "200":
35078           description: successful operation
35079           schema:
35080               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35081         "default":
35082           description: Response codes found in [response codes](https://wiki.onap.org/).
35083       parameters:
35084         - name: vnf-id2
35085           in: path
35086           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35087           required: true
35088           type: string
35089           example: __VNF-ID2__
35090         - name: interface-name
35091           in: path
35092           description: Name given to the interface
35093           required: true
35094           type: string
35095           example: __INTERFACE-NAME__
35096         - name: vlan-interface
35097           in: path
35098           description: String that identifies the interface
35099           required: true
35100           type: string
35101           example: __VLAN-INTERFACE__
35102         - name: l3-interface-ipv4-address
35103           in: path
35104           description: IP address
35105           required: true
35106           type: string
35107           example: __L3-INTERFACE-IPV4-ADDRESS__
35108         - name: vnf-name
35109           in: query
35110           description: Name of VNF.
35111           required: false
35112           type: string
35113         - name: vnf-name2
35114           in: query
35115           description: Alternate name of VNF.
35116           required: false
35117           type: string
35118         - name: vnf-type
35119           in: query
35120           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
35121           required: false
35122           type: string
35123         - name: prov-status
35124           in: query
35125           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35126           required: false
35127           type: string
35128         - name: heat-stack-id
35129           in: query
35130           description: Heat stack id corresponding to this instance, managed by MSO
35131           required: false
35132           type: string
35133         - name: interface-id
35134           in: query
35135           description: ID of interface
35136           required: false
35137           type: string
35138         - name: macaddr
35139           in: query
35140           description: MAC address for the interface
35141           required: false
35142           type: string
35143         - name: network-name
35144           in: query
35145           description: Name of the network
35146           required: false
35147           type: string
35148         - name: vlan-id-inner
35149           in: query
35150           description: Inner VLAN tag
35151           required: false
35152           type: integer
35153           format: int64
35154         - name: vpn-id
35155           in: query
35156           description: This indicates the customers VPN ID associated with this vlan
35157           required: false
35158           type: string
35159         - name: vlan-id-inner
35160           in: query
35161           description: Inner VLAN tag
35162           required: false
35163           type: integer
35164           format: int64
35165         - name: neutron-network-id
35166           in: query
35167           description: Neutron network id of the interface that address belongs to
35168           required: false
35169           type: string
35170         - name: neutron-subnet-id
35171           in: query
35172           description: Neutron id of subnet that address belongs to
35173           required: false
35174           type: string
35175     put:
35176       tags:
35177         - Network
35178       summary: create or update an existing l3-interface-ipv4-address-list
35179       description: |
35180         Create or update an existing l3-interface-ipv4-address-list.
35181         #
35182         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
35183       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35184       consumes:
35185         - application/json
35186         - application/xml
35187       produces:
35188         - application/json
35189         - application/xml
35190       responses:
35191         "default":
35192           description: Response codes found in [response codes](https://wiki.onap.org/).
35193       parameters:
35194         - name: vnf-id2
35195           in: path
35196           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35197           required: true
35198           type: string
35199           example: __VNF-ID2__
35200         - name: interface-name
35201           in: path
35202           description: Name given to the interface
35203           required: true
35204           type: string
35205           example: __INTERFACE-NAME__
35206         - name: vlan-interface
35207           in: path
35208           description: String that identifies the interface
35209           required: true
35210           type: string
35211           example: __VLAN-INTERFACE__
35212         - name: l3-interface-ipv4-address
35213           in: path
35214           description: IP address
35215           required: true
35216           type: string
35217           example: __L3-INTERFACE-IPV4-ADDRESS__
35218         - name: body
35219           in: body
35220           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
35221           required: true
35222           schema:
35223             $ref: "#/definitions/l3-interface-ipv4-address-list"
35224     patch:
35225       tags:
35226         - Network
35227       summary: update an existing l3-interface-ipv4-address-list
35228       description: |
35229         Update an existing l3-interface-ipv4-address-list
35230         #
35231         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35232         The PUT operation will entirely replace an existing object.
35233         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.
35234         #
35235         Other differences between PUT and PATCH are:
35236         #
35237         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35238         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35239         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35240       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35241       consumes:
35242         - application/json
35243         - application/xml
35244       produces:
35245         - application/json
35246         - application/xml
35247       responses:
35248         "default":
35249           description: Response codes found in [response codes](https://wiki.onap.org/).
35250       parameters:
35251         - name: vnf-id2
35252           in: path
35253           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35254           required: true
35255           type: string
35256           example: __VNF-ID2__
35257         - name: interface-name
35258           in: path
35259           description: Name given to the interface
35260           required: true
35261           type: string
35262           example: __INTERFACE-NAME__
35263         - name: vlan-interface
35264           in: path
35265           description: String that identifies the interface
35266           required: true
35267           type: string
35268           example: __VLAN-INTERFACE__
35269         - name: l3-interface-ipv4-address
35270           in: path
35271           description: IP address
35272           required: true
35273           type: string
35274           example: __L3-INTERFACE-IPV4-ADDRESS__
35275         - name: body
35276           in: body
35277           description: l3-interface-ipv4-address-list object that needs to be created or updated.
35278           required: true
35279           schema:
35280             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
35281     delete:
35282       tags:
35283         - Network
35284       summary: delete an existing l3-interface-ipv4-address-list
35285       description: delete an existing l3-interface-ipv4-address-list
35286       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
35287       consumes:
35288         - application/json
35289         - application/xml
35290       produces:
35291         - application/json
35292         - application/xml
35293       responses:
35294         "default":
35295           description: Response codes found in [response codes](https://wiki.onap.org/).
35296       parameters:
35297         - name: vnf-id2
35298           in: path
35299           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35300           required: true
35301           type: string
35302           example: __VNF-ID2__
35303         - name: interface-name
35304           in: path
35305           description: Name given to the interface
35306           required: true
35307           type: string
35308           example: __INTERFACE-NAME__
35309         - name: vlan-interface
35310           in: path
35311           description: String that identifies the interface
35312           required: true
35313           type: string
35314           example: __VLAN-INTERFACE__
35315         - name: l3-interface-ipv4-address
35316           in: path
35317           description: IP address
35318           required: true
35319           type: string
35320           example: __L3-INTERFACE-IPV4-ADDRESS__
35321         - name: resource-version
35322           in: query
35323           description: resource-version for concurrency
35324           required: true
35325           type: string
35326   /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:
35327     put:
35328       tags:
35329         - Network
35330       summary: see node definition for valid relationships
35331       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35332       consumes:
35333         - application/json
35334         - application/xml
35335       produces:
35336         - application/json
35337         - application/xml
35338       responses:
35339         "default":
35340           description: Response codes found in [response codes](https://wiki.onap.org/).
35341       parameters:
35342         - name: vnf-id2
35343           in: path
35344           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35345           required: true
35346           type: string
35347           example: __VNF-ID2__
35348         - name: interface-name
35349           in: path
35350           description: Name given to the interface
35351           required: true
35352           type: string
35353           example: __INTERFACE-NAME__
35354         - name: vlan-interface
35355           in: path
35356           description: String that identifies the interface
35357           required: true
35358           type: string
35359           example: __VLAN-INTERFACE__
35360         - name: l3-interface-ipv6-address
35361           in: path
35362           description: IP address
35363           required: true
35364           type: string
35365           example: __L3-INTERFACE-IPV6-ADDRESS__
35366         - name: body
35367           in: body
35368           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35369           required: true
35370           schema:
35371             $ref: "#/definitions/relationship"
35372     delete:
35373       tags:
35374         - Network
35375       summary: delete an existing relationship
35376       description: delete an existing relationship
35377       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
35378       consumes:
35379         - application/json
35380         - application/xml
35381       produces:
35382         - application/json
35383         - application/xml
35384       responses:
35385         "default":
35386           description: Response codes found in [response codes](https://wiki.onap.org/).
35387       parameters:
35388         - name: vnf-id2
35389           in: path
35390           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35391           required: true
35392           type: string
35393           example: __VNF-ID2__
35394         - name: interface-name
35395           in: path
35396           description: Name given to the interface
35397           required: true
35398           type: string
35399           example: __INTERFACE-NAME__
35400         - name: vlan-interface
35401           in: path
35402           description: String that identifies the interface
35403           required: true
35404           type: string
35405           example: __VLAN-INTERFACE__
35406         - name: l3-interface-ipv6-address
35407           in: path
35408           description: IP address
35409           required: true
35410           type: string
35411           example: __L3-INTERFACE-IPV6-ADDRESS__
35412   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
35413     get:
35414       tags:
35415         - Network
35416       summary: returns l3-interface-ipv6-address-list
35417       description: returns l3-interface-ipv6-address-list
35418       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35419       produces:
35420         - application/json
35421         - application/xml
35422       responses:
35423         "200":
35424           description: successful operation
35425           schema:
35426               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
35427         "default":
35428           description: Response codes found in [response codes](https://wiki.onap.org/).
35429       parameters:
35430         - name: vnf-id2
35431           in: path
35432           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35433           required: true
35434           type: string
35435           example: __VNF-ID2__
35436         - name: interface-name
35437           in: path
35438           description: Name given to the interface
35439           required: true
35440           type: string
35441           example: __INTERFACE-NAME__
35442         - name: vlan-interface
35443           in: path
35444           description: String that identifies the interface
35445           required: true
35446           type: string
35447           example: __VLAN-INTERFACE__
35448         - name: l3-interface-ipv6-address
35449           in: path
35450           description: IP address
35451           required: true
35452           type: string
35453           example: __L3-INTERFACE-IPV6-ADDRESS__
35454         - name: vnf-name
35455           in: query
35456           description: Name of VNF.
35457           required: false
35458           type: string
35459         - name: vnf-name2
35460           in: query
35461           description: Alternate name of VNF.
35462           required: false
35463           type: string
35464         - name: vnf-type
35465           in: query
35466           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
35467           required: false
35468           type: string
35469         - name: prov-status
35470           in: query
35471           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35472           required: false
35473           type: string
35474         - name: heat-stack-id
35475           in: query
35476           description: Heat stack id corresponding to this instance, managed by MSO
35477           required: false
35478           type: string
35479         - name: interface-id
35480           in: query
35481           description: ID of interface
35482           required: false
35483           type: string
35484         - name: macaddr
35485           in: query
35486           description: MAC address for the interface
35487           required: false
35488           type: string
35489         - name: network-name
35490           in: query
35491           description: Name of the network
35492           required: false
35493           type: string
35494         - name: vlan-id-inner
35495           in: query
35496           description: Inner VLAN tag
35497           required: false
35498           type: integer
35499           format: int64
35500         - name: vpn-id
35501           in: query
35502           description: This indicates the customers VPN ID associated with this vlan
35503           required: false
35504           type: string
35505         - name: vlan-id-inner
35506           in: query
35507           description: Inner VLAN tag
35508           required: false
35509           type: integer
35510           format: int64
35511         - name: neutron-network-id
35512           in: query
35513           description: Neutron network id of the interface that address belongs to
35514           required: false
35515           type: string
35516         - name: neutron-subnet-id
35517           in: query
35518           description: Neutron id of subnet that address belongs to
35519           required: false
35520           type: string
35521     put:
35522       tags:
35523         - Network
35524       summary: create or update an existing l3-interface-ipv6-address-list
35525       description: |
35526         Create or update an existing l3-interface-ipv6-address-list.
35527         #
35528         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
35529       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35530       consumes:
35531         - application/json
35532         - application/xml
35533       produces:
35534         - application/json
35535         - application/xml
35536       responses:
35537         "default":
35538           description: Response codes found in [response codes](https://wiki.onap.org/).
35539       parameters:
35540         - name: vnf-id2
35541           in: path
35542           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35543           required: true
35544           type: string
35545           example: __VNF-ID2__
35546         - name: interface-name
35547           in: path
35548           description: Name given to the interface
35549           required: true
35550           type: string
35551           example: __INTERFACE-NAME__
35552         - name: vlan-interface
35553           in: path
35554           description: String that identifies the interface
35555           required: true
35556           type: string
35557           example: __VLAN-INTERFACE__
35558         - name: l3-interface-ipv6-address
35559           in: path
35560           description: IP address
35561           required: true
35562           type: string
35563           example: __L3-INTERFACE-IPV6-ADDRESS__
35564         - name: body
35565           in: body
35566           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
35567           required: true
35568           schema:
35569             $ref: "#/definitions/l3-interface-ipv6-address-list"
35570     patch:
35571       tags:
35572         - Network
35573       summary: update an existing l3-interface-ipv6-address-list
35574       description: |
35575         Update an existing l3-interface-ipv6-address-list
35576         #
35577         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35578         The PUT operation will entirely replace an existing object.
35579         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.
35580         #
35581         Other differences between PUT and PATCH are:
35582         #
35583         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35584         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35585         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35586       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35587       consumes:
35588         - application/json
35589         - application/xml
35590       produces:
35591         - application/json
35592         - application/xml
35593       responses:
35594         "default":
35595           description: Response codes found in [response codes](https://wiki.onap.org/).
35596       parameters:
35597         - name: vnf-id2
35598           in: path
35599           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35600           required: true
35601           type: string
35602           example: __VNF-ID2__
35603         - name: interface-name
35604           in: path
35605           description: Name given to the interface
35606           required: true
35607           type: string
35608           example: __INTERFACE-NAME__
35609         - name: vlan-interface
35610           in: path
35611           description: String that identifies the interface
35612           required: true
35613           type: string
35614           example: __VLAN-INTERFACE__
35615         - name: l3-interface-ipv6-address
35616           in: path
35617           description: IP address
35618           required: true
35619           type: string
35620           example: __L3-INTERFACE-IPV6-ADDRESS__
35621         - name: body
35622           in: body
35623           description: l3-interface-ipv6-address-list object that needs to be created or updated.
35624           required: true
35625           schema:
35626             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
35627     delete:
35628       tags:
35629         - Network
35630       summary: delete an existing l3-interface-ipv6-address-list
35631       description: delete an existing l3-interface-ipv6-address-list
35632       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
35633       consumes:
35634         - application/json
35635         - application/xml
35636       produces:
35637         - application/json
35638         - application/xml
35639       responses:
35640         "default":
35641           description: Response codes found in [response codes](https://wiki.onap.org/).
35642       parameters:
35643         - name: vnf-id2
35644           in: path
35645           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35646           required: true
35647           type: string
35648           example: __VNF-ID2__
35649         - name: interface-name
35650           in: path
35651           description: Name given to the interface
35652           required: true
35653           type: string
35654           example: __INTERFACE-NAME__
35655         - name: vlan-interface
35656           in: path
35657           description: String that identifies the interface
35658           required: true
35659           type: string
35660           example: __VLAN-INTERFACE__
35661         - name: l3-interface-ipv6-address
35662           in: path
35663           description: IP address
35664           required: true
35665           type: string
35666           example: __L3-INTERFACE-IPV6-ADDRESS__
35667         - name: resource-version
35668           in: query
35669           description: resource-version for concurrency
35670           required: true
35671           type: string
35672   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
35673     get:
35674       tags:
35675         - Network
35676       summary: returns vlan
35677       description: returns vlan
35678       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35679       produces:
35680         - application/json
35681         - application/xml
35682       responses:
35683         "200":
35684           description: successful operation
35685           schema:
35686               $ref: "#/getDefinitions/vlan"
35687         "default":
35688           description: Response codes found in [response codes](https://wiki.onap.org/).
35689       parameters:
35690         - name: vnf-id2
35691           in: path
35692           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35693           required: true
35694           type: string
35695           example: __VNF-ID2__
35696         - name: interface-name
35697           in: path
35698           description: Name given to the interface
35699           required: true
35700           type: string
35701           example: __INTERFACE-NAME__
35702         - name: vlan-interface
35703           in: path
35704           description: String that identifies the interface
35705           required: true
35706           type: string
35707           example: __VLAN-INTERFACE__
35708         - name: vnf-name
35709           in: query
35710           description: Name of VNF.
35711           required: false
35712           type: string
35713         - name: vnf-name2
35714           in: query
35715           description: Alternate name of VNF.
35716           required: false
35717           type: string
35718         - name: vnf-type
35719           in: query
35720           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
35721           required: false
35722           type: string
35723         - name: prov-status
35724           in: query
35725           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35726           required: false
35727           type: string
35728         - name: heat-stack-id
35729           in: query
35730           description: Heat stack id corresponding to this instance, managed by MSO
35731           required: false
35732           type: string
35733         - name: interface-id
35734           in: query
35735           description: ID of interface
35736           required: false
35737           type: string
35738         - name: macaddr
35739           in: query
35740           description: MAC address for the interface
35741           required: false
35742           type: string
35743         - name: network-name
35744           in: query
35745           description: Name of the network
35746           required: false
35747           type: string
35748         - name: vlan-id-inner
35749           in: query
35750           description: Inner VLAN tag
35751           required: false
35752           type: integer
35753           format: int64
35754         - name: vpn-id
35755           in: query
35756           description: This indicates the customers VPN ID associated with this vlan
35757           required: false
35758           type: string
35759     put:
35760       tags:
35761         - Network
35762       summary: create or update an existing vlan
35763       description: |
35764         Create or update an existing vlan.
35765         #
35766         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
35767       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35768       consumes:
35769         - application/json
35770         - application/xml
35771       produces:
35772         - application/json
35773         - application/xml
35774       responses:
35775         "default":
35776           description: Response codes found in [response codes](https://wiki.onap.org/).
35777       parameters:
35778         - name: vnf-id2
35779           in: path
35780           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35781           required: true
35782           type: string
35783           example: __VNF-ID2__
35784         - name: interface-name
35785           in: path
35786           description: Name given to the interface
35787           required: true
35788           type: string
35789           example: __INTERFACE-NAME__
35790         - name: vlan-interface
35791           in: path
35792           description: String that identifies the interface
35793           required: true
35794           type: string
35795           example: __VLAN-INTERFACE__
35796         - name: body
35797           in: body
35798           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
35799           required: true
35800           schema:
35801             $ref: "#/definitions/vlan"
35802     patch:
35803       tags:
35804         - Network
35805       summary: update an existing vlan
35806       description: |
35807         Update an existing vlan
35808         #
35809         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35810         The PUT operation will entirely replace an existing object.
35811         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.
35812         #
35813         Other differences between PUT and PATCH are:
35814         #
35815         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35816         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35817         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35818       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35819       consumes:
35820         - application/json
35821         - application/xml
35822       produces:
35823         - application/json
35824         - application/xml
35825       responses:
35826         "default":
35827           description: Response codes found in [response codes](https://wiki.onap.org/).
35828       parameters:
35829         - name: vnf-id2
35830           in: path
35831           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35832           required: true
35833           type: string
35834           example: __VNF-ID2__
35835         - name: interface-name
35836           in: path
35837           description: Name given to the interface
35838           required: true
35839           type: string
35840           example: __INTERFACE-NAME__
35841         - name: vlan-interface
35842           in: path
35843           description: String that identifies the interface
35844           required: true
35845           type: string
35846           example: __VLAN-INTERFACE__
35847         - name: body
35848           in: body
35849           description: vlan object that needs to be created or updated.
35850           required: true
35851           schema:
35852             $ref: "#/patchDefinitions/vlan"
35853     delete:
35854       tags:
35855         - Network
35856       summary: delete an existing vlan
35857       description: delete an existing vlan
35858       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
35859       consumes:
35860         - application/json
35861         - application/xml
35862       produces:
35863         - application/json
35864         - application/xml
35865       responses:
35866         "default":
35867           description: Response codes found in [response codes](https://wiki.onap.org/).
35868       parameters:
35869         - name: vnf-id2
35870           in: path
35871           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35872           required: true
35873           type: string
35874           example: __VNF-ID2__
35875         - name: interface-name
35876           in: path
35877           description: Name given to the interface
35878           required: true
35879           type: string
35880           example: __INTERFACE-NAME__
35881         - name: vlan-interface
35882           in: path
35883           description: String that identifies the interface
35884           required: true
35885           type: string
35886           example: __VLAN-INTERFACE__
35887         - name: resource-version
35888           in: query
35889           description: resource-version for concurrency
35890           required: true
35891           type: string
35892   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
35893     get:
35894       tags:
35895         - Network
35896       summary: returns vlans
35897       description: returns vlans
35898       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
35899       produces:
35900         - application/json
35901         - application/xml
35902       responses:
35903         "200":
35904           description: successful operation
35905           schema:
35906               $ref: "#/getDefinitions/vlans"
35907         "default":
35908           description: Response codes found in [response codes](https://wiki.onap.org/).
35909       parameters:
35910         - name: vnf-id2
35911           in: path
35912           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35913           required: true
35914           type: string
35915           example: __VNF-ID2__
35916         - name: interface-name
35917           in: path
35918           description: Name given to the interface
35919           required: true
35920           type: string
35921           example: __INTERFACE-NAME__
35922         - name: vnf-name
35923           in: query
35924           description: Name of VNF.
35925           required: false
35926           type: string
35927         - name: vnf-name2
35928           in: query
35929           description: Alternate name of VNF.
35930           required: false
35931           type: string
35932         - name: vnf-type
35933           in: query
35934           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
35935           required: false
35936           type: string
35937         - name: prov-status
35938           in: query
35939           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
35940           required: false
35941           type: string
35942         - name: heat-stack-id
35943           in: query
35944           description: Heat stack id corresponding to this instance, managed by MSO
35945           required: false
35946           type: string
35947         - name: interface-id
35948           in: query
35949           description: ID of interface
35950           required: false
35951           type: string
35952         - name: macaddr
35953           in: query
35954           description: MAC address for the interface
35955           required: false
35956           type: string
35957         - name: network-name
35958           in: query
35959           description: Name of the network
35960           required: false
35961           type: string
35962   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
35963     put:
35964       tags:
35965         - Network
35966       summary: see node definition for valid relationships
35967       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35968       consumes:
35969         - application/json
35970         - application/xml
35971       produces:
35972         - application/json
35973         - application/xml
35974       responses:
35975         "default":
35976           description: Response codes found in [response codes](https://wiki.onap.org/).
35977       parameters:
35978         - name: vnf-id2
35979           in: path
35980           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
35981           required: true
35982           type: string
35983           example: __VNF-ID2__
35984         - name: interface-name
35985           in: path
35986           description: Name given to the interface
35987           required: true
35988           type: string
35989           example: __INTERFACE-NAME__
35990         - name: pci-id
35991           in: path
35992           description: PCI ID used to identify the sriov-vf
35993           required: true
35994           type: string
35995           example: __PCI-ID__
35996         - name: body
35997           in: body
35998           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
35999           required: true
36000           schema:
36001             $ref: "#/definitions/relationship"
36002     delete:
36003       tags:
36004         - Network
36005       summary: delete an existing relationship
36006       description: delete an existing relationship
36007       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
36008       consumes:
36009         - application/json
36010         - application/xml
36011       produces:
36012         - application/json
36013         - application/xml
36014       responses:
36015         "default":
36016           description: Response codes found in [response codes](https://wiki.onap.org/).
36017       parameters:
36018         - name: vnf-id2
36019           in: path
36020           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36021           required: true
36022           type: string
36023           example: __VNF-ID2__
36024         - name: interface-name
36025           in: path
36026           description: Name given to the interface
36027           required: true
36028           type: string
36029           example: __INTERFACE-NAME__
36030         - name: pci-id
36031           in: path
36032           description: PCI ID used to identify the sriov-vf
36033           required: true
36034           type: string
36035           example: __PCI-ID__
36036   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
36037     get:
36038       tags:
36039         - Network
36040       summary: returns sriov-vf
36041       description: returns sriov-vf
36042       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36043       produces:
36044         - application/json
36045         - application/xml
36046       responses:
36047         "200":
36048           description: successful operation
36049           schema:
36050               $ref: "#/getDefinitions/sriov-vf"
36051         "default":
36052           description: Response codes found in [response codes](https://wiki.onap.org/).
36053       parameters:
36054         - name: vnf-id2
36055           in: path
36056           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36057           required: true
36058           type: string
36059           example: __VNF-ID2__
36060         - name: interface-name
36061           in: path
36062           description: Name given to the interface
36063           required: true
36064           type: string
36065           example: __INTERFACE-NAME__
36066         - name: pci-id
36067           in: path
36068           description: PCI ID used to identify the sriov-vf
36069           required: true
36070           type: string
36071           example: __PCI-ID__
36072         - name: vnf-name
36073           in: query
36074           description: Name of VNF.
36075           required: false
36076           type: string
36077         - name: vnf-name2
36078           in: query
36079           description: Alternate name of VNF.
36080           required: false
36081           type: string
36082         - name: vnf-type
36083           in: query
36084           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
36085           required: false
36086           type: string
36087         - name: prov-status
36088           in: query
36089           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36090           required: false
36091           type: string
36092         - name: heat-stack-id
36093           in: query
36094           description: Heat stack id corresponding to this instance, managed by MSO
36095           required: false
36096           type: string
36097         - name: interface-id
36098           in: query
36099           description: ID of interface
36100           required: false
36101           type: string
36102         - name: macaddr
36103           in: query
36104           description: MAC address for the interface
36105           required: false
36106           type: string
36107         - name: network-name
36108           in: query
36109           description: Name of the network
36110           required: false
36111           type: string
36112         - name: vf-vlan-filter
36113           in: query
36114           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
36115           required: false
36116           type: string
36117         - name: vf-mac-filter
36118           in: query
36119           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
36120           required: false
36121           type: string
36122         - name: vf-vlan-strip
36123           in: query
36124           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
36125           required: false
36126           type: boolean
36127         - name: neutron-network-id
36128           in: query
36129           description: Neutron network id of the interface
36130           required: false
36131           type: string
36132     put:
36133       tags:
36134         - Network
36135       summary: create or update an existing sriov-vf
36136       description: |
36137         Create or update an existing sriov-vf.
36138         #
36139         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
36140       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36141       consumes:
36142         - application/json
36143         - application/xml
36144       produces:
36145         - application/json
36146         - application/xml
36147       responses:
36148         "default":
36149           description: Response codes found in [response codes](https://wiki.onap.org/).
36150       parameters:
36151         - name: vnf-id2
36152           in: path
36153           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36154           required: true
36155           type: string
36156           example: __VNF-ID2__
36157         - name: interface-name
36158           in: path
36159           description: Name given to the interface
36160           required: true
36161           type: string
36162           example: __INTERFACE-NAME__
36163         - name: pci-id
36164           in: path
36165           description: PCI ID used to identify the sriov-vf
36166           required: true
36167           type: string
36168           example: __PCI-ID__
36169         - name: body
36170           in: body
36171           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
36172           required: true
36173           schema:
36174             $ref: "#/definitions/sriov-vf"
36175     patch:
36176       tags:
36177         - Network
36178       summary: update an existing sriov-vf
36179       description: |
36180         Update an existing sriov-vf
36181         #
36182         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36183         The PUT operation will entirely replace an existing object.
36184         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.
36185         #
36186         Other differences between PUT and PATCH are:
36187         #
36188         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36189         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36190         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36191       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36192       consumes:
36193         - application/json
36194         - application/xml
36195       produces:
36196         - application/json
36197         - application/xml
36198       responses:
36199         "default":
36200           description: Response codes found in [response codes](https://wiki.onap.org/).
36201       parameters:
36202         - name: vnf-id2
36203           in: path
36204           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36205           required: true
36206           type: string
36207           example: __VNF-ID2__
36208         - name: interface-name
36209           in: path
36210           description: Name given to the interface
36211           required: true
36212           type: string
36213           example: __INTERFACE-NAME__
36214         - name: pci-id
36215           in: path
36216           description: PCI ID used to identify the sriov-vf
36217           required: true
36218           type: string
36219           example: __PCI-ID__
36220         - name: body
36221           in: body
36222           description: sriov-vf object that needs to be created or updated.
36223           required: true
36224           schema:
36225             $ref: "#/patchDefinitions/sriov-vf"
36226     delete:
36227       tags:
36228         - Network
36229       summary: delete an existing sriov-vf
36230       description: delete an existing sriov-vf
36231       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
36232       consumes:
36233         - application/json
36234         - application/xml
36235       produces:
36236         - application/json
36237         - application/xml
36238       responses:
36239         "default":
36240           description: Response codes found in [response codes](https://wiki.onap.org/).
36241       parameters:
36242         - name: vnf-id2
36243           in: path
36244           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36245           required: true
36246           type: string
36247           example: __VNF-ID2__
36248         - name: interface-name
36249           in: path
36250           description: Name given to the interface
36251           required: true
36252           type: string
36253           example: __INTERFACE-NAME__
36254         - name: pci-id
36255           in: path
36256           description: PCI ID used to identify the sriov-vf
36257           required: true
36258           type: string
36259           example: __PCI-ID__
36260         - name: resource-version
36261           in: query
36262           description: resource-version for concurrency
36263           required: true
36264           type: string
36265   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
36266     get:
36267       tags:
36268         - Network
36269       summary: returns sriov-vfs
36270       description: returns sriov-vfs
36271       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
36272       produces:
36273         - application/json
36274         - application/xml
36275       responses:
36276         "200":
36277           description: successful operation
36278           schema:
36279               $ref: "#/getDefinitions/sriov-vfs"
36280         "default":
36281           description: Response codes found in [response codes](https://wiki.onap.org/).
36282       parameters:
36283         - name: vnf-id2
36284           in: path
36285           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36286           required: true
36287           type: string
36288           example: __VNF-ID2__
36289         - name: interface-name
36290           in: path
36291           description: Name given to the interface
36292           required: true
36293           type: string
36294           example: __INTERFACE-NAME__
36295         - name: vnf-name
36296           in: query
36297           description: Name of VNF.
36298           required: false
36299           type: string
36300         - name: vnf-name2
36301           in: query
36302           description: Alternate name of VNF.
36303           required: false
36304           type: string
36305         - name: vnf-type
36306           in: query
36307           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
36308           required: false
36309           type: string
36310         - name: prov-status
36311           in: query
36312           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36313           required: false
36314           type: string
36315         - name: heat-stack-id
36316           in: query
36317           description: Heat stack id corresponding to this instance, managed by MSO
36318           required: false
36319           type: string
36320         - name: interface-id
36321           in: query
36322           description: ID of interface
36323           required: false
36324           type: string
36325         - name: macaddr
36326           in: query
36327           description: MAC address for the interface
36328           required: false
36329           type: string
36330         - name: network-name
36331           in: query
36332           description: Name of the network
36333           required: false
36334           type: string
36335   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
36336     put:
36337       tags:
36338         - Network
36339       summary: see node definition for valid relationships
36340       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36341       consumes:
36342         - application/json
36343         - application/xml
36344       produces:
36345         - application/json
36346         - application/xml
36347       responses:
36348         "default":
36349           description: Response codes found in [response codes](https://wiki.onap.org/).
36350       parameters:
36351         - name: vnf-id2
36352           in: path
36353           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36354           required: true
36355           type: string
36356           example: __VNF-ID2__
36357         - name: interface-name
36358           in: path
36359           description: Name given to the interface
36360           required: true
36361           type: string
36362           example: __INTERFACE-NAME__
36363         - name: body
36364           in: body
36365           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
36366           required: true
36367           schema:
36368             $ref: "#/definitions/relationship"
36369     delete:
36370       tags:
36371         - Network
36372       summary: delete an existing relationship
36373       description: delete an existing relationship
36374       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
36375       consumes:
36376         - application/json
36377         - application/xml
36378       produces:
36379         - application/json
36380         - application/xml
36381       responses:
36382         "default":
36383           description: Response codes found in [response codes](https://wiki.onap.org/).
36384       parameters:
36385         - name: vnf-id2
36386           in: path
36387           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36388           required: true
36389           type: string
36390           example: __VNF-ID2__
36391         - name: interface-name
36392           in: path
36393           description: Name given to the interface
36394           required: true
36395           type: string
36396           example: __INTERFACE-NAME__
36397   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
36398     put:
36399       tags:
36400         - Network
36401       summary: see node definition for valid relationships
36402       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36403       consumes:
36404         - application/json
36405         - application/xml
36406       produces:
36407         - application/json
36408         - application/xml
36409       responses:
36410         "default":
36411           description: Response codes found in [response codes](https://wiki.onap.org/).
36412       parameters:
36413         - name: vnf-id2
36414           in: path
36415           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36416           required: true
36417           type: string
36418           example: __VNF-ID2__
36419         - name: interface-name
36420           in: path
36421           description: Name given to the interface
36422           required: true
36423           type: string
36424           example: __INTERFACE-NAME__
36425         - name: l3-interface-ipv4-address
36426           in: path
36427           description: IP address
36428           required: true
36429           type: string
36430           example: __L3-INTERFACE-IPV4-ADDRESS__
36431         - name: body
36432           in: body
36433           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36434           required: true
36435           schema:
36436             $ref: "#/definitions/relationship"
36437     delete:
36438       tags:
36439         - Network
36440       summary: delete an existing relationship
36441       description: delete an existing relationship
36442       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
36443       consumes:
36444         - application/json
36445         - application/xml
36446       produces:
36447         - application/json
36448         - application/xml
36449       responses:
36450         "default":
36451           description: Response codes found in [response codes](https://wiki.onap.org/).
36452       parameters:
36453         - name: vnf-id2
36454           in: path
36455           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36456           required: true
36457           type: string
36458           example: __VNF-ID2__
36459         - name: interface-name
36460           in: path
36461           description: Name given to the interface
36462           required: true
36463           type: string
36464           example: __INTERFACE-NAME__
36465         - name: l3-interface-ipv4-address
36466           in: path
36467           description: IP address
36468           required: true
36469           type: string
36470           example: __L3-INTERFACE-IPV4-ADDRESS__
36471   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
36472     get:
36473       tags:
36474         - Network
36475       summary: returns l3-interface-ipv4-address-list
36476       description: returns l3-interface-ipv4-address-list
36477       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36478       produces:
36479         - application/json
36480         - application/xml
36481       responses:
36482         "200":
36483           description: successful operation
36484           schema:
36485               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36486         "default":
36487           description: Response codes found in [response codes](https://wiki.onap.org/).
36488       parameters:
36489         - name: vnf-id2
36490           in: path
36491           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36492           required: true
36493           type: string
36494           example: __VNF-ID2__
36495         - name: interface-name
36496           in: path
36497           description: Name given to the interface
36498           required: true
36499           type: string
36500           example: __INTERFACE-NAME__
36501         - name: l3-interface-ipv4-address
36502           in: path
36503           description: IP address
36504           required: true
36505           type: string
36506           example: __L3-INTERFACE-IPV4-ADDRESS__
36507         - name: vnf-name
36508           in: query
36509           description: Name of VNF.
36510           required: false
36511           type: string
36512         - name: vnf-name2
36513           in: query
36514           description: Alternate name of VNF.
36515           required: false
36516           type: string
36517         - name: vnf-type
36518           in: query
36519           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
36520           required: false
36521           type: string
36522         - name: prov-status
36523           in: query
36524           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36525           required: false
36526           type: string
36527         - name: heat-stack-id
36528           in: query
36529           description: Heat stack id corresponding to this instance, managed by MSO
36530           required: false
36531           type: string
36532         - name: interface-id
36533           in: query
36534           description: ID of interface
36535           required: false
36536           type: string
36537         - name: macaddr
36538           in: query
36539           description: MAC address for the interface
36540           required: false
36541           type: string
36542         - name: network-name
36543           in: query
36544           description: Name of the network
36545           required: false
36546           type: string
36547         - name: vlan-id-inner
36548           in: query
36549           description: Inner VLAN tag
36550           required: false
36551           type: integer
36552           format: int64
36553         - name: neutron-network-id
36554           in: query
36555           description: Neutron network id of the interface that address belongs to
36556           required: false
36557           type: string
36558         - name: neutron-subnet-id
36559           in: query
36560           description: Neutron id of subnet that address belongs to
36561           required: false
36562           type: string
36563     put:
36564       tags:
36565         - Network
36566       summary: create or update an existing l3-interface-ipv4-address-list
36567       description: |
36568         Create or update an existing l3-interface-ipv4-address-list.
36569         #
36570         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
36571       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36572       consumes:
36573         - application/json
36574         - application/xml
36575       produces:
36576         - application/json
36577         - application/xml
36578       responses:
36579         "default":
36580           description: Response codes found in [response codes](https://wiki.onap.org/).
36581       parameters:
36582         - name: vnf-id2
36583           in: path
36584           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36585           required: true
36586           type: string
36587           example: __VNF-ID2__
36588         - name: interface-name
36589           in: path
36590           description: Name given to the interface
36591           required: true
36592           type: string
36593           example: __INTERFACE-NAME__
36594         - name: l3-interface-ipv4-address
36595           in: path
36596           description: IP address
36597           required: true
36598           type: string
36599           example: __L3-INTERFACE-IPV4-ADDRESS__
36600         - name: body
36601           in: body
36602           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36603           required: true
36604           schema:
36605             $ref: "#/definitions/l3-interface-ipv4-address-list"
36606     patch:
36607       tags:
36608         - Network
36609       summary: update an existing l3-interface-ipv4-address-list
36610       description: |
36611         Update an existing l3-interface-ipv4-address-list
36612         #
36613         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36614         The PUT operation will entirely replace an existing object.
36615         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.
36616         #
36617         Other differences between PUT and PATCH are:
36618         #
36619         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36620         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36621         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36622       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36623       consumes:
36624         - application/json
36625         - application/xml
36626       produces:
36627         - application/json
36628         - application/xml
36629       responses:
36630         "default":
36631           description: Response codes found in [response codes](https://wiki.onap.org/).
36632       parameters:
36633         - name: vnf-id2
36634           in: path
36635           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36636           required: true
36637           type: string
36638           example: __VNF-ID2__
36639         - name: interface-name
36640           in: path
36641           description: Name given to the interface
36642           required: true
36643           type: string
36644           example: __INTERFACE-NAME__
36645         - name: l3-interface-ipv4-address
36646           in: path
36647           description: IP address
36648           required: true
36649           type: string
36650           example: __L3-INTERFACE-IPV4-ADDRESS__
36651         - name: body
36652           in: body
36653           description: l3-interface-ipv4-address-list object that needs to be created or updated.
36654           required: true
36655           schema:
36656             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36657     delete:
36658       tags:
36659         - Network
36660       summary: delete an existing l3-interface-ipv4-address-list
36661       description: delete an existing l3-interface-ipv4-address-list
36662       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36663       consumes:
36664         - application/json
36665         - application/xml
36666       produces:
36667         - application/json
36668         - application/xml
36669       responses:
36670         "default":
36671           description: Response codes found in [response codes](https://wiki.onap.org/).
36672       parameters:
36673         - name: vnf-id2
36674           in: path
36675           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36676           required: true
36677           type: string
36678           example: __VNF-ID2__
36679         - name: interface-name
36680           in: path
36681           description: Name given to the interface
36682           required: true
36683           type: string
36684           example: __INTERFACE-NAME__
36685         - name: l3-interface-ipv4-address
36686           in: path
36687           description: IP address
36688           required: true
36689           type: string
36690           example: __L3-INTERFACE-IPV4-ADDRESS__
36691         - name: resource-version
36692           in: query
36693           description: resource-version for concurrency
36694           required: true
36695           type: string
36696   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
36697     put:
36698       tags:
36699         - Network
36700       summary: see node definition for valid relationships
36701       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36702       consumes:
36703         - application/json
36704         - application/xml
36705       produces:
36706         - application/json
36707         - application/xml
36708       responses:
36709         "default":
36710           description: Response codes found in [response codes](https://wiki.onap.org/).
36711       parameters:
36712         - name: vnf-id2
36713           in: path
36714           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36715           required: true
36716           type: string
36717           example: __VNF-ID2__
36718         - name: interface-name
36719           in: path
36720           description: Name given to the interface
36721           required: true
36722           type: string
36723           example: __INTERFACE-NAME__
36724         - name: l3-interface-ipv6-address
36725           in: path
36726           description: IP address
36727           required: true
36728           type: string
36729           example: __L3-INTERFACE-IPV6-ADDRESS__
36730         - name: body
36731           in: body
36732           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36733           required: true
36734           schema:
36735             $ref: "#/definitions/relationship"
36736     delete:
36737       tags:
36738         - Network
36739       summary: delete an existing relationship
36740       description: delete an existing relationship
36741       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36742       consumes:
36743         - application/json
36744         - application/xml
36745       produces:
36746         - application/json
36747         - application/xml
36748       responses:
36749         "default":
36750           description: Response codes found in [response codes](https://wiki.onap.org/).
36751       parameters:
36752         - name: vnf-id2
36753           in: path
36754           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36755           required: true
36756           type: string
36757           example: __VNF-ID2__
36758         - name: interface-name
36759           in: path
36760           description: Name given to the interface
36761           required: true
36762           type: string
36763           example: __INTERFACE-NAME__
36764         - name: l3-interface-ipv6-address
36765           in: path
36766           description: IP address
36767           required: true
36768           type: string
36769           example: __L3-INTERFACE-IPV6-ADDRESS__
36770   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36771     get:
36772       tags:
36773         - Network
36774       summary: returns l3-interface-ipv6-address-list
36775       description: returns l3-interface-ipv6-address-list
36776       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36777       produces:
36778         - application/json
36779         - application/xml
36780       responses:
36781         "200":
36782           description: successful operation
36783           schema:
36784               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36785         "default":
36786           description: Response codes found in [response codes](https://wiki.onap.org/).
36787       parameters:
36788         - name: vnf-id2
36789           in: path
36790           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36791           required: true
36792           type: string
36793           example: __VNF-ID2__
36794         - name: interface-name
36795           in: path
36796           description: Name given to the interface
36797           required: true
36798           type: string
36799           example: __INTERFACE-NAME__
36800         - name: l3-interface-ipv6-address
36801           in: path
36802           description: IP address
36803           required: true
36804           type: string
36805           example: __L3-INTERFACE-IPV6-ADDRESS__
36806         - name: vnf-name
36807           in: query
36808           description: Name of VNF.
36809           required: false
36810           type: string
36811         - name: vnf-name2
36812           in: query
36813           description: Alternate name of VNF.
36814           required: false
36815           type: string
36816         - name: vnf-type
36817           in: query
36818           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
36819           required: false
36820           type: string
36821         - name: prov-status
36822           in: query
36823           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
36824           required: false
36825           type: string
36826         - name: heat-stack-id
36827           in: query
36828           description: Heat stack id corresponding to this instance, managed by MSO
36829           required: false
36830           type: string
36831         - name: interface-id
36832           in: query
36833           description: ID of interface
36834           required: false
36835           type: string
36836         - name: macaddr
36837           in: query
36838           description: MAC address for the interface
36839           required: false
36840           type: string
36841         - name: network-name
36842           in: query
36843           description: Name of the network
36844           required: false
36845           type: string
36846         - name: vlan-id-inner
36847           in: query
36848           description: Inner VLAN tag
36849           required: false
36850           type: integer
36851           format: int64
36852         - name: neutron-network-id
36853           in: query
36854           description: Neutron network id of the interface that address belongs to
36855           required: false
36856           type: string
36857         - name: neutron-subnet-id
36858           in: query
36859           description: Neutron id of subnet that address belongs to
36860           required: false
36861           type: string
36862     put:
36863       tags:
36864         - Network
36865       summary: create or update an existing l3-interface-ipv6-address-list
36866       description: |
36867         Create or update an existing l3-interface-ipv6-address-list.
36868         #
36869         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
36870       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36871       consumes:
36872         - application/json
36873         - application/xml
36874       produces:
36875         - application/json
36876         - application/xml
36877       responses:
36878         "default":
36879           description: Response codes found in [response codes](https://wiki.onap.org/).
36880       parameters:
36881         - name: vnf-id2
36882           in: path
36883           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36884           required: true
36885           type: string
36886           example: __VNF-ID2__
36887         - name: interface-name
36888           in: path
36889           description: Name given to the interface
36890           required: true
36891           type: string
36892           example: __INTERFACE-NAME__
36893         - name: l3-interface-ipv6-address
36894           in: path
36895           description: IP address
36896           required: true
36897           type: string
36898           example: __L3-INTERFACE-IPV6-ADDRESS__
36899         - name: body
36900           in: body
36901           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36902           required: true
36903           schema:
36904             $ref: "#/definitions/l3-interface-ipv6-address-list"
36905     patch:
36906       tags:
36907         - Network
36908       summary: update an existing l3-interface-ipv6-address-list
36909       description: |
36910         Update an existing l3-interface-ipv6-address-list
36911         #
36912         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36913         The PUT operation will entirely replace an existing object.
36914         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.
36915         #
36916         Other differences between PUT and PATCH are:
36917         #
36918         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36919         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36920         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36921       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36922       consumes:
36923         - application/json
36924         - application/xml
36925       produces:
36926         - application/json
36927         - application/xml
36928       responses:
36929         "default":
36930           description: Response codes found in [response codes](https://wiki.onap.org/).
36931       parameters:
36932         - name: vnf-id2
36933           in: path
36934           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36935           required: true
36936           type: string
36937           example: __VNF-ID2__
36938         - name: interface-name
36939           in: path
36940           description: Name given to the interface
36941           required: true
36942           type: string
36943           example: __INTERFACE-NAME__
36944         - name: l3-interface-ipv6-address
36945           in: path
36946           description: IP address
36947           required: true
36948           type: string
36949           example: __L3-INTERFACE-IPV6-ADDRESS__
36950         - name: body
36951           in: body
36952           description: l3-interface-ipv6-address-list object that needs to be created or updated.
36953           required: true
36954           schema:
36955             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36956     delete:
36957       tags:
36958         - Network
36959       summary: delete an existing l3-interface-ipv6-address-list
36960       description: delete an existing l3-interface-ipv6-address-list
36961       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36962       consumes:
36963         - application/json
36964         - application/xml
36965       produces:
36966         - application/json
36967         - application/xml
36968       responses:
36969         "default":
36970           description: Response codes found in [response codes](https://wiki.onap.org/).
36971       parameters:
36972         - name: vnf-id2
36973           in: path
36974           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
36975           required: true
36976           type: string
36977           example: __VNF-ID2__
36978         - name: interface-name
36979           in: path
36980           description: Name given to the interface
36981           required: true
36982           type: string
36983           example: __INTERFACE-NAME__
36984         - name: l3-interface-ipv6-address
36985           in: path
36986           description: IP address
36987           required: true
36988           type: string
36989           example: __L3-INTERFACE-IPV6-ADDRESS__
36990         - name: resource-version
36991           in: query
36992           description: resource-version for concurrency
36993           required: true
36994           type: string
36995   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
36996     get:
36997       tags:
36998         - Network
36999       summary: returns l-interface
37000       description: returns l-interface
37001       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
37002       produces:
37003         - application/json
37004         - application/xml
37005       responses:
37006         "200":
37007           description: successful operation
37008           schema:
37009               $ref: "#/getDefinitions/l-interface"
37010         "default":
37011           description: Response codes found in [response codes](https://wiki.onap.org/).
37012       parameters:
37013         - name: vnf-id2
37014           in: path
37015           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37016           required: true
37017           type: string
37018           example: __VNF-ID2__
37019         - name: interface-name
37020           in: path
37021           description: Name given to the interface
37022           required: true
37023           type: string
37024           example: __INTERFACE-NAME__
37025         - name: vnf-name
37026           in: query
37027           description: Name of VNF.
37028           required: false
37029           type: string
37030         - name: vnf-name2
37031           in: query
37032           description: Alternate name of VNF.
37033           required: false
37034           type: string
37035         - name: vnf-type
37036           in: query
37037           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
37038           required: false
37039           type: string
37040         - name: prov-status
37041           in: query
37042           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
37043           required: false
37044           type: string
37045         - name: heat-stack-id
37046           in: query
37047           description: Heat stack id corresponding to this instance, managed by MSO
37048           required: false
37049           type: string
37050         - name: interface-id
37051           in: query
37052           description: ID of interface
37053           required: false
37054           type: string
37055         - name: macaddr
37056           in: query
37057           description: MAC address for the interface
37058           required: false
37059           type: string
37060         - name: network-name
37061           in: query
37062           description: Name of the network
37063           required: false
37064           type: string
37065     put:
37066       tags:
37067         - Network
37068       summary: create or update an existing l-interface
37069       description: |
37070         Create or update an existing l-interface.
37071         #
37072         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
37073       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
37074       consumes:
37075         - application/json
37076         - application/xml
37077       produces:
37078         - application/json
37079         - application/xml
37080       responses:
37081         "default":
37082           description: Response codes found in [response codes](https://wiki.onap.org/).
37083       parameters:
37084         - name: vnf-id2
37085           in: path
37086           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37087           required: true
37088           type: string
37089           example: __VNF-ID2__
37090         - name: interface-name
37091           in: path
37092           description: Name given to the interface
37093           required: true
37094           type: string
37095           example: __INTERFACE-NAME__
37096         - name: body
37097           in: body
37098           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvceLInterfacesLInterface.json)
37099           required: true
37100           schema:
37101             $ref: "#/definitions/l-interface"
37102     patch:
37103       tags:
37104         - Network
37105       summary: update an existing l-interface
37106       description: |
37107         Update an existing l-interface
37108         #
37109         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37110         The PUT operation will entirely replace an existing object.
37111         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.
37112         #
37113         Other differences between PUT and PATCH are:
37114         #
37115         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37116         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37117         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37118       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
37119       consumes:
37120         - application/json
37121         - application/xml
37122       produces:
37123         - application/json
37124         - application/xml
37125       responses:
37126         "default":
37127           description: Response codes found in [response codes](https://wiki.onap.org/).
37128       parameters:
37129         - name: vnf-id2
37130           in: path
37131           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37132           required: true
37133           type: string
37134           example: __VNF-ID2__
37135         - name: interface-name
37136           in: path
37137           description: Name given to the interface
37138           required: true
37139           type: string
37140           example: __INTERFACE-NAME__
37141         - name: body
37142           in: body
37143           description: l-interface object that needs to be created or updated.
37144           required: true
37145           schema:
37146             $ref: "#/patchDefinitions/l-interface"
37147     delete:
37148       tags:
37149         - Network
37150       summary: delete an existing l-interface
37151       description: delete an existing l-interface
37152       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
37153       consumes:
37154         - application/json
37155         - application/xml
37156       produces:
37157         - application/json
37158         - application/xml
37159       responses:
37160         "default":
37161           description: Response codes found in [response codes](https://wiki.onap.org/).
37162       parameters:
37163         - name: vnf-id2
37164           in: path
37165           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37166           required: true
37167           type: string
37168           example: __VNF-ID2__
37169         - name: interface-name
37170           in: path
37171           description: Name given to the interface
37172           required: true
37173           type: string
37174           example: __INTERFACE-NAME__
37175         - name: resource-version
37176           in: query
37177           description: resource-version for concurrency
37178           required: true
37179           type: string
37180   /network/newvces/newvce/{vnf-id2}/l-interfaces:
37181     get:
37182       tags:
37183         - Network
37184       summary: returns l-interfaces
37185       description: returns l-interfaces
37186       operationId: getNetworkNewvcesNewvceLInterfaces
37187       produces:
37188         - application/json
37189         - application/xml
37190       responses:
37191         "200":
37192           description: successful operation
37193           schema:
37194               $ref: "#/getDefinitions/l-interfaces"
37195         "default":
37196           description: Response codes found in [response codes](https://wiki.onap.org/).
37197       parameters:
37198         - name: vnf-id2
37199           in: path
37200           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37201           required: true
37202           type: string
37203           example: __VNF-ID2__
37204         - name: vnf-name
37205           in: query
37206           description: Name of VNF.
37207           required: false
37208           type: string
37209         - name: vnf-name2
37210           in: query
37211           description: Alternate name of VNF.
37212           required: false
37213           type: string
37214         - name: vnf-type
37215           in: query
37216           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
37217           required: false
37218           type: string
37219         - name: prov-status
37220           in: query
37221           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
37222           required: false
37223           type: string
37224         - name: heat-stack-id
37225           in: query
37226           description: Heat stack id corresponding to this instance, managed by MSO
37227           required: false
37228           type: string
37229   /network/newvces/newvce/{vnf-id2}:
37230     get:
37231       tags:
37232         - Network
37233       summary: returns newvce
37234       description: returns newvce
37235       operationId: getNetworkNewvcesNewvce
37236       produces:
37237         - application/json
37238         - application/xml
37239       responses:
37240         "200":
37241           description: successful operation
37242           schema:
37243               $ref: "#/getDefinitions/newvce"
37244         "default":
37245           description: Response codes found in [response codes](https://wiki.onap.org/).
37246       parameters:
37247         - name: vnf-id2
37248           in: path
37249           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37250           required: true
37251           type: string
37252           example: __VNF-ID2__
37253         - name: vnf-name
37254           in: query
37255           description: Name of VNF.
37256           required: false
37257           type: string
37258         - name: vnf-name2
37259           in: query
37260           description: Alternate name of VNF.
37261           required: false
37262           type: string
37263         - name: vnf-type
37264           in: query
37265           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
37266           required: false
37267           type: string
37268         - name: prov-status
37269           in: query
37270           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
37271           required: false
37272           type: string
37273         - name: heat-stack-id
37274           in: query
37275           description: Heat stack id corresponding to this instance, managed by MSO
37276           required: false
37277           type: string
37278     put:
37279       tags:
37280         - Network
37281       summary: create or update an existing newvce
37282       description: |
37283         Create or update an existing newvce.
37284         #
37285         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
37286       operationId: createOrUpdateNetworkNewvcesNewvce
37287       consumes:
37288         - application/json
37289         - application/xml
37290       produces:
37291         - application/json
37292         - application/xml
37293       responses:
37294         "default":
37295           description: Response codes found in [response codes](https://wiki.onap.org/).
37296       parameters:
37297         - name: vnf-id2
37298           in: path
37299           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37300           required: true
37301           type: string
37302           example: __VNF-ID2__
37303         - name: body
37304           in: body
37305           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkNewvcesNewvce.json)
37306           required: true
37307           schema:
37308             $ref: "#/definitions/newvce"
37309     patch:
37310       tags:
37311         - Network
37312       summary: update an existing newvce
37313       description: |
37314         Update an existing newvce
37315         #
37316         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37317         The PUT operation will entirely replace an existing object.
37318         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.
37319         #
37320         Other differences between PUT and PATCH are:
37321         #
37322         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37323         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37324         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37325       operationId: UpdateNetworkNewvcesNewvce
37326       consumes:
37327         - application/json
37328         - application/xml
37329       produces:
37330         - application/json
37331         - application/xml
37332       responses:
37333         "default":
37334           description: Response codes found in [response codes](https://wiki.onap.org/).
37335       parameters:
37336         - name: vnf-id2
37337           in: path
37338           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37339           required: true
37340           type: string
37341           example: __VNF-ID2__
37342         - name: body
37343           in: body
37344           description: newvce object that needs to be created or updated.
37345           required: true
37346           schema:
37347             $ref: "#/patchDefinitions/newvce"
37348     delete:
37349       tags:
37350         - Network
37351       summary: delete an existing newvce
37352       description: delete an existing newvce
37353       operationId: deleteNetworkNewvcesNewvce
37354       consumes:
37355         - application/json
37356         - application/xml
37357       produces:
37358         - application/json
37359         - application/xml
37360       responses:
37361         "default":
37362           description: Response codes found in [response codes](https://wiki.onap.org/).
37363       parameters:
37364         - name: vnf-id2
37365           in: path
37366           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
37367           required: true
37368           type: string
37369           example: __VNF-ID2__
37370         - name: resource-version
37371           in: query
37372           description: resource-version for concurrency
37373           required: true
37374           type: string
37375   /network/newvces:
37376     get:
37377       tags:
37378         - Network
37379       summary: returns newvces
37380       description: returns newvces
37381       operationId: getNetworkNewvces
37382       produces:
37383         - application/json
37384         - application/xml
37385       responses:
37386         "200":
37387           description: successful operation
37388           schema:
37389               $ref: "#/getDefinitions/newvces"
37390         "default":
37391           description: Response codes found in [response codes](https://wiki.onap.org/).
37392   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
37393     put:
37394       tags:
37395         - Network
37396       summary: see node definition for valid relationships
37397       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
37398       consumes:
37399         - application/json
37400         - application/xml
37401       produces:
37402         - application/json
37403         - application/xml
37404       responses:
37405         "default":
37406           description: Response codes found in [response codes](https://wiki.onap.org/).
37407       parameters:
37408         - name: pnf-name
37409           in: path
37410           description: unique name of Physical Network Function.
37411           required: true
37412           type: string
37413           example: __PNF-NAME__
37414         - name: body
37415           in: body
37416           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
37417           required: true
37418           schema:
37419             $ref: "#/definitions/relationship"
37420     delete:
37421       tags:
37422         - Network
37423       summary: delete an existing relationship
37424       description: delete an existing relationship
37425       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
37426       consumes:
37427         - application/json
37428         - application/xml
37429       produces:
37430         - application/json
37431         - application/xml
37432       responses:
37433         "default":
37434           description: Response codes found in [response codes](https://wiki.onap.org/).
37435       parameters:
37436         - name: pnf-name
37437           in: path
37438           description: unique name of Physical Network Function.
37439           required: true
37440           type: string
37441           example: __PNF-NAME__
37442   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
37443     put:
37444       tags:
37445         - Network
37446       summary: see node definition for valid relationships
37447       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37448       consumes:
37449         - application/json
37450         - application/xml
37451       produces:
37452         - application/json
37453         - application/xml
37454       responses:
37455         "default":
37456           description: Response codes found in [response codes](https://wiki.onap.org/).
37457       parameters:
37458         - name: pnf-name
37459           in: path
37460           description: unique name of Physical Network Function.
37461           required: true
37462           type: string
37463           example: __PNF-NAME__
37464         - name: interface-name
37465           in: path
37466           description: Name that identifies the physical interface
37467           required: true
37468           type: string
37469           example: __INTERFACE-NAME__
37470         - name: body
37471           in: body
37472           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
37473           required: true
37474           schema:
37475             $ref: "#/definitions/relationship"
37476     delete:
37477       tags:
37478         - Network
37479       summary: delete an existing relationship
37480       description: delete an existing relationship
37481       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
37482       consumes:
37483         - application/json
37484         - application/xml
37485       produces:
37486         - application/json
37487         - application/xml
37488       responses:
37489         "default":
37490           description: Response codes found in [response codes](https://wiki.onap.org/).
37491       parameters:
37492         - name: pnf-name
37493           in: path
37494           description: unique name of Physical Network Function.
37495           required: true
37496           type: string
37497           example: __PNF-NAME__
37498         - name: interface-name
37499           in: path
37500           description: Name that identifies the physical interface
37501           required: true
37502           type: string
37503           example: __INTERFACE-NAME__
37504   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
37505     put:
37506       tags:
37507         - Network
37508       summary: see node definition for valid relationships
37509       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37510       consumes:
37511         - application/json
37512         - application/xml
37513       produces:
37514         - application/json
37515         - application/xml
37516       responses:
37517         "default":
37518           description: Response codes found in [response codes](https://wiki.onap.org/).
37519       parameters:
37520         - name: pnf-name
37521           in: path
37522           description: unique name of Physical Network Function.
37523           required: true
37524           type: string
37525           example: __PNF-NAME__
37526         - name: interface-name
37527           in: path
37528           description: Name that identifies the physical interface
37529           required: true
37530           type: string
37531           example: __INTERFACE-NAME__
37532         - name: interface-name
37533           in: path
37534           description: Name given to the interface
37535           required: true
37536           type: string
37537           example: __INTERFACE-NAME__
37538         - name: vlan-interface
37539           in: path
37540           description: String that identifies the interface
37541           required: true
37542           type: string
37543           example: __VLAN-INTERFACE__
37544         - name: body
37545           in: body
37546           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
37547           required: true
37548           schema:
37549             $ref: "#/definitions/relationship"
37550     delete:
37551       tags:
37552         - Network
37553       summary: delete an existing relationship
37554       description: delete an existing relationship
37555       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37556       consumes:
37557         - application/json
37558         - application/xml
37559       produces:
37560         - application/json
37561         - application/xml
37562       responses:
37563         "default":
37564           description: Response codes found in [response codes](https://wiki.onap.org/).
37565       parameters:
37566         - name: pnf-name
37567           in: path
37568           description: unique name of Physical Network Function.
37569           required: true
37570           type: string
37571           example: __PNF-NAME__
37572         - name: interface-name
37573           in: path
37574           description: Name that identifies the physical interface
37575           required: true
37576           type: string
37577           example: __INTERFACE-NAME__
37578         - name: interface-name
37579           in: path
37580           description: Name given to the interface
37581           required: true
37582           type: string
37583           example: __INTERFACE-NAME__
37584         - name: vlan-interface
37585           in: path
37586           description: String that identifies the interface
37587           required: true
37588           type: string
37589           example: __VLAN-INTERFACE__
37590   /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:
37591     put:
37592       tags:
37593         - Network
37594       summary: see node definition for valid relationships
37595       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37596       consumes:
37597         - application/json
37598         - application/xml
37599       produces:
37600         - application/json
37601         - application/xml
37602       responses:
37603         "default":
37604           description: Response codes found in [response codes](https://wiki.onap.org/).
37605       parameters:
37606         - name: pnf-name
37607           in: path
37608           description: unique name of Physical Network Function.
37609           required: true
37610           type: string
37611           example: __PNF-NAME__
37612         - name: interface-name
37613           in: path
37614           description: Name that identifies the physical interface
37615           required: true
37616           type: string
37617           example: __INTERFACE-NAME__
37618         - name: interface-name
37619           in: path
37620           description: Name given to the interface
37621           required: true
37622           type: string
37623           example: __INTERFACE-NAME__
37624         - name: vlan-interface
37625           in: path
37626           description: String that identifies the interface
37627           required: true
37628           type: string
37629           example: __VLAN-INTERFACE__
37630         - name: l3-interface-ipv4-address
37631           in: path
37632           description: IP address
37633           required: true
37634           type: string
37635           example: __L3-INTERFACE-IPV4-ADDRESS__
37636         - name: body
37637           in: body
37638           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37639           required: true
37640           schema:
37641             $ref: "#/definitions/relationship"
37642     delete:
37643       tags:
37644         - Network
37645       summary: delete an existing relationship
37646       description: delete an existing relationship
37647       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37648       consumes:
37649         - application/json
37650         - application/xml
37651       produces:
37652         - application/json
37653         - application/xml
37654       responses:
37655         "default":
37656           description: Response codes found in [response codes](https://wiki.onap.org/).
37657       parameters:
37658         - name: pnf-name
37659           in: path
37660           description: unique name of Physical Network Function.
37661           required: true
37662           type: string
37663           example: __PNF-NAME__
37664         - name: interface-name
37665           in: path
37666           description: Name that identifies the physical interface
37667           required: true
37668           type: string
37669           example: __INTERFACE-NAME__
37670         - name: interface-name
37671           in: path
37672           description: Name given to the interface
37673           required: true
37674           type: string
37675           example: __INTERFACE-NAME__
37676         - name: vlan-interface
37677           in: path
37678           description: String that identifies the interface
37679           required: true
37680           type: string
37681           example: __VLAN-INTERFACE__
37682         - name: l3-interface-ipv4-address
37683           in: path
37684           description: IP address
37685           required: true
37686           type: string
37687           example: __L3-INTERFACE-IPV4-ADDRESS__
37688   /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}:
37689     get:
37690       tags:
37691         - Network
37692       summary: returns l3-interface-ipv4-address-list
37693       description: returns l3-interface-ipv4-address-list
37694       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37695       produces:
37696         - application/json
37697         - application/xml
37698       responses:
37699         "200":
37700           description: successful operation
37701           schema:
37702               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37703         "default":
37704           description: Response codes found in [response codes](https://wiki.onap.org/).
37705       parameters:
37706         - name: pnf-name
37707           in: path
37708           description: unique name of Physical Network Function.
37709           required: true
37710           type: string
37711           example: __PNF-NAME__
37712         - name: interface-name
37713           in: path
37714           description: Name that identifies the physical interface
37715           required: true
37716           type: string
37717           example: __INTERFACE-NAME__
37718         - name: interface-name
37719           in: path
37720           description: Name given to the interface
37721           required: true
37722           type: string
37723           example: __INTERFACE-NAME__
37724         - name: vlan-interface
37725           in: path
37726           description: String that identifies the interface
37727           required: true
37728           type: string
37729           example: __VLAN-INTERFACE__
37730         - name: l3-interface-ipv4-address
37731           in: path
37732           description: IP address
37733           required: true
37734           type: string
37735           example: __L3-INTERFACE-IPV4-ADDRESS__
37736         - name: orchestration-status
37737           in: query
37738           description: orchestration-status is the status of orchestration on the PNF.
37739           required: false
37740           type: string
37741         - name: interface-id
37742           in: query
37743           description: ID of interface
37744           required: false
37745           type: string
37746         - name: macaddr
37747           in: query
37748           description: MAC address for the interface
37749           required: false
37750           type: string
37751         - name: network-name
37752           in: query
37753           description: Name of the network
37754           required: false
37755           type: string
37756         - name: vlan-id-inner
37757           in: query
37758           description: Inner VLAN tag
37759           required: false
37760           type: integer
37761           format: int64
37762         - name: vpn-id
37763           in: query
37764           description: This indicates the customers VPN ID associated with this vlan
37765           required: false
37766           type: string
37767         - name: vlan-id-inner
37768           in: query
37769           description: Inner VLAN tag
37770           required: false
37771           type: integer
37772           format: int64
37773         - name: neutron-network-id
37774           in: query
37775           description: Neutron network id of the interface that address belongs to
37776           required: false
37777           type: string
37778         - name: neutron-subnet-id
37779           in: query
37780           description: Neutron id of subnet that address belongs to
37781           required: false
37782           type: string
37783     put:
37784       tags:
37785         - Network
37786       summary: create or update an existing l3-interface-ipv4-address-list
37787       description: |
37788         Create or update an existing l3-interface-ipv4-address-list.
37789         #
37790         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
37791       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37792       consumes:
37793         - application/json
37794         - application/xml
37795       produces:
37796         - application/json
37797         - application/xml
37798       responses:
37799         "default":
37800           description: Response codes found in [response codes](https://wiki.onap.org/).
37801       parameters:
37802         - name: pnf-name
37803           in: path
37804           description: unique name of Physical Network Function.
37805           required: true
37806           type: string
37807           example: __PNF-NAME__
37808         - name: interface-name
37809           in: path
37810           description: Name that identifies the physical interface
37811           required: true
37812           type: string
37813           example: __INTERFACE-NAME__
37814         - name: interface-name
37815           in: path
37816           description: Name given to the interface
37817           required: true
37818           type: string
37819           example: __INTERFACE-NAME__
37820         - name: vlan-interface
37821           in: path
37822           description: String that identifies the interface
37823           required: true
37824           type: string
37825           example: __VLAN-INTERFACE__
37826         - name: l3-interface-ipv4-address
37827           in: path
37828           description: IP address
37829           required: true
37830           type: string
37831           example: __L3-INTERFACE-IPV4-ADDRESS__
37832         - name: body
37833           in: body
37834           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37835           required: true
37836           schema:
37837             $ref: "#/definitions/l3-interface-ipv4-address-list"
37838     patch:
37839       tags:
37840         - Network
37841       summary: update an existing l3-interface-ipv4-address-list
37842       description: |
37843         Update an existing l3-interface-ipv4-address-list
37844         #
37845         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37846         The PUT operation will entirely replace an existing object.
37847         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.
37848         #
37849         Other differences between PUT and PATCH are:
37850         #
37851         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37852         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37853         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37854       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37855       consumes:
37856         - application/json
37857         - application/xml
37858       produces:
37859         - application/json
37860         - application/xml
37861       responses:
37862         "default":
37863           description: Response codes found in [response codes](https://wiki.onap.org/).
37864       parameters:
37865         - name: pnf-name
37866           in: path
37867           description: unique name of Physical Network Function.
37868           required: true
37869           type: string
37870           example: __PNF-NAME__
37871         - name: interface-name
37872           in: path
37873           description: Name that identifies the physical interface
37874           required: true
37875           type: string
37876           example: __INTERFACE-NAME__
37877         - name: interface-name
37878           in: path
37879           description: Name given to the interface
37880           required: true
37881           type: string
37882           example: __INTERFACE-NAME__
37883         - name: vlan-interface
37884           in: path
37885           description: String that identifies the interface
37886           required: true
37887           type: string
37888           example: __VLAN-INTERFACE__
37889         - name: l3-interface-ipv4-address
37890           in: path
37891           description: IP address
37892           required: true
37893           type: string
37894           example: __L3-INTERFACE-IPV4-ADDRESS__
37895         - name: body
37896           in: body
37897           description: l3-interface-ipv4-address-list object that needs to be created or updated.
37898           required: true
37899           schema:
37900             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37901     delete:
37902       tags:
37903         - Network
37904       summary: delete an existing l3-interface-ipv4-address-list
37905       description: delete an existing l3-interface-ipv4-address-list
37906       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37907       consumes:
37908         - application/json
37909         - application/xml
37910       produces:
37911         - application/json
37912         - application/xml
37913       responses:
37914         "default":
37915           description: Response codes found in [response codes](https://wiki.onap.org/).
37916       parameters:
37917         - name: pnf-name
37918           in: path
37919           description: unique name of Physical Network Function.
37920           required: true
37921           type: string
37922           example: __PNF-NAME__
37923         - name: interface-name
37924           in: path
37925           description: Name that identifies the physical interface
37926           required: true
37927           type: string
37928           example: __INTERFACE-NAME__
37929         - name: interface-name
37930           in: path
37931           description: Name given to the interface
37932           required: true
37933           type: string
37934           example: __INTERFACE-NAME__
37935         - name: vlan-interface
37936           in: path
37937           description: String that identifies the interface
37938           required: true
37939           type: string
37940           example: __VLAN-INTERFACE__
37941         - name: l3-interface-ipv4-address
37942           in: path
37943           description: IP address
37944           required: true
37945           type: string
37946           example: __L3-INTERFACE-IPV4-ADDRESS__
37947         - name: resource-version
37948           in: query
37949           description: resource-version for concurrency
37950           required: true
37951           type: string
37952   /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:
37953     put:
37954       tags:
37955         - Network
37956       summary: see node definition for valid relationships
37957       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37958       consumes:
37959         - application/json
37960         - application/xml
37961       produces:
37962         - application/json
37963         - application/xml
37964       responses:
37965         "default":
37966           description: Response codes found in [response codes](https://wiki.onap.org/).
37967       parameters:
37968         - name: pnf-name
37969           in: path
37970           description: unique name of Physical Network Function.
37971           required: true
37972           type: string
37973           example: __PNF-NAME__
37974         - name: interface-name
37975           in: path
37976           description: Name that identifies the physical interface
37977           required: true
37978           type: string
37979           example: __INTERFACE-NAME__
37980         - name: interface-name
37981           in: path
37982           description: Name given to the interface
37983           required: true
37984           type: string
37985           example: __INTERFACE-NAME__
37986         - name: vlan-interface
37987           in: path
37988           description: String that identifies the interface
37989           required: true
37990           type: string
37991           example: __VLAN-INTERFACE__
37992         - name: l3-interface-ipv6-address
37993           in: path
37994           description: IP address
37995           required: true
37996           type: string
37997           example: __L3-INTERFACE-IPV6-ADDRESS__
37998         - name: body
37999           in: body
38000           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38001           required: true
38002           schema:
38003             $ref: "#/definitions/relationship"
38004     delete:
38005       tags:
38006         - Network
38007       summary: delete an existing relationship
38008       description: delete an existing relationship
38009       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
38010       consumes:
38011         - application/json
38012         - application/xml
38013       produces:
38014         - application/json
38015         - application/xml
38016       responses:
38017         "default":
38018           description: Response codes found in [response codes](https://wiki.onap.org/).
38019       parameters:
38020         - name: pnf-name
38021           in: path
38022           description: unique name of Physical Network Function.
38023           required: true
38024           type: string
38025           example: __PNF-NAME__
38026         - name: interface-name
38027           in: path
38028           description: Name that identifies the physical interface
38029           required: true
38030           type: string
38031           example: __INTERFACE-NAME__
38032         - name: interface-name
38033           in: path
38034           description: Name given to the interface
38035           required: true
38036           type: string
38037           example: __INTERFACE-NAME__
38038         - name: vlan-interface
38039           in: path
38040           description: String that identifies the interface
38041           required: true
38042           type: string
38043           example: __VLAN-INTERFACE__
38044         - name: l3-interface-ipv6-address
38045           in: path
38046           description: IP address
38047           required: true
38048           type: string
38049           example: __L3-INTERFACE-IPV6-ADDRESS__
38050   /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}:
38051     get:
38052       tags:
38053         - Network
38054       summary: returns l3-interface-ipv6-address-list
38055       description: returns l3-interface-ipv6-address-list
38056       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38057       produces:
38058         - application/json
38059         - application/xml
38060       responses:
38061         "200":
38062           description: successful operation
38063           schema:
38064               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
38065         "default":
38066           description: Response codes found in [response codes](https://wiki.onap.org/).
38067       parameters:
38068         - name: pnf-name
38069           in: path
38070           description: unique name of Physical Network Function.
38071           required: true
38072           type: string
38073           example: __PNF-NAME__
38074         - name: interface-name
38075           in: path
38076           description: Name that identifies the physical interface
38077           required: true
38078           type: string
38079           example: __INTERFACE-NAME__
38080         - name: interface-name
38081           in: path
38082           description: Name given to the interface
38083           required: true
38084           type: string
38085           example: __INTERFACE-NAME__
38086         - name: vlan-interface
38087           in: path
38088           description: String that identifies the interface
38089           required: true
38090           type: string
38091           example: __VLAN-INTERFACE__
38092         - name: l3-interface-ipv6-address
38093           in: path
38094           description: IP address
38095           required: true
38096           type: string
38097           example: __L3-INTERFACE-IPV6-ADDRESS__
38098         - name: orchestration-status
38099           in: query
38100           description: orchestration-status is the status of orchestration on the PNF.
38101           required: false
38102           type: string
38103         - name: interface-id
38104           in: query
38105           description: ID of interface
38106           required: false
38107           type: string
38108         - name: macaddr
38109           in: query
38110           description: MAC address for the interface
38111           required: false
38112           type: string
38113         - name: network-name
38114           in: query
38115           description: Name of the network
38116           required: false
38117           type: string
38118         - name: vlan-id-inner
38119           in: query
38120           description: Inner VLAN tag
38121           required: false
38122           type: integer
38123           format: int64
38124         - name: vpn-id
38125           in: query
38126           description: This indicates the customers VPN ID associated with this vlan
38127           required: false
38128           type: string
38129         - name: vlan-id-inner
38130           in: query
38131           description: Inner VLAN tag
38132           required: false
38133           type: integer
38134           format: int64
38135         - name: neutron-network-id
38136           in: query
38137           description: Neutron network id of the interface that address belongs to
38138           required: false
38139           type: string
38140         - name: neutron-subnet-id
38141           in: query
38142           description: Neutron id of subnet that address belongs to
38143           required: false
38144           type: string
38145     put:
38146       tags:
38147         - Network
38148       summary: create or update an existing l3-interface-ipv6-address-list
38149       description: |
38150         Create or update an existing l3-interface-ipv6-address-list.
38151         #
38152         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
38153       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38154       consumes:
38155         - application/json
38156         - application/xml
38157       produces:
38158         - application/json
38159         - application/xml
38160       responses:
38161         "default":
38162           description: Response codes found in [response codes](https://wiki.onap.org/).
38163       parameters:
38164         - name: pnf-name
38165           in: path
38166           description: unique name of Physical Network Function.
38167           required: true
38168           type: string
38169           example: __PNF-NAME__
38170         - name: interface-name
38171           in: path
38172           description: Name that identifies the physical interface
38173           required: true
38174           type: string
38175           example: __INTERFACE-NAME__
38176         - name: interface-name
38177           in: path
38178           description: Name given to the interface
38179           required: true
38180           type: string
38181           example: __INTERFACE-NAME__
38182         - name: vlan-interface
38183           in: path
38184           description: String that identifies the interface
38185           required: true
38186           type: string
38187           example: __VLAN-INTERFACE__
38188         - name: l3-interface-ipv6-address
38189           in: path
38190           description: IP address
38191           required: true
38192           type: string
38193           example: __L3-INTERFACE-IPV6-ADDRESS__
38194         - name: body
38195           in: body
38196           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
38197           required: true
38198           schema:
38199             $ref: "#/definitions/l3-interface-ipv6-address-list"
38200     patch:
38201       tags:
38202         - Network
38203       summary: update an existing l3-interface-ipv6-address-list
38204       description: |
38205         Update an existing l3-interface-ipv6-address-list
38206         #
38207         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38208         The PUT operation will entirely replace an existing object.
38209         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.
38210         #
38211         Other differences between PUT and PATCH are:
38212         #
38213         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38214         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38215         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38216       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38217       consumes:
38218         - application/json
38219         - application/xml
38220       produces:
38221         - application/json
38222         - application/xml
38223       responses:
38224         "default":
38225           description: Response codes found in [response codes](https://wiki.onap.org/).
38226       parameters:
38227         - name: pnf-name
38228           in: path
38229           description: unique name of Physical Network Function.
38230           required: true
38231           type: string
38232           example: __PNF-NAME__
38233         - name: interface-name
38234           in: path
38235           description: Name that identifies the physical interface
38236           required: true
38237           type: string
38238           example: __INTERFACE-NAME__
38239         - name: interface-name
38240           in: path
38241           description: Name given to the interface
38242           required: true
38243           type: string
38244           example: __INTERFACE-NAME__
38245         - name: vlan-interface
38246           in: path
38247           description: String that identifies the interface
38248           required: true
38249           type: string
38250           example: __VLAN-INTERFACE__
38251         - name: l3-interface-ipv6-address
38252           in: path
38253           description: IP address
38254           required: true
38255           type: string
38256           example: __L3-INTERFACE-IPV6-ADDRESS__
38257         - name: body
38258           in: body
38259           description: l3-interface-ipv6-address-list object that needs to be created or updated.
38260           required: true
38261           schema:
38262             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
38263     delete:
38264       tags:
38265         - Network
38266       summary: delete an existing l3-interface-ipv6-address-list
38267       description: delete an existing l3-interface-ipv6-address-list
38268       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
38269       consumes:
38270         - application/json
38271         - application/xml
38272       produces:
38273         - application/json
38274         - application/xml
38275       responses:
38276         "default":
38277           description: Response codes found in [response codes](https://wiki.onap.org/).
38278       parameters:
38279         - name: pnf-name
38280           in: path
38281           description: unique name of Physical Network Function.
38282           required: true
38283           type: string
38284           example: __PNF-NAME__
38285         - name: interface-name
38286           in: path
38287           description: Name that identifies the physical interface
38288           required: true
38289           type: string
38290           example: __INTERFACE-NAME__
38291         - name: interface-name
38292           in: path
38293           description: Name given to the interface
38294           required: true
38295           type: string
38296           example: __INTERFACE-NAME__
38297         - name: vlan-interface
38298           in: path
38299           description: String that identifies the interface
38300           required: true
38301           type: string
38302           example: __VLAN-INTERFACE__
38303         - name: l3-interface-ipv6-address
38304           in: path
38305           description: IP address
38306           required: true
38307           type: string
38308           example: __L3-INTERFACE-IPV6-ADDRESS__
38309         - name: resource-version
38310           in: query
38311           description: resource-version for concurrency
38312           required: true
38313           type: string
38314   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38315     get:
38316       tags:
38317         - Network
38318       summary: returns vlan
38319       description: returns vlan
38320       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38321       produces:
38322         - application/json
38323         - application/xml
38324       responses:
38325         "200":
38326           description: successful operation
38327           schema:
38328               $ref: "#/getDefinitions/vlan"
38329         "default":
38330           description: Response codes found in [response codes](https://wiki.onap.org/).
38331       parameters:
38332         - name: pnf-name
38333           in: path
38334           description: unique name of Physical Network Function.
38335           required: true
38336           type: string
38337           example: __PNF-NAME__
38338         - name: interface-name
38339           in: path
38340           description: Name that identifies the physical interface
38341           required: true
38342           type: string
38343           example: __INTERFACE-NAME__
38344         - name: interface-name
38345           in: path
38346           description: Name given to the interface
38347           required: true
38348           type: string
38349           example: __INTERFACE-NAME__
38350         - name: vlan-interface
38351           in: path
38352           description: String that identifies the interface
38353           required: true
38354           type: string
38355           example: __VLAN-INTERFACE__
38356         - name: orchestration-status
38357           in: query
38358           description: orchestration-status is the status of orchestration on the PNF.
38359           required: false
38360           type: string
38361         - name: interface-id
38362           in: query
38363           description: ID of interface
38364           required: false
38365           type: string
38366         - name: macaddr
38367           in: query
38368           description: MAC address for the interface
38369           required: false
38370           type: string
38371         - name: network-name
38372           in: query
38373           description: Name of the network
38374           required: false
38375           type: string
38376         - name: vlan-id-inner
38377           in: query
38378           description: Inner VLAN tag
38379           required: false
38380           type: integer
38381           format: int64
38382         - name: vpn-id
38383           in: query
38384           description: This indicates the customers VPN ID associated with this vlan
38385           required: false
38386           type: string
38387     put:
38388       tags:
38389         - Network
38390       summary: create or update an existing vlan
38391       description: |
38392         Create or update an existing vlan.
38393         #
38394         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
38395       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38396       consumes:
38397         - application/json
38398         - application/xml
38399       produces:
38400         - application/json
38401         - application/xml
38402       responses:
38403         "default":
38404           description: Response codes found in [response codes](https://wiki.onap.org/).
38405       parameters:
38406         - name: pnf-name
38407           in: path
38408           description: unique name of Physical Network Function.
38409           required: true
38410           type: string
38411           example: __PNF-NAME__
38412         - name: interface-name
38413           in: path
38414           description: Name that identifies the physical interface
38415           required: true
38416           type: string
38417           example: __INTERFACE-NAME__
38418         - name: interface-name
38419           in: path
38420           description: Name given to the interface
38421           required: true
38422           type: string
38423           example: __INTERFACE-NAME__
38424         - name: vlan-interface
38425           in: path
38426           description: String that identifies the interface
38427           required: true
38428           type: string
38429           example: __VLAN-INTERFACE__
38430         - name: body
38431           in: body
38432           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
38433           required: true
38434           schema:
38435             $ref: "#/definitions/vlan"
38436     patch:
38437       tags:
38438         - Network
38439       summary: update an existing vlan
38440       description: |
38441         Update an existing vlan
38442         #
38443         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38444         The PUT operation will entirely replace an existing object.
38445         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.
38446         #
38447         Other differences between PUT and PATCH are:
38448         #
38449         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38450         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38451         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38452       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38453       consumes:
38454         - application/json
38455         - application/xml
38456       produces:
38457         - application/json
38458         - application/xml
38459       responses:
38460         "default":
38461           description: Response codes found in [response codes](https://wiki.onap.org/).
38462       parameters:
38463         - name: pnf-name
38464           in: path
38465           description: unique name of Physical Network Function.
38466           required: true
38467           type: string
38468           example: __PNF-NAME__
38469         - name: interface-name
38470           in: path
38471           description: Name that identifies the physical interface
38472           required: true
38473           type: string
38474           example: __INTERFACE-NAME__
38475         - name: interface-name
38476           in: path
38477           description: Name given to the interface
38478           required: true
38479           type: string
38480           example: __INTERFACE-NAME__
38481         - name: vlan-interface
38482           in: path
38483           description: String that identifies the interface
38484           required: true
38485           type: string
38486           example: __VLAN-INTERFACE__
38487         - name: body
38488           in: body
38489           description: vlan object that needs to be created or updated.
38490           required: true
38491           schema:
38492             $ref: "#/patchDefinitions/vlan"
38493     delete:
38494       tags:
38495         - Network
38496       summary: delete an existing vlan
38497       description: delete an existing vlan
38498       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
38499       consumes:
38500         - application/json
38501         - application/xml
38502       produces:
38503         - application/json
38504         - application/xml
38505       responses:
38506         "default":
38507           description: Response codes found in [response codes](https://wiki.onap.org/).
38508       parameters:
38509         - name: pnf-name
38510           in: path
38511           description: unique name of Physical Network Function.
38512           required: true
38513           type: string
38514           example: __PNF-NAME__
38515         - name: interface-name
38516           in: path
38517           description: Name that identifies the physical interface
38518           required: true
38519           type: string
38520           example: __INTERFACE-NAME__
38521         - name: interface-name
38522           in: path
38523           description: Name given to the interface
38524           required: true
38525           type: string
38526           example: __INTERFACE-NAME__
38527         - name: vlan-interface
38528           in: path
38529           description: String that identifies the interface
38530           required: true
38531           type: string
38532           example: __VLAN-INTERFACE__
38533         - name: resource-version
38534           in: query
38535           description: resource-version for concurrency
38536           required: true
38537           type: string
38538   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38539     get:
38540       tags:
38541         - Network
38542       summary: returns vlans
38543       description: returns vlans
38544       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
38545       produces:
38546         - application/json
38547         - application/xml
38548       responses:
38549         "200":
38550           description: successful operation
38551           schema:
38552               $ref: "#/getDefinitions/vlans"
38553         "default":
38554           description: Response codes found in [response codes](https://wiki.onap.org/).
38555       parameters:
38556         - name: pnf-name
38557           in: path
38558           description: unique name of Physical Network Function.
38559           required: true
38560           type: string
38561           example: __PNF-NAME__
38562         - name: interface-name
38563           in: path
38564           description: Name that identifies the physical interface
38565           required: true
38566           type: string
38567           example: __INTERFACE-NAME__
38568         - name: interface-name
38569           in: path
38570           description: Name given to the interface
38571           required: true
38572           type: string
38573           example: __INTERFACE-NAME__
38574         - name: orchestration-status
38575           in: query
38576           description: orchestration-status is the status of orchestration on the PNF.
38577           required: false
38578           type: string
38579         - name: interface-id
38580           in: query
38581           description: ID of interface
38582           required: false
38583           type: string
38584         - name: macaddr
38585           in: query
38586           description: MAC address for the interface
38587           required: false
38588           type: string
38589         - name: network-name
38590           in: query
38591           description: Name of the network
38592           required: false
38593           type: string
38594   /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:
38595     put:
38596       tags:
38597         - Network
38598       summary: see node definition for valid relationships
38599       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38600       consumes:
38601         - application/json
38602         - application/xml
38603       produces:
38604         - application/json
38605         - application/xml
38606       responses:
38607         "default":
38608           description: Response codes found in [response codes](https://wiki.onap.org/).
38609       parameters:
38610         - name: pnf-name
38611           in: path
38612           description: unique name of Physical Network Function.
38613           required: true
38614           type: string
38615           example: __PNF-NAME__
38616         - name: interface-name
38617           in: path
38618           description: Name that identifies the physical interface
38619           required: true
38620           type: string
38621           example: __INTERFACE-NAME__
38622         - name: interface-name
38623           in: path
38624           description: Name given to the interface
38625           required: true
38626           type: string
38627           example: __INTERFACE-NAME__
38628         - name: pci-id
38629           in: path
38630           description: PCI ID used to identify the sriov-vf
38631           required: true
38632           type: string
38633           example: __PCI-ID__
38634         - name: body
38635           in: body
38636           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38637           required: true
38638           schema:
38639             $ref: "#/definitions/relationship"
38640     delete:
38641       tags:
38642         - Network
38643       summary: delete an existing relationship
38644       description: delete an existing relationship
38645       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38646       consumes:
38647         - application/json
38648         - application/xml
38649       produces:
38650         - application/json
38651         - application/xml
38652       responses:
38653         "default":
38654           description: Response codes found in [response codes](https://wiki.onap.org/).
38655       parameters:
38656         - name: pnf-name
38657           in: path
38658           description: unique name of Physical Network Function.
38659           required: true
38660           type: string
38661           example: __PNF-NAME__
38662         - name: interface-name
38663           in: path
38664           description: Name that identifies the physical interface
38665           required: true
38666           type: string
38667           example: __INTERFACE-NAME__
38668         - name: interface-name
38669           in: path
38670           description: Name given to the interface
38671           required: true
38672           type: string
38673           example: __INTERFACE-NAME__
38674         - name: pci-id
38675           in: path
38676           description: PCI ID used to identify the sriov-vf
38677           required: true
38678           type: string
38679           example: __PCI-ID__
38680   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
38681     get:
38682       tags:
38683         - Network
38684       summary: returns sriov-vf
38685       description: returns sriov-vf
38686       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38687       produces:
38688         - application/json
38689         - application/xml
38690       responses:
38691         "200":
38692           description: successful operation
38693           schema:
38694               $ref: "#/getDefinitions/sriov-vf"
38695         "default":
38696           description: Response codes found in [response codes](https://wiki.onap.org/).
38697       parameters:
38698         - name: pnf-name
38699           in: path
38700           description: unique name of Physical Network Function.
38701           required: true
38702           type: string
38703           example: __PNF-NAME__
38704         - name: interface-name
38705           in: path
38706           description: Name that identifies the physical interface
38707           required: true
38708           type: string
38709           example: __INTERFACE-NAME__
38710         - name: interface-name
38711           in: path
38712           description: Name given to the interface
38713           required: true
38714           type: string
38715           example: __INTERFACE-NAME__
38716         - name: pci-id
38717           in: path
38718           description: PCI ID used to identify the sriov-vf
38719           required: true
38720           type: string
38721           example: __PCI-ID__
38722         - name: orchestration-status
38723           in: query
38724           description: orchestration-status is the status of orchestration on the PNF.
38725           required: false
38726           type: string
38727         - name: interface-id
38728           in: query
38729           description: ID of interface
38730           required: false
38731           type: string
38732         - name: macaddr
38733           in: query
38734           description: MAC address for the interface
38735           required: false
38736           type: string
38737         - name: network-name
38738           in: query
38739           description: Name of the network
38740           required: false
38741           type: string
38742         - name: vf-vlan-filter
38743           in: query
38744           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
38745           required: false
38746           type: string
38747         - name: vf-mac-filter
38748           in: query
38749           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
38750           required: false
38751           type: string
38752         - name: vf-vlan-strip
38753           in: query
38754           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
38755           required: false
38756           type: boolean
38757         - name: neutron-network-id
38758           in: query
38759           description: Neutron network id of the interface
38760           required: false
38761           type: string
38762     put:
38763       tags:
38764         - Network
38765       summary: create or update an existing sriov-vf
38766       description: |
38767         Create or update an existing sriov-vf.
38768         #
38769         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
38770       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38771       consumes:
38772         - application/json
38773         - application/xml
38774       produces:
38775         - application/json
38776         - application/xml
38777       responses:
38778         "default":
38779           description: Response codes found in [response codes](https://wiki.onap.org/).
38780       parameters:
38781         - name: pnf-name
38782           in: path
38783           description: unique name of Physical Network Function.
38784           required: true
38785           type: string
38786           example: __PNF-NAME__
38787         - name: interface-name
38788           in: path
38789           description: Name that identifies the physical interface
38790           required: true
38791           type: string
38792           example: __INTERFACE-NAME__
38793         - name: interface-name
38794           in: path
38795           description: Name given to the interface
38796           required: true
38797           type: string
38798           example: __INTERFACE-NAME__
38799         - name: pci-id
38800           in: path
38801           description: PCI ID used to identify the sriov-vf
38802           required: true
38803           type: string
38804           example: __PCI-ID__
38805         - name: body
38806           in: body
38807           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38808           required: true
38809           schema:
38810             $ref: "#/definitions/sriov-vf"
38811     patch:
38812       tags:
38813         - Network
38814       summary: update an existing sriov-vf
38815       description: |
38816         Update an existing sriov-vf
38817         #
38818         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38819         The PUT operation will entirely replace an existing object.
38820         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.
38821         #
38822         Other differences between PUT and PATCH are:
38823         #
38824         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38825         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38826         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38827       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38828       consumes:
38829         - application/json
38830         - application/xml
38831       produces:
38832         - application/json
38833         - application/xml
38834       responses:
38835         "default":
38836           description: Response codes found in [response codes](https://wiki.onap.org/).
38837       parameters:
38838         - name: pnf-name
38839           in: path
38840           description: unique name of Physical Network Function.
38841           required: true
38842           type: string
38843           example: __PNF-NAME__
38844         - name: interface-name
38845           in: path
38846           description: Name that identifies the physical interface
38847           required: true
38848           type: string
38849           example: __INTERFACE-NAME__
38850         - name: interface-name
38851           in: path
38852           description: Name given to the interface
38853           required: true
38854           type: string
38855           example: __INTERFACE-NAME__
38856         - name: pci-id
38857           in: path
38858           description: PCI ID used to identify the sriov-vf
38859           required: true
38860           type: string
38861           example: __PCI-ID__
38862         - name: body
38863           in: body
38864           description: sriov-vf object that needs to be created or updated.
38865           required: true
38866           schema:
38867             $ref: "#/patchDefinitions/sriov-vf"
38868     delete:
38869       tags:
38870         - Network
38871       summary: delete an existing sriov-vf
38872       description: delete an existing sriov-vf
38873       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38874       consumes:
38875         - application/json
38876         - application/xml
38877       produces:
38878         - application/json
38879         - application/xml
38880       responses:
38881         "default":
38882           description: Response codes found in [response codes](https://wiki.onap.org/).
38883       parameters:
38884         - name: pnf-name
38885           in: path
38886           description: unique name of Physical Network Function.
38887           required: true
38888           type: string
38889           example: __PNF-NAME__
38890         - name: interface-name
38891           in: path
38892           description: Name that identifies the physical interface
38893           required: true
38894           type: string
38895           example: __INTERFACE-NAME__
38896         - name: interface-name
38897           in: path
38898           description: Name given to the interface
38899           required: true
38900           type: string
38901           example: __INTERFACE-NAME__
38902         - name: pci-id
38903           in: path
38904           description: PCI ID used to identify the sriov-vf
38905           required: true
38906           type: string
38907           example: __PCI-ID__
38908         - name: resource-version
38909           in: query
38910           description: resource-version for concurrency
38911           required: true
38912           type: string
38913   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38914     get:
38915       tags:
38916         - Network
38917       summary: returns sriov-vfs
38918       description: returns sriov-vfs
38919       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
38920       produces:
38921         - application/json
38922         - application/xml
38923       responses:
38924         "200":
38925           description: successful operation
38926           schema:
38927               $ref: "#/getDefinitions/sriov-vfs"
38928         "default":
38929           description: Response codes found in [response codes](https://wiki.onap.org/).
38930       parameters:
38931         - name: pnf-name
38932           in: path
38933           description: unique name of Physical Network Function.
38934           required: true
38935           type: string
38936           example: __PNF-NAME__
38937         - name: interface-name
38938           in: path
38939           description: Name that identifies the physical interface
38940           required: true
38941           type: string
38942           example: __INTERFACE-NAME__
38943         - name: interface-name
38944           in: path
38945           description: Name given to the interface
38946           required: true
38947           type: string
38948           example: __INTERFACE-NAME__
38949         - name: orchestration-status
38950           in: query
38951           description: orchestration-status is the status of orchestration on the PNF.
38952           required: false
38953           type: string
38954         - name: interface-id
38955           in: query
38956           description: ID of interface
38957           required: false
38958           type: string
38959         - name: macaddr
38960           in: query
38961           description: MAC address for the interface
38962           required: false
38963           type: string
38964         - name: network-name
38965           in: query
38966           description: Name of the network
38967           required: false
38968           type: string
38969   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
38970     put:
38971       tags:
38972         - Network
38973       summary: see node definition for valid relationships
38974       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
38975       consumes:
38976         - application/json
38977         - application/xml
38978       produces:
38979         - application/json
38980         - application/xml
38981       responses:
38982         "default":
38983           description: Response codes found in [response codes](https://wiki.onap.org/).
38984       parameters:
38985         - name: pnf-name
38986           in: path
38987           description: unique name of Physical Network Function.
38988           required: true
38989           type: string
38990           example: __PNF-NAME__
38991         - name: interface-name
38992           in: path
38993           description: Name that identifies the physical interface
38994           required: true
38995           type: string
38996           example: __INTERFACE-NAME__
38997         - name: interface-name
38998           in: path
38999           description: Name given to the interface
39000           required: true
39001           type: string
39002           example: __INTERFACE-NAME__
39003         - name: body
39004           in: body
39005           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
39006           required: true
39007           schema:
39008             $ref: "#/definitions/relationship"
39009     delete:
39010       tags:
39011         - Network
39012       summary: delete an existing relationship
39013       description: delete an existing relationship
39014       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
39015       consumes:
39016         - application/json
39017         - application/xml
39018       produces:
39019         - application/json
39020         - application/xml
39021       responses:
39022         "default":
39023           description: Response codes found in [response codes](https://wiki.onap.org/).
39024       parameters:
39025         - name: pnf-name
39026           in: path
39027           description: unique name of Physical Network Function.
39028           required: true
39029           type: string
39030           example: __PNF-NAME__
39031         - name: interface-name
39032           in: path
39033           description: Name that identifies the physical interface
39034           required: true
39035           type: string
39036           example: __INTERFACE-NAME__
39037         - name: interface-name
39038           in: path
39039           description: Name given to the interface
39040           required: true
39041           type: string
39042           example: __INTERFACE-NAME__
39043   /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:
39044     put:
39045       tags:
39046         - Network
39047       summary: see node definition for valid relationships
39048       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39049       consumes:
39050         - application/json
39051         - application/xml
39052       produces:
39053         - application/json
39054         - application/xml
39055       responses:
39056         "default":
39057           description: Response codes found in [response codes](https://wiki.onap.org/).
39058       parameters:
39059         - name: pnf-name
39060           in: path
39061           description: unique name of Physical Network Function.
39062           required: true
39063           type: string
39064           example: __PNF-NAME__
39065         - name: interface-name
39066           in: path
39067           description: Name that identifies the physical interface
39068           required: true
39069           type: string
39070           example: __INTERFACE-NAME__
39071         - name: interface-name
39072           in: path
39073           description: Name given to the interface
39074           required: true
39075           type: string
39076           example: __INTERFACE-NAME__
39077         - name: l3-interface-ipv4-address
39078           in: path
39079           description: IP address
39080           required: true
39081           type: string
39082           example: __L3-INTERFACE-IPV4-ADDRESS__
39083         - name: body
39084           in: body
39085           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39086           required: true
39087           schema:
39088             $ref: "#/definitions/relationship"
39089     delete:
39090       tags:
39091         - Network
39092       summary: delete an existing relationship
39093       description: delete an existing relationship
39094       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39095       consumes:
39096         - application/json
39097         - application/xml
39098       produces:
39099         - application/json
39100         - application/xml
39101       responses:
39102         "default":
39103           description: Response codes found in [response codes](https://wiki.onap.org/).
39104       parameters:
39105         - name: pnf-name
39106           in: path
39107           description: unique name of Physical Network Function.
39108           required: true
39109           type: string
39110           example: __PNF-NAME__
39111         - name: interface-name
39112           in: path
39113           description: Name that identifies the physical interface
39114           required: true
39115           type: string
39116           example: __INTERFACE-NAME__
39117         - name: interface-name
39118           in: path
39119           description: Name given to the interface
39120           required: true
39121           type: string
39122           example: __INTERFACE-NAME__
39123         - name: l3-interface-ipv4-address
39124           in: path
39125           description: IP address
39126           required: true
39127           type: string
39128           example: __L3-INTERFACE-IPV4-ADDRESS__
39129   /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}:
39130     get:
39131       tags:
39132         - Network
39133       summary: returns l3-interface-ipv4-address-list
39134       description: returns l3-interface-ipv4-address-list
39135       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39136       produces:
39137         - application/json
39138         - application/xml
39139       responses:
39140         "200":
39141           description: successful operation
39142           schema:
39143               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39144         "default":
39145           description: Response codes found in [response codes](https://wiki.onap.org/).
39146       parameters:
39147         - name: pnf-name
39148           in: path
39149           description: unique name of Physical Network Function.
39150           required: true
39151           type: string
39152           example: __PNF-NAME__
39153         - name: interface-name
39154           in: path
39155           description: Name that identifies the physical interface
39156           required: true
39157           type: string
39158           example: __INTERFACE-NAME__
39159         - name: interface-name
39160           in: path
39161           description: Name given to the interface
39162           required: true
39163           type: string
39164           example: __INTERFACE-NAME__
39165         - name: l3-interface-ipv4-address
39166           in: path
39167           description: IP address
39168           required: true
39169           type: string
39170           example: __L3-INTERFACE-IPV4-ADDRESS__
39171         - name: orchestration-status
39172           in: query
39173           description: orchestration-status is the status of orchestration on the PNF.
39174           required: false
39175           type: string
39176         - name: interface-id
39177           in: query
39178           description: ID of interface
39179           required: false
39180           type: string
39181         - name: macaddr
39182           in: query
39183           description: MAC address for the interface
39184           required: false
39185           type: string
39186         - name: network-name
39187           in: query
39188           description: Name of the network
39189           required: false
39190           type: string
39191         - name: vlan-id-inner
39192           in: query
39193           description: Inner VLAN tag
39194           required: false
39195           type: integer
39196           format: int64
39197         - name: neutron-network-id
39198           in: query
39199           description: Neutron network id of the interface that address belongs to
39200           required: false
39201           type: string
39202         - name: neutron-subnet-id
39203           in: query
39204           description: Neutron id of subnet that address belongs to
39205           required: false
39206           type: string
39207     put:
39208       tags:
39209         - Network
39210       summary: create or update an existing l3-interface-ipv4-address-list
39211       description: |
39212         Create or update an existing l3-interface-ipv4-address-list.
39213         #
39214         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
39215       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39216       consumes:
39217         - application/json
39218         - application/xml
39219       produces:
39220         - application/json
39221         - application/xml
39222       responses:
39223         "default":
39224           description: Response codes found in [response codes](https://wiki.onap.org/).
39225       parameters:
39226         - name: pnf-name
39227           in: path
39228           description: unique name of Physical Network Function.
39229           required: true
39230           type: string
39231           example: __PNF-NAME__
39232         - name: interface-name
39233           in: path
39234           description: Name that identifies the physical interface
39235           required: true
39236           type: string
39237           example: __INTERFACE-NAME__
39238         - name: interface-name
39239           in: path
39240           description: Name given to the interface
39241           required: true
39242           type: string
39243           example: __INTERFACE-NAME__
39244         - name: l3-interface-ipv4-address
39245           in: path
39246           description: IP address
39247           required: true
39248           type: string
39249           example: __L3-INTERFACE-IPV4-ADDRESS__
39250         - name: body
39251           in: body
39252           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39253           required: true
39254           schema:
39255             $ref: "#/definitions/l3-interface-ipv4-address-list"
39256     patch:
39257       tags:
39258         - Network
39259       summary: update an existing l3-interface-ipv4-address-list
39260       description: |
39261         Update an existing l3-interface-ipv4-address-list
39262         #
39263         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39264         The PUT operation will entirely replace an existing object.
39265         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.
39266         #
39267         Other differences between PUT and PATCH are:
39268         #
39269         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39270         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39271         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39272       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39273       consumes:
39274         - application/json
39275         - application/xml
39276       produces:
39277         - application/json
39278         - application/xml
39279       responses:
39280         "default":
39281           description: Response codes found in [response codes](https://wiki.onap.org/).
39282       parameters:
39283         - name: pnf-name
39284           in: path
39285           description: unique name of Physical Network Function.
39286           required: true
39287           type: string
39288           example: __PNF-NAME__
39289         - name: interface-name
39290           in: path
39291           description: Name that identifies the physical interface
39292           required: true
39293           type: string
39294           example: __INTERFACE-NAME__
39295         - name: interface-name
39296           in: path
39297           description: Name given to the interface
39298           required: true
39299           type: string
39300           example: __INTERFACE-NAME__
39301         - name: l3-interface-ipv4-address
39302           in: path
39303           description: IP address
39304           required: true
39305           type: string
39306           example: __L3-INTERFACE-IPV4-ADDRESS__
39307         - name: body
39308           in: body
39309           description: l3-interface-ipv4-address-list object that needs to be created or updated.
39310           required: true
39311           schema:
39312             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39313     delete:
39314       tags:
39315         - Network
39316       summary: delete an existing l3-interface-ipv4-address-list
39317       description: delete an existing l3-interface-ipv4-address-list
39318       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39319       consumes:
39320         - application/json
39321         - application/xml
39322       produces:
39323         - application/json
39324         - application/xml
39325       responses:
39326         "default":
39327           description: Response codes found in [response codes](https://wiki.onap.org/).
39328       parameters:
39329         - name: pnf-name
39330           in: path
39331           description: unique name of Physical Network Function.
39332           required: true
39333           type: string
39334           example: __PNF-NAME__
39335         - name: interface-name
39336           in: path
39337           description: Name that identifies the physical interface
39338           required: true
39339           type: string
39340           example: __INTERFACE-NAME__
39341         - name: interface-name
39342           in: path
39343           description: Name given to the interface
39344           required: true
39345           type: string
39346           example: __INTERFACE-NAME__
39347         - name: l3-interface-ipv4-address
39348           in: path
39349           description: IP address
39350           required: true
39351           type: string
39352           example: __L3-INTERFACE-IPV4-ADDRESS__
39353         - name: resource-version
39354           in: query
39355           description: resource-version for concurrency
39356           required: true
39357           type: string
39358   /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:
39359     put:
39360       tags:
39361         - Network
39362       summary: see node definition for valid relationships
39363       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39364       consumes:
39365         - application/json
39366         - application/xml
39367       produces:
39368         - application/json
39369         - application/xml
39370       responses:
39371         "default":
39372           description: Response codes found in [response codes](https://wiki.onap.org/).
39373       parameters:
39374         - name: pnf-name
39375           in: path
39376           description: unique name of Physical Network Function.
39377           required: true
39378           type: string
39379           example: __PNF-NAME__
39380         - name: interface-name
39381           in: path
39382           description: Name that identifies the physical interface
39383           required: true
39384           type: string
39385           example: __INTERFACE-NAME__
39386         - name: interface-name
39387           in: path
39388           description: Name given to the interface
39389           required: true
39390           type: string
39391           example: __INTERFACE-NAME__
39392         - name: l3-interface-ipv6-address
39393           in: path
39394           description: IP address
39395           required: true
39396           type: string
39397           example: __L3-INTERFACE-IPV6-ADDRESS__
39398         - name: body
39399           in: body
39400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39401           required: true
39402           schema:
39403             $ref: "#/definitions/relationship"
39404     delete:
39405       tags:
39406         - Network
39407       summary: delete an existing relationship
39408       description: delete an existing relationship
39409       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39410       consumes:
39411         - application/json
39412         - application/xml
39413       produces:
39414         - application/json
39415         - application/xml
39416       responses:
39417         "default":
39418           description: Response codes found in [response codes](https://wiki.onap.org/).
39419       parameters:
39420         - name: pnf-name
39421           in: path
39422           description: unique name of Physical Network Function.
39423           required: true
39424           type: string
39425           example: __PNF-NAME__
39426         - name: interface-name
39427           in: path
39428           description: Name that identifies the physical interface
39429           required: true
39430           type: string
39431           example: __INTERFACE-NAME__
39432         - name: interface-name
39433           in: path
39434           description: Name given to the interface
39435           required: true
39436           type: string
39437           example: __INTERFACE-NAME__
39438         - name: l3-interface-ipv6-address
39439           in: path
39440           description: IP address
39441           required: true
39442           type: string
39443           example: __L3-INTERFACE-IPV6-ADDRESS__
39444   /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}:
39445     get:
39446       tags:
39447         - Network
39448       summary: returns l3-interface-ipv6-address-list
39449       description: returns l3-interface-ipv6-address-list
39450       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39451       produces:
39452         - application/json
39453         - application/xml
39454       responses:
39455         "200":
39456           description: successful operation
39457           schema:
39458               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39459         "default":
39460           description: Response codes found in [response codes](https://wiki.onap.org/).
39461       parameters:
39462         - name: pnf-name
39463           in: path
39464           description: unique name of Physical Network Function.
39465           required: true
39466           type: string
39467           example: __PNF-NAME__
39468         - name: interface-name
39469           in: path
39470           description: Name that identifies the physical interface
39471           required: true
39472           type: string
39473           example: __INTERFACE-NAME__
39474         - name: interface-name
39475           in: path
39476           description: Name given to the interface
39477           required: true
39478           type: string
39479           example: __INTERFACE-NAME__
39480         - name: l3-interface-ipv6-address
39481           in: path
39482           description: IP address
39483           required: true
39484           type: string
39485           example: __L3-INTERFACE-IPV6-ADDRESS__
39486         - name: orchestration-status
39487           in: query
39488           description: orchestration-status is the status of orchestration on the PNF.
39489           required: false
39490           type: string
39491         - name: interface-id
39492           in: query
39493           description: ID of interface
39494           required: false
39495           type: string
39496         - name: macaddr
39497           in: query
39498           description: MAC address for the interface
39499           required: false
39500           type: string
39501         - name: network-name
39502           in: query
39503           description: Name of the network
39504           required: false
39505           type: string
39506         - name: vlan-id-inner
39507           in: query
39508           description: Inner VLAN tag
39509           required: false
39510           type: integer
39511           format: int64
39512         - name: neutron-network-id
39513           in: query
39514           description: Neutron network id of the interface that address belongs to
39515           required: false
39516           type: string
39517         - name: neutron-subnet-id
39518           in: query
39519           description: Neutron id of subnet that address belongs to
39520           required: false
39521           type: string
39522     put:
39523       tags:
39524         - Network
39525       summary: create or update an existing l3-interface-ipv6-address-list
39526       description: |
39527         Create or update an existing l3-interface-ipv6-address-list.
39528         #
39529         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
39530       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39531       consumes:
39532         - application/json
39533         - application/xml
39534       produces:
39535         - application/json
39536         - application/xml
39537       responses:
39538         "default":
39539           description: Response codes found in [response codes](https://wiki.onap.org/).
39540       parameters:
39541         - name: pnf-name
39542           in: path
39543           description: unique name of Physical Network Function.
39544           required: true
39545           type: string
39546           example: __PNF-NAME__
39547         - name: interface-name
39548           in: path
39549           description: Name that identifies the physical interface
39550           required: true
39551           type: string
39552           example: __INTERFACE-NAME__
39553         - name: interface-name
39554           in: path
39555           description: Name given to the interface
39556           required: true
39557           type: string
39558           example: __INTERFACE-NAME__
39559         - name: l3-interface-ipv6-address
39560           in: path
39561           description: IP address
39562           required: true
39563           type: string
39564           example: __L3-INTERFACE-IPV6-ADDRESS__
39565         - name: body
39566           in: body
39567           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39568           required: true
39569           schema:
39570             $ref: "#/definitions/l3-interface-ipv6-address-list"
39571     patch:
39572       tags:
39573         - Network
39574       summary: update an existing l3-interface-ipv6-address-list
39575       description: |
39576         Update an existing l3-interface-ipv6-address-list
39577         #
39578         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39579         The PUT operation will entirely replace an existing object.
39580         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.
39581         #
39582         Other differences between PUT and PATCH are:
39583         #
39584         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39585         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39586         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39587       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39588       consumes:
39589         - application/json
39590         - application/xml
39591       produces:
39592         - application/json
39593         - application/xml
39594       responses:
39595         "default":
39596           description: Response codes found in [response codes](https://wiki.onap.org/).
39597       parameters:
39598         - name: pnf-name
39599           in: path
39600           description: unique name of Physical Network Function.
39601           required: true
39602           type: string
39603           example: __PNF-NAME__
39604         - name: interface-name
39605           in: path
39606           description: Name that identifies the physical interface
39607           required: true
39608           type: string
39609           example: __INTERFACE-NAME__
39610         - name: interface-name
39611           in: path
39612           description: Name given to the interface
39613           required: true
39614           type: string
39615           example: __INTERFACE-NAME__
39616         - name: l3-interface-ipv6-address
39617           in: path
39618           description: IP address
39619           required: true
39620           type: string
39621           example: __L3-INTERFACE-IPV6-ADDRESS__
39622         - name: body
39623           in: body
39624           description: l3-interface-ipv6-address-list object that needs to be created or updated.
39625           required: true
39626           schema:
39627             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39628     delete:
39629       tags:
39630         - Network
39631       summary: delete an existing l3-interface-ipv6-address-list
39632       description: delete an existing l3-interface-ipv6-address-list
39633       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39634       consumes:
39635         - application/json
39636         - application/xml
39637       produces:
39638         - application/json
39639         - application/xml
39640       responses:
39641         "default":
39642           description: Response codes found in [response codes](https://wiki.onap.org/).
39643       parameters:
39644         - name: pnf-name
39645           in: path
39646           description: unique name of Physical Network Function.
39647           required: true
39648           type: string
39649           example: __PNF-NAME__
39650         - name: interface-name
39651           in: path
39652           description: Name that identifies the physical interface
39653           required: true
39654           type: string
39655           example: __INTERFACE-NAME__
39656         - name: interface-name
39657           in: path
39658           description: Name given to the interface
39659           required: true
39660           type: string
39661           example: __INTERFACE-NAME__
39662         - name: l3-interface-ipv6-address
39663           in: path
39664           description: IP address
39665           required: true
39666           type: string
39667           example: __L3-INTERFACE-IPV6-ADDRESS__
39668         - name: resource-version
39669           in: query
39670           description: resource-version for concurrency
39671           required: true
39672           type: string
39673   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39674     get:
39675       tags:
39676         - Network
39677       summary: returns l-interface
39678       description: returns l-interface
39679       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39680       produces:
39681         - application/json
39682         - application/xml
39683       responses:
39684         "200":
39685           description: successful operation
39686           schema:
39687               $ref: "#/getDefinitions/l-interface"
39688         "default":
39689           description: Response codes found in [response codes](https://wiki.onap.org/).
39690       parameters:
39691         - name: pnf-name
39692           in: path
39693           description: unique name of Physical Network Function.
39694           required: true
39695           type: string
39696           example: __PNF-NAME__
39697         - name: interface-name
39698           in: path
39699           description: Name that identifies the physical interface
39700           required: true
39701           type: string
39702           example: __INTERFACE-NAME__
39703         - name: interface-name
39704           in: path
39705           description: Name given to the interface
39706           required: true
39707           type: string
39708           example: __INTERFACE-NAME__
39709         - name: orchestration-status
39710           in: query
39711           description: orchestration-status is the status of orchestration on the PNF.
39712           required: false
39713           type: string
39714         - name: interface-id
39715           in: query
39716           description: ID of interface
39717           required: false
39718           type: string
39719         - name: macaddr
39720           in: query
39721           description: MAC address for the interface
39722           required: false
39723           type: string
39724         - name: network-name
39725           in: query
39726           description: Name of the network
39727           required: false
39728           type: string
39729     put:
39730       tags:
39731         - Network
39732       summary: create or update an existing l-interface
39733       description: |
39734         Create or update an existing l-interface.
39735         #
39736         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
39737       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39738       consumes:
39739         - application/json
39740         - application/xml
39741       produces:
39742         - application/json
39743         - application/xml
39744       responses:
39745         "default":
39746           description: Response codes found in [response codes](https://wiki.onap.org/).
39747       parameters:
39748         - name: pnf-name
39749           in: path
39750           description: unique name of Physical Network Function.
39751           required: true
39752           type: string
39753           example: __PNF-NAME__
39754         - name: interface-name
39755           in: path
39756           description: Name that identifies the physical interface
39757           required: true
39758           type: string
39759           example: __INTERFACE-NAME__
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         - name: body
39767           in: body
39768           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
39769           required: true
39770           schema:
39771             $ref: "#/definitions/l-interface"
39772     patch:
39773       tags:
39774         - Network
39775       summary: update an existing l-interface
39776       description: |
39777         Update an existing l-interface
39778         #
39779         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39780         The PUT operation will entirely replace an existing object.
39781         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.
39782         #
39783         Other differences between PUT and PATCH are:
39784         #
39785         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39786         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39787         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39788       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39789       consumes:
39790         - application/json
39791         - application/xml
39792       produces:
39793         - application/json
39794         - application/xml
39795       responses:
39796         "default":
39797           description: Response codes found in [response codes](https://wiki.onap.org/).
39798       parameters:
39799         - name: pnf-name
39800           in: path
39801           description: unique name of Physical Network Function.
39802           required: true
39803           type: string
39804           example: __PNF-NAME__
39805         - name: interface-name
39806           in: path
39807           description: Name that identifies the physical interface
39808           required: true
39809           type: string
39810           example: __INTERFACE-NAME__
39811         - name: interface-name
39812           in: path
39813           description: Name given to the interface
39814           required: true
39815           type: string
39816           example: __INTERFACE-NAME__
39817         - name: body
39818           in: body
39819           description: l-interface object that needs to be created or updated.
39820           required: true
39821           schema:
39822             $ref: "#/patchDefinitions/l-interface"
39823     delete:
39824       tags:
39825         - Network
39826       summary: delete an existing l-interface
39827       description: delete an existing l-interface
39828       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
39829       consumes:
39830         - application/json
39831         - application/xml
39832       produces:
39833         - application/json
39834         - application/xml
39835       responses:
39836         "default":
39837           description: Response codes found in [response codes](https://wiki.onap.org/).
39838       parameters:
39839         - name: pnf-name
39840           in: path
39841           description: unique name of Physical Network Function.
39842           required: true
39843           type: string
39844           example: __PNF-NAME__
39845         - name: interface-name
39846           in: path
39847           description: Name that identifies the physical interface
39848           required: true
39849           type: string
39850           example: __INTERFACE-NAME__
39851         - name: interface-name
39852           in: path
39853           description: Name given to the interface
39854           required: true
39855           type: string
39856           example: __INTERFACE-NAME__
39857         - name: resource-version
39858           in: query
39859           description: resource-version for concurrency
39860           required: true
39861           type: string
39862   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
39863     get:
39864       tags:
39865         - Network
39866       summary: returns l-interfaces
39867       description: returns l-interfaces
39868       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
39869       produces:
39870         - application/json
39871         - application/xml
39872       responses:
39873         "200":
39874           description: successful operation
39875           schema:
39876               $ref: "#/getDefinitions/l-interfaces"
39877         "default":
39878           description: Response codes found in [response codes](https://wiki.onap.org/).
39879       parameters:
39880         - name: pnf-name
39881           in: path
39882           description: unique name of Physical Network Function.
39883           required: true
39884           type: string
39885           example: __PNF-NAME__
39886         - name: interface-name
39887           in: path
39888           description: Name that identifies the physical interface
39889           required: true
39890           type: string
39891           example: __INTERFACE-NAME__
39892         - name: orchestration-status
39893           in: query
39894           description: orchestration-status is the status of orchestration on the PNF.
39895           required: false
39896           type: string
39897   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
39898     get:
39899       tags:
39900         - Network
39901       summary: returns p-interface
39902       description: returns p-interface
39903       operationId: getNetworkPnfsPnfPInterfacesPInterface
39904       produces:
39905         - application/json
39906         - application/xml
39907       responses:
39908         "200":
39909           description: successful operation
39910           schema:
39911               $ref: "#/getDefinitions/p-interface"
39912         "default":
39913           description: Response codes found in [response codes](https://wiki.onap.org/).
39914       parameters:
39915         - name: pnf-name
39916           in: path
39917           description: unique name of Physical Network Function.
39918           required: true
39919           type: string
39920           example: __PNF-NAME__
39921         - name: interface-name
39922           in: path
39923           description: Name that identifies the physical interface
39924           required: true
39925           type: string
39926           example: __INTERFACE-NAME__
39927         - name: orchestration-status
39928           in: query
39929           description: orchestration-status is the status of orchestration on the PNF.
39930           required: false
39931           type: string
39932     put:
39933       tags:
39934         - Network
39935       summary: create or update an existing p-interface
39936       description: |
39937         Create or update an existing p-interface.
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: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
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: pnf-name
39952           in: path
39953           description: unique name of Physical Network Function.
39954           required: true
39955           type: string
39956           example: __PNF-NAME__
39957         - name: interface-name
39958           in: path
39959           description: Name that identifies the physical interface
39960           required: true
39961           type: string
39962           example: __INTERFACE-NAME__
39963         - name: body
39964           in: body
39965           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfPInterfacesPInterface.json)
39966           required: true
39967           schema:
39968             $ref: "#/definitions/p-interface"
39969     patch:
39970       tags:
39971         - Network
39972       summary: update an existing p-interface
39973       description: |
39974         Update an existing p-interface
39975         #
39976         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39977         The PUT operation will entirely replace an existing object.
39978         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.
39979         #
39980         Other differences between PUT and PATCH are:
39981         #
39982         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39983         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39984         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39985       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
39986       consumes:
39987         - application/json
39988         - application/xml
39989       produces:
39990         - application/json
39991         - application/xml
39992       responses:
39993         "default":
39994           description: Response codes found in [response codes](https://wiki.onap.org/).
39995       parameters:
39996         - name: pnf-name
39997           in: path
39998           description: unique name of Physical Network Function.
39999           required: true
40000           type: string
40001           example: __PNF-NAME__
40002         - name: interface-name
40003           in: path
40004           description: Name that identifies the physical interface
40005           required: true
40006           type: string
40007           example: __INTERFACE-NAME__
40008         - name: body
40009           in: body
40010           description: p-interface object that needs to be created or updated.
40011           required: true
40012           schema:
40013             $ref: "#/patchDefinitions/p-interface"
40014     delete:
40015       tags:
40016         - Network
40017       summary: delete an existing p-interface
40018       description: delete an existing p-interface
40019       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
40020       consumes:
40021         - application/json
40022         - application/xml
40023       produces:
40024         - application/json
40025         - application/xml
40026       responses:
40027         "default":
40028           description: Response codes found in [response codes](https://wiki.onap.org/).
40029       parameters:
40030         - name: pnf-name
40031           in: path
40032           description: unique name of Physical Network Function.
40033           required: true
40034           type: string
40035           example: __PNF-NAME__
40036         - name: interface-name
40037           in: path
40038           description: Name that identifies the physical interface
40039           required: true
40040           type: string
40041           example: __INTERFACE-NAME__
40042         - name: resource-version
40043           in: query
40044           description: resource-version for concurrency
40045           required: true
40046           type: string
40047   /network/pnfs/pnf/{pnf-name}/p-interfaces:
40048     get:
40049       tags:
40050         - Network
40051       summary: returns p-interfaces
40052       description: returns p-interfaces
40053       operationId: getNetworkPnfsPnfPInterfaces
40054       produces:
40055         - application/json
40056         - application/xml
40057       responses:
40058         "200":
40059           description: successful operation
40060           schema:
40061               $ref: "#/getDefinitions/p-interfaces"
40062         "default":
40063           description: Response codes found in [response codes](https://wiki.onap.org/).
40064       parameters:
40065         - name: pnf-name
40066           in: path
40067           description: unique name of Physical Network Function.
40068           required: true
40069           type: string
40070           example: __PNF-NAME__
40071         - name: orchestration-status
40072           in: query
40073           description: orchestration-status is the status of orchestration on the PNF.
40074           required: false
40075           type: string
40076   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
40077     put:
40078       tags:
40079         - Network
40080       summary: see node definition for valid relationships
40081       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40082       consumes:
40083         - application/json
40084         - application/xml
40085       produces:
40086         - application/json
40087         - application/xml
40088       responses:
40089         "default":
40090           description: Response codes found in [response codes](https://wiki.onap.org/).
40091       parameters:
40092         - name: pnf-name
40093           in: path
40094           description: unique name of Physical Network Function.
40095           required: true
40096           type: string
40097           example: __PNF-NAME__
40098         - name: interface-name
40099           in: path
40100           description: Name that identifies the link aggregate interface
40101           required: true
40102           type: string
40103           example: __INTERFACE-NAME__
40104         - name: body
40105           in: body
40106           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
40107           required: true
40108           schema:
40109             $ref: "#/definitions/relationship"
40110     delete:
40111       tags:
40112         - Network
40113       summary: delete an existing relationship
40114       description: delete an existing relationship
40115       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
40116       consumes:
40117         - application/json
40118         - application/xml
40119       produces:
40120         - application/json
40121         - application/xml
40122       responses:
40123         "default":
40124           description: Response codes found in [response codes](https://wiki.onap.org/).
40125       parameters:
40126         - name: pnf-name
40127           in: path
40128           description: unique name of Physical Network Function.
40129           required: true
40130           type: string
40131           example: __PNF-NAME__
40132         - name: interface-name
40133           in: path
40134           description: Name that identifies the link aggregate interface
40135           required: true
40136           type: string
40137           example: __INTERFACE-NAME__
40138   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
40139     put:
40140       tags:
40141         - Network
40142       summary: see node definition for valid relationships
40143       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40144       consumes:
40145         - application/json
40146         - application/xml
40147       produces:
40148         - application/json
40149         - application/xml
40150       responses:
40151         "default":
40152           description: Response codes found in [response codes](https://wiki.onap.org/).
40153       parameters:
40154         - name: pnf-name
40155           in: path
40156           description: unique name of Physical Network Function.
40157           required: true
40158           type: string
40159           example: __PNF-NAME__
40160         - name: interface-name
40161           in: path
40162           description: Name that identifies the link aggregate interface
40163           required: true
40164           type: string
40165           example: __INTERFACE-NAME__
40166         - name: interface-name
40167           in: path
40168           description: Name given to the interface
40169           required: true
40170           type: string
40171           example: __INTERFACE-NAME__
40172         - name: vlan-interface
40173           in: path
40174           description: String that identifies the interface
40175           required: true
40176           type: string
40177           example: __VLAN-INTERFACE__
40178         - name: body
40179           in: body
40180           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
40181           required: true
40182           schema:
40183             $ref: "#/definitions/relationship"
40184     delete:
40185       tags:
40186         - Network
40187       summary: delete an existing relationship
40188       description: delete an existing relationship
40189       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
40190       consumes:
40191         - application/json
40192         - application/xml
40193       produces:
40194         - application/json
40195         - application/xml
40196       responses:
40197         "default":
40198           description: Response codes found in [response codes](https://wiki.onap.org/).
40199       parameters:
40200         - name: pnf-name
40201           in: path
40202           description: unique name of Physical Network Function.
40203           required: true
40204           type: string
40205           example: __PNF-NAME__
40206         - name: interface-name
40207           in: path
40208           description: Name that identifies the link aggregate interface
40209           required: true
40210           type: string
40211           example: __INTERFACE-NAME__
40212         - name: interface-name
40213           in: path
40214           description: Name given to the interface
40215           required: true
40216           type: string
40217           example: __INTERFACE-NAME__
40218         - name: vlan-interface
40219           in: path
40220           description: String that identifies the interface
40221           required: true
40222           type: string
40223           example: __VLAN-INTERFACE__
40224   /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:
40225     put:
40226       tags:
40227         - Network
40228       summary: see node definition for valid relationships
40229       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40230       consumes:
40231         - application/json
40232         - application/xml
40233       produces:
40234         - application/json
40235         - application/xml
40236       responses:
40237         "default":
40238           description: Response codes found in [response codes](https://wiki.onap.org/).
40239       parameters:
40240         - name: pnf-name
40241           in: path
40242           description: unique name of Physical Network Function.
40243           required: true
40244           type: string
40245           example: __PNF-NAME__
40246         - name: interface-name
40247           in: path
40248           description: Name that identifies the link aggregate interface
40249           required: true
40250           type: string
40251           example: __INTERFACE-NAME__
40252         - name: interface-name
40253           in: path
40254           description: Name given to the interface
40255           required: true
40256           type: string
40257           example: __INTERFACE-NAME__
40258         - name: vlan-interface
40259           in: path
40260           description: String that identifies the interface
40261           required: true
40262           type: string
40263           example: __VLAN-INTERFACE__
40264         - name: l3-interface-ipv4-address
40265           in: path
40266           description: IP address
40267           required: true
40268           type: string
40269           example: __L3-INTERFACE-IPV4-ADDRESS__
40270         - name: body
40271           in: body
40272           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40273           required: true
40274           schema:
40275             $ref: "#/definitions/relationship"
40276     delete:
40277       tags:
40278         - Network
40279       summary: delete an existing relationship
40280       description: delete an existing relationship
40281       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
40282       consumes:
40283         - application/json
40284         - application/xml
40285       produces:
40286         - application/json
40287         - application/xml
40288       responses:
40289         "default":
40290           description: Response codes found in [response codes](https://wiki.onap.org/).
40291       parameters:
40292         - name: pnf-name
40293           in: path
40294           description: unique name of Physical Network Function.
40295           required: true
40296           type: string
40297           example: __PNF-NAME__
40298         - name: interface-name
40299           in: path
40300           description: Name that identifies the link aggregate interface
40301           required: true
40302           type: string
40303           example: __INTERFACE-NAME__
40304         - name: interface-name
40305           in: path
40306           description: Name given to the interface
40307           required: true
40308           type: string
40309           example: __INTERFACE-NAME__
40310         - name: vlan-interface
40311           in: path
40312           description: String that identifies the interface
40313           required: true
40314           type: string
40315           example: __VLAN-INTERFACE__
40316         - name: l3-interface-ipv4-address
40317           in: path
40318           description: IP address
40319           required: true
40320           type: string
40321           example: __L3-INTERFACE-IPV4-ADDRESS__
40322   /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}:
40323     get:
40324       tags:
40325         - Network
40326       summary: returns l3-interface-ipv4-address-list
40327       description: returns l3-interface-ipv4-address-list
40328       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40329       produces:
40330         - application/json
40331         - application/xml
40332       responses:
40333         "200":
40334           description: successful operation
40335           schema:
40336               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40337         "default":
40338           description: Response codes found in [response codes](https://wiki.onap.org/).
40339       parameters:
40340         - name: pnf-name
40341           in: path
40342           description: unique name of Physical Network Function.
40343           required: true
40344           type: string
40345           example: __PNF-NAME__
40346         - name: interface-name
40347           in: path
40348           description: Name that identifies the link aggregate interface
40349           required: true
40350           type: string
40351           example: __INTERFACE-NAME__
40352         - name: interface-name
40353           in: path
40354           description: Name given to the interface
40355           required: true
40356           type: string
40357           example: __INTERFACE-NAME__
40358         - name: vlan-interface
40359           in: path
40360           description: String that identifies the interface
40361           required: true
40362           type: string
40363           example: __VLAN-INTERFACE__
40364         - name: l3-interface-ipv4-address
40365           in: path
40366           description: IP address
40367           required: true
40368           type: string
40369           example: __L3-INTERFACE-IPV4-ADDRESS__
40370         - name: orchestration-status
40371           in: query
40372           description: orchestration-status is the status of orchestration on the PNF.
40373           required: false
40374           type: string
40375         - name: interface-id
40376           in: query
40377           description: ID of interface
40378           required: false
40379           type: string
40380         - name: macaddr
40381           in: query
40382           description: MAC address for the interface
40383           required: false
40384           type: string
40385         - name: network-name
40386           in: query
40387           description: Name of the network
40388           required: false
40389           type: string
40390         - name: vlan-id-inner
40391           in: query
40392           description: Inner VLAN tag
40393           required: false
40394           type: integer
40395           format: int64
40396         - name: vpn-id
40397           in: query
40398           description: This indicates the customers VPN ID associated with this vlan
40399           required: false
40400           type: string
40401         - name: vlan-id-inner
40402           in: query
40403           description: Inner VLAN tag
40404           required: false
40405           type: integer
40406           format: int64
40407         - name: neutron-network-id
40408           in: query
40409           description: Neutron network id of the interface that address belongs to
40410           required: false
40411           type: string
40412         - name: neutron-subnet-id
40413           in: query
40414           description: Neutron id of subnet that address belongs to
40415           required: false
40416           type: string
40417     put:
40418       tags:
40419         - Network
40420       summary: create or update an existing l3-interface-ipv4-address-list
40421       description: |
40422         Create or update an existing l3-interface-ipv4-address-list.
40423         #
40424         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
40425       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40426       consumes:
40427         - application/json
40428         - application/xml
40429       produces:
40430         - application/json
40431         - application/xml
40432       responses:
40433         "default":
40434           description: Response codes found in [response codes](https://wiki.onap.org/).
40435       parameters:
40436         - name: pnf-name
40437           in: path
40438           description: unique name of Physical Network Function.
40439           required: true
40440           type: string
40441           example: __PNF-NAME__
40442         - name: interface-name
40443           in: path
40444           description: Name that identifies the link aggregate interface
40445           required: true
40446           type: string
40447           example: __INTERFACE-NAME__
40448         - name: interface-name
40449           in: path
40450           description: Name given to the interface
40451           required: true
40452           type: string
40453           example: __INTERFACE-NAME__
40454         - name: vlan-interface
40455           in: path
40456           description: String that identifies the interface
40457           required: true
40458           type: string
40459           example: __VLAN-INTERFACE__
40460         - name: l3-interface-ipv4-address
40461           in: path
40462           description: IP address
40463           required: true
40464           type: string
40465           example: __L3-INTERFACE-IPV4-ADDRESS__
40466         - name: body
40467           in: body
40468           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
40469           required: true
40470           schema:
40471             $ref: "#/definitions/l3-interface-ipv4-address-list"
40472     patch:
40473       tags:
40474         - Network
40475       summary: update an existing l3-interface-ipv4-address-list
40476       description: |
40477         Update an existing l3-interface-ipv4-address-list
40478         #
40479         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40480         The PUT operation will entirely replace an existing object.
40481         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.
40482         #
40483         Other differences between PUT and PATCH are:
40484         #
40485         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40486         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40487         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40488       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40489       consumes:
40490         - application/json
40491         - application/xml
40492       produces:
40493         - application/json
40494         - application/xml
40495       responses:
40496         "default":
40497           description: Response codes found in [response codes](https://wiki.onap.org/).
40498       parameters:
40499         - name: pnf-name
40500           in: path
40501           description: unique name of Physical Network Function.
40502           required: true
40503           type: string
40504           example: __PNF-NAME__
40505         - name: interface-name
40506           in: path
40507           description: Name that identifies the link aggregate interface
40508           required: true
40509           type: string
40510           example: __INTERFACE-NAME__
40511         - name: interface-name
40512           in: path
40513           description: Name given to the interface
40514           required: true
40515           type: string
40516           example: __INTERFACE-NAME__
40517         - name: vlan-interface
40518           in: path
40519           description: String that identifies the interface
40520           required: true
40521           type: string
40522           example: __VLAN-INTERFACE__
40523         - name: l3-interface-ipv4-address
40524           in: path
40525           description: IP address
40526           required: true
40527           type: string
40528           example: __L3-INTERFACE-IPV4-ADDRESS__
40529         - name: body
40530           in: body
40531           description: l3-interface-ipv4-address-list object that needs to be created or updated.
40532           required: true
40533           schema:
40534             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40535     delete:
40536       tags:
40537         - Network
40538       summary: delete an existing l3-interface-ipv4-address-list
40539       description: delete an existing l3-interface-ipv4-address-list
40540       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
40541       consumes:
40542         - application/json
40543         - application/xml
40544       produces:
40545         - application/json
40546         - application/xml
40547       responses:
40548         "default":
40549           description: Response codes found in [response codes](https://wiki.onap.org/).
40550       parameters:
40551         - name: pnf-name
40552           in: path
40553           description: unique name of Physical Network Function.
40554           required: true
40555           type: string
40556           example: __PNF-NAME__
40557         - name: interface-name
40558           in: path
40559           description: Name that identifies the link aggregate interface
40560           required: true
40561           type: string
40562           example: __INTERFACE-NAME__
40563         - name: interface-name
40564           in: path
40565           description: Name given to the interface
40566           required: true
40567           type: string
40568           example: __INTERFACE-NAME__
40569         - name: vlan-interface
40570           in: path
40571           description: String that identifies the interface
40572           required: true
40573           type: string
40574           example: __VLAN-INTERFACE__
40575         - name: l3-interface-ipv4-address
40576           in: path
40577           description: IP address
40578           required: true
40579           type: string
40580           example: __L3-INTERFACE-IPV4-ADDRESS__
40581         - name: resource-version
40582           in: query
40583           description: resource-version for concurrency
40584           required: true
40585           type: string
40586   /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:
40587     put:
40588       tags:
40589         - Network
40590       summary: see node definition for valid relationships
40591       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40592       consumes:
40593         - application/json
40594         - application/xml
40595       produces:
40596         - application/json
40597         - application/xml
40598       responses:
40599         "default":
40600           description: Response codes found in [response codes](https://wiki.onap.org/).
40601       parameters:
40602         - name: pnf-name
40603           in: path
40604           description: unique name of Physical Network Function.
40605           required: true
40606           type: string
40607           example: __PNF-NAME__
40608         - name: interface-name
40609           in: path
40610           description: Name that identifies the link aggregate interface
40611           required: true
40612           type: string
40613           example: __INTERFACE-NAME__
40614         - name: interface-name
40615           in: path
40616           description: Name given to the interface
40617           required: true
40618           type: string
40619           example: __INTERFACE-NAME__
40620         - name: vlan-interface
40621           in: path
40622           description: String that identifies the interface
40623           required: true
40624           type: string
40625           example: __VLAN-INTERFACE__
40626         - name: l3-interface-ipv6-address
40627           in: path
40628           description: IP address
40629           required: true
40630           type: string
40631           example: __L3-INTERFACE-IPV6-ADDRESS__
40632         - name: body
40633           in: body
40634           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40635           required: true
40636           schema:
40637             $ref: "#/definitions/relationship"
40638     delete:
40639       tags:
40640         - Network
40641       summary: delete an existing relationship
40642       description: delete an existing relationship
40643       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
40644       consumes:
40645         - application/json
40646         - application/xml
40647       produces:
40648         - application/json
40649         - application/xml
40650       responses:
40651         "default":
40652           description: Response codes found in [response codes](https://wiki.onap.org/).
40653       parameters:
40654         - name: pnf-name
40655           in: path
40656           description: unique name of Physical Network Function.
40657           required: true
40658           type: string
40659           example: __PNF-NAME__
40660         - name: interface-name
40661           in: path
40662           description: Name that identifies the link aggregate interface
40663           required: true
40664           type: string
40665           example: __INTERFACE-NAME__
40666         - name: interface-name
40667           in: path
40668           description: Name given to the interface
40669           required: true
40670           type: string
40671           example: __INTERFACE-NAME__
40672         - name: vlan-interface
40673           in: path
40674           description: String that identifies the interface
40675           required: true
40676           type: string
40677           example: __VLAN-INTERFACE__
40678         - name: l3-interface-ipv6-address
40679           in: path
40680           description: IP address
40681           required: true
40682           type: string
40683           example: __L3-INTERFACE-IPV6-ADDRESS__
40684   /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}:
40685     get:
40686       tags:
40687         - Network
40688       summary: returns l3-interface-ipv6-address-list
40689       description: returns l3-interface-ipv6-address-list
40690       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40691       produces:
40692         - application/json
40693         - application/xml
40694       responses:
40695         "200":
40696           description: successful operation
40697           schema:
40698               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
40699         "default":
40700           description: Response codes found in [response codes](https://wiki.onap.org/).
40701       parameters:
40702         - name: pnf-name
40703           in: path
40704           description: unique name of Physical Network Function.
40705           required: true
40706           type: string
40707           example: __PNF-NAME__
40708         - name: interface-name
40709           in: path
40710           description: Name that identifies the link aggregate interface
40711           required: true
40712           type: string
40713           example: __INTERFACE-NAME__
40714         - name: interface-name
40715           in: path
40716           description: Name given to the interface
40717           required: true
40718           type: string
40719           example: __INTERFACE-NAME__
40720         - name: vlan-interface
40721           in: path
40722           description: String that identifies the interface
40723           required: true
40724           type: string
40725           example: __VLAN-INTERFACE__
40726         - name: l3-interface-ipv6-address
40727           in: path
40728           description: IP address
40729           required: true
40730           type: string
40731           example: __L3-INTERFACE-IPV6-ADDRESS__
40732         - name: orchestration-status
40733           in: query
40734           description: orchestration-status is the status of orchestration on the PNF.
40735           required: false
40736           type: string
40737         - name: interface-id
40738           in: query
40739           description: ID of interface
40740           required: false
40741           type: string
40742         - name: macaddr
40743           in: query
40744           description: MAC address for the interface
40745           required: false
40746           type: string
40747         - name: network-name
40748           in: query
40749           description: Name of the network
40750           required: false
40751           type: string
40752         - name: vlan-id-inner
40753           in: query
40754           description: Inner VLAN tag
40755           required: false
40756           type: integer
40757           format: int64
40758         - name: vpn-id
40759           in: query
40760           description: This indicates the customers VPN ID associated with this vlan
40761           required: false
40762           type: string
40763         - name: vlan-id-inner
40764           in: query
40765           description: Inner VLAN tag
40766           required: false
40767           type: integer
40768           format: int64
40769         - name: neutron-network-id
40770           in: query
40771           description: Neutron network id of the interface that address belongs to
40772           required: false
40773           type: string
40774         - name: neutron-subnet-id
40775           in: query
40776           description: Neutron id of subnet that address belongs to
40777           required: false
40778           type: string
40779     put:
40780       tags:
40781         - Network
40782       summary: create or update an existing l3-interface-ipv6-address-list
40783       description: |
40784         Create or update an existing l3-interface-ipv6-address-list.
40785         #
40786         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
40787       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40788       consumes:
40789         - application/json
40790         - application/xml
40791       produces:
40792         - application/json
40793         - application/xml
40794       responses:
40795         "default":
40796           description: Response codes found in [response codes](https://wiki.onap.org/).
40797       parameters:
40798         - name: pnf-name
40799           in: path
40800           description: unique name of Physical Network Function.
40801           required: true
40802           type: string
40803           example: __PNF-NAME__
40804         - name: interface-name
40805           in: path
40806           description: Name that identifies the link aggregate interface
40807           required: true
40808           type: string
40809           example: __INTERFACE-NAME__
40810         - name: interface-name
40811           in: path
40812           description: Name given to the interface
40813           required: true
40814           type: string
40815           example: __INTERFACE-NAME__
40816         - name: vlan-interface
40817           in: path
40818           description: String that identifies the interface
40819           required: true
40820           type: string
40821           example: __VLAN-INTERFACE__
40822         - name: l3-interface-ipv6-address
40823           in: path
40824           description: IP address
40825           required: true
40826           type: string
40827           example: __L3-INTERFACE-IPV6-ADDRESS__
40828         - name: body
40829           in: body
40830           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
40831           required: true
40832           schema:
40833             $ref: "#/definitions/l3-interface-ipv6-address-list"
40834     patch:
40835       tags:
40836         - Network
40837       summary: update an existing l3-interface-ipv6-address-list
40838       description: |
40839         Update an existing l3-interface-ipv6-address-list
40840         #
40841         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40842         The PUT operation will entirely replace an existing object.
40843         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.
40844         #
40845         Other differences between PUT and PATCH are:
40846         #
40847         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40848         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40849         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40850       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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 link aggregate interface
40870           required: true
40871           type: string
40872           example: __INTERFACE-NAME__
40873         - name: interface-name
40874           in: path
40875           description: Name given to the interface
40876           required: true
40877           type: string
40878           example: __INTERFACE-NAME__
40879         - name: vlan-interface
40880           in: path
40881           description: String that identifies the interface
40882           required: true
40883           type: string
40884           example: __VLAN-INTERFACE__
40885         - name: l3-interface-ipv6-address
40886           in: path
40887           description: IP address
40888           required: true
40889           type: string
40890           example: __L3-INTERFACE-IPV6-ADDRESS__
40891         - name: body
40892           in: body
40893           description: l3-interface-ipv6-address-list object that needs to be created or updated.
40894           required: true
40895           schema:
40896             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
40897     delete:
40898       tags:
40899         - Network
40900       summary: delete an existing l3-interface-ipv6-address-list
40901       description: delete an existing l3-interface-ipv6-address-list
40902       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
40903       consumes:
40904         - application/json
40905         - application/xml
40906       produces:
40907         - application/json
40908         - application/xml
40909       responses:
40910         "default":
40911           description: Response codes found in [response codes](https://wiki.onap.org/).
40912       parameters:
40913         - name: pnf-name
40914           in: path
40915           description: unique name of Physical Network Function.
40916           required: true
40917           type: string
40918           example: __PNF-NAME__
40919         - name: interface-name
40920           in: path
40921           description: Name that identifies the link aggregate interface
40922           required: true
40923           type: string
40924           example: __INTERFACE-NAME__
40925         - name: interface-name
40926           in: path
40927           description: Name given to the interface
40928           required: true
40929           type: string
40930           example: __INTERFACE-NAME__
40931         - name: vlan-interface
40932           in: path
40933           description: String that identifies the interface
40934           required: true
40935           type: string
40936           example: __VLAN-INTERFACE__
40937         - name: l3-interface-ipv6-address
40938           in: path
40939           description: IP address
40940           required: true
40941           type: string
40942           example: __L3-INTERFACE-IPV6-ADDRESS__
40943         - name: resource-version
40944           in: query
40945           description: resource-version for concurrency
40946           required: true
40947           type: string
40948   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
40949     get:
40950       tags:
40951         - Network
40952       summary: returns vlan
40953       description: returns vlan
40954       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
40955       produces:
40956         - application/json
40957         - application/xml
40958       responses:
40959         "200":
40960           description: successful operation
40961           schema:
40962               $ref: "#/getDefinitions/vlan"
40963         "default":
40964           description: Response codes found in [response codes](https://wiki.onap.org/).
40965       parameters:
40966         - name: pnf-name
40967           in: path
40968           description: unique name of Physical Network Function.
40969           required: true
40970           type: string
40971           example: __PNF-NAME__
40972         - name: interface-name
40973           in: path
40974           description: Name that identifies the link aggregate interface
40975           required: true
40976           type: string
40977           example: __INTERFACE-NAME__
40978         - name: interface-name
40979           in: path
40980           description: Name given to the interface
40981           required: true
40982           type: string
40983           example: __INTERFACE-NAME__
40984         - name: vlan-interface
40985           in: path
40986           description: String that identifies the interface
40987           required: true
40988           type: string
40989           example: __VLAN-INTERFACE__
40990         - name: orchestration-status
40991           in: query
40992           description: orchestration-status is the status of orchestration on the PNF.
40993           required: false
40994           type: string
40995         - name: interface-id
40996           in: query
40997           description: ID of interface
40998           required: false
40999           type: string
41000         - name: macaddr
41001           in: query
41002           description: MAC address for the interface
41003           required: false
41004           type: string
41005         - name: network-name
41006           in: query
41007           description: Name of the network
41008           required: false
41009           type: string
41010         - name: vlan-id-inner
41011           in: query
41012           description: Inner VLAN tag
41013           required: false
41014           type: integer
41015           format: int64
41016         - name: vpn-id
41017           in: query
41018           description: This indicates the customers VPN ID associated with this vlan
41019           required: false
41020           type: string
41021     put:
41022       tags:
41023         - Network
41024       summary: create or update an existing vlan
41025       description: |
41026         Create or update an existing vlan.
41027         #
41028         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
41029       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41030       consumes:
41031         - application/json
41032         - application/xml
41033       produces:
41034         - application/json
41035         - application/xml
41036       responses:
41037         "default":
41038           description: Response codes found in [response codes](https://wiki.onap.org/).
41039       parameters:
41040         - name: pnf-name
41041           in: path
41042           description: unique name of Physical Network Function.
41043           required: true
41044           type: string
41045           example: __PNF-NAME__
41046         - name: interface-name
41047           in: path
41048           description: Name that identifies the link aggregate interface
41049           required: true
41050           type: string
41051           example: __INTERFACE-NAME__
41052         - name: interface-name
41053           in: path
41054           description: Name given to the interface
41055           required: true
41056           type: string
41057           example: __INTERFACE-NAME__
41058         - name: vlan-interface
41059           in: path
41060           description: String that identifies the interface
41061           required: true
41062           type: string
41063           example: __VLAN-INTERFACE__
41064         - name: body
41065           in: body
41066           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
41067           required: true
41068           schema:
41069             $ref: "#/definitions/vlan"
41070     patch:
41071       tags:
41072         - Network
41073       summary: update an existing vlan
41074       description: |
41075         Update an existing vlan
41076         #
41077         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41078         The PUT operation will entirely replace an existing object.
41079         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.
41080         #
41081         Other differences between PUT and PATCH are:
41082         #
41083         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41084         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41085         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41086       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41087       consumes:
41088         - application/json
41089         - application/xml
41090       produces:
41091         - application/json
41092         - application/xml
41093       responses:
41094         "default":
41095           description: Response codes found in [response codes](https://wiki.onap.org/).
41096       parameters:
41097         - name: pnf-name
41098           in: path
41099           description: unique name of Physical Network Function.
41100           required: true
41101           type: string
41102           example: __PNF-NAME__
41103         - name: interface-name
41104           in: path
41105           description: Name that identifies the link aggregate interface
41106           required: true
41107           type: string
41108           example: __INTERFACE-NAME__
41109         - name: interface-name
41110           in: path
41111           description: Name given to the interface
41112           required: true
41113           type: string
41114           example: __INTERFACE-NAME__
41115         - name: vlan-interface
41116           in: path
41117           description: String that identifies the interface
41118           required: true
41119           type: string
41120           example: __VLAN-INTERFACE__
41121         - name: body
41122           in: body
41123           description: vlan object that needs to be created or updated.
41124           required: true
41125           schema:
41126             $ref: "#/patchDefinitions/vlan"
41127     delete:
41128       tags:
41129         - Network
41130       summary: delete an existing vlan
41131       description: delete an existing vlan
41132       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
41133       consumes:
41134         - application/json
41135         - application/xml
41136       produces:
41137         - application/json
41138         - application/xml
41139       responses:
41140         "default":
41141           description: Response codes found in [response codes](https://wiki.onap.org/).
41142       parameters:
41143         - name: pnf-name
41144           in: path
41145           description: unique name of Physical Network Function.
41146           required: true
41147           type: string
41148           example: __PNF-NAME__
41149         - name: interface-name
41150           in: path
41151           description: Name that identifies the link aggregate interface
41152           required: true
41153           type: string
41154           example: __INTERFACE-NAME__
41155         - name: interface-name
41156           in: path
41157           description: Name given to the interface
41158           required: true
41159           type: string
41160           example: __INTERFACE-NAME__
41161         - name: vlan-interface
41162           in: path
41163           description: String that identifies the interface
41164           required: true
41165           type: string
41166           example: __VLAN-INTERFACE__
41167         - name: resource-version
41168           in: query
41169           description: resource-version for concurrency
41170           required: true
41171           type: string
41172   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
41173     get:
41174       tags:
41175         - Network
41176       summary: returns vlans
41177       description: returns vlans
41178       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
41179       produces:
41180         - application/json
41181         - application/xml
41182       responses:
41183         "200":
41184           description: successful operation
41185           schema:
41186               $ref: "#/getDefinitions/vlans"
41187         "default":
41188           description: Response codes found in [response codes](https://wiki.onap.org/).
41189       parameters:
41190         - name: pnf-name
41191           in: path
41192           description: unique name of Physical Network Function.
41193           required: true
41194           type: string
41195           example: __PNF-NAME__
41196         - name: interface-name
41197           in: path
41198           description: Name that identifies the link aggregate interface
41199           required: true
41200           type: string
41201           example: __INTERFACE-NAME__
41202         - name: interface-name
41203           in: path
41204           description: Name given to the interface
41205           required: true
41206           type: string
41207           example: __INTERFACE-NAME__
41208         - name: orchestration-status
41209           in: query
41210           description: orchestration-status is the status of orchestration on the PNF.
41211           required: false
41212           type: string
41213         - name: interface-id
41214           in: query
41215           description: ID of interface
41216           required: false
41217           type: string
41218         - name: macaddr
41219           in: query
41220           description: MAC address for the interface
41221           required: false
41222           type: string
41223         - name: network-name
41224           in: query
41225           description: Name of the network
41226           required: false
41227           type: string
41228   /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:
41229     put:
41230       tags:
41231         - Network
41232       summary: see node definition for valid relationships
41233       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41234       consumes:
41235         - application/json
41236         - application/xml
41237       produces:
41238         - application/json
41239         - application/xml
41240       responses:
41241         "default":
41242           description: Response codes found in [response codes](https://wiki.onap.org/).
41243       parameters:
41244         - name: pnf-name
41245           in: path
41246           description: unique name of Physical Network Function.
41247           required: true
41248           type: string
41249           example: __PNF-NAME__
41250         - name: interface-name
41251           in: path
41252           description: Name that identifies the link aggregate interface
41253           required: true
41254           type: string
41255           example: __INTERFACE-NAME__
41256         - name: interface-name
41257           in: path
41258           description: Name given to the interface
41259           required: true
41260           type: string
41261           example: __INTERFACE-NAME__
41262         - name: pci-id
41263           in: path
41264           description: PCI ID used to identify the sriov-vf
41265           required: true
41266           type: string
41267           example: __PCI-ID__
41268         - name: body
41269           in: body
41270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41271           required: true
41272           schema:
41273             $ref: "#/definitions/relationship"
41274     delete:
41275       tags:
41276         - Network
41277       summary: delete an existing relationship
41278       description: delete an existing relationship
41279       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
41280       consumes:
41281         - application/json
41282         - application/xml
41283       produces:
41284         - application/json
41285         - application/xml
41286       responses:
41287         "default":
41288           description: Response codes found in [response codes](https://wiki.onap.org/).
41289       parameters:
41290         - name: pnf-name
41291           in: path
41292           description: unique name of Physical Network Function.
41293           required: true
41294           type: string
41295           example: __PNF-NAME__
41296         - name: interface-name
41297           in: path
41298           description: Name that identifies the link aggregate interface
41299           required: true
41300           type: string
41301           example: __INTERFACE-NAME__
41302         - name: interface-name
41303           in: path
41304           description: Name given to the interface
41305           required: true
41306           type: string
41307           example: __INTERFACE-NAME__
41308         - name: pci-id
41309           in: path
41310           description: PCI ID used to identify the sriov-vf
41311           required: true
41312           type: string
41313           example: __PCI-ID__
41314   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
41315     get:
41316       tags:
41317         - Network
41318       summary: returns sriov-vf
41319       description: returns sriov-vf
41320       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41321       produces:
41322         - application/json
41323         - application/xml
41324       responses:
41325         "200":
41326           description: successful operation
41327           schema:
41328               $ref: "#/getDefinitions/sriov-vf"
41329         "default":
41330           description: Response codes found in [response codes](https://wiki.onap.org/).
41331       parameters:
41332         - name: pnf-name
41333           in: path
41334           description: unique name of Physical Network Function.
41335           required: true
41336           type: string
41337           example: __PNF-NAME__
41338         - name: interface-name
41339           in: path
41340           description: Name that identifies the link aggregate interface
41341           required: true
41342           type: string
41343           example: __INTERFACE-NAME__
41344         - name: interface-name
41345           in: path
41346           description: Name given to the interface
41347           required: true
41348           type: string
41349           example: __INTERFACE-NAME__
41350         - name: pci-id
41351           in: path
41352           description: PCI ID used to identify the sriov-vf
41353           required: true
41354           type: string
41355           example: __PCI-ID__
41356         - name: orchestration-status
41357           in: query
41358           description: orchestration-status is the status of orchestration on the PNF.
41359           required: false
41360           type: string
41361         - name: interface-id
41362           in: query
41363           description: ID of interface
41364           required: false
41365           type: string
41366         - name: macaddr
41367           in: query
41368           description: MAC address for the interface
41369           required: false
41370           type: string
41371         - name: network-name
41372           in: query
41373           description: Name of the network
41374           required: false
41375           type: string
41376         - name: vf-vlan-filter
41377           in: query
41378           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
41379           required: false
41380           type: string
41381         - name: vf-mac-filter
41382           in: query
41383           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
41384           required: false
41385           type: string
41386         - name: vf-vlan-strip
41387           in: query
41388           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
41389           required: false
41390           type: boolean
41391         - name: neutron-network-id
41392           in: query
41393           description: Neutron network id of the interface
41394           required: false
41395           type: string
41396     put:
41397       tags:
41398         - Network
41399       summary: create or update an existing sriov-vf
41400       description: |
41401         Create or update an existing sriov-vf.
41402         #
41403         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
41404       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41405       consumes:
41406         - application/json
41407         - application/xml
41408       produces:
41409         - application/json
41410         - application/xml
41411       responses:
41412         "default":
41413           description: Response codes found in [response codes](https://wiki.onap.org/).
41414       parameters:
41415         - name: pnf-name
41416           in: path
41417           description: unique name of Physical Network Function.
41418           required: true
41419           type: string
41420           example: __PNF-NAME__
41421         - name: interface-name
41422           in: path
41423           description: Name that identifies the link aggregate interface
41424           required: true
41425           type: string
41426           example: __INTERFACE-NAME__
41427         - name: interface-name
41428           in: path
41429           description: Name given to the interface
41430           required: true
41431           type: string
41432           example: __INTERFACE-NAME__
41433         - name: pci-id
41434           in: path
41435           description: PCI ID used to identify the sriov-vf
41436           required: true
41437           type: string
41438           example: __PCI-ID__
41439         - name: body
41440           in: body
41441           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
41442           required: true
41443           schema:
41444             $ref: "#/definitions/sriov-vf"
41445     patch:
41446       tags:
41447         - Network
41448       summary: update an existing sriov-vf
41449       description: |
41450         Update an existing sriov-vf
41451         #
41452         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41453         The PUT operation will entirely replace an existing object.
41454         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.
41455         #
41456         Other differences between PUT and PATCH are:
41457         #
41458         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41459         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41460         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41461       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41462       consumes:
41463         - application/json
41464         - application/xml
41465       produces:
41466         - application/json
41467         - application/xml
41468       responses:
41469         "default":
41470           description: Response codes found in [response codes](https://wiki.onap.org/).
41471       parameters:
41472         - name: pnf-name
41473           in: path
41474           description: unique name of Physical Network Function.
41475           required: true
41476           type: string
41477           example: __PNF-NAME__
41478         - name: interface-name
41479           in: path
41480           description: Name that identifies the link aggregate interface
41481           required: true
41482           type: string
41483           example: __INTERFACE-NAME__
41484         - name: interface-name
41485           in: path
41486           description: Name given to the interface
41487           required: true
41488           type: string
41489           example: __INTERFACE-NAME__
41490         - name: pci-id
41491           in: path
41492           description: PCI ID used to identify the sriov-vf
41493           required: true
41494           type: string
41495           example: __PCI-ID__
41496         - name: body
41497           in: body
41498           description: sriov-vf object that needs to be created or updated.
41499           required: true
41500           schema:
41501             $ref: "#/patchDefinitions/sriov-vf"
41502     delete:
41503       tags:
41504         - Network
41505       summary: delete an existing sriov-vf
41506       description: delete an existing sriov-vf
41507       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
41508       consumes:
41509         - application/json
41510         - application/xml
41511       produces:
41512         - application/json
41513         - application/xml
41514       responses:
41515         "default":
41516           description: Response codes found in [response codes](https://wiki.onap.org/).
41517       parameters:
41518         - name: pnf-name
41519           in: path
41520           description: unique name of Physical Network Function.
41521           required: true
41522           type: string
41523           example: __PNF-NAME__
41524         - name: interface-name
41525           in: path
41526           description: Name that identifies the link aggregate interface
41527           required: true
41528           type: string
41529           example: __INTERFACE-NAME__
41530         - name: interface-name
41531           in: path
41532           description: Name given to the interface
41533           required: true
41534           type: string
41535           example: __INTERFACE-NAME__
41536         - name: pci-id
41537           in: path
41538           description: PCI ID used to identify the sriov-vf
41539           required: true
41540           type: string
41541           example: __PCI-ID__
41542         - name: resource-version
41543           in: query
41544           description: resource-version for concurrency
41545           required: true
41546           type: string
41547   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
41548     get:
41549       tags:
41550         - Network
41551       summary: returns sriov-vfs
41552       description: returns sriov-vfs
41553       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
41554       produces:
41555         - application/json
41556         - application/xml
41557       responses:
41558         "200":
41559           description: successful operation
41560           schema:
41561               $ref: "#/getDefinitions/sriov-vfs"
41562         "default":
41563           description: Response codes found in [response codes](https://wiki.onap.org/).
41564       parameters:
41565         - name: pnf-name
41566           in: path
41567           description: unique name of Physical Network Function.
41568           required: true
41569           type: string
41570           example: __PNF-NAME__
41571         - name: interface-name
41572           in: path
41573           description: Name that identifies the link aggregate interface
41574           required: true
41575           type: string
41576           example: __INTERFACE-NAME__
41577         - name: interface-name
41578           in: path
41579           description: Name given to the interface
41580           required: true
41581           type: string
41582           example: __INTERFACE-NAME__
41583         - name: orchestration-status
41584           in: query
41585           description: orchestration-status is the status of orchestration on the PNF.
41586           required: false
41587           type: string
41588         - name: interface-id
41589           in: query
41590           description: ID of interface
41591           required: false
41592           type: string
41593         - name: macaddr
41594           in: query
41595           description: MAC address for the interface
41596           required: false
41597           type: string
41598         - name: network-name
41599           in: query
41600           description: Name of the network
41601           required: false
41602           type: string
41603   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
41604     put:
41605       tags:
41606         - Network
41607       summary: see node definition for valid relationships
41608       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41609       consumes:
41610         - application/json
41611         - application/xml
41612       produces:
41613         - application/json
41614         - application/xml
41615       responses:
41616         "default":
41617           description: Response codes found in [response codes](https://wiki.onap.org/).
41618       parameters:
41619         - name: pnf-name
41620           in: path
41621           description: unique name of Physical Network Function.
41622           required: true
41623           type: string
41624           example: __PNF-NAME__
41625         - name: interface-name
41626           in: path
41627           description: Name that identifies the link aggregate interface
41628           required: true
41629           type: string
41630           example: __INTERFACE-NAME__
41631         - name: interface-name
41632           in: path
41633           description: Name given to the interface
41634           required: true
41635           type: string
41636           example: __INTERFACE-NAME__
41637         - name: body
41638           in: body
41639           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
41640           required: true
41641           schema:
41642             $ref: "#/definitions/relationship"
41643     delete:
41644       tags:
41645         - Network
41646       summary: delete an existing relationship
41647       description: delete an existing relationship
41648       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
41649       consumes:
41650         - application/json
41651         - application/xml
41652       produces:
41653         - application/json
41654         - application/xml
41655       responses:
41656         "default":
41657           description: Response codes found in [response codes](https://wiki.onap.org/).
41658       parameters:
41659         - name: pnf-name
41660           in: path
41661           description: unique name of Physical Network Function.
41662           required: true
41663           type: string
41664           example: __PNF-NAME__
41665         - name: interface-name
41666           in: path
41667           description: Name that identifies the link aggregate interface
41668           required: true
41669           type: string
41670           example: __INTERFACE-NAME__
41671         - name: interface-name
41672           in: path
41673           description: Name given to the interface
41674           required: true
41675           type: string
41676           example: __INTERFACE-NAME__
41677   /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:
41678     put:
41679       tags:
41680         - Network
41681       summary: see node definition for valid relationships
41682       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41683       consumes:
41684         - application/json
41685         - application/xml
41686       produces:
41687         - application/json
41688         - application/xml
41689       responses:
41690         "default":
41691           description: Response codes found in [response codes](https://wiki.onap.org/).
41692       parameters:
41693         - name: pnf-name
41694           in: path
41695           description: unique name of Physical Network Function.
41696           required: true
41697           type: string
41698           example: __PNF-NAME__
41699         - name: interface-name
41700           in: path
41701           description: Name that identifies the link aggregate interface
41702           required: true
41703           type: string
41704           example: __INTERFACE-NAME__
41705         - name: interface-name
41706           in: path
41707           description: Name given to the interface
41708           required: true
41709           type: string
41710           example: __INTERFACE-NAME__
41711         - name: l3-interface-ipv4-address
41712           in: path
41713           description: IP address
41714           required: true
41715           type: string
41716           example: __L3-INTERFACE-IPV4-ADDRESS__
41717         - name: body
41718           in: body
41719           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41720           required: true
41721           schema:
41722             $ref: "#/definitions/relationship"
41723     delete:
41724       tags:
41725         - Network
41726       summary: delete an existing relationship
41727       description: delete an existing relationship
41728       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
41729       consumes:
41730         - application/json
41731         - application/xml
41732       produces:
41733         - application/json
41734         - application/xml
41735       responses:
41736         "default":
41737           description: Response codes found in [response codes](https://wiki.onap.org/).
41738       parameters:
41739         - name: pnf-name
41740           in: path
41741           description: unique name of Physical Network Function.
41742           required: true
41743           type: string
41744           example: __PNF-NAME__
41745         - name: interface-name
41746           in: path
41747           description: Name that identifies the link aggregate interface
41748           required: true
41749           type: string
41750           example: __INTERFACE-NAME__
41751         - name: interface-name
41752           in: path
41753           description: Name given to the interface
41754           required: true
41755           type: string
41756           example: __INTERFACE-NAME__
41757         - name: l3-interface-ipv4-address
41758           in: path
41759           description: IP address
41760           required: true
41761           type: string
41762           example: __L3-INTERFACE-IPV4-ADDRESS__
41763   /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}:
41764     get:
41765       tags:
41766         - Network
41767       summary: returns l3-interface-ipv4-address-list
41768       description: returns l3-interface-ipv4-address-list
41769       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41770       produces:
41771         - application/json
41772         - application/xml
41773       responses:
41774         "200":
41775           description: successful operation
41776           schema:
41777               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41778         "default":
41779           description: Response codes found in [response codes](https://wiki.onap.org/).
41780       parameters:
41781         - name: pnf-name
41782           in: path
41783           description: unique name of Physical Network Function.
41784           required: true
41785           type: string
41786           example: __PNF-NAME__
41787         - name: interface-name
41788           in: path
41789           description: Name that identifies the link aggregate interface
41790           required: true
41791           type: string
41792           example: __INTERFACE-NAME__
41793         - name: interface-name
41794           in: path
41795           description: Name given to the interface
41796           required: true
41797           type: string
41798           example: __INTERFACE-NAME__
41799         - name: l3-interface-ipv4-address
41800           in: path
41801           description: IP address
41802           required: true
41803           type: string
41804           example: __L3-INTERFACE-IPV4-ADDRESS__
41805         - name: orchestration-status
41806           in: query
41807           description: orchestration-status is the status of orchestration on the PNF.
41808           required: false
41809           type: string
41810         - name: interface-id
41811           in: query
41812           description: ID of interface
41813           required: false
41814           type: string
41815         - name: macaddr
41816           in: query
41817           description: MAC address for the interface
41818           required: false
41819           type: string
41820         - name: network-name
41821           in: query
41822           description: Name of the network
41823           required: false
41824           type: string
41825         - name: vlan-id-inner
41826           in: query
41827           description: Inner VLAN tag
41828           required: false
41829           type: integer
41830           format: int64
41831         - name: neutron-network-id
41832           in: query
41833           description: Neutron network id of the interface that address belongs to
41834           required: false
41835           type: string
41836         - name: neutron-subnet-id
41837           in: query
41838           description: Neutron id of subnet that address belongs to
41839           required: false
41840           type: string
41841     put:
41842       tags:
41843         - Network
41844       summary: create or update an existing l3-interface-ipv4-address-list
41845       description: |
41846         Create or update an existing l3-interface-ipv4-address-list.
41847         #
41848         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
41849       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41850       consumes:
41851         - application/json
41852         - application/xml
41853       produces:
41854         - application/json
41855         - application/xml
41856       responses:
41857         "default":
41858           description: Response codes found in [response codes](https://wiki.onap.org/).
41859       parameters:
41860         - name: pnf-name
41861           in: path
41862           description: unique name of Physical Network Function.
41863           required: true
41864           type: string
41865           example: __PNF-NAME__
41866         - name: interface-name
41867           in: path
41868           description: Name that identifies the link aggregate interface
41869           required: true
41870           type: string
41871           example: __INTERFACE-NAME__
41872         - name: interface-name
41873           in: path
41874           description: Name given to the interface
41875           required: true
41876           type: string
41877           example: __INTERFACE-NAME__
41878         - name: l3-interface-ipv4-address
41879           in: path
41880           description: IP address
41881           required: true
41882           type: string
41883           example: __L3-INTERFACE-IPV4-ADDRESS__
41884         - name: body
41885           in: body
41886           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
41887           required: true
41888           schema:
41889             $ref: "#/definitions/l3-interface-ipv4-address-list"
41890     patch:
41891       tags:
41892         - Network
41893       summary: update an existing l3-interface-ipv4-address-list
41894       description: |
41895         Update an existing l3-interface-ipv4-address-list
41896         #
41897         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41898         The PUT operation will entirely replace an existing object.
41899         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.
41900         #
41901         Other differences between PUT and PATCH are:
41902         #
41903         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41904         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41905         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41906       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41907       consumes:
41908         - application/json
41909         - application/xml
41910       produces:
41911         - application/json
41912         - application/xml
41913       responses:
41914         "default":
41915           description: Response codes found in [response codes](https://wiki.onap.org/).
41916       parameters:
41917         - name: pnf-name
41918           in: path
41919           description: unique name of Physical Network Function.
41920           required: true
41921           type: string
41922           example: __PNF-NAME__
41923         - name: interface-name
41924           in: path
41925           description: Name that identifies the link aggregate interface
41926           required: true
41927           type: string
41928           example: __INTERFACE-NAME__
41929         - name: interface-name
41930           in: path
41931           description: Name given to the interface
41932           required: true
41933           type: string
41934           example: __INTERFACE-NAME__
41935         - name: l3-interface-ipv4-address
41936           in: path
41937           description: IP address
41938           required: true
41939           type: string
41940           example: __L3-INTERFACE-IPV4-ADDRESS__
41941         - name: body
41942           in: body
41943           description: l3-interface-ipv4-address-list object that needs to be created or updated.
41944           required: true
41945           schema:
41946             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
41947     delete:
41948       tags:
41949         - Network
41950       summary: delete an existing l3-interface-ipv4-address-list
41951       description: delete an existing l3-interface-ipv4-address-list
41952       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
41953       consumes:
41954         - application/json
41955         - application/xml
41956       produces:
41957         - application/json
41958         - application/xml
41959       responses:
41960         "default":
41961           description: Response codes found in [response codes](https://wiki.onap.org/).
41962       parameters:
41963         - name: pnf-name
41964           in: path
41965           description: unique name of Physical Network Function.
41966           required: true
41967           type: string
41968           example: __PNF-NAME__
41969         - name: interface-name
41970           in: path
41971           description: Name that identifies the link aggregate interface
41972           required: true
41973           type: string
41974           example: __INTERFACE-NAME__
41975         - name: interface-name
41976           in: path
41977           description: Name given to the interface
41978           required: true
41979           type: string
41980           example: __INTERFACE-NAME__
41981         - name: l3-interface-ipv4-address
41982           in: path
41983           description: IP address
41984           required: true
41985           type: string
41986           example: __L3-INTERFACE-IPV4-ADDRESS__
41987         - name: resource-version
41988           in: query
41989           description: resource-version for concurrency
41990           required: true
41991           type: string
41992   /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:
41993     put:
41994       tags:
41995         - Network
41996       summary: see node definition for valid relationships
41997       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41998       consumes:
41999         - application/json
42000         - application/xml
42001       produces:
42002         - application/json
42003         - application/xml
42004       responses:
42005         "default":
42006           description: Response codes found in [response codes](https://wiki.onap.org/).
42007       parameters:
42008         - name: pnf-name
42009           in: path
42010           description: unique name of Physical Network Function.
42011           required: true
42012           type: string
42013           example: __PNF-NAME__
42014         - name: interface-name
42015           in: path
42016           description: Name that identifies the link aggregate interface
42017           required: true
42018           type: string
42019           example: __INTERFACE-NAME__
42020         - name: interface-name
42021           in: path
42022           description: Name given to the interface
42023           required: true
42024           type: string
42025           example: __INTERFACE-NAME__
42026         - name: l3-interface-ipv6-address
42027           in: path
42028           description: IP address
42029           required: true
42030           type: string
42031           example: __L3-INTERFACE-IPV6-ADDRESS__
42032         - name: body
42033           in: body
42034           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42035           required: true
42036           schema:
42037             $ref: "#/definitions/relationship"
42038     delete:
42039       tags:
42040         - Network
42041       summary: delete an existing relationship
42042       description: delete an existing relationship
42043       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
42044       consumes:
42045         - application/json
42046         - application/xml
42047       produces:
42048         - application/json
42049         - application/xml
42050       responses:
42051         "default":
42052           description: Response codes found in [response codes](https://wiki.onap.org/).
42053       parameters:
42054         - name: pnf-name
42055           in: path
42056           description: unique name of Physical Network Function.
42057           required: true
42058           type: string
42059           example: __PNF-NAME__
42060         - name: interface-name
42061           in: path
42062           description: Name that identifies the link aggregate interface
42063           required: true
42064           type: string
42065           example: __INTERFACE-NAME__
42066         - name: interface-name
42067           in: path
42068           description: Name given to the interface
42069           required: true
42070           type: string
42071           example: __INTERFACE-NAME__
42072         - name: l3-interface-ipv6-address
42073           in: path
42074           description: IP address
42075           required: true
42076           type: string
42077           example: __L3-INTERFACE-IPV6-ADDRESS__
42078   /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}:
42079     get:
42080       tags:
42081         - Network
42082       summary: returns l3-interface-ipv6-address-list
42083       description: returns l3-interface-ipv6-address-list
42084       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
42085       produces:
42086         - application/json
42087         - application/xml
42088       responses:
42089         "200":
42090           description: successful operation
42091           schema:
42092               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42093         "default":
42094           description: Response codes found in [response codes](https://wiki.onap.org/).
42095       parameters:
42096         - name: pnf-name
42097           in: path
42098           description: unique name of Physical Network Function.
42099           required: true
42100           type: string
42101           example: __PNF-NAME__
42102         - name: interface-name
42103           in: path
42104           description: Name that identifies the link aggregate interface
42105           required: true
42106           type: string
42107           example: __INTERFACE-NAME__
42108         - name: interface-name
42109           in: path
42110           description: Name given to the interface
42111           required: true
42112           type: string
42113           example: __INTERFACE-NAME__
42114         - name: l3-interface-ipv6-address
42115           in: path
42116           description: IP address
42117           required: true
42118           type: string
42119           example: __L3-INTERFACE-IPV6-ADDRESS__
42120         - name: orchestration-status
42121           in: query
42122           description: orchestration-status is the status of orchestration on the PNF.
42123           required: false
42124           type: string
42125         - name: interface-id
42126           in: query
42127           description: ID of interface
42128           required: false
42129           type: string
42130         - name: macaddr
42131           in: query
42132           description: MAC address for the interface
42133           required: false
42134           type: string
42135         - name: network-name
42136           in: query
42137           description: Name of the network
42138           required: false
42139           type: string
42140         - name: vlan-id-inner
42141           in: query
42142           description: Inner VLAN tag
42143           required: false
42144           type: integer
42145           format: int64
42146         - name: neutron-network-id
42147           in: query
42148           description: Neutron network id of the interface that address belongs to
42149           required: false
42150           type: string
42151         - name: neutron-subnet-id
42152           in: query
42153           description: Neutron id of subnet that address belongs to
42154           required: false
42155           type: string
42156     put:
42157       tags:
42158         - Network
42159       summary: create or update an existing l3-interface-ipv6-address-list
42160       description: |
42161         Create or update an existing l3-interface-ipv6-address-list.
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: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
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 link aggregate 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: l3-interface-ipv6-address
42194           in: path
42195           description: IP address
42196           required: true
42197           type: string
42198           example: __L3-INTERFACE-IPV6-ADDRESS__
42199         - name: body
42200           in: body
42201           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
42202           required: true
42203           schema:
42204             $ref: "#/definitions/l3-interface-ipv6-address-list"
42205     patch:
42206       tags:
42207         - Network
42208       summary: update an existing l3-interface-ipv6-address-list
42209       description: |
42210         Update an existing l3-interface-ipv6-address-list
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: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
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 link aggregate 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: l3-interface-ipv6-address
42251           in: path
42252           description: IP address
42253           required: true
42254           type: string
42255           example: __L3-INTERFACE-IPV6-ADDRESS__
42256         - name: body
42257           in: body
42258           description: l3-interface-ipv6-address-list object that needs to be created or updated.
42259           required: true
42260           schema:
42261             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42262     delete:
42263       tags:
42264         - Network
42265       summary: delete an existing l3-interface-ipv6-address-list
42266       description: delete an existing l3-interface-ipv6-address-list
42267       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
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 link aggregate 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: l3-interface-ipv6-address
42297           in: path
42298           description: IP address
42299           required: true
42300           type: string
42301           example: __L3-INTERFACE-IPV6-ADDRESS__
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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
42308     get:
42309       tags:
42310         - Network
42311       summary: returns l-interface
42312       description: returns l-interface
42313       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42314       produces:
42315         - application/json
42316         - application/xml
42317       responses:
42318         "200":
42319           description: successful operation
42320           schema:
42321               $ref: "#/getDefinitions/l-interface"
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 link aggregate 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: orchestration-status
42344           in: query
42345           description: orchestration-status is the status of orchestration on the PNF.
42346           required: false
42347           type: string
42348         - name: interface-id
42349           in: query
42350           description: ID of interface
42351           required: false
42352           type: string
42353         - name: macaddr
42354           in: query
42355           description: MAC address for the interface
42356           required: false
42357           type: string
42358         - name: network-name
42359           in: query
42360           description: Name of the network
42361           required: false
42362           type: string
42363     put:
42364       tags:
42365         - Network
42366       summary: create or update an existing l-interface
42367       description: |
42368         Create or update an existing l-interface.
42369         #
42370         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
42371       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42372       consumes:
42373         - application/json
42374         - application/xml
42375       produces:
42376         - application/json
42377         - application/xml
42378       responses:
42379         "default":
42380           description: Response codes found in [response codes](https://wiki.onap.org/).
42381       parameters:
42382         - name: pnf-name
42383           in: path
42384           description: unique name of Physical Network Function.
42385           required: true
42386           type: string
42387           example: __PNF-NAME__
42388         - name: interface-name
42389           in: path
42390           description: Name that identifies the link aggregate interface
42391           required: true
42392           type: string
42393           example: __INTERFACE-NAME__
42394         - name: interface-name
42395           in: path
42396           description: Name given to the interface
42397           required: true
42398           type: string
42399           example: __INTERFACE-NAME__
42400         - name: body
42401           in: body
42402           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
42403           required: true
42404           schema:
42405             $ref: "#/definitions/l-interface"
42406     patch:
42407       tags:
42408         - Network
42409       summary: update an existing l-interface
42410       description: |
42411         Update an existing l-interface
42412         #
42413         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42414         The PUT operation will entirely replace an existing object.
42415         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.
42416         #
42417         Other differences between PUT and PATCH are:
42418         #
42419         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42420         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42421         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42422       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42423       consumes:
42424         - application/json
42425         - application/xml
42426       produces:
42427         - application/json
42428         - application/xml
42429       responses:
42430         "default":
42431           description: Response codes found in [response codes](https://wiki.onap.org/).
42432       parameters:
42433         - name: pnf-name
42434           in: path
42435           description: unique name of Physical Network Function.
42436           required: true
42437           type: string
42438           example: __PNF-NAME__
42439         - name: interface-name
42440           in: path
42441           description: Name that identifies the link aggregate interface
42442           required: true
42443           type: string
42444           example: __INTERFACE-NAME__
42445         - name: interface-name
42446           in: path
42447           description: Name given to the interface
42448           required: true
42449           type: string
42450           example: __INTERFACE-NAME__
42451         - name: body
42452           in: body
42453           description: l-interface object that needs to be created or updated.
42454           required: true
42455           schema:
42456             $ref: "#/patchDefinitions/l-interface"
42457     delete:
42458       tags:
42459         - Network
42460       summary: delete an existing l-interface
42461       description: delete an existing l-interface
42462       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
42463       consumes:
42464         - application/json
42465         - application/xml
42466       produces:
42467         - application/json
42468         - application/xml
42469       responses:
42470         "default":
42471           description: Response codes found in [response codes](https://wiki.onap.org/).
42472       parameters:
42473         - name: pnf-name
42474           in: path
42475           description: unique name of Physical Network Function.
42476           required: true
42477           type: string
42478           example: __PNF-NAME__
42479         - name: interface-name
42480           in: path
42481           description: Name that identifies the link aggregate interface
42482           required: true
42483           type: string
42484           example: __INTERFACE-NAME__
42485         - name: interface-name
42486           in: path
42487           description: Name given to the interface
42488           required: true
42489           type: string
42490           example: __INTERFACE-NAME__
42491         - name: resource-version
42492           in: query
42493           description: resource-version for concurrency
42494           required: true
42495           type: string
42496   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
42497     get:
42498       tags:
42499         - Network
42500       summary: returns l-interfaces
42501       description: returns l-interfaces
42502       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
42503       produces:
42504         - application/json
42505         - application/xml
42506       responses:
42507         "200":
42508           description: successful operation
42509           schema:
42510               $ref: "#/getDefinitions/l-interfaces"
42511         "default":
42512           description: Response codes found in [response codes](https://wiki.onap.org/).
42513       parameters:
42514         - name: pnf-name
42515           in: path
42516           description: unique name of Physical Network Function.
42517           required: true
42518           type: string
42519           example: __PNF-NAME__
42520         - name: interface-name
42521           in: path
42522           description: Name that identifies the link aggregate interface
42523           required: true
42524           type: string
42525           example: __INTERFACE-NAME__
42526         - name: orchestration-status
42527           in: query
42528           description: orchestration-status is the status of orchestration on the PNF.
42529           required: false
42530           type: string
42531   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
42532     get:
42533       tags:
42534         - Network
42535       summary: returns lag-interface
42536       description: returns lag-interface
42537       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
42538       produces:
42539         - application/json
42540         - application/xml
42541       responses:
42542         "200":
42543           description: successful operation
42544           schema:
42545               $ref: "#/getDefinitions/lag-interface"
42546         "default":
42547           description: Response codes found in [response codes](https://wiki.onap.org/).
42548       parameters:
42549         - name: pnf-name
42550           in: path
42551           description: unique name of Physical Network Function.
42552           required: true
42553           type: string
42554           example: __PNF-NAME__
42555         - name: interface-name
42556           in: path
42557           description: Name that identifies the link aggregate interface
42558           required: true
42559           type: string
42560           example: __INTERFACE-NAME__
42561         - name: orchestration-status
42562           in: query
42563           description: orchestration-status is the status of orchestration on the PNF.
42564           required: false
42565           type: string
42566     put:
42567       tags:
42568         - Network
42569       summary: create or update an existing lag-interface
42570       description: |
42571         Create or update an existing lag-interface.
42572         #
42573         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
42574       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
42575       consumes:
42576         - application/json
42577         - application/xml
42578       produces:
42579         - application/json
42580         - application/xml
42581       responses:
42582         "default":
42583           description: Response codes found in [response codes](https://wiki.onap.org/).
42584       parameters:
42585         - name: pnf-name
42586           in: path
42587           description: unique name of Physical Network Function.
42588           required: true
42589           type: string
42590           example: __PNF-NAME__
42591         - name: interface-name
42592           in: path
42593           description: Name that identifies the link aggregate interface
42594           required: true
42595           type: string
42596           example: __INTERFACE-NAME__
42597         - name: body
42598           in: body
42599           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnfLagInterfacesLagInterface.json)
42600           required: true
42601           schema:
42602             $ref: "#/definitions/lag-interface"
42603     patch:
42604       tags:
42605         - Network
42606       summary: update an existing lag-interface
42607       description: |
42608         Update an existing lag-interface
42609         #
42610         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42611         The PUT operation will entirely replace an existing object.
42612         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.
42613         #
42614         Other differences between PUT and PATCH are:
42615         #
42616         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42617         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42618         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42619       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
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 link aggregate interface
42639           required: true
42640           type: string
42641           example: __INTERFACE-NAME__
42642         - name: body
42643           in: body
42644           description: lag-interface object that needs to be created or updated.
42645           required: true
42646           schema:
42647             $ref: "#/patchDefinitions/lag-interface"
42648     delete:
42649       tags:
42650         - Network
42651       summary: delete an existing lag-interface
42652       description: delete an existing lag-interface
42653       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
42654       consumes:
42655         - application/json
42656         - application/xml
42657       produces:
42658         - application/json
42659         - application/xml
42660       responses:
42661         "default":
42662           description: Response codes found in [response codes](https://wiki.onap.org/).
42663       parameters:
42664         - name: pnf-name
42665           in: path
42666           description: unique name of Physical Network Function.
42667           required: true
42668           type: string
42669           example: __PNF-NAME__
42670         - name: interface-name
42671           in: path
42672           description: Name that identifies the link aggregate interface
42673           required: true
42674           type: string
42675           example: __INTERFACE-NAME__
42676         - name: resource-version
42677           in: query
42678           description: resource-version for concurrency
42679           required: true
42680           type: string
42681   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
42682     get:
42683       tags:
42684         - Network
42685       summary: returns lag-interfaces
42686       description: returns lag-interfaces
42687       operationId: getNetworkPnfsPnfLagInterfaces
42688       produces:
42689         - application/json
42690         - application/xml
42691       responses:
42692         "200":
42693           description: successful operation
42694           schema:
42695               $ref: "#/getDefinitions/lag-interfaces"
42696         "default":
42697           description: Response codes found in [response codes](https://wiki.onap.org/).
42698       parameters:
42699         - name: pnf-name
42700           in: path
42701           description: unique name of Physical Network Function.
42702           required: true
42703           type: string
42704           example: __PNF-NAME__
42705         - name: orchestration-status
42706           in: query
42707           description: orchestration-status is the status of orchestration on the PNF.
42708           required: false
42709           type: string
42710   /network/pnfs/pnf/{pnf-name}:
42711     get:
42712       tags:
42713         - Network
42714       summary: returns pnf
42715       description: returns pnf
42716       operationId: getNetworkPnfsPnf
42717       produces:
42718         - application/json
42719         - application/xml
42720       responses:
42721         "200":
42722           description: successful operation
42723           schema:
42724               $ref: "#/getDefinitions/pnf"
42725         "default":
42726           description: Response codes found in [response codes](https://wiki.onap.org/).
42727       parameters:
42728         - name: pnf-name
42729           in: path
42730           description: unique name of Physical Network Function.
42731           required: true
42732           type: string
42733           example: __PNF-NAME__
42734         - name: orchestration-status
42735           in: query
42736           description: orchestration-status is the status of orchestration on the PNF.
42737           required: false
42738           type: string
42739     put:
42740       tags:
42741         - Network
42742       summary: create or update an existing pnf
42743       description: |
42744         Create or update an existing pnf.
42745         #
42746         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
42747       operationId: createOrUpdateNetworkPnfsPnf
42748       consumes:
42749         - application/json
42750         - application/xml
42751       produces:
42752         - application/json
42753         - application/xml
42754       responses:
42755         "default":
42756           description: Response codes found in [response codes](https://wiki.onap.org/).
42757       parameters:
42758         - name: pnf-name
42759           in: path
42760           description: unique name of Physical Network Function.
42761           required: true
42762           type: string
42763           example: __PNF-NAME__
42764         - name: body
42765           in: body
42766           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPnfsPnf.json)
42767           required: true
42768           schema:
42769             $ref: "#/definitions/pnf"
42770     patch:
42771       tags:
42772         - Network
42773       summary: update an existing pnf
42774       description: |
42775         Update an existing pnf
42776         #
42777         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42778         The PUT operation will entirely replace an existing object.
42779         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.
42780         #
42781         Other differences between PUT and PATCH are:
42782         #
42783         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42784         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42785         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42786       operationId: UpdateNetworkPnfsPnf
42787       consumes:
42788         - application/json
42789         - application/xml
42790       produces:
42791         - application/json
42792         - application/xml
42793       responses:
42794         "default":
42795           description: Response codes found in [response codes](https://wiki.onap.org/).
42796       parameters:
42797         - name: pnf-name
42798           in: path
42799           description: unique name of Physical Network Function.
42800           required: true
42801           type: string
42802           example: __PNF-NAME__
42803         - name: body
42804           in: body
42805           description: pnf object that needs to be created or updated.
42806           required: true
42807           schema:
42808             $ref: "#/patchDefinitions/pnf"
42809     delete:
42810       tags:
42811         - Network
42812       summary: delete an existing pnf
42813       description: delete an existing pnf
42814       operationId: deleteNetworkPnfsPnf
42815       consumes:
42816         - application/json
42817         - application/xml
42818       produces:
42819         - application/json
42820         - application/xml
42821       responses:
42822         "default":
42823           description: Response codes found in [response codes](https://wiki.onap.org/).
42824       parameters:
42825         - name: pnf-name
42826           in: path
42827           description: unique name of Physical Network Function.
42828           required: true
42829           type: string
42830           example: __PNF-NAME__
42831         - name: resource-version
42832           in: query
42833           description: resource-version for concurrency
42834           required: true
42835           type: string
42836   /network/pnfs:
42837     get:
42838       tags:
42839         - Network
42840       summary: returns pnfs
42841       description: returns pnfs
42842       operationId: getNetworkPnfs
42843       produces:
42844         - application/json
42845         - application/xml
42846       responses:
42847         "200":
42848           description: successful operation
42849           schema:
42850               $ref: "#/getDefinitions/pnfs"
42851         "default":
42852           description: Response codes found in [response codes](https://wiki.onap.org/).
42853   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
42854     put:
42855       tags:
42856         - Network
42857       summary: see node definition for valid relationships
42858       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
42859       consumes:
42860         - application/json
42861         - application/xml
42862       produces:
42863         - application/json
42864         - application/xml
42865       responses:
42866         "default":
42867           description: Response codes found in [response codes](https://wiki.onap.org/).
42868       parameters:
42869         - name: link-name
42870           in: path
42871           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42872           required: true
42873           type: string
42874           example: __LINK-NAME__
42875         - name: body
42876           in: body
42877           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
42878           required: true
42879           schema:
42880             $ref: "#/definitions/relationship"
42881     delete:
42882       tags:
42883         - Network
42884       summary: delete an existing relationship
42885       description: delete an existing relationship
42886       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
42887       consumes:
42888         - application/json
42889         - application/xml
42890       produces:
42891         - application/json
42892         - application/xml
42893       responses:
42894         "default":
42895           description: Response codes found in [response codes](https://wiki.onap.org/).
42896       parameters:
42897         - name: link-name
42898           in: path
42899           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42900           required: true
42901           type: string
42902           example: __LINK-NAME__
42903   /network/physical-links/physical-link/{link-name}:
42904     get:
42905       tags:
42906         - Network
42907       summary: returns physical-link
42908       description: returns physical-link
42909       operationId: getNetworkPhysicalLinksPhysicalLink
42910       produces:
42911         - application/json
42912         - application/xml
42913       responses:
42914         "200":
42915           description: successful operation
42916           schema:
42917               $ref: "#/getDefinitions/physical-link"
42918         "default":
42919           description: Response codes found in [response codes](https://wiki.onap.org/).
42920       parameters:
42921         - name: link-name
42922           in: path
42923           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42924           required: true
42925           type: string
42926           example: __LINK-NAME__
42927         - name: circuit-id
42928           in: query
42929           description: Circuit it
42930           required: false
42931           type: string
42932     put:
42933       tags:
42934         - Network
42935       summary: create or update an existing physical-link
42936       description: |
42937         Create or update an existing physical-link.
42938         #
42939         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
42940       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
42941       consumes:
42942         - application/json
42943         - application/xml
42944       produces:
42945         - application/json
42946         - application/xml
42947       responses:
42948         "default":
42949           description: Response codes found in [response codes](https://wiki.onap.org/).
42950       parameters:
42951         - name: link-name
42952           in: path
42953           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42954           required: true
42955           type: string
42956           example: __LINK-NAME__
42957         - name: body
42958           in: body
42959           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkPhysicalLinksPhysicalLink.json)
42960           required: true
42961           schema:
42962             $ref: "#/definitions/physical-link"
42963     patch:
42964       tags:
42965         - Network
42966       summary: update an existing physical-link
42967       description: |
42968         Update an existing physical-link
42969         #
42970         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42971         The PUT operation will entirely replace an existing object.
42972         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.
42973         #
42974         Other differences between PUT and PATCH are:
42975         #
42976         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42977         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42978         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42979       operationId: UpdateNetworkPhysicalLinksPhysicalLink
42980       consumes:
42981         - application/json
42982         - application/xml
42983       produces:
42984         - application/json
42985         - application/xml
42986       responses:
42987         "default":
42988           description: Response codes found in [response codes](https://wiki.onap.org/).
42989       parameters:
42990         - name: link-name
42991           in: path
42992           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
42993           required: true
42994           type: string
42995           example: __LINK-NAME__
42996         - name: body
42997           in: body
42998           description: physical-link object that needs to be created or updated.
42999           required: true
43000           schema:
43001             $ref: "#/patchDefinitions/physical-link"
43002     delete:
43003       tags:
43004         - Network
43005       summary: delete an existing physical-link
43006       description: delete an existing physical-link
43007       operationId: deleteNetworkPhysicalLinksPhysicalLink
43008       consumes:
43009         - application/json
43010         - application/xml
43011       produces:
43012         - application/json
43013         - application/xml
43014       responses:
43015         "default":
43016           description: Response codes found in [response codes](https://wiki.onap.org/).
43017       parameters:
43018         - name: link-name
43019           in: path
43020           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
43021           required: true
43022           type: string
43023           example: __LINK-NAME__
43024         - name: resource-version
43025           in: query
43026           description: resource-version for concurrency
43027           required: true
43028           type: string
43029   /network/physical-links:
43030     get:
43031       tags:
43032         - Network
43033       summary: returns physical-links
43034       description: returns physical-links
43035       operationId: getNetworkPhysicalLinks
43036       produces:
43037         - application/json
43038         - application/xml
43039       responses:
43040         "200":
43041           description: successful operation
43042           schema:
43043               $ref: "#/getDefinitions/physical-links"
43044         "default":
43045           description: Response codes found in [response codes](https://wiki.onap.org/).
43046   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
43047     put:
43048       tags:
43049         - Network
43050       summary: see node definition for valid relationships
43051       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43052       consumes:
43053         - application/json
43054         - application/xml
43055       produces:
43056         - application/json
43057         - application/xml
43058       responses:
43059         "default":
43060           description: Response codes found in [response codes](https://wiki.onap.org/).
43061       parameters:
43062         - name: ipsec-configuration-id
43063           in: path
43064           description: UUID of this configuration
43065           required: true
43066           type: string
43067           example: __IPSEC-CONFIGURATION-ID__
43068         - name: body
43069           in: body
43070           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
43071           required: true
43072           schema:
43073             $ref: "#/definitions/relationship"
43074     delete:
43075       tags:
43076         - Network
43077       summary: delete an existing relationship
43078       description: delete an existing relationship
43079       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
43080       consumes:
43081         - application/json
43082         - application/xml
43083       produces:
43084         - application/json
43085         - application/xml
43086       responses:
43087         "default":
43088           description: Response codes found in [response codes](https://wiki.onap.org/).
43089       parameters:
43090         - name: ipsec-configuration-id
43091           in: path
43092           description: UUID of this configuration
43093           required: true
43094           type: string
43095           example: __IPSEC-CONFIGURATION-ID__
43096   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
43097     put:
43098       tags:
43099         - Network
43100       summary: see node definition for valid relationships
43101       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43102       consumes:
43103         - application/json
43104         - application/xml
43105       produces:
43106         - application/json
43107         - application/xml
43108       responses:
43109         "default":
43110           description: Response codes found in [response codes](https://wiki.onap.org/).
43111       parameters:
43112         - name: ipsec-configuration-id
43113           in: path
43114           description: UUID of this configuration
43115           required: true
43116           type: string
43117           example: __IPSEC-CONFIGURATION-ID__
43118         - name: vig-address-type
43119           in: path
43120           description: indicates whether the VIG is for AVPN or INTERNET
43121           required: true
43122           type: string
43123           example: __VIG-ADDRESS-TYPE__
43124         - name: body
43125           in: body
43126           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43127           required: true
43128           schema:
43129             $ref: "#/definitions/relationship"
43130     delete:
43131       tags:
43132         - Network
43133       summary: delete an existing relationship
43134       description: delete an existing relationship
43135       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
43136       consumes:
43137         - application/json
43138         - application/xml
43139       produces:
43140         - application/json
43141         - application/xml
43142       responses:
43143         "default":
43144           description: Response codes found in [response codes](https://wiki.onap.org/).
43145       parameters:
43146         - name: ipsec-configuration-id
43147           in: path
43148           description: UUID of this configuration
43149           required: true
43150           type: string
43151           example: __IPSEC-CONFIGURATION-ID__
43152         - name: vig-address-type
43153           in: path
43154           description: indicates whether the VIG is for AVPN or INTERNET
43155           required: true
43156           type: string
43157           example: __VIG-ADDRESS-TYPE__
43158   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
43159     get:
43160       tags:
43161         - Network
43162       summary: returns vig-server
43163       description: returns vig-server
43164       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43165       produces:
43166         - application/json
43167         - application/xml
43168       responses:
43169         "200":
43170           description: successful operation
43171           schema:
43172               $ref: "#/getDefinitions/vig-server"
43173         "default":
43174           description: Response codes found in [response codes](https://wiki.onap.org/).
43175       parameters:
43176         - name: ipsec-configuration-id
43177           in: path
43178           description: UUID of this configuration
43179           required: true
43180           type: string
43181           example: __IPSEC-CONFIGURATION-ID__
43182         - name: vig-address-type
43183           in: path
43184           description: indicates whether the VIG is for AVPN or INTERNET
43185           required: true
43186           type: string
43187           example: __VIG-ADDRESS-TYPE__
43188     put:
43189       tags:
43190         - Network
43191       summary: create or update an existing vig-server
43192       description: |
43193         Create or update an existing vig-server.
43194         #
43195         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
43196       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43197       consumes:
43198         - application/json
43199         - application/xml
43200       produces:
43201         - application/json
43202         - application/xml
43203       responses:
43204         "default":
43205           description: Response codes found in [response codes](https://wiki.onap.org/).
43206       parameters:
43207         - name: ipsec-configuration-id
43208           in: path
43209           description: UUID of this configuration
43210           required: true
43211           type: string
43212           example: __IPSEC-CONFIGURATION-ID__
43213         - name: vig-address-type
43214           in: path
43215           description: indicates whether the VIG is for AVPN or INTERNET
43216           required: true
43217           type: string
43218           example: __VIG-ADDRESS-TYPE__
43219         - name: body
43220           in: body
43221           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
43222           required: true
43223           schema:
43224             $ref: "#/definitions/vig-server"
43225     patch:
43226       tags:
43227         - Network
43228       summary: update an existing vig-server
43229       description: |
43230         Update an existing vig-server
43231         #
43232         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43233         The PUT operation will entirely replace an existing object.
43234         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.
43235         #
43236         Other differences between PUT and PATCH are:
43237         #
43238         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43239         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43240         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43241       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43242       consumes:
43243         - application/json
43244         - application/xml
43245       produces:
43246         - application/json
43247         - application/xml
43248       responses:
43249         "default":
43250           description: Response codes found in [response codes](https://wiki.onap.org/).
43251       parameters:
43252         - name: ipsec-configuration-id
43253           in: path
43254           description: UUID of this configuration
43255           required: true
43256           type: string
43257           example: __IPSEC-CONFIGURATION-ID__
43258         - name: vig-address-type
43259           in: path
43260           description: indicates whether the VIG is for AVPN or INTERNET
43261           required: true
43262           type: string
43263           example: __VIG-ADDRESS-TYPE__
43264         - name: body
43265           in: body
43266           description: vig-server object that needs to be created or updated.
43267           required: true
43268           schema:
43269             $ref: "#/patchDefinitions/vig-server"
43270     delete:
43271       tags:
43272         - Network
43273       summary: delete an existing vig-server
43274       description: delete an existing vig-server
43275       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
43276       consumes:
43277         - application/json
43278         - application/xml
43279       produces:
43280         - application/json
43281         - application/xml
43282       responses:
43283         "default":
43284           description: Response codes found in [response codes](https://wiki.onap.org/).
43285       parameters:
43286         - name: ipsec-configuration-id
43287           in: path
43288           description: UUID of this configuration
43289           required: true
43290           type: string
43291           example: __IPSEC-CONFIGURATION-ID__
43292         - name: vig-address-type
43293           in: path
43294           description: indicates whether the VIG is for AVPN or INTERNET
43295           required: true
43296           type: string
43297           example: __VIG-ADDRESS-TYPE__
43298         - name: resource-version
43299           in: query
43300           description: resource-version for concurrency
43301           required: true
43302           type: string
43303   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
43304     get:
43305       tags:
43306         - Network
43307       summary: returns vig-servers
43308       description: returns vig-servers
43309       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
43310       produces:
43311         - application/json
43312         - application/xml
43313       responses:
43314         "200":
43315           description: successful operation
43316           schema:
43317               $ref: "#/getDefinitions/vig-servers"
43318         "default":
43319           description: Response codes found in [response codes](https://wiki.onap.org/).
43320       parameters:
43321         - name: ipsec-configuration-id
43322           in: path
43323           description: UUID of this configuration
43324           required: true
43325           type: string
43326           example: __IPSEC-CONFIGURATION-ID__
43327   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
43328     get:
43329       tags:
43330         - Network
43331       summary: returns ipsec-configuration
43332       description: returns ipsec-configuration
43333       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
43334       produces:
43335         - application/json
43336         - application/xml
43337       responses:
43338         "200":
43339           description: successful operation
43340           schema:
43341               $ref: "#/getDefinitions/ipsec-configuration"
43342         "default":
43343           description: Response codes found in [response codes](https://wiki.onap.org/).
43344       parameters:
43345         - name: ipsec-configuration-id
43346           in: path
43347           description: UUID of this configuration
43348           required: true
43349           type: string
43350           example: __IPSEC-CONFIGURATION-ID__
43351     put:
43352       tags:
43353         - Network
43354       summary: create or update an existing ipsec-configuration
43355       description: |
43356         Create or update an existing ipsec-configuration.
43357         #
43358         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
43359       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
43360       consumes:
43361         - application/json
43362         - application/xml
43363       produces:
43364         - application/json
43365         - application/xml
43366       responses:
43367         "default":
43368           description: Response codes found in [response codes](https://wiki.onap.org/).
43369       parameters:
43370         - name: ipsec-configuration-id
43371           in: path
43372           description: UUID of this configuration
43373           required: true
43374           type: string
43375           example: __IPSEC-CONFIGURATION-ID__
43376         - name: body
43377           in: body
43378           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkIpsecConfigurationsIpsecConfiguration.json)
43379           required: true
43380           schema:
43381             $ref: "#/definitions/ipsec-configuration"
43382     patch:
43383       tags:
43384         - Network
43385       summary: update an existing ipsec-configuration
43386       description: |
43387         Update an existing ipsec-configuration
43388         #
43389         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43390         The PUT operation will entirely replace an existing object.
43391         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.
43392         #
43393         Other differences between PUT and PATCH are:
43394         #
43395         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43396         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43397         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43398       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
43399       consumes:
43400         - application/json
43401         - application/xml
43402       produces:
43403         - application/json
43404         - application/xml
43405       responses:
43406         "default":
43407           description: Response codes found in [response codes](https://wiki.onap.org/).
43408       parameters:
43409         - name: ipsec-configuration-id
43410           in: path
43411           description: UUID of this configuration
43412           required: true
43413           type: string
43414           example: __IPSEC-CONFIGURATION-ID__
43415         - name: body
43416           in: body
43417           description: ipsec-configuration object that needs to be created or updated.
43418           required: true
43419           schema:
43420             $ref: "#/patchDefinitions/ipsec-configuration"
43421     delete:
43422       tags:
43423         - Network
43424       summary: delete an existing ipsec-configuration
43425       description: delete an existing ipsec-configuration
43426       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
43427       consumes:
43428         - application/json
43429         - application/xml
43430       produces:
43431         - application/json
43432         - application/xml
43433       responses:
43434         "default":
43435           description: Response codes found in [response codes](https://wiki.onap.org/).
43436       parameters:
43437         - name: ipsec-configuration-id
43438           in: path
43439           description: UUID of this configuration
43440           required: true
43441           type: string
43442           example: __IPSEC-CONFIGURATION-ID__
43443         - name: resource-version
43444           in: query
43445           description: resource-version for concurrency
43446           required: true
43447           type: string
43448   /network/ipsec-configurations:
43449     get:
43450       tags:
43451         - Network
43452       summary: returns ipsec-configurations
43453       description: returns ipsec-configurations
43454       operationId: getNetworkIpsecConfigurations
43455       produces:
43456         - application/json
43457         - application/xml
43458       responses:
43459         "200":
43460           description: successful operation
43461           schema:
43462               $ref: "#/getDefinitions/ipsec-configurations"
43463         "default":
43464           description: Response codes found in [response codes](https://wiki.onap.org/).
43465   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
43466     put:
43467       tags:
43468         - Network
43469       summary: see node definition for valid relationships
43470       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43471       consumes:
43472         - application/json
43473         - application/xml
43474       produces:
43475         - application/json
43476         - application/xml
43477       responses:
43478         "default":
43479           description: Response codes found in [response codes](https://wiki.onap.org/).
43480       parameters:
43481         - name: route-table-reference-id
43482           in: path
43483           description: Route Table Reference id, UUID assigned to this instance.
43484           required: true
43485           type: string
43486           example: __ROUTE-TABLE-REFERENCE-ID__
43487         - name: body
43488           in: body
43489           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
43490           required: true
43491           schema:
43492             $ref: "#/definitions/relationship"
43493     delete:
43494       tags:
43495         - Network
43496       summary: delete an existing relationship
43497       description: delete an existing relationship
43498       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
43499       consumes:
43500         - application/json
43501         - application/xml
43502       produces:
43503         - application/json
43504         - application/xml
43505       responses:
43506         "default":
43507           description: Response codes found in [response codes](https://wiki.onap.org/).
43508       parameters:
43509         - name: route-table-reference-id
43510           in: path
43511           description: Route Table Reference id, UUID assigned to this instance.
43512           required: true
43513           type: string
43514           example: __ROUTE-TABLE-REFERENCE-ID__
43515   /network/route-table-references/route-table-reference/{route-table-reference-id}:
43516     get:
43517       tags:
43518         - Network
43519       summary: returns route-table-reference
43520       description: returns route-table-reference
43521       operationId: getNetworkRouteTableReferencesRouteTableReference
43522       produces:
43523         - application/json
43524         - application/xml
43525       responses:
43526         "200":
43527           description: successful operation
43528           schema:
43529               $ref: "#/getDefinitions/route-table-reference"
43530         "default":
43531           description: Response codes found in [response codes](https://wiki.onap.org/).
43532       parameters:
43533         - name: route-table-reference-id
43534           in: path
43535           description: Route Table Reference id, UUID assigned to this instance.
43536           required: true
43537           type: string
43538           example: __ROUTE-TABLE-REFERENCE-ID__
43539         - name: route-table-reference-fqdn
43540           in: query
43541           description: FQDN entry in the route table.
43542           required: false
43543           type: string
43544     put:
43545       tags:
43546         - Network
43547       summary: create or update an existing route-table-reference
43548       description: |
43549         Create or update an existing route-table-reference.
43550         #
43551         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
43552       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
43553       consumes:
43554         - application/json
43555         - application/xml
43556       produces:
43557         - application/json
43558         - application/xml
43559       responses:
43560         "default":
43561           description: Response codes found in [response codes](https://wiki.onap.org/).
43562       parameters:
43563         - name: route-table-reference-id
43564           in: path
43565           description: Route Table Reference id, UUID assigned to this instance.
43566           required: true
43567           type: string
43568           example: __ROUTE-TABLE-REFERENCE-ID__
43569         - name: body
43570           in: body
43571           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v8/NetworkRouteTableReferencesRouteTableReference.json)
43572           required: true
43573           schema:
43574             $ref: "#/definitions/route-table-reference"
43575     patch:
43576       tags:
43577         - Network
43578       summary: update an existing route-table-reference
43579       description: |
43580         Update an existing route-table-reference
43581         #
43582         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43583         The PUT operation will entirely replace an existing object.
43584         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.
43585         #
43586         Other differences between PUT and PATCH are:
43587         #
43588         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43589         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43590         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43591       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
43592       consumes:
43593         - application/json
43594         - application/xml
43595       produces:
43596         - application/json
43597         - application/xml
43598       responses:
43599         "default":
43600           description: Response codes found in [response codes](https://wiki.onap.org/).
43601       parameters:
43602         - name: route-table-reference-id
43603           in: path
43604           description: Route Table Reference id, UUID assigned to this instance.
43605           required: true
43606           type: string
43607           example: __ROUTE-TABLE-REFERENCE-ID__
43608         - name: body
43609           in: body
43610           description: route-table-reference object that needs to be created or updated.
43611           required: true
43612           schema:
43613             $ref: "#/patchDefinitions/route-table-reference"
43614     delete:
43615       tags:
43616         - Network
43617       summary: delete an existing route-table-reference
43618       description: delete an existing route-table-reference
43619       operationId: deleteNetworkRouteTableReferencesRouteTableReference
43620       consumes:
43621         - application/json
43622         - application/xml
43623       produces:
43624         - application/json
43625         - application/xml
43626       responses:
43627         "default":
43628           description: Response codes found in [response codes](https://wiki.onap.org/).
43629       parameters:
43630         - name: route-table-reference-id
43631           in: path
43632           description: Route Table Reference id, UUID assigned to this instance.
43633           required: true
43634           type: string
43635           example: __ROUTE-TABLE-REFERENCE-ID__
43636         - name: resource-version
43637           in: query
43638           description: resource-version for concurrency
43639           required: true
43640           type: string
43641   /network/route-table-references:
43642     get:
43643       tags:
43644         - Network
43645       summary: returns route-table-references
43646       description: returns route-table-references
43647       operationId: getNetworkRouteTableReferences
43648       produces:
43649         - application/json
43650         - application/xml
43651       responses:
43652         "200":
43653           description: successful operation
43654           schema:
43655               $ref: "#/getDefinitions/route-table-references"
43656         "default":
43657           description: Response codes found in [response codes](https://wiki.onap.org/).
43658 definitions:
43659   aai-internal:
43660     properties:
43661       property-name:
43662         type: string
43663       property-value:
43664         type: string
43665   action:
43666     properties:
43667       action-type:
43668         type: string
43669       action-data:
43670         type: array
43671         items:
43672           $ref: "#/definitions/action-data"
43673   action-data:
43674     properties:
43675       property-name:
43676         type: string
43677       property-value:
43678         type: string
43679   actions:
43680     description: |
43681       APIs that are more action related than REST (e.g., notify, update).
43682     properties:
43683       update:
43684         type: object
43685         $ref: "#/definitions/update"
43686       notify:
43687         type: object
43688         $ref: "#/definitions/notify"
43689   allotted-resource:
43690     description: |
43691       Represents a slice or partial piece of a resource that gets separately allotted
43692       ###### Related Nodes
43693       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
43694       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
43695       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
43696       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
43697       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
43698       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
43699       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
43700       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
43701     required:
43702     - id
43703     properties:
43704       id:
43705         type: string
43706         description: Allotted Resource id UUID assigned to this instance.
43707       description:
43708         type: string
43709         description: The descriptive information assigned to this allotted resource instance
43710       selflink:
43711         type: string
43712         description: Link back to more information in the controller
43713       persona-model-id:
43714         type: string
43715         description: the ASDC model id for this resource or service model.
43716       persona-model-version:
43717         type: string
43718         description: the ASDC model version for this resource or service model.
43719       model-version-id:
43720         type: string
43721         description: the ASDC model version for this resource or service model.
43722       persona-model-customization-id:
43723         type: string
43724         description: captures the id of all the configuration used to customize the resource for the service.
43725       resource-version:
43726         type: string
43727         description: Concurrency value
43728       tunnel-xconnects:
43729         type: array
43730         items:
43731           $ref: "#/definitions/tunnel-xconnect"
43732       relationship-list:
43733         type: array
43734         items:
43735           $ref: "#/definitions/relationship"
43736   allotted-resources:
43737     description: |
43738       This object is used to store slices of services being offered
43739     properties:
43740       allotted-resource:
43741         type: array
43742         items:
43743           $ref: "#/definitions/allotted-resource"
43744   availability-zone:
43745     description: |
43746       Availability zone, a collection of compute hosts/pservers
43747       ###### Related Nodes
43748       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43749       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
43750       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43751       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
43752       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
43753       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
43754       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
43755       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
43756       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
43757     required:
43758     - availability-zone-name
43759     - hypervisor-type
43760     properties:
43761       availability-zone-name:
43762         type: string
43763         description: Name of the availability zone.  Unique across a cloud region
43764       hypervisor-type:
43765         type: string
43766         description: Type of hypervisor.  Source of truth should define valid values.
43767       operational-state:
43768         type: string
43769         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
43770       resource-version:
43771         type: string
43772         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43773       relationship-list:
43774         type: array
43775         items:
43776           $ref: "#/definitions/relationship"
43777   availability-zones:
43778     description: |
43779       Collection of availability zones
43780     properties:
43781       availability-zone:
43782         type: array
43783         items:
43784           $ref: "#/definitions/availability-zone"
43785   az-and-dvs-switches:
43786     properties:
43787       dvs-switches:
43788         type: object
43789         $ref: "#/definitions/dvs-switches"
43790       availability-zone:
43791         type: object
43792         $ref: "#/definitions/availability-zone"
43793   business:
43794     description: |
43795       Namespace for business related constructs
43796     properties:
43797       connectors:
43798         type: array
43799         items:
43800           $ref: "#/definitions/connector"
43801       customers:
43802         type: array
43803         items:
43804           $ref: "#/definitions/customer"
43805   class-of-service:
43806     description: |
43807       ###### Related Nodes
43808       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
43809     required:
43810     - cos
43811     properties:
43812       cos:
43813         type: string
43814         description: unique identifier of probe
43815       probe-id:
43816         type: string
43817         description: identifier of probe
43818       probe-type:
43819         type: string
43820         description: type of probe
43821       resource-version:
43822         type: string
43823         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43824       relationship-list:
43825         type: array
43826         items:
43827           $ref: "#/definitions/relationship"
43828   classes-of-service:
43829     description: |
43830       class-of-service of probe
43831     properties:
43832       class-of-service:
43833         type: array
43834         items:
43835           $ref: "#/definitions/class-of-service"
43836   cloud-infrastructure:
43837     description: |
43838       Namespace for cloud infrastructure.
43839     properties:
43840       complexes:
43841         type: array
43842         items:
43843           $ref: "#/definitions/complex"
43844       cloud-regions:
43845         type: array
43846         items:
43847           $ref: "#/definitions/cloud-region"
43848       network-profiles:
43849         type: array
43850         items:
43851           $ref: "#/definitions/network-profile"
43852       pservers:
43853         type: array
43854         items:
43855           $ref: "#/definitions/pserver"
43856       virtual-data-centers:
43857         type: array
43858         items:
43859           $ref: "#/definitions/virtual-data-center"
43860   cloud-region:
43861     description: |
43862       cloud-region designates an installation of a cloud cluster or region or instantiation.
43863       ###### Related Nodes
43864       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43865       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
43866       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43867       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43868       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43869       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43870       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43871       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43872       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43873       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43874       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
43875       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
43876       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
43877       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
43878     required:
43879     - cloud-owner
43880     - cloud-region-id
43881     properties:
43882       cloud-owner:
43883         type: string
43884         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
43885       cloud-region-id:
43886         type: string
43887         description: Identifier used by the vendor for the region. Second part of composite key
43888       cloud-type:
43889         type: string
43890         description: Type of the cloud (e.g., openstack)
43891       owner-defined-type:
43892         type: string
43893         description: Cloud-owner defined type indicator (e.g., DCP, LCP)
43894       cloud-region-version:
43895         type: string
43896         description: Software version employed at the site
43897       identity-url:
43898         type: string
43899         description: URL of the keystone identity service
43900       cloud-zone:
43901         type: string
43902         description: Zone where the cloud is homed
43903       complex-name:
43904         type: string
43905         description: complex name for cloud-region instance
43906       resource-version:
43907         type: string
43908         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43909       volume-groups:
43910         type: array
43911         items:
43912           $ref: "#/definitions/volume-group"
43913       tenants:
43914         type: array
43915         items:
43916           $ref: "#/definitions/tenant"
43917       flavors:
43918         type: array
43919         items:
43920           $ref: "#/definitions/flavor"
43921       group-assignments:
43922         type: array
43923         items:
43924           $ref: "#/definitions/group-assignment"
43925       snapshots:
43926         type: array
43927         items:
43928           $ref: "#/definitions/snapshot"
43929       images:
43930         type: array
43931         items:
43932           $ref: "#/definitions/image"
43933       dvs-switches:
43934         type: array
43935         items:
43936           $ref: "#/definitions/dvs-switch"
43937       oam-networks:
43938         type: array
43939         items:
43940           $ref: "#/definitions/oam-network"
43941       availability-zones:
43942         type: array
43943         items:
43944           $ref: "#/definitions/availability-zone"
43945       relationship-list:
43946         type: array
43947         items:
43948           $ref: "#/definitions/relationship"
43949   cloud-regions:
43950     properties:
43951       cloud-region:
43952         type: array
43953         items:
43954           $ref: "#/definitions/cloud-region"
43955   complex:
43956     description: |
43957       Collection of physical locations that can house cloud-regions.
43958       ###### Related Nodes
43959       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
43960       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43961       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43962       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
43963       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
43964       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43965       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43966       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
43967       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43968       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
43969       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
43970       - COMPLEX is DELETED when these are DELETED CTAG-POOL
43971     required:
43972     - physical-location-id
43973     - physical-location-type
43974     - street1
43975     - city
43976     - postal-code
43977     - country
43978     - region
43979     properties:
43980       physical-location-id:
43981         type: string
43982         description: Unique identifier for physical location, e.g., CLLI
43983       data-center-code:
43984         type: string
43985         description: Data center code which can be an alternate way to identify a complex
43986       complex-name:
43987         type: string
43988         description: Gamma complex name for LCP instance.
43989       identity-url:
43990         type: string
43991         description: URL of the keystone identity service
43992       resource-version:
43993         type: string
43994         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
43995       physical-location-type:
43996         type: string
43997         description: Type, e.g., central office, data center.
43998       street1:
43999         type: string
44000       street2:
44001         type: string
44002       city:
44003         type: string
44004       state:
44005         type: string
44006       postal-code:
44007         type: string
44008       country:
44009         type: string
44010       region:
44011         type: string
44012       latitude:
44013         type: string
44014       longitude:
44015         type: string
44016       elevation:
44017         type: string
44018       lata:
44019         type: string
44020       ctag-pools:
44021         type: array
44022         items:
44023           $ref: "#/definitions/ctag-pool"
44024       relationship-list:
44025         type: array
44026         items:
44027           $ref: "#/definitions/relationship"
44028   complexes:
44029     description: |
44030       Collection of physical locations that can house cloud-regions.
44031     properties:
44032       complex:
44033         type: array
44034         items:
44035           $ref: "#/definitions/complex"
44036   configuration:
44037     description: |
44038       Port Mirror Configuration.
44039       ###### Related Nodes
44040       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
44041       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
44042       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
44043       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
44044       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
44045       - CONFIGURATION is DELETED when these are DELETED METADATUM
44046       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
44047     required:
44048     - configuration-id
44049     - configuration-type
44050     - configuration-sub-type
44051     - orchestration-status
44052     - operational-status
44053     - configuration-selflink
44054     - model-customization-id
44055     properties:
44056       configuration-id:
44057         type: string
44058         description: UUID assigned to configuration.
44059       management-option:
44060         type: string
44061         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
44062       configuration-name:
44063         type: string
44064         description: Name of the configuration.
44065       configuration-type:
44066         type: string
44067         description: port-mirroring-configuration.
44068       configuration-sub-type:
44069         type: string
44070         description: vprobe, pprobe.
44071       model-invariant-id:
44072         type: string
44073         description: the ASDC model id for this resource or service model.
44074       model-version-id:
44075         type: string
44076         description: the ASDC model version for this resource or service model.
44077       orchestration-status:
44078         type: string
44079         description: Orchestration status of the configuration.
44080       operational-status:
44081         type: string
44082         description: Indicator for whether the resource is considered operational.
44083       configuration-selflink:
44084         type: string
44085         description: URL to endpoint where AAI can get more details from SDN-GC.
44086       model-customization-id:
44087         type: string
44088         description: id of  the configuration used to customize the resource
44089       resource-version:
44090         type: string
44091         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44092       relationship-list:
44093         type: array
44094         items:
44095           $ref: "#/definitions/relationship"
44096       metadata:
44097         type: array
44098         items:
44099           $ref: "#/definitions/metadatum"
44100   configurations:
44101     description: |
44102       Collection of configurations
44103     properties:
44104       configuration:
44105         type: array
44106         items:
44107           $ref: "#/definitions/configuration"
44108   connector:
44109     description: |
44110       Collection of resource instances used to connect a variety of disparate inventory widgets
44111       ###### Related Nodes
44112       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
44113       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
44114       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
44115       - CONNECTOR is DELETED when these are DELETED METADATUM
44116     required:
44117     - resource-instance-id
44118     properties:
44119       resource-instance-id:
44120         type: string
44121         description: Unique id of resource instance.
44122       resource-version:
44123         type: string
44124         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44125       persona-model-id:
44126         type: string
44127         description: the ASDC model id for this resource or service model.
44128       persona-model-version:
44129         type: string
44130         description: the ASDC model version for this resource or service model.
44131       model-version-id:
44132         type: string
44133         description: the ASDC model version for this resource or service model.
44134       widget-model-id:
44135         type: string
44136         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
44137       widget-model-version:
44138         type: string
44139         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
44140       relationship-list:
44141         type: array
44142         items:
44143           $ref: "#/definitions/relationship"
44144       metadata:
44145         type: array
44146         items:
44147           $ref: "#/definitions/metadatum"
44148   connectors:
44149     description: |
44150       Collection of resource instances used to connect a variety of disparate inventory widgets
44151     properties:
44152       connector:
44153         type: array
44154         items:
44155           $ref: "#/definitions/connector"
44156   constrained-element-set:
44157     description: |
44158       This is how we would capture constraints defining allowed sets of elements.
44159       ###### Related Nodes
44160       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
44161       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
44162       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
44163       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
44164     required:
44165     - constrained-element-set-uuid
44166     - constraint-type
44167     - check-type
44168     properties:
44169       constrained-element-set-uuid:
44170         type: string
44171       constraint-type:
44172         type: string
44173       check-type:
44174         type: string
44175       resource-version:
44176         type: string
44177       element-choice-sets:
44178         type: array
44179         items:
44180           $ref: "#/definitions/element-choice-set"
44181       relationship-list:
44182         type: array
44183         items:
44184           $ref: "#/definitions/relationship"
44185   constrained-element-sets:
44186     properties:
44187       constrained-element-set:
44188         type: array
44189         items:
44190           $ref: "#/definitions/constrained-element-set"
44191   ctag-assignment:
44192     description: |
44193       ###### Related Nodes
44194       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
44195     required:
44196     - vlan-id-inner
44197     properties:
44198       vlan-id-inner:
44199         type: integer
44200         format: int64
44201         description: id.
44202       resource-version:
44203         type: string
44204         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44205       relationship-list:
44206         type: array
44207         items:
44208           $ref: "#/definitions/relationship"
44209   ctag-assignments:
44210     properties:
44211       ctag-assignment:
44212         type: array
44213         items:
44214           $ref: "#/definitions/ctag-assignment"
44215   ctag-pool:
44216     description: |
44217       A collection of C tags (vlan tags) grouped for a specific purpose.
44218       ###### Related Nodes
44219       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
44220       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
44221       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
44222     required:
44223     - target-pe
44224     - availability-zone-name
44225     - ctag-pool-purpose
44226     properties:
44227       target-pe:
44228         type: string
44229         description: The Target provider edge router
44230       availability-zone-name:
44231         type: string
44232         description: Name of the availability zone
44233       ctag-pool-purpose:
44234         type: string
44235         description: Describes what the intended purpose of this pool is.
44236       ctag-values:
44237         type: string
44238         description: Comma separated list of ctags
44239       resource-version:
44240         type: string
44241         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44242       relationship-list:
44243         type: array
44244         items:
44245           $ref: "#/definitions/relationship"
44246   ctag-pools:
44247     properties:
44248       ctag-pool:
44249         type: array
44250         items:
44251           $ref: "#/definitions/ctag-pool"
44252   customer:
44253     description: |
44254       customer identifiers to provide linkage back to BSS information.
44255       ###### Related Nodes
44256       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
44257       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
44258     required:
44259     - global-customer-id
44260     - subscriber-name
44261     - subscriber-type
44262     properties:
44263       global-customer-id:
44264         type: string
44265         description: Global customer id used across ECOMP to uniquely identify customer.
44266       subscriber-name:
44267         type: string
44268         description: Subscriber name, an alternate way to retrieve a customer.
44269       subscriber-type:
44270         type: string
44271         description: Subscriber type, a way to provide VID with only the INFRA customers.
44272       resource-version:
44273         type: string
44274         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44275       service-subscriptions:
44276         type: array
44277         items:
44278           $ref: "#/definitions/service-subscription"
44279       relationship-list:
44280         type: array
44281         items:
44282           $ref: "#/definitions/relationship"
44283   customers:
44284     description: |
44285       Collection of customer identifiers to provide linkage back to BSS information.
44286     properties:
44287       customer:
44288         type: array
44289         items:
44290           $ref: "#/definitions/customer"
44291   cvlan-tag-entry:
44292     required:
44293     - cvlan-tag
44294     properties:
44295       cvlan-tag:
44296         type: integer
44297         format: int64
44298         description: See mis-na-virtualization-platform.yang
44299       resource-version:
44300         type: string
44301         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44302       relationship-list:
44303         type: array
44304         items:
44305           $ref: "#/definitions/relationship"
44306   cvlan-tags:
44307     properties:
44308       cvlan-tag-entry:
44309         type: array
44310         items:
44311           $ref: "#/definitions/cvlan-tag-entry"
44312   dvs-switch:
44313     description: |
44314       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.
44315       ###### Related Nodes
44316       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
44317       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
44318     required:
44319     - switch-name
44320     - vcenter-url
44321     properties:
44322       switch-name:
44323         type: string
44324         description: DVS switch name
44325       vcenter-url:
44326         type: string
44327         description: URL used to reach the vcenter
44328       resource-version:
44329         type: string
44330         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44331       relationship-list:
44332         type: array
44333         items:
44334           $ref: "#/definitions/relationship"
44335   dvs-switches:
44336     description: |
44337       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
44338     properties:
44339       dvs-switch:
44340         type: array
44341         items:
44342           $ref: "#/definitions/dvs-switch"
44343   edge-prop-names:
44344     description: |
44345       Internal map to define the properties of an edge and interpret the map EdgeRules
44346     properties:
44347       edgeLabel:
44348         type: string
44349       direction:
44350         type: string
44351       multiplicityRule:
44352         type: string
44353       isParent:
44354         type: boolean
44355       usesResource:
44356         type: boolean
44357       hasDelTarget:
44358         type: boolean
44359       SVC-INFRA:
44360         type: boolean
44361       SVC-INFRA-REV:
44362         type: boolean
44363   edge-tag-query-request:
44364     properties:
44365       edge-tag:
44366         type: string
44367       result-detail:
44368         type: string
44369       start-node-type:
44370         type: string
44371       start-node-filter:
44372         type: array
44373         items:
44374           $ref: "#/definitions/start-node-filter"
44375       include-node-filter:
44376         type: array
44377         items:
44378           $ref: "#/definitions/include-node-filter"
44379       secondary-filter:
44380         type: array
44381         items:
44382           $ref: "#/definitions/secondary-filter"
44383   edge-tag-query-result:
44384     properties:
44385       tagged-inventory-item-list:
44386         type: array
44387         items:
44388           $ref: "#/definitions/tagged-inventory-item-list"
44389   element-choice-set:
44390     description: |
44391       This is how we would capture constraints defining allowed sets of elements.
44392       ###### Related Nodes
44393       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
44394       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
44395       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
44396     required:
44397     - element-choice-set-uuid
44398     - element-choice-set-name
44399     properties:
44400       element-choice-set-uuid:
44401         type: string
44402       element-choice-set-name:
44403         type: string
44404       cardinality:
44405         type: string
44406       resource-version:
44407         type: string
44408       model-elements:
44409         type: array
44410         items:
44411           $ref: "#/definitions/model-element"
44412       relationship-list:
44413         type: array
44414         items:
44415           $ref: "#/definitions/relationship"
44416   element-choice-sets:
44417     properties:
44418       element-choice-set:
44419         type: array
44420         items:
44421           $ref: "#/definitions/element-choice-set"
44422   entitlement:
44423     description: |
44424       Metadata for entitlement group.
44425       ###### Related Nodes
44426       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44427       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
44428     required:
44429     - group-uuid
44430     - resource-uuid
44431     properties:
44432       group-uuid:
44433         type: string
44434         description: Unique ID for the entitlement group the resource comes from, should be uuid.
44435       resource-uuid:
44436         type: string
44437         description: Unique ID of an entitlement resource.
44438       resource-version:
44439         type: string
44440         description: Concurrency value
44441       relationship-list:
44442         type: array
44443         items:
44444           $ref: "#/definitions/relationship"
44445   entitlements:
44446     description: |
44447       Entitlements, keyed by group-uuid and resource-uuid, related to license management
44448     properties:
44449       entitlement:
44450         type: array
44451         items:
44452           $ref: "#/definitions/entitlement"
44453   esr-ems:
44454     description: |
44455       Persist EMS address information used by EMS driver.
44456       ###### Related Nodes
44457       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
44458       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
44459     required:
44460     - ems-id
44461     properties:
44462       ems-id:
44463         type: string
44464         description: Unique ID of EMS.
44465       resource-version:
44466         type: string
44467         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44468       esr-system-info-list:
44469         type: object
44470         $ref: "#/definitions/esr-system-info-list"
44471       relationship-list:
44472         type: object
44473         $ref: "#/definitions/relationship-list"
44474   esr-ems-list:
44475     properties:
44476       esr-ems:
44477         type: array
44478         items:
44479           $ref: "#/definitions/esr-ems"
44480   esr-system-info:
44481     description: |
44482       Persist common address information of external systems.
44483       ###### Related Nodes
44484       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
44485       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
44486       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
44487       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
44488     required:
44489     - esr-system-info-id
44490     - user-name
44491     - password
44492     - system-type
44493     properties:
44494       esr-system-info-id:
44495         type: string
44496         description: Unique ID of esr system info.
44497       system-name:
44498         type: string
44499         description: name of external system.
44500       type:
44501         type: string
44502         description: type of external systems.
44503       vendor:
44504         type: string
44505         description: vendor of external systems.
44506       version:
44507         type: string
44508         description: version of external systems.
44509       service-url:
44510         type: string
44511         description: url used to access external systems.
44512       user-name:
44513         type: string
44514         description: username used to access external systems.
44515       password:
44516         type: string
44517         description: password used to access external systems.
44518       system-type:
44519         type: string
44520         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
44521       protocol:
44522         type: string
44523         description: protocol of third party SDNC, for example netconf/snmp.
44524       ssl-cacert:
44525         type: string
44526         description: ca file content if enabled ssl on auth-url.
44527       ssl-insecure:
44528         type: boolean
44529         description: Whether to verify VIM's certificate.
44530       ip-address:
44531         type: string
44532         description: service IP of ftp server.
44533       port:
44534         type: string
44535         description: service port of ftp server.
44536       cloud-domain:
44537         type: string
44538         description: domain info for authentication.
44539       default-tenant:
44540         type: string
44541         description: default tenant of VIM.
44542       passive:
44543         type: boolean
44544         description: ftp passive mode or not.
44545       remote-path:
44546         type: string
44547         description: resource or performance data file path.
44548       system-status:
44549         type: string
44550         description: the status of external system.
44551       resource-version:
44552         type: string
44553         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44554       relationship-list:
44555         type: array
44556         items:
44557           $ref: "#/definitions/relationship"
44558   esr-system-info-list:
44559     description: |
44560       Collection of persistent block-level external system auth info.
44561     properties:
44562       esr-system-info:
44563         type: array
44564         items:
44565           $ref: "#/definitions/esr-system-info"
44566   esr-thirdparty-sdnc:
44567     description: |
44568       Persist SDNC address information used by ONAP SDNC.
44569       ###### Related Nodes
44570       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
44571       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
44572       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
44573     required:
44574     - thirdparty-sdnc-id
44575     properties:
44576       thirdparty-sdnc-id:
44577         type: string
44578         description: Unique ID of SDNC.
44579       location:
44580         type: string
44581         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
44582       product-name:
44583         type: string
44584         description: password used to access SDNC server.
44585       resource-version:
44586         type: string
44587         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44588       esr-system-info-list:
44589         type: object
44590         $ref: "#/definitions/esr-system-info-list"
44591       relationship-list:
44592         type: object
44593         $ref: "#/definitions/relationship-list"
44594   esr-thirdparty-sdnc-list:
44595     properties:
44596       esr-thirdparty-sdnc:
44597         type: array
44598         items:
44599           $ref: "#/definitions/esr-thirdparty-sdnc"
44600   esr-vnfm:
44601     description: |
44602       Persist VNFM address information used by VF-C.
44603       ###### Related Nodes
44604       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
44605       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
44606     required:
44607     - vnfm-id
44608     properties:
44609       vnfm-id:
44610         type: string
44611         description: Unique ID of VNFM.
44612       vim-id:
44613         type: string
44614         description: indecate the VIM to deploy VNF.
44615       certificate-url:
44616         type: string
44617         description: certificate url of VNFM.
44618       resource-version:
44619         type: string
44620         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44621       esr-system-info-list:
44622         type: object
44623         $ref: "#/definitions/esr-system-info-list"
44624       relationship-list:
44625         type: object
44626         $ref: "#/definitions/relationship-list"
44627   esr-vnfm-list:
44628     properties:
44629       esr-vnfm:
44630         type: array
44631         items:
44632           $ref: "#/definitions/esr-vnfm"
44633   evc:
44634     description: |
44635       evc object is an optional child object of the Configuration object.
44636       ###### Related Nodes
44637       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
44638     required:
44639     - evc-id
44640     properties:
44641       evc-id:
44642         type: string
44643         description: Unique/key field for the evc object
44644       forwarding-path-topology:
44645         type: string
44646         description: Point-to-Point, Multi-Point
44647       cir-value:
44648         type: string
44649         description: Commited Information Rate
44650       cir-units:
44651         type: string
44652         description: CIR units
44653       connection-diversity-group-id:
44654         type: string
44655         description: Diversity Group ID
44656       service-hours:
44657         type: string
44658         description: formerly Performance Group
44659       esp-evc-circuit-id:
44660         type: string
44661         description: EVC Circuit ID of ESP EVC
44662       esp-evc-cir-value:
44663         type: string
44664         description: Committed Information Rate (For ESP)
44665       esp-evc-cir-units:
44666         type: string
44667         description: CIR units (For ESP)
44668       esp-itu-code:
44669         type: string
44670         description: Identifies ESP
44671       collector-pop-clli:
44672         type: string
44673         description: Collector POP CLLI (from the hostname of the access pnf)
44674       inter-connect-type-ingress:
44675         type: string
44676         description: Interconnect type on ingress side of EVC.
44677       tagmode-access-ingress:
44678         type: string
44679         description: tagode for collector side of EVC
44680       tagmode-access-egress:
44681         type: string
44682         description: tagMode for network side of EVC
44683       relationship-list:
44684         type: array
44685         items:
44686           $ref: "#/definitions/relationship"
44687       resource-version:
44688         type: string
44689         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44690   evcs:
44691     properties:
44692       evc:
44693         type: array
44694         items:
44695           $ref: "#/definitions/evc"
44696   external-system:
44697     description: |
44698       Namespace for external system.
44699     properties:
44700       esr-ems-list:
44701         type: object
44702         $ref: "#/definitions/esr-ems-list"
44703       esr-vnfm-list:
44704         type: object
44705         $ref: "#/definitions/esr-vnfm-list"
44706       esr-thirdparty-sdnc-list:
44707         type: object
44708         $ref: "#/definitions/esr-thirdparty-sdnc-list"
44709   extra-properties:
44710     description: |
44711       Extra properties for inventory item for response list
44712   extra-property:
44713     properties:
44714       property-name:
44715         type: string
44716   flavor:
44717     description: |
44718       Openstack flavor.
44719       ###### Related Nodes
44720       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
44721       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
44722       - FLAVOR cannot be deleted if linked to VSERVER
44723     required:
44724     - flavor-id
44725     - flavor-name
44726     - flavor-selflink
44727     properties:
44728       flavor-id:
44729         type: string
44730         description: Flavor id, expected to be unique across cloud-region.
44731       flavor-name:
44732         type: string
44733         description: Flavor name
44734       flavor-vcpus:
44735         type: integer
44736         format: int32
44737         description: Number of CPUs
44738       flavor-ram:
44739         type: integer
44740         format: int32
44741         description: Amount of memory
44742       flavor-disk:
44743         type: integer
44744         format: int32
44745         description: Disk space
44746       flavor-ephemeral:
44747         type: integer
44748         format: int32
44749         description: Amount of ephemeral disk space
44750       flavor-swap:
44751         type: string
44752         description: amount of swap space allocation
44753       flavor-is-public:
44754         type: boolean
44755         description: whether flavor is available to all users or private to the tenant it was created in.
44756       flavor-selflink:
44757         type: string
44758         description: URL to endpoint where AAI can get more details
44759       flavor-disabled:
44760         type: boolean
44761         description: Boolean as to whether this flavor is no longer enabled
44762       resource-version:
44763         type: string
44764         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44765       relationship-list:
44766         type: array
44767         items:
44768           $ref: "#/definitions/relationship"
44769   flavors:
44770     description: |
44771       Collection of openstack flavors.
44772     properties:
44773       flavor:
44774         type: array
44775         items:
44776           $ref: "#/definitions/flavor"
44777   forwarder:
44778     description: |
44779       Entity describing a sequenced segment of forwarding path
44780       ###### Related Nodes
44781       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
44782       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
44783       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
44784       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
44785       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
44786       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
44787     required:
44788     - sequence
44789     properties:
44790       sequence:
44791         type: integer
44792         format: int32
44793         description: Unique ID of this segmentation
44794       forwarder-role:
44795         type: string
44796         description: ingress, intermediate, egress
44797       relationship-list:
44798         type: array
44799         items:
44800           $ref: "#/definitions/relationship"
44801       resource-version:
44802         type: string
44803         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44804   forwarder-evc:
44805     description: |
44806       forwarder object is an optional child object of the Configuration object.
44807       ###### Related Nodes
44808       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
44809     required:
44810     - forwarder-evc-id
44811     properties:
44812       forwarder-evc-id:
44813         type: string
44814         description: Key for forwarder-evc object
44815       circuit-id:
44816         type: string
44817         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
44818       ivlan:
44819         type: string
44820         description: Internal VLAN.
44821       svlan:
44822         type: string
44823         description: SVLAN value for ingress of egress forwarder.
44824       cvlan:
44825         type: string
44826         description: CVLAN value for ingress of egress forwarder.
44827       relationship-list:
44828         type: array
44829         items:
44830           $ref: "#/definitions/relationship"
44831       resource-version:
44832         type: string
44833         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44834   forwarder-evcs:
44835     properties:
44836       forwarder-evc:
44837         type: array
44838         items:
44839           $ref: "#/definitions/forwarder-evc"
44840   forwarders:
44841     properties:
44842       forwarder:
44843         type: array
44844         items:
44845           $ref: "#/definitions/forwarder"
44846   forwarding-path:
44847     description: |
44848       Entity that describes the sequenced forwarding path between interfaces of services or resources
44849       ###### Related Nodes
44850       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
44851       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
44852       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
44853       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
44854       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
44855     required:
44856     - forwarding-path-id
44857     - forwarding-path-name
44858     properties:
44859       forwarding-path-id:
44860         type: string
44861         description: Unique ID of this FP
44862       forwarding-path-name:
44863         type: string
44864         description: Name of the FP
44865       relationship-list:
44866         type: array
44867         items:
44868           $ref: "#/definitions/relationship"
44869       resource-version:
44870         type: string
44871         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
44872       selflink:
44873         type: string
44874         description: the self link for this FP
44875       forwarders:
44876         type: array
44877         items:
44878           $ref: "#/definitions/forwarder"
44879   forwarding-paths:
44880     properties:
44881       forwarding-path:
44882         type: array
44883         items:
44884           $ref: "#/definitions/forwarding-path"
44885   generic-vnf:
44886     description: |
44887       General purpose VNF
44888       ###### Related Nodes
44889       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
44890       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
44891       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
44892       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
44893       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
44894       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
44895       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
44896       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
44897       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
44898       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44899       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44900       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44901       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
44902       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
44903       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
44904       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
44905       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
44906       - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
44907     required:
44908     - vnf-id
44909     - vnf-name
44910     - vnf-type
44911     - in-maint
44912     - is-closed-loop-disabled
44913     properties:
44914       vnf-id:
44915         type: string
44916         description: Unique id of VNF.  This is unique across the graph.
44917       vnf-name:
44918         type: string
44919         description: Name of VNF.
44920       vnf-name2:
44921         type: string
44922         description: Alternate name of VNF.
44923       vnf-type:
44924         type: string
44925         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
44926       service-id:
44927         type: string
44928         description: Unique identifier of service from ASDC
44929       regional-resource-zone:
44930         type: string
44931         description: Regional way of organizing pservers, source of truth should define values
44932       prov-status:
44933         type: string
44934         description: Trigger for operational monitoring of this resource by Service Assurance systems.
44935       operational-state:
44936         type: string
44937         description: Indicator for whether the resource is considered operational
44938       license-key:
44939         type: string
44940         description: License key
44941       equipment-role:
44942         type: string
44943         description: Client should send valid enumerated value
44944       orchestration-status:
44945         type: string
44946         description: Orchestration status of this VNF, used by MSO.
44947       heat-stack-id:
44948         type: string
44949         description: Heat stack id corresponding to this instance, managed by MSO
44950       mso-catalog-key:
44951         type: string
44952         description: Corresponds to the SDN-C catalog id used to configure this VCE
44953       management-option:
44954         type: string
44955         description: identifier of managed by company or customer
44956       ipv4-oam-address:
44957         type: string
44958         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
44959       ipv4-loopback0-address:
44960         type: string
44961         description: v4 Loopback0 address
44962       nm-lan-v6-address:
44963         type: string
44964         description: v6 Loopback address
44965       management-v6-address:
44966         type: string
44967         description: v6 management address
44968       vcpu:
44969         type: integer
44970         format: int64
44971         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
44972       vcpu-units:
44973         type: string
44974         description: units associated with vcpu, used for VNFs with no vservers/flavors
44975       vmemory:
44976         type: integer
44977         format: int64
44978         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
44979       vmemory-units:
44980         type: string
44981         description: units associated with vmemory, used for VNFs with no vservers/flavors
44982       vdisk:
44983         type: integer
44984         format: int64
44985         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
44986       vdisk-units:
44987         type: string
44988         description: units associated with vdisk, used for VNFs with no vservers/flavors
44989       in-maint:
44990         type: boolean
44991       is-closed-loop-disabled:
44992         type: boolean
44993       resource-version:
44994         type: string
44995         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
44996       summary-status:
44997         type: string
44998         description: details regarding the generic-vnf operation
44999       encrypted-access-flag:
45000         type: boolean
45001         description: indicates whether generic-vnf access uses SSH
45002       persona-model-id:
45003         type: string
45004         description: the ASDC model id for this resource or service model.
45005       persona-model-version:
45006         type: string
45007         description: the ASDC model version for this resource or service model.
45008       model-version-id:
45009         type: string
45010         description: the ASDC model version for this resource or service model.
45011       widget-model-id:
45012         type: string
45013         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45014       widget-model-version:
45015         type: string
45016         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45017       as-number:
45018         type: string
45019         description: as-number of the VNF
45020       regional-resource-subzone:
45021         type: string
45022         description: represents sub zone of the rr plane
45023       relationship-list:
45024         type: array
45025         items:
45026           $ref: "#/definitions/relationship"
45027       l-interfaces:
45028         type: array
45029         items:
45030           $ref: "#/definitions/l-interface"
45031       lag-interfaces:
45032         type: array
45033         items:
45034           $ref: "#/definitions/lag-interface"
45035       vf-modules:
45036         type: array
45037         items:
45038           $ref: "#/definitions/vf-module"
45039   generic-vnfs:
45040     description: |
45041       Collection of VNFs
45042     properties:
45043       generic-vnf:
45044         type: array
45045         items:
45046           $ref: "#/definitions/generic-vnf"
45047   group-assignment:
45048     description: |
45049       Openstack group-assignment used to store exclusivity groups (EG).
45050       ###### Related Nodes
45051       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
45052       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
45053       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
45054     required:
45055     - group-id
45056     - group-type
45057     - group-name
45058     properties:
45059       group-id:
45060         type: string
45061         description: Group id, expected to be unique across cloud-region.
45062       group-type:
45063         type: string
45064         description: Group type - the type of group this instance refers to
45065       group-name:
45066         type: string
45067         description: Group name - name assigned to the group
45068       group-description:
45069         type: string
45070         description: Group description - description of the group
45071       resource-version:
45072         type: string
45073         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45074       relationship-list:
45075         type: array
45076         items:
45077           $ref: "#/definitions/relationship"
45078   group-assignments:
45079     description: |
45080       Collection of openstack group assignments
45081     properties:
45082       group-assignment:
45083         type: array
45084         items:
45085           $ref: "#/definitions/group-assignment"
45086   host-route:
45087     description: |
45088       ###### Related Nodes
45089       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
45090     required:
45091     - host-route-id
45092     - route-prefix
45093     - next-hop
45094     properties:
45095       host-route-id:
45096         type: string
45097         description: host-route id
45098       route-prefix:
45099         type: string
45100         description: subnet prefix
45101       next-hop:
45102         type: string
45103         description: Could be ip-address, hostname, or service-instance
45104       next-hop-type:
45105         type: string
45106         description: Should be ip-address, hostname, or service-instance to match next-hop
45107       resource-version:
45108         type: string
45109         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45110       relationship-list:
45111         type: array
45112         items:
45113           $ref: "#/definitions/relationship"
45114   host-routes:
45115     properties:
45116       host-route:
45117         type: array
45118         items:
45119           $ref: "#/definitions/host-route"
45120   image:
45121     description: |
45122       Openstack image.
45123       ###### Related Nodes
45124       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
45125       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
45126       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
45127       - IMAGE cannot be deleted if linked to VSERVER
45128       - IMAGE is DELETED when these are DELETED METADATUM
45129     required:
45130     - image-id
45131     - image-name
45132     - image-os-distro
45133     - image-os-version
45134     - image-selflink
45135     properties:
45136       image-id:
45137         type: string
45138         description: Image id, expected to be unique across cloud region
45139       image-name:
45140         type: string
45141         description: Image name
45142       image-architecture:
45143         type: string
45144         description: Operating system architecture.
45145       image-os-distro:
45146         type: string
45147         description: The common name of the operating system distribution in lowercase
45148       image-os-version:
45149         type: string
45150         description: The operating system version as specified by the distributor.
45151       application:
45152         type: string
45153         description: The application that the image instantiates.
45154       application-vendor:
45155         type: string
45156         description: The vendor of the application.
45157       application-version:
45158         type: string
45159         description: The version of the application.
45160       image-selflink:
45161         type: string
45162         description: URL to endpoint where AAI can get more details
45163       resource-version:
45164         type: string
45165         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45166       relationship-list:
45167         type: array
45168         items:
45169           $ref: "#/definitions/relationship"
45170       metadata:
45171         type: array
45172         items:
45173           $ref: "#/definitions/metadatum"
45174   images:
45175     description: |
45176       Collectio of Openstack images.
45177     properties:
45178       image:
45179         type: array
45180         items:
45181           $ref: "#/definitions/image"
45182   include-node-filter:
45183     properties:
45184       include-node-type:
45185         type: string
45186   instance-filter:
45187     description: |
45188       InstanceFilter for performing a named-query or model query
45189   instance-filters:
45190     description: |
45191       InstanceFilters for performing a named-query or model query
45192     properties:
45193       instance-filter:
45194         type: array
45195         items:
45196           $ref: "#/definitions/instance-filter"
45197   instance-group:
45198     description: |
45199       General mechanism for grouping instances
45200       ###### Related Nodes
45201       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
45202       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45203       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45204       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45205       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
45206     required:
45207     - id
45208     - description
45209     - type
45210     properties:
45211       id:
45212         type: string
45213         description: Instance Group ID, UUID assigned to this instance.
45214       description:
45215         type: string
45216         description: Descriptive text to help identify the usage of this instance-group
45217       type:
45218         type: string
45219         description: Only valid value today is lower case ha for high availability
45220       sub-type:
45221         type: string
45222         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
45223       resource-version:
45224         type: string
45225         description: Concurrency value
45226       relationship-list:
45227         type: array
45228         items:
45229           $ref: "#/definitions/relationship"
45230   instance-groups:
45231     description: |
45232       Collection of openstack route table references
45233     properties:
45234       instance-group:
45235         type: array
45236         items:
45237           $ref: "#/definitions/instance-group"
45238   inventory:
45239     properties:
45240       search:
45241         type: object
45242         $ref: "#/definitions/search"
45243       actions:
45244         type: object
45245         $ref: "#/definitions/actions"
45246       cloud-infrastructure:
45247         type: object
45248         $ref: "#/definitions/cloud-infrastructure"
45249       business:
45250         type: object
45251         $ref: "#/definitions/business"
45252       service-design-and-creation:
45253         type: object
45254         $ref: "#/definitions/service-design-and-creation"
45255       network:
45256         type: object
45257         $ref: "#/definitions/network"
45258       aai-internal:
45259         type: object
45260         $ref: "#/definitions/aai-internal"
45261   inventory-item:
45262     properties:
45263       inventory-item-type:
45264         type: string
45265       inventory-item-link:
45266         type: string
45267       inventory-item-data:
45268         type: array
45269         items:
45270           $ref: "#/definitions/inventory-item-data"
45271       tagged-inventory-item-list:
45272         type: array
45273         items:
45274           $ref: "#/definitions/tagged-inventory-item-list"
45275   inventory-item-data:
45276     properties:
45277       property-name:
45278         type: string
45279       property-value:
45280         type: string
45281   inventory-response-item:
45282     description: |
45283       Inventory item for response list
45284     properties:
45285       model-name:
45286         type: string
45287       extra-properties:
45288         type: object
45289         $ref: "#/definitions/extra-properties"
45290       inventory-response-items:
45291         type: object
45292         $ref: "#/definitions/inventory-response-items"
45293   inventory-response-items:
45294     description: |
45295       Container for inventory items in response list
45296     properties:
45297       inventory-response-item:
45298         type: array
45299         items:
45300           $ref: "#/definitions/inventory-response-item"
45301   ipsec-configuration:
45302     description: |
45303       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
45304       ###### Related Nodes
45305       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
45306       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
45307       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
45308     required:
45309     - ipsec-configuration-id
45310     properties:
45311       ipsec-configuration-id:
45312         type: string
45313         description: UUID of this configuration
45314       requested-vig-address-type:
45315         type: string
45316         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
45317       requested-encryption-strength:
45318         type: string
45319         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
45320       requested-dmz-type:
45321         type: string
45322         description: can offer a shared DMZ or a DMZ specific to a customer
45323       shared-dmz-network-address:
45324         type: string
45325         description: Network address of shared DMZ
45326       requested-customer-name:
45327         type: string
45328         description: If the DMZ is a custom DMZ, this field will indicate the customer information
45329       ike-version:
45330         type: string
45331         description: can be 1 or 2
45332       ikev1-authentication:
45333         type: string
45334         description: Contains values like md5, sha1, sha256, sha384
45335       ikev1-encryption:
45336         type: string
45337         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
45338       ikev1-dh-group:
45339         type: string
45340         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
45341       ikev1-am-group-id:
45342         type: string
45343         description: Group name defined in VIG for clients using aggressive mode
45344       ikev1-am-password:
45345         type: string
45346         description: pre-shared key for the above group name
45347       ikev1-sa-lifetime:
45348         type: string
45349         description: Lifetime for IKEv1 SA
45350       ipsec-authentication:
45351         type: string
45352         description: md5, sha1, sha256, sha384
45353       ipsec-encryption:
45354         type: string
45355         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
45356       ipsec-sa-lifetime:
45357         type: string
45358         description: Life time for IPSec SA
45359       ipsec-pfs:
45360         type: string
45361         description: enable PFS or not
45362       xauth-userid:
45363         type: string
45364         description: user ID for xAuth, sm-user, ,nmteHostName
45365       xauth-user-password:
45366         type: string
45367         description: Encrypted using the Juniper $9$ algorithm
45368       dpd-interval:
45369         type: string
45370         description: The time between DPD probe
45371       dpd-frequency:
45372         type: string
45373         description: Maximum number of DPD before claiming the tunnel is down
45374       resource-version:
45375         type: string
45376         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45377       relationship-list:
45378         type: array
45379         items:
45380           $ref: "#/definitions/relationship"
45381       vig-servers:
45382         type: array
45383         items:
45384           $ref: "#/definitions/vig-server"
45385   ipsec-configurations:
45386     properties:
45387       ipsec-configuration:
45388         type: array
45389         items:
45390           $ref: "#/definitions/ipsec-configuration"
45391   key-data:
45392     properties:
45393       key-name:
45394         type: string
45395       key-value:
45396         type: string
45397   l-interface:
45398     description: |
45399       Logical interfaces, e.g., a vnic.
45400       ###### Related Nodes
45401       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
45402       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
45403       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
45404       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
45405       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
45406       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
45407       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45408       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45409       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
45410       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
45411       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
45412       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
45413     required:
45414     - interface-name
45415     properties:
45416       interface-name:
45417         type: string
45418         description: Name given to the interface
45419       interface-role:
45420         type: string
45421         description: E.g., CUSTOMER, UPLINK, etc.
45422       v6-wan-link-ip:
45423         type: string
45424         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
45425       selflink:
45426         type: string
45427         description: URL to endpoint where AAI can get more details
45428       interface-id:
45429         type: string
45430         description: ID of interface
45431       macaddr:
45432         type: string
45433         description: MAC address for the interface
45434       network-name:
45435         type: string
45436         description: Name of the network
45437       management-option:
45438         type: string
45439         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
45440       resource-version:
45441         type: string
45442         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45443       vlans:
45444         type: array
45445         items:
45446           $ref: "#/definitions/vlan"
45447       sriov-vfs:
45448         type: array
45449         items:
45450           $ref: "#/definitions/sriov-vf"
45451       relationship-list:
45452         type: array
45453         items:
45454           $ref: "#/definitions/relationship"
45455       l3-interface-ipv4-address-list:
45456         type: array
45457         items:
45458           $ref: "#/definitions/l3-interface-ipv4-address-list"
45459       l3-interface-ipv6-address-list:
45460         type: array
45461         items:
45462           $ref: "#/definitions/l3-interface-ipv6-address-list"
45463   l-interfaces:
45464     description: |
45465       Collection of logical interfaces.
45466     properties:
45467       l-interface:
45468         type: array
45469         items:
45470           $ref: "#/definitions/l-interface"
45471   l3-interface-ipv4-address-list:
45472     description: |
45473       IPv4 Address Range
45474       ###### Related Nodes
45475       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45476       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
45477       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45478       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
45479     required:
45480     - l3-interface-ipv4-address
45481     properties:
45482       l3-interface-ipv4-address:
45483         type: string
45484         description: IP address
45485       l3-interface-ipv4-prefix-length:
45486         type: integer
45487         format: int64
45488         description: Prefix length, 32 for single address
45489       vlan-id-inner:
45490         type: integer
45491         format: int64
45492         description: Inner VLAN tag
45493       vlan-id-outer:
45494         type: integer
45495         format: int64
45496         description: Outer VLAN tag
45497       is-floating:
45498         type: boolean
45499         description: Indicator of fixed or floating address
45500       resource-version:
45501         type: string
45502         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45503       neutron-network-id:
45504         type: string
45505         description: Neutron network id of the interface that address belongs to
45506       neutron-subnet-id:
45507         type: string
45508         description: Neutron id of subnet that address belongs to
45509       relationship-list:
45510         type: array
45511         items:
45512           $ref: "#/definitions/relationship"
45513   l3-interface-ipv6-address-list:
45514     description: |
45515       IPv6 Address Range
45516       ###### Related Nodes
45517       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45518       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
45519       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
45520       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
45521     required:
45522     - l3-interface-ipv6-address
45523     properties:
45524       l3-interface-ipv6-address:
45525         type: string
45526         description: IP address
45527       l3-interface-ipv6-prefix-length:
45528         type: integer
45529         format: int64
45530         description: Prefix length, 128 for single address
45531       vlan-id-inner:
45532         type: integer
45533         format: int64
45534         description: Inner VLAN tag
45535       vlan-id-outer:
45536         type: integer
45537         format: int64
45538         description: Outer VLAN tag
45539       is-floating:
45540         type: boolean
45541         description: Indicator of fixed or floating address
45542       resource-version:
45543         type: string
45544         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45545       neutron-network-id:
45546         type: string
45547         description: Neutron network id of the interface that address belongs to
45548       neutron-subnet-id:
45549         type: string
45550         description: Neutron id of subnet that address belongs to
45551       relationship-list:
45552         type: array
45553         items:
45554           $ref: "#/definitions/relationship"
45555   l3-network:
45556     description: |
45557       Generic network definition
45558       ###### Related Nodes
45559       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
45560       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
45561       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
45562       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45563       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45564       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45565       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45566       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
45567       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
45568       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
45569       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
45570       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
45571       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
45572       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
45573       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
45574     required:
45575     - network-id
45576     - network-name
45577     - is-bound-to-vpn
45578     - is-provider-network
45579     - is-shared-network
45580     - is-external-network
45581     properties:
45582       network-id:
45583         type: string
45584         description: Network ID, should be uuid. Unique across A&AI.
45585       network-name:
45586         type: string
45587         description: Name of the network, governed by some naming convention..
45588       network-type:
45589         type: string
45590         description: Type of the network - who defines these values?
45591       network-role:
45592         type: string
45593         description: Role the network plans - who defines these values?
45594       network-technology:
45595         type: string
45596         description: Network technology - who defines these values?
45597       neutron-network-id:
45598         type: string
45599         description: Neutron network id of this Interface
45600       is-bound-to-vpn:
45601         type: boolean
45602       service-id:
45603         type: string
45604         description: Unique identifier of service from ASDC
45605       network-role-instance:
45606         type: integer
45607         format: int64
45608         description: network role instance
45609       resource-version:
45610         type: string
45611         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45612       orchestration-status:
45613         type: string
45614         description: Orchestration status of this VNF, mastered by MSO
45615       heat-stack-id:
45616         type: string
45617         description: Heat stack id corresponding to this instance, managed by MSO
45618       mso-catalog-key:
45619         type: string
45620         description: Corresponds to the SDN-C catalog id used to configure this VCE
45621       contrail-network-fqdn:
45622         type: string
45623         description: Contrail FQDN for the network
45624       persona-model-id:
45625         type: string
45626         description: the ASDC model id for this resource or service model.
45627       persona-model-version:
45628         type: string
45629         description: the ASDC model version for this resource or service model.
45630       model-version-id:
45631         type: string
45632         description: the ASDC model version for this resource or service model.
45633       widget-model-id:
45634         type: string
45635         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45636       widget-model-version:
45637         type: string
45638         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45639       physical-network-name:
45640         type: string
45641         description: Name associated with the physical network.
45642       is-provider-network:
45643         type: boolean
45644       is-shared-network:
45645         type: boolean
45646       is-external-network:
45647         type: boolean
45648       subnets:
45649         type: array
45650         items:
45651           $ref: "#/definitions/subnet"
45652       ctag-assignments:
45653         type: array
45654         items:
45655           $ref: "#/definitions/ctag-assignment"
45656       segmentation-assignments:
45657         type: array
45658         items:
45659           $ref: "#/definitions/segmentation-assignment"
45660       relationship-list:
45661         type: array
45662         items:
45663           $ref: "#/definitions/relationship"
45664         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
45665   l3-networks:
45666     properties:
45667       l3-network:
45668         type: array
45669         items:
45670           $ref: "#/definitions/l3-network"
45671   lag-interface:
45672     description: |
45673       Link aggregate interface
45674       ###### Related Nodes
45675       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
45676       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
45677       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
45678       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
45679       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
45680       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
45681       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
45682       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
45683       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
45684     required:
45685     - interface-name
45686     properties:
45687       interface-name:
45688         type: string
45689         description: Name that identifies the link aggregate interface
45690       resource-version:
45691         type: string
45692         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45693       speed-value:
45694         type: string
45695         description: Captures the numeric part of the speed
45696       speed-units:
45697         type: string
45698         description: Captures the units corresponding to the speed
45699       relationship-list:
45700         type: array
45701         items:
45702           $ref: "#/definitions/relationship"
45703       l-interfaces:
45704         type: array
45705         items:
45706           $ref: "#/definitions/l-interface"
45707   lag-interfaces:
45708     description: |
45709       Collection of link aggregate interfaces.
45710     properties:
45711       lag-interface:
45712         type: array
45713         items:
45714           $ref: "#/definitions/lag-interface"
45715   lag-link:
45716     description: |
45717       LAG links can connect lag-interfaces
45718       ###### Related Nodes
45719       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
45720       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
45721     required:
45722     - link-name
45723     properties:
45724       link-name:
45725         type: string
45726         description: Alphabetical concatenation of lag-interface names
45727       resource-version:
45728         type: string
45729         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45730       relationship-list:
45731         type: array
45732         items:
45733           $ref: "#/definitions/relationship"
45734   lag-links:
45735     description: |
45736       Collection of link aggregation connections
45737     properties:
45738       lag-link:
45739         type: array
45740         items:
45741           $ref: "#/definitions/lag-link"
45742   license:
45743     description: |
45744       Metadata for license group.
45745       ###### Related Nodes
45746       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
45747       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
45748     required:
45749     - group-uuid
45750     - resource-uuid
45751     properties:
45752       group-uuid:
45753         type: string
45754         description: Unique ID for the license group the resource belongs to, should be uuid.
45755       resource-uuid:
45756         type: string
45757         description: Unique ID of a license resource.
45758       resource-version:
45759         type: string
45760         description: Concurrency value
45761       relationship-list:
45762         type: array
45763         items:
45764           $ref: "#/definitions/relationship"
45765   licenses:
45766     description: |
45767       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
45768     properties:
45769       license:
45770         type: array
45771         items:
45772           $ref: "#/definitions/license"
45773   line-of-business:
45774     description: |
45775       describes a line-of-business
45776       ###### Related Nodes
45777       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
45778     required:
45779     - line-of-business-name
45780     properties:
45781       line-of-business-name:
45782         type: string
45783         description: Name of the line-of-business (product)
45784       resource-version:
45785         type: string
45786         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45787       relationship-list:
45788         type: array
45789         items:
45790           $ref: "#/definitions/relationship"
45791   lines-of-business:
45792     description: |
45793       Collection of lines-of-business
45794     properties:
45795       line-of-business:
45796         type: array
45797         items:
45798           $ref: "#/definitions/line-of-business"
45799   logical-link:
45800     description: |
45801       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
45802       ###### Related Nodes
45803       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
45804       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
45805       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
45806       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
45807       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
45808       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
45809       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
45810       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
45811       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
45812       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
45813       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
45814     required:
45815     - link-name
45816     - link-type
45817     properties:
45818       link-name:
45819         type: string
45820         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
45821       link-type:
45822         type: string
45823         description: Type of logical link, e.g., evc
45824       speed-value:
45825         type: string
45826         description: Captures the numeric part of the speed
45827       speed-units:
45828         type: string
45829         description: Captures the units corresponding to the speed
45830       ip-version:
45831         type: string
45832         description: v4, v6, or ds for dual stack
45833       routing-protocol:
45834         type: string
45835         description: For example, static or BGP
45836       resource-version:
45837         type: string
45838         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45839       persona-model-id:
45840         type: string
45841         description: the ASDC model id for this resource or service model.
45842       persona-model-version:
45843         type: string
45844         description: the ASDC model version for this resource or service model.
45845       model-version-id:
45846         type: string
45847         description: the ASDC model version for this resource or service model.
45848       widget-model-id:
45849         type: string
45850         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
45851       widget-model-version:
45852         type: string
45853         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
45854       operational-status:
45855         type: string
45856         description: Indication of operational status of the logical link.
45857       link-role:
45858         type: string
45859         description: Indication of the network use of the logical link.
45860       link-name2:
45861         type: string
45862         description: Alias or alternate name (CLCI or D1 name).
45863       link-id:
45864         type: string
45865         description: UUID of the logical-link, SDNC generates this.
45866       relationship-list:
45867         type: array
45868         items:
45869           $ref: "#/definitions/relationship"
45870   logical-links:
45871     description: |
45872       Collection of logical connections
45873     properties:
45874       logical-link:
45875         type: array
45876         items:
45877           $ref: "#/definitions/logical-link"
45878   metadata:
45879     description: |
45880       Collection of metadatum (key/value pairs)
45881     properties:
45882       metadatum:
45883         type: array
45884         items:
45885           $ref: "#/definitions/metadatum"
45886   metadatum:
45887     description: |
45888       Key/value pairs
45889       ###### Related Nodes
45890       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
45891       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
45892       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
45893       - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
45894     required:
45895     - metaname
45896     - metaval
45897     properties:
45898       metaname:
45899         type: string
45900       metaval:
45901         type: string
45902       resource-version:
45903         type: string
45904         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45905   model:
45906     description: |
45907       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
45908       ###### Related Nodes
45909       - TO model( model-element isA model, MANY2ONE)
45910       - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)
45911       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
45912       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
45913       - FROM model-element( model-element isA model, MANY2ONE)
45914       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
45915       - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT
45916       - MODEL is DELETED when these are DELETED METADATUM
45917       - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT
45918     required:
45919     - model-name-version-id
45920     - model-type
45921     - model-name
45922     - model-id
45923     - model-version
45924     properties:
45925       model-name-version-id:
45926         type: string
45927         description: Unique identifier corresponding to one version of a model in ASDC
45928       model-type:
45929         type: string
45930         description: Type of the model, e.g., service, resource, widget, etc.
45931       model-name:
45932         type: string
45933         description: Name of the model, which can change from version to version.
45934       model-id:
45935         type: string
45936         description: Invariant unique ID which does not change from version to version
45937       model-version:
45938         type: string
45939         description: Version
45940       model-description:
45941         type: string
45942         description: Description
45943       resource-version:
45944         type: string
45945         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
45946       model-elements:
45947         type: array
45948         items:
45949           $ref: "#/definitions/model-element"
45950       metadata:
45951         type: array
45952         items:
45953           $ref: "#/definitions/metadatum"
45954       relationship-list:
45955         type: array
45956         items:
45957           $ref: "#/definitions/relationship"
45958   model-and-named-query-search:
45959     description: |
45960       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
45961     properties:
45962       query-parameters:
45963         type: object
45964         $ref: "#/definitions/query-parameters"
45965       instance-filters:
45966         type: object
45967         $ref: "#/definitions/instance-filters"
45968       top-node-type:
45969         type: string
45970   model-constraint:
45971     description: |
45972       This is how we would capture constraints defining allowed sets of elements.
45973       ###### Related Nodes
45974       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
45975       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
45976       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
45977     required:
45978     - model-constraint-uuid
45979     - constrained-element-set-uuid-to-replace
45980     properties:
45981       model-constraint-uuid:
45982         type: string
45983       constrained-element-set-uuid-to-replace:
45984         type: string
45985       constrained-element-sets:
45986         type: array
45987         items:
45988           $ref: "#/definitions/constrained-element-set"
45989   model-constraints:
45990     properties:
45991       model-constraint:
45992         type: array
45993         items:
45994           $ref: "#/definitions/model-constraint"
45995   model-element:
45996     description: |
45997       Defines how other models combine to make up a higher-level model.
45998       ###### Related Nodes
45999       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
46000       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46001       - TO model( model-element isA model, MANY2ONE)
46002       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46003       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46004       - FROM model (PARENT of model-element, model startsWith model-element)
46005       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
46006       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
46007     required:
46008     - model-element-uuid
46009     - new-data-del-flag
46010     - cardinality
46011     properties:
46012       model-element-uuid:
46013         type: string
46014       new-data-del-flag:
46015         type: string
46016         description: Indicates whether this element was created as part of instantiation from this model
46017       cardinality:
46018         type: string
46019         description: How many of this type of element are required/allowed
46020       linkage-points:
46021         type: string
46022       resource-version:
46023         type: string
46024         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46025       model-elements:
46026         type: array
46027         items:
46028           $ref: "#/definitions/model-element"
46029         description: Defines how other models combine to make up a higher-level model
46030       model-constraints:
46031         type: array
46032         items:
46033           $ref: "#/definitions/model-constraint"
46034         description: Describes new constraints on this model element that are not part of that model's definition
46035       relationship-list:
46036         type: array
46037         items:
46038           $ref: "#/definitions/relationship"
46039   model-elements:
46040     properties:
46041       model-element:
46042         type: array
46043         items:
46044           $ref: "#/definitions/model-element"
46045   model-ver:
46046     description: |
46047       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
46048       ###### Related Nodes
46049       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
46050       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
46051       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
46052       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
46053       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
46054       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
46055     required:
46056     - model-version-id
46057     - model-name
46058     - model-version
46059     properties:
46060       model-version-id:
46061         type: string
46062         description: Unique identifier corresponding to one version of a model in ASDC
46063       model-name:
46064         type: string
46065         description: Name of the model, which can change from version to version.
46066       model-version:
46067         type: string
46068         description: Version
46069       model-description:
46070         type: string
46071         description: Description
46072       resource-version:
46073         type: string
46074         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46075       model-elements:
46076         type: array
46077         items:
46078           $ref: "#/definitions/model-element"
46079       metadata:
46080         type: array
46081         items:
46082           $ref: "#/definitions/metadatum"
46083       relationship-list:
46084         type: array
46085         items:
46086           $ref: "#/definitions/relationship"
46087   model-vers:
46088     properties:
46089       model-ver:
46090         type: array
46091         items:
46092           $ref: "#/definitions/model-ver"
46093   models:
46094     description: |
46095       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
46096     properties:
46097       model:
46098         type: array
46099         items:
46100           $ref: "#/definitions/model"
46101   multicast-configuration:
46102     description: |
46103       ###### Related Nodes
46104       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
46105     required:
46106     - multicast-configuration-id
46107     - multicast-protocol
46108     - rp-type
46109     properties:
46110       multicast-configuration-id:
46111         type: string
46112         description: Unique id of multicast configuration.
46113       multicast-protocol:
46114         type: string
46115         description: protocol of multicast configuration
46116       rp-type:
46117         type: string
46118         description: rp type of multicast configuration
46119       resource-version:
46120         type: string
46121         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46122       relationship-list:
46123         type: array
46124         items:
46125           $ref: "#/definitions/relationship"
46126   multicast-configurations:
46127     description: |
46128       multicast configuration of generic-vnf ip-address
46129     properties:
46130       multicast-configuration:
46131         type: array
46132         items:
46133           $ref: "#/definitions/multicast-configuration"
46134   named-queries:
46135     properties:
46136       named-query:
46137         type: array
46138         items:
46139           $ref: "#/definitions/named-query"
46140   named-query:
46141     description: |
46142       TBD
46143       ###### Related Nodes
46144       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
46145       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
46146       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
46147       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
46148     required:
46149     - named-query-uuid
46150     - named-query-name
46151     - named-query-version
46152     properties:
46153       named-query-uuid:
46154         type: string
46155       named-query-name:
46156         type: string
46157       named-query-version:
46158         type: string
46159       required-input-param:
46160         type: string
46161       description:
46162         type: string
46163       resource-version:
46164         type: string
46165       named-query-elements:
46166         type: array
46167         items:
46168           $ref: "#/definitions/named-query-element"
46169       relationship-list:
46170         type: array
46171         items:
46172           $ref: "#/definitions/relationship"
46173   named-query-element:
46174     description: |
46175       TBD
46176       ###### Related Nodes
46177       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
46178       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
46179       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46180       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46181       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46182       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46183       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
46184     required:
46185     - named-query-element-uuid
46186     properties:
46187       named-query-element-uuid:
46188         type: string
46189       property-collect-list:
46190         type: string
46191       resource-version:
46192         type: string
46193       property-limit-desc:
46194         type: string
46195       do-not-output:
46196         type: string
46197       named-query-elements:
46198         type: array
46199         items:
46200           $ref: "#/definitions/named-query-element"
46201       related-lookups:
46202         type: array
46203         items:
46204           $ref: "#/definitions/related-lookup"
46205       property-constraints:
46206         type: array
46207         items:
46208           $ref: "#/definitions/property-constraint"
46209       relationship-list:
46210         type: array
46211         items:
46212           $ref: "#/definitions/relationship"
46213   named-query-elements:
46214     properties:
46215       named-query-element:
46216         type: array
46217         items:
46218           $ref: "#/definitions/named-query-element"
46219   network:
46220     description: |
46221       Namespace for network inventory resources.
46222     properties:
46223       logical-links:
46224         type: array
46225         items:
46226           $ref: "#/definitions/logical-link"
46227       site-pair-sets:
46228         type: array
46229         items:
46230           $ref: "#/definitions/site-pair-set"
46231       vpn-bindings:
46232         type: array
46233         items:
46234           $ref: "#/definitions/vpn-binding"
46235       vpls-pes:
46236         type: array
46237         items:
46238           $ref: "#/definitions/vpls-pe"
46239       multicast-configurations:
46240         type: array
46241         items:
46242           $ref: "#/definitions/multicast-configuration"
46243       vces:
46244         type: array
46245         items:
46246           $ref: "#/definitions/vce"
46247       vnfcs:
46248         type: array
46249         items:
46250           $ref: "#/definitions/vnfc"
46251       l3-networks:
46252         type: array
46253         items:
46254           $ref: "#/definitions/l3-network"
46255       network-policies:
46256         type: array
46257         items:
46258           $ref: "#/definitions/network-policy"
46259       generic-vnfs:
46260         type: array
46261         items:
46262           $ref: "#/definitions/generic-vnf"
46263       lag-links:
46264         type: array
46265         items:
46266           $ref: "#/definitions/lag-link"
46267       newvces:
46268         type: array
46269         items:
46270           $ref: "#/definitions/newvce"
46271       pnfs:
46272         type: array
46273         items:
46274           $ref: "#/definitions/pnf"
46275       physical-links:
46276         type: array
46277         items:
46278           $ref: "#/definitions/physical-link"
46279       ipsec-configurations:
46280         type: array
46281         items:
46282           $ref: "#/definitions/ipsec-configuration"
46283       route-table-references:
46284         type: array
46285         items:
46286           $ref: "#/definitions/route-table-reference"
46287   network-policies:
46288     properties:
46289       network-policy:
46290         type: array
46291         items:
46292           $ref: "#/definitions/network-policy"
46293   network-policy:
46294     description: |
46295       ###### Related Nodes
46296       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
46297     required:
46298     - network-policy-id
46299     properties:
46300       network-policy-id:
46301         type: string
46302         description: UUID representing unique key to this instance
46303       network-policy-fqdn:
46304         type: string
46305         description: Contrail FQDN for the policy
46306       heat-stack-id:
46307         type: string
46308         description: ID for the openStack Heat instance
46309       resource-version:
46310         type: string
46311         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46312       relationship-list:
46313         type: array
46314         items:
46315           $ref: "#/definitions/relationship"
46316   network-profile:
46317     description: |
46318       Network profile populated by SDN-GP for SNMP
46319       ###### Related Nodes
46320       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
46321     required:
46322     - nm-profile-name
46323     properties:
46324       nm-profile-name:
46325         type: string
46326         description: Unique name of network profile.
46327       community-string:
46328         type: string
46329         description: Encrypted SNMP community string
46330       resource-version:
46331         type: string
46332         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46333       relationship-list:
46334         type: array
46335         items:
46336           $ref: "#/definitions/relationship"
46337   network-profiles:
46338     description: |
46339       Collection of network profiles
46340     properties:
46341       network-profile:
46342         type: array
46343         items:
46344           $ref: "#/definitions/network-profile"
46345   newvce:
46346     description: |
46347       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
46348       ###### Related Nodes
46349       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
46350       - NEWVCE is DELETED when these are DELETED L-INTERFACE
46351     required:
46352     - vnf-id2
46353     - vnf-name
46354     - vnf-type
46355     properties:
46356       vnf-id2:
46357         type: string
46358         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
46359       vnf-name:
46360         type: string
46361         description: Name of VNF.
46362       vnf-name2:
46363         type: string
46364         description: Alternate name of VNF.
46365       vnf-type:
46366         type: string
46367         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
46368       prov-status:
46369         type: string
46370         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
46371       operational-state:
46372         type: string
46373         description: Indicator for whether the resource is considered operational
46374       license-key:
46375         type: string
46376         description: License key
46377       ipv4-oam-address:
46378         type: string
46379         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
46380       equipment-role:
46381         type: string
46382         description: Client should send valid enumerated value.
46383       resource-version:
46384         type: string
46385         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46386       ipv4-loopback0-address:
46387         type: string
46388         description: v4 Loopback0 address
46389       orchestration-status:
46390         type: string
46391         description: Orchestration status of this VNF, mastered by MSO.
46392       heat-stack-id:
46393         type: string
46394         description: Heat stack id corresponding to this instance, managed by MSO
46395       mso-catalog-key:
46396         type: string
46397         description: Corresponds to the SDN-C catalog id used to configure this VCE
46398       relationship-list:
46399         type: array
46400         items:
46401           $ref: "#/definitions/relationship"
46402       l-interfaces:
46403         type: array
46404         items:
46405           $ref: "#/definitions/l-interface"
46406   newvces:
46407     description: |
46408       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
46409     properties:
46410       newvce:
46411         type: array
46412         items:
46413           $ref: "#/definitions/newvce"
46414   notification-event:
46415     properties:
46416       cambria.partition:
46417         type: string
46418       notification-event-header:
46419         type: object
46420         $ref: "#/definitions/notification-event-header"
46421   notification-event-header:
46422     properties:
46423       id:
46424         type: string
46425       timestamp:
46426         type: string
46427       source-name:
46428         type: string
46429       domain:
46430         type: string
46431       sequence-number:
46432         type: string
46433       severity:
46434         type: string
46435       event-type:
46436         type: string
46437       version:
46438         type: string
46439       action:
46440         type: string
46441       entity-type:
46442         type: string
46443       top-entity-type:
46444         type: string
46445       entity-link:
46446         type: string
46447       status:
46448         type: string
46449   notify:
46450     required:
46451     - event-id
46452     properties:
46453       event-id:
46454         type: string
46455       node-type:
46456         type: string
46457       event-trigger:
46458         type: string
46459       key-data:
46460         type: array
46461         items:
46462           $ref: "#/definitions/key-data"
46463       selflink:
46464         type: string
46465   oam-network:
46466     description: |
46467       OAM network, to be deprecated shortly.  Do not use for new purposes.
46468       ###### Related Nodes
46469       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
46470       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
46471       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
46472     required:
46473     - network-uuid
46474     - network-name
46475     - cvlan-tag
46476     properties:
46477       network-uuid:
46478         type: string
46479         description: UUID of the network. Unique across a cloud-region
46480       network-name:
46481         type: string
46482         description: Name of the network.
46483       cvlan-tag:
46484         type: integer
46485         format: int64
46486         description: cvlan-id
46487       ipv4-oam-gateway-address:
46488         type: string
46489         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
46490       ipv4-oam-gateway-address-prefix-length:
46491         type: integer
46492         format: int32
46493         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
46494       resource-version:
46495         type: string
46496         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46497       relationship-list:
46498         type: array
46499         items:
46500           $ref: "#/definitions/relationship"
46501   oam-networks:
46502     description: |
46503       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
46504     properties:
46505       oam-network:
46506         type: array
46507         items:
46508           $ref: "#/definitions/oam-network"
46509   operational-environment:
46510     description: |
46511       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
46512       ###### Related Nodes
46513       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
46514       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
46515     required:
46516     - operational-environment-id
46517     - operational-environment-name
46518     - operational-environment-type
46519     - operational-environment-status
46520     - tenant-context
46521     - workload-context
46522     properties:
46523       operational-environment-id:
46524         type: string
46525         description: UUID of an operational environment
46526       operational-environment-name:
46527         type: string
46528         description: Operational Environment name
46529       operational-environment-type:
46530         type: string
46531         description: Operational Environment Type.
46532       operational-environment-status:
46533         type: string
46534         description: Status
46535       tenant-context:
46536         type: string
46537         description: Tenant Context.
46538       workload-context:
46539         type: string
46540         description: Workload Context.
46541       resource-version:
46542         type: string
46543         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46544       relationship-list:
46545         type: array
46546         items:
46547           $ref: "#/definitions/relationship"
46548   operational-environments:
46549     description: |
46550       a logical partition of the cloud which allows to have multiple environments in the production AIC.
46551     properties:
46552       operational-environment:
46553         type: array
46554         items:
46555           $ref: "#/definitions/operational-environment"
46556   overloaded-model:
46557     description: |
46558       Allows for legacy POST of old-style and new-style models
46559     required:
46560     - model-invariant-id
46561     - model-name-version-id
46562     - model-type
46563     - model-name
46564     - model-id
46565     - model-version
46566     properties:
46567       model-invariant-id:
46568         type: string
46569         description: Unique identifier corresponding to the main definition of a model in ASDC
46570       model-name-version-id:
46571         type: string
46572         description: Unique identifier corresponding to one version of a model in ASDC
46573       model-type:
46574         type: string
46575         description: Type of the model, e.g., service, resource, widget, etc.
46576       model-name:
46577         type: string
46578         description: Name of the model, which can change from version to version.
46579       model-id:
46580         type: string
46581         description: Invariant unique ID which does not change from version to version
46582       model-version:
46583         type: string
46584         description: Version
46585       model-description:
46586         type: string
46587         description: Description
46588       resource-version:
46589         type: string
46590         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46591       model-vers:
46592         type: object
46593         $ref: "#/definitions/model-vers"
46594       relationship-list:
46595         type: object
46596         $ref: "#/definitions/relationship-list"
46597   owning-entities:
46598     description: |
46599       Collection of owning-entities
46600     properties:
46601       owning-entity:
46602         type: array
46603         items:
46604           $ref: "#/definitions/owning-entity"
46605   owning-entity:
46606     description: |
46607       describes an owning-entity
46608       ###### Related Nodes
46609       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
46610     required:
46611     - owning-entity-id
46612     - owning-entity-name
46613     properties:
46614       owning-entity-id:
46615         type: string
46616         description: UUID of an owning entity
46617       owning-entity-name:
46618         type: string
46619         description: Owning entity name
46620       resource-version:
46621         type: string
46622         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46623       relationship-list:
46624         type: array
46625         items:
46626           $ref: "#/definitions/relationship"
46627   p-interface:
46628     description: |
46629       Physical interface (e.g., nic)
46630       ###### Related Nodes
46631       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
46632       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
46633       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
46634       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
46635       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
46636       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
46637       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
46638       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
46639       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
46640     required:
46641     - interface-name
46642     properties:
46643       interface-name:
46644         type: string
46645         description: Name that identifies the physical interface
46646       speed-value:
46647         type: string
46648         description: Captures the numeric part of the speed
46649       speed-units:
46650         type: string
46651         description: Captures the units corresponding to the speed
46652       port-description:
46653         type: string
46654         description: Nature of the services and connectivity on this port.
46655       equipment-identifier:
46656         type: string
46657         description: CLEI or other specification for p-interface hardware.
46658       interface-role:
46659         type: string
46660         description: Role specification for p-interface hardware.
46661       interface-type:
46662         type: string
46663         description: Indicates the physical properties of the interface.
46664       resource-version:
46665         type: string
46666         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46667       relationship-list:
46668         type: array
46669         items:
46670           $ref: "#/definitions/relationship"
46671       l-interfaces:
46672         type: array
46673         items:
46674           $ref: "#/definitions/l-interface"
46675   p-interfaces:
46676     description: |
46677       Collection of physical interfaces.
46678     properties:
46679       p-interface:
46680         type: array
46681         items:
46682           $ref: "#/definitions/p-interface"
46683   physical-link:
46684     description: |
46685       Collection of physical connections, typically between p-interfaces
46686       ###### Related Nodes
46687       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
46688     required:
46689     - link-name
46690     properties:
46691       link-name:
46692         type: string
46693         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
46694       speed-value:
46695         type: string
46696         description: Captures the numeric part of the speed
46697       speed-units:
46698         type: string
46699         description: Captures the units corresponding to the speed
46700       circuit-id:
46701         type: string
46702         description: Circuit it
46703       dual-mode:
46704         type: string
46705         description: Dual access mode (e.g., primary, secondary
46706       management-option:
46707         type: string
46708         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
46709       service-provider-name:
46710         type: string
46711         description: Name of the service Provider on this link.
46712       resource-version:
46713         type: string
46714         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46715       relationship-list:
46716         type: array
46717         items:
46718           $ref: "#/definitions/relationship"
46719   physical-links:
46720     description: |
46721       Collection of physical connections, typically between p-interfaces
46722     properties:
46723       physical-link:
46724         type: array
46725         items:
46726           $ref: "#/definitions/physical-link"
46727   platform:
46728     description: |
46729       describes a platform
46730       ###### Related Nodes
46731       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
46732     required:
46733     - platform-name
46734     properties:
46735       platform-name:
46736         type: string
46737         description: Name of the platform
46738       resource-version:
46739         type: string
46740         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46741       relationship-list:
46742         type: array
46743         items:
46744           $ref: "#/definitions/relationship"
46745   platforms:
46746     description: |
46747       Collection of platforms
46748     properties:
46749       platform:
46750         type: array
46751         items:
46752           $ref: "#/definitions/platform"
46753   pnf:
46754     description: |
46755       PNF represents a physical network function. typically equipment used in the D1 world.
46756       ###### Related Nodes
46757       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
46758       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
46759       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
46760       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
46761       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
46762     required:
46763     - pnf-name
46764     - in-maint
46765     properties:
46766       pnf-name:
46767         type: string
46768         description: unique name of Physical Network Function.
46769       pnf-name2:
46770         type: string
46771         description: name of Physical Network Function.
46772       pnf-name2-source:
46773         type: string
46774         description: source of name2
46775       pnf-id:
46776         type: string
46777         description: id of pnf
46778       equip-type:
46779         type: string
46780         description: Equipment type.  Source of truth should define valid values.
46781       equip-vendor:
46782         type: string
46783         description: Equipment vendor.  Source of truth should define valid values.
46784       equip-model:
46785         type: string
46786         description: Equipment model.  Source of truth should define valid values.
46787       management-option:
46788         type: string
46789         description: identifier of managed by company or customer
46790       ipaddress-v4-oam:
46791         type: string
46792         description: ipv4-oam-address with new naming convention for IP addresses
46793       sw-version:
46794         type: string
46795         description: sw-version is the version of SW for the hosted application on the PNF.
46796       orchestration-status:
46797         type: string
46798         description: orchestration-status is the status of orchestration on the PNF.
46799       in-maint:
46800         type: boolean
46801       frame-id:
46802         type: string
46803         description: ID of the physical frame (relay rack) where pnf is installed.
46804       resource-version:
46805         type: string
46806         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46807       relationship-list:
46808         type: array
46809         items:
46810           $ref: "#/definitions/relationship"
46811       p-interfaces:
46812         type: array
46813         items:
46814           $ref: "#/definitions/p-interface"
46815       lag-interfaces:
46816         type: array
46817         items:
46818           $ref: "#/definitions/lag-interface"
46819   pnfs:
46820     description: |
46821       Collection of Physical Network Functions.
46822     properties:
46823       pnf:
46824         type: array
46825         items:
46826           $ref: "#/definitions/pnf"
46827   port-group:
46828     description: |
46829       Used to capture the network interfaces of this VCE
46830       ###### Related Nodes
46831       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
46832       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
46833       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
46834     required:
46835     - interface-id
46836     - orchestration-status
46837     properties:
46838       interface-id:
46839         type: string
46840         description: Unique ID of the interface
46841       neutron-network-id:
46842         type: string
46843         description: Neutron network id of this Interface
46844       neutron-network-name:
46845         type: string
46846         description: Neutron network name of this Interface
46847       interface-role:
46848         type: string
46849         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46850       resource-version:
46851         type: string
46852         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46853       port-group-id:
46854         type: string
46855         description: Unique ID for port group in vmware
46856       port-group-name:
46857         type: string
46858         description: Likely to duplicate value of neutron network name
46859       switch-name:
46860         type: string
46861         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
46862       orchestration-status:
46863         type: string
46864         description: Orchestration status of this VNF, mastered by MSO
46865       heat-stack-id:
46866         type: string
46867         description: Heat stack id corresponding to this instance, managed by MSO
46868       mso-catalog-key:
46869         type: string
46870         description: Corresponds to the SDN-C catalog id used to configure this VCE
46871       cvlan-tags:
46872         type: array
46873         items:
46874           $ref: "#/definitions/cvlan-tag-entry"
46875       relationship-list:
46876         type: array
46877         items:
46878           $ref: "#/definitions/relationship"
46879   port-groups:
46880     properties:
46881       port-group:
46882         type: array
46883         items:
46884           $ref: "#/definitions/port-group"
46885   project:
46886     description: |
46887       describes the project
46888       ###### Related Nodes
46889       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
46890     required:
46891     - project-name
46892     properties:
46893       project-name:
46894         type: string
46895         description: Name of the project deploying a service
46896       resource-version:
46897         type: string
46898         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
46899       relationship-list:
46900         type: array
46901         items:
46902           $ref: "#/definitions/relationship"
46903   projects:
46904     description: |
46905       Collection of projects
46906     properties:
46907       project:
46908         type: array
46909         items:
46910           $ref: "#/definitions/project"
46911   properties:
46912     description: |
46913       Property holder for query properties or instance properties
46914     properties:
46915       property-name:
46916         type: string
46917       property-value:
46918         type: string
46919   property-constraint:
46920     description: |
46921       TBD
46922       ###### Related Nodes
46923       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
46924     required:
46925     - property-constraint-uuid
46926     - constraint-type
46927     - property-name
46928     - property-value
46929     properties:
46930       property-constraint-uuid:
46931         type: string
46932       constraint-type:
46933         type: string
46934       property-name:
46935         type: string
46936       property-value:
46937         type: string
46938       resource-version:
46939         type: string
46940   property-constraints:
46941     properties:
46942       property-constraint:
46943         type: array
46944         items:
46945           $ref: "#/definitions/property-constraint"
46946   pserver:
46947     description: |
46948       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
46949       ###### Related Nodes
46950       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
46951       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
46952       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
46953       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
46954       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
46955       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
46956       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
46957       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
46958       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
46959       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
46960       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
46961       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
46962     required:
46963     - hostname
46964     - in-maint
46965     properties:
46966       hostname:
46967         type: string
46968         description: Value from executing hostname on the compute node.
46969       ptnii-equip-name:
46970         type: string
46971         description: PTNII name
46972       number-of-cpus:
46973         type: integer
46974         format: int32
46975         description: Number of cpus
46976       disk-in-gigabytes:
46977         type: integer
46978         format: int32
46979         description: Disk size, in GBs
46980       ram-in-megabytes:
46981         type: integer
46982         format: int32
46983         description: RAM size, in MBs
46984       equip-type:
46985         type: string
46986         description: Equipment type.  Source of truth should define valid values.
46987       equip-vendor:
46988         type: string
46989         description: Equipment vendor.  Source of truth should define valid values.
46990       equip-model:
46991         type: string
46992         description: Equipment model.  Source of truth should define valid values.
46993       fqdn:
46994         type: string
46995         description: Fully-qualified domain name
46996       pserver-selflink:
46997         type: string
46998         description: URL to endpoint where AAI can get more details
46999       ipv4-oam-address:
47000         type: string
47001         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
47002       serial-number:
47003         type: string
47004         description: Serial number, may be queried
47005       pserver-id:
47006         type: string
47007         description: ID of Pserver
47008       internet-topology:
47009         type: string
47010         description: internet topology of Pserver
47011       in-maint:
47012         type: boolean
47013       resource-version:
47014         type: string
47015         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47016       pserver-name2:
47017         type: string
47018         description: alternative pserver name
47019       purpose:
47020         type: string
47021         description: purpose of pserver
47022       relationship-list:
47023         type: array
47024         items:
47025           $ref: "#/definitions/relationship"
47026       p-interfaces:
47027         type: array
47028         items:
47029           $ref: "#/definitions/p-interface"
47030       lag-interfaces:
47031         type: array
47032         items:
47033           $ref: "#/definitions/lag-interface"
47034   pservers:
47035     description: |
47036       Collection of compute hosts.
47037     properties:
47038       pserver:
47039         type: array
47040         items:
47041           $ref: "#/definitions/pserver"
47042   query-parameters:
47043     description: |
47044       QueryParameters for performing a named-query or model query
47045     properties:
47046       named-query:
47047         type: object
47048         $ref: "#/definitions/named-query"
47049       model:
47050         type: object
47051         $ref: "#/definitions/model"
47052   related-lookup:
47053     description: |
47054       TBD
47055       ###### Related Nodes
47056       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
47057     required:
47058     - related-lookup-uuid
47059     - source-node-type
47060     - source-node-property
47061     - target-node-type
47062     - target-node-property
47063     properties:
47064       related-lookup-uuid:
47065         type: string
47066       source-node-type:
47067         type: string
47068       source-node-property:
47069         type: string
47070       target-node-type:
47071         type: string
47072       target-node-property:
47073         type: string
47074       property-collect-list:
47075         type: string
47076       resource-version:
47077         type: string
47078       relationship-list:
47079         type: array
47080         items:
47081           $ref: "#/definitions/relationship"
47082   related-lookups:
47083     properties:
47084       related-lookup:
47085         type: array
47086         items:
47087           $ref: "#/definitions/related-lookup"
47088   related-to-property:
47089     properties:
47090       property-key:
47091         type: string
47092         description: Key part of a key/value pair
47093       property-value:
47094         type: string
47095         description: Value part of a key/value pair
47096   relationship:
47097     properties:
47098       related-to:
47099         type: string
47100         description: A keyword provided by A&AI to indicate type of node.
47101       related-link:
47102         type: string
47103         description: URL to the object in A&AI.
47104       relationship-data:
47105         type: array
47106         items:
47107           $ref: "#/definitions/relationship-data"
47108   relationship-data:
47109     required:
47110     - relationship-key
47111     - relationship-value
47112     properties:
47113       relationship-key:
47114         type: string
47115         description: A keyword provided by A&AI to indicate an attribute.
47116       relationship-value:
47117         type: string
47118         description: Value of the attribute.
47119   relationship-list:
47120     properties:
47121       relationship:
47122         type: array
47123         items:
47124           $ref: "#/definitions/relationship"
47125   reserved-prop-names:
47126     description: |
47127       Internal map to define some reserved properties of a vertex
47128     properties:
47129       last-mod-source-of-truth:
47130         type: string
47131       aai-node-type:
47132         type: string
47133       aai-created-ts:
47134         type: integer
47135         format: int64
47136       aai-unique-key:
47137         type: string
47138       aai-last-mod-ts:
47139         type: integer
47140         format: int64
47141       source-of-truth:
47142         type: string
47143   response-list:
47144     description: |
47145       Response container for the results of a named-query or model query
47146     properties:
47147       inventory-response-items:
47148         type: object
47149         $ref: "#/definitions/inventory-response-items"
47150   result-data:
47151     properties:
47152       resource-type:
47153         type: string
47154         description: The specific type of node in the A&AI graph
47155       resource-link:
47156         type: string
47157         description: The URL to the specific resource
47158   route-table-reference:
47159     description: |
47160       Openstack route table reference.
47161       ###### Related Nodes
47162       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
47163     required:
47164     - route-table-reference-id
47165     - route-table-reference-fqdn
47166     properties:
47167       route-table-reference-id:
47168         type: string
47169         description: Route Table Reference id, UUID assigned to this instance.
47170       route-table-reference-fqdn:
47171         type: string
47172         description: FQDN entry in the route table.
47173       resource-version:
47174         type: string
47175         description: Concurrency value
47176       relationship-list:
47177         type: array
47178         items:
47179           $ref: "#/definitions/relationship"
47180   route-table-references:
47181     description: |
47182       Collection of openstack route table references
47183     properties:
47184       route-table-reference:
47185         type: array
47186         items:
47187           $ref: "#/definitions/route-table-reference"
47188   route-target:
47189     description: |
47190       Route target information
47191       ###### Related Nodes
47192       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
47193     required:
47194     - global-route-target
47195     - route-target-role
47196     properties:
47197       global-route-target:
47198         type: string
47199         description: Number used to identify an RT, globally unique in the network
47200       route-target-role:
47201         type: string
47202         description: Role assigned to this route target
47203       resource-version:
47204         type: string
47205         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47206       relationship-list:
47207         type: array
47208         items:
47209           $ref: "#/definitions/relationship"
47210   route-targets:
47211     description: |
47212       Collection of route target information
47213     properties:
47214       route-target:
47215         type: array
47216         items:
47217           $ref: "#/definitions/route-target"
47218   routing-instance:
47219     description: |
47220       ###### Related Nodes
47221       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
47222       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
47223       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
47224     required:
47225     - routing-instance-id
47226     properties:
47227       routing-instance-id:
47228         type: string
47229         description: Unique id of routing instance
47230       rpm-owner:
47231         type: string
47232         description: rpm owner
47233       resource-version:
47234         type: string
47235         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47236       site-pairs:
47237         type: array
47238         items:
47239           $ref: "#/definitions/site-pair"
47240       relationship-list:
47241         type: array
47242         items:
47243           $ref: "#/definitions/relationship"
47244   routing-instances:
47245     description: |
47246       set of probes related to generic-vnf routing instance
47247     properties:
47248       routing-instance:
47249         type: array
47250         items:
47251           $ref: "#/definitions/routing-instance"
47252   sdn-zone-response:
47253     properties:
47254       oam-networks:
47255         type: object
47256         $ref: "#/definitions/oam-networks"
47257       az-and-dvs-switches:
47258         type: array
47259         items:
47260           $ref: "#/definitions/az-and-dvs-switches"
47261   search:
47262     properties:
47263       edge-tag-query-result:
47264         type: object
47265         $ref: "#/definitions/edge-tag-query-result"
47266       edge-tag-query-request:
47267         type: object
47268         $ref: "#/definitions/edge-tag-query-request"
47269       search-results:
47270         type: object
47271         $ref: "#/definitions/search-results"
47272       sdn-zone-response:
47273         type: object
47274         $ref: "#/definitions/sdn-zone-response"
47275   search-results:
47276     properties:
47277       result-data:
47278         type: array
47279         items:
47280           $ref: "#/definitions/result-data"
47281   secondary-filt:
47282     description: |
47283       SecondaryFilt for performing a named-query or model query
47284   secondary-filter:
47285     properties:
47286       property-name:
47287         type: string
47288       filter-type:
47289         type: string
47290       property-value:
47291         type: string
47292   secondary-filts:
47293     description: |
47294       SecondaryFilts for performing a named-query or model query
47295     properties:
47296       secondary-filt:
47297         type: array
47298         items:
47299           $ref: "#/definitions/secondary-filt"
47300   segmentation-assignment:
47301     description: |
47302       Openstack segmentation assignment.
47303       ###### Related Nodes
47304       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
47305     required:
47306     - segmentation-id
47307     properties:
47308       segmentation-id:
47309         type: string
47310         description: Route Table Reference id, UUID assigned to this instance.
47311       resource-version:
47312         type: string
47313         description: Concurrency value
47314       relationship-list:
47315         type: array
47316         items:
47317           $ref: "#/definitions/relationship"
47318   segmentation-assignments:
47319     description: |
47320       Collection of openstack segmentation assignments
47321     properties:
47322       segmentation-assignment:
47323         type: array
47324         items:
47325           $ref: "#/definitions/segmentation-assignment"
47326   service:
47327     description: |
47328       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.
47329     required:
47330     - service-id
47331     - service-description
47332     properties:
47333       service-id:
47334         type: string
47335         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
47336       service-description:
47337         type: string
47338         description: Description of the service
47339       service-selflink:
47340         type: string
47341         description: URL to endpoint where AAI can get more details
47342       resource-version:
47343         type: string
47344         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47345       service-version:
47346         type: string
47347         description: service version
47348       relationship-list:
47349         type: array
47350         items:
47351           $ref: "#/definitions/relationship"
47352   service-capabilities:
47353     description: |
47354       Collection of service capabilities.
47355     properties:
47356       service-capability:
47357         type: array
47358         items:
47359           $ref: "#/definitions/service-capability"
47360   service-capability:
47361     description: |
47362       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
47363       ###### Related Nodes
47364       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
47365       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
47366       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
47367     required:
47368     - service-type
47369     - vnf-type
47370     properties:
47371       service-type:
47372         type: string
47373         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
47374       vnf-type:
47375         type: string
47376         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
47377       resource-version:
47378         type: string
47379         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47380       relationship-list:
47381         type: array
47382         items:
47383           $ref: "#/definitions/relationship"
47384   service-design-and-creation:
47385     description: |
47386       Namespace for objects managed by ASDC
47387     properties:
47388       vnf-images:
47389         type: array
47390         items:
47391           $ref: "#/definitions/vnf-image"
47392       services:
47393         type: array
47394         items:
47395           $ref: "#/definitions/service"
47396       service-capabilities:
47397         type: array
47398         items:
47399           $ref: "#/definitions/service-capability"
47400       models:
47401         type: array
47402         items:
47403           $ref: "#/definitions/model"
47404       named-queries:
47405         type: array
47406         items:
47407           $ref: "#/definitions/named-query"
47408   service-instance:
47409     description: |
47410       Instance of a service
47411       ###### Related Nodes
47412       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
47413       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
47414       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
47415       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
47416       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
47417       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
47418       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
47419       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
47420       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
47421       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
47422       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
47423       - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM
47424       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
47425     required:
47426     - service-instance-id
47427     properties:
47428       service-instance-id:
47429         type: string
47430         description: Uniquely identifies this instance of a service
47431       service-instance-name:
47432         type: string
47433         description: This field will store a name assigned to the service-instance.
47434       persona-model-id:
47435         type: string
47436         description: the ASDC model id for this resource or service model.
47437       persona-model-version:
47438         type: string
47439         description: the ASDC model version for this resource or service model.
47440       model-version-id:
47441         type: string
47442         description: the ASDC model version for this resource or service model.
47443       widget-model-id:
47444         type: string
47445         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
47446       widget-model-version:
47447         type: string
47448         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
47449       bandwidth-total:
47450         type: string
47451         description: Indicates the total bandwidth to be used for this service.
47452       bandwidth-up-wan1:
47453         type: string
47454         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
47455       bandwidth-down-wan1:
47456         type: string
47457         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
47458       bandwidth-up-wan2:
47459         type: string
47460         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
47461       bandwidth-down-wan2:
47462         type: string
47463         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
47464       vhn-portal-url:
47465         type: string
47466         description: URL customers will use to access the vHN Portal.
47467       service-instance-location-id:
47468         type: string
47469         description: An identifier that customers assign to the location where this service is being used.
47470       resource-version:
47471         type: string
47472         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47473       relationship-list:
47474         type: array
47475         items:
47476           $ref: "#/definitions/relationship"
47477       metadata:
47478         type: array
47479         items:
47480           $ref: "#/definitions/metadatum"
47481   service-instances:
47482     description: |
47483       Collection of service instances
47484     properties:
47485       service-instance:
47486         type: array
47487         items:
47488           $ref: "#/definitions/service-instance"
47489   service-subscription:
47490     description: |
47491       Object that group service instances.
47492       ###### Related Nodes
47493       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
47494       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
47495       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
47496       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
47497     required:
47498     - service-type
47499     properties:
47500       service-type:
47501         type: string
47502         description: Value defined by orchestration to identify this service across ECOMP.
47503       temp-ub-sub-account-id:
47504         type: string
47505         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
47506       resource-version:
47507         type: string
47508         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47509       service-instances:
47510         type: array
47511         items:
47512           $ref: "#/definitions/service-instance"
47513       relationship-list:
47514         type: array
47515         items:
47516           $ref: "#/definitions/relationship"
47517   service-subscriptions:
47518     description: |
47519       Collection of objects that group service instances.
47520     properties:
47521       service-subscription:
47522         type: array
47523         items:
47524           $ref: "#/definitions/service-subscription"
47525   services:
47526     description: |
47527       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
47528     properties:
47529       service:
47530         type: array
47531         items:
47532           $ref: "#/definitions/service"
47533   site-pair:
47534     description: |
47535       ###### Related Nodes
47536       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
47537       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
47538       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
47539     required:
47540     - site-pair-id
47541     properties:
47542       site-pair-id:
47543         type: string
47544         description: unique identifier of probe
47545       source-ip:
47546         type: string
47547         description: Prefix address
47548       destination-ip:
47549         type: string
47550         description: Prefix address
47551       ip-version:
47552         type: string
47553         description: ip version, v4, v6
47554       destination-hostname:
47555         type: string
47556         description: Hostname of the destination equipment to which SLAs are measured against.
47557       destination-equip-type:
47558         type: string
47559         description: The type of destinatination equipment. Could be Router, etc.
47560       resource-version:
47561         type: string
47562         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47563       classes-of-service:
47564         type: array
47565         items:
47566           $ref: "#/definitions/class-of-service"
47567       relationship-list:
47568         type: array
47569         items:
47570           $ref: "#/definitions/relationship"
47571   site-pair-set:
47572     description: |
47573       Set of instances for probes used to measure service level agreements
47574       ###### Related Nodes
47575       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
47576       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
47577       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
47578     required:
47579     - site-pair-set-id
47580     properties:
47581       site-pair-set-id:
47582         type: string
47583         description: Unique id of site pair set.
47584       resource-version:
47585         type: string
47586         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47587       routing-instances:
47588         type: array
47589         items:
47590           $ref: "#/definitions/routing-instance"
47591       relationship-list:
47592         type: array
47593         items:
47594           $ref: "#/definitions/relationship"
47595   site-pair-sets:
47596     description: |
47597       Collection of sets of instances for probes related to generic-vnf
47598     properties:
47599       site-pair-set:
47600         type: array
47601         items:
47602           $ref: "#/definitions/site-pair-set"
47603   site-pairs:
47604     description: |
47605       probe within a set
47606     properties:
47607       site-pair:
47608         type: array
47609         items:
47610           $ref: "#/definitions/site-pair"
47611   snapshot:
47612     description: |
47613       Openstack snapshot
47614       ###### Related Nodes
47615       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47616       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
47617     required:
47618     - snapshot-id
47619     properties:
47620       snapshot-id:
47621         type: string
47622         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
47623       snapshot-name:
47624         type: string
47625         description: Snapshot name
47626       snapshot-architecture:
47627         type: string
47628         description: Operating system architecture
47629       snapshot-os-distro:
47630         type: string
47631         description: The common name of the operating system distribution in lowercase
47632       snapshot-os-version:
47633         type: string
47634         description: The operating system version as specified by the distributor.
47635       application:
47636         type: string
47637         description: The application that the image instantiates.
47638       application-vendor:
47639         type: string
47640         description: The vendor of the application.
47641       application-version:
47642         type: string
47643         description: The version of the application.
47644       snapshot-selflink:
47645         type: string
47646         description: URL to endpoint where AAI can get more details
47647       prev-snapshot-id:
47648         type: string
47649         description: This field contains the UUID of the previous snapshot (if any).
47650       resource-version:
47651         type: string
47652         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47653       relationship-list:
47654         type: array
47655         items:
47656           $ref: "#/definitions/relationship"
47657   snapshots:
47658     description: |
47659       Collection of openstack snapshots
47660     properties:
47661       snapshot:
47662         type: array
47663         items:
47664           $ref: "#/definitions/snapshot"
47665   sriov-pf:
47666     description: |
47667       SR-IOV Physical Function
47668       ###### Related Nodes
47669       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
47670       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
47671     required:
47672     - pf-pci-id
47673     properties:
47674       pf-pci-id:
47675         type: string
47676         description: Identifier for the sriov-pf
47677       resource-version:
47678         type: string
47679         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47680       relationship-list:
47681         type: array
47682         items:
47683           $ref: "#/definitions/relationship"
47684   sriov-pfs:
47685     description: |
47686       Collection of SR-IOV Physical Functions.
47687     properties:
47688       sriov-pf:
47689         type: array
47690         items:
47691           $ref: "#/definitions/sriov-pf"
47692   sriov-vf:
47693     description: |
47694       SR-IOV Virtual Function (not to be confused with virtual network function)
47695       ###### Related Nodes
47696       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
47697     required:
47698     - pci-id
47699     properties:
47700       pci-id:
47701         type: string
47702         description: PCI ID used to identify the sriov-vf
47703       vf-vlan-filter:
47704         type: string
47705         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
47706       vf-mac-filter:
47707         type: string
47708         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
47709       vf-vlan-strip:
47710         type: boolean
47711         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
47712       vf-vlan-anti-spoof-check:
47713         type: boolean
47714         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.
47715       vf-mac-anti-spoof-check:
47716         type: boolean
47717         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.
47718       vf-mirrors:
47719         type: string
47720         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
47721       vf-broadcast-allow:
47722         type: boolean
47723         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
47724       vf-unknown-multicast-allow:
47725         type: boolean
47726         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
47727       vf-unknown-unicast-allow:
47728         type: boolean
47729         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
47730       vf-insert-stag:
47731         type: boolean
47732         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
47733       vf-link-status:
47734         type: string
47735         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
47736       resource-version:
47737         type: string
47738         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47739       neutron-network-id:
47740         type: string
47741         description: Neutron network id of the interface
47742       relationship-list:
47743         type: array
47744         items:
47745           $ref: "#/definitions/relationship"
47746   sriov-vfs:
47747     description: |
47748       Collection of SR-IOV Virtual Functions.
47749     properties:
47750       sriov-vf:
47751         type: array
47752         items:
47753           $ref: "#/definitions/sriov-vf"
47754   start-node-filter:
47755     properties:
47756       property-name:
47757         type: string
47758       property-value:
47759         type: string
47760   subnet:
47761     description: |
47762       ###### Related Nodes
47763       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
47764       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
47765       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
47766       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
47767     required:
47768     - subnet-id
47769     - dhcp-enabled
47770     properties:
47771       subnet-id:
47772         type: string
47773         description: Subnet ID, should be UUID.
47774       subnet-name:
47775         type: string
47776         description: Name associated with the subnet.
47777       neutron-subnet-id:
47778         type: string
47779         description: Neutron id of this subnet
47780       gateway-address:
47781         type: string
47782         description: gateway ip address
47783       network-start-address:
47784         type: string
47785         description: network start address
47786       cidr-mask:
47787         type: string
47788         description: cidr mask
47789       ip-version:
47790         type: string
47791         description: ip version
47792       orchestration-status:
47793         type: string
47794         description: Orchestration status of this VNF, mastered by MSO
47795       dhcp-enabled:
47796         type: boolean
47797       dhcp-start:
47798         type: string
47799         description: the start address reserved for use by dhcp
47800       dhcp-end:
47801         type: string
47802         description: the last address reserved for use by dhcp
47803       resource-version:
47804         type: string
47805         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47806       relationship-list:
47807         type: array
47808         items:
47809           $ref: "#/definitions/relationship"
47810   subnets:
47811     properties:
47812       subnet:
47813         type: array
47814         items:
47815           $ref: "#/definitions/subnet"
47816   tagged-inventory-item-list:
47817     properties:
47818       inventory-item:
47819         type: array
47820         items:
47821           $ref: "#/definitions/inventory-item"
47822   tenant:
47823     description: |
47824       Openstack tenant
47825       ###### Related Nodes
47826       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
47827       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
47828       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
47829       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
47830       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
47831       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
47832       - TENANT cannot be deleted if linked to VSERVER
47833     required:
47834     - tenant-id
47835     - tenant-name
47836     properties:
47837       tenant-id:
47838         type: string
47839         description: Unique id relative to the cloud-region.
47840       tenant-name:
47841         type: string
47842         description: Readable name of tenant
47843       resource-version:
47844         type: string
47845         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47846       vservers:
47847         type: array
47848         items:
47849           $ref: "#/definitions/vserver"
47850       relationship-list:
47851         type: array
47852         items:
47853           $ref: "#/definitions/relationship"
47854   tenants:
47855     description: |
47856       Collection of openstack tenants.
47857     properties:
47858       tenant:
47859         type: array
47860         items:
47861           $ref: "#/definitions/tenant"
47862   tunnel-xconnect:
47863     description: |
47864       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
47865       ###### Related Nodes
47866       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
47867     required:
47868     - id
47869     - bandwidth-up-wan1
47870     - bandwidth-down-wan1
47871     - bandwidth-up-wan2
47872     - bandwidth-down-wan2
47873     properties:
47874       id:
47875         type: string
47876         description: Allotted Resource id UUID assigned to this instance.
47877       bandwidth-up-wan1:
47878         type: string
47879         description: The WAN uplink bandwidth for WAN1
47880       bandwidth-down-wan1:
47881         type: string
47882         description: The WAN downlink bandwidth for WAN1
47883       bandwidth-up-wan2:
47884         type: string
47885         description: The WAN uplink bandwidth for WAN2
47886       bandwidth-down-wan2:
47887         type: string
47888         description: The WAN downlink bandwidth for WAN2
47889       resource-version:
47890         type: string
47891         description: Concurrency value
47892       relationship-list:
47893         type: array
47894         items:
47895           $ref: "#/definitions/relationship"
47896   tunnel-xconnects:
47897     description: |
47898       This object is used to store the specific tunnel cross connect aspects of an allotted resource
47899     properties:
47900       tunnel-xconnect:
47901         type: array
47902         items:
47903           $ref: "#/definitions/tunnel-xconnect"
47904   update:
47905     description: |
47906       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
47907     required:
47908     - update-node-type
47909     properties:
47910       update-node-type:
47911         type: string
47912       update-node-key:
47913         type: array
47914         items:
47915           $ref: "#/definitions/update-node-key"
47916       update-node-uri:
47917         type: string
47918       action:
47919         type: array
47920         items:
47921           $ref: "#/definitions/action"
47922   update-node-key:
47923     properties:
47924       key-name:
47925         type: string
47926       key-value:
47927         type: string
47928   vce:
47929     description: |
47930       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
47931       ###### Related Nodes
47932       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
47933       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
47934       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
47935       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
47936       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
47937       - VCE is DELETED when these are DELETED PORT-GROUP
47938     required:
47939     - vnf-id
47940     - vnf-name
47941     - vnf-type
47942     properties:
47943       vnf-id:
47944         type: string
47945         description: Unique id of VNF.  This is unique across the graph.
47946       vnf-name:
47947         type: string
47948         description: Name of VNF.
47949       vnf-name2:
47950         type: string
47951         description: Alternate name of VNF.
47952       vnf-type:
47953         type: string
47954         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
47955       service-id:
47956         type: string
47957         description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
47958       regional-resource-zone:
47959         type: string
47960         description: Regional way of organizing pservers, source of truth should define values
47961       prov-status:
47962         type: string
47963         description: Trigger for operational monitoring of this resource by Service Assurance systems.
47964       operational-state:
47965         type: string
47966         description: Indicator for whether the resource is considered operational
47967       license-key:
47968         type: string
47969         description: License key
47970       equipment-role:
47971         type: string
47972         description: Network role being played by this VNF
47973       orchestration-status:
47974         type: string
47975         description: Orchestration status of this VNF, mastered by MSO
47976       heat-stack-id:
47977         type: string
47978         description: Heat stack id corresponding to this instance, managed by MSO
47979       mso-catalog-key:
47980         type: string
47981         description: Corresponds to the SDN-C catalog id used to configure this VCE
47982       vpe-id:
47983         type: string
47984         description: Unique ID of VPE connected to this VCE.
47985       v6-vce-wan-address:
47986         type: string
47987         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
47988       ipv4-oam-address:
47989         type: string
47990         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
47991       resource-version:
47992         type: string
47993         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
47994       ipv4-loopback0-address:
47995         type: string
47996         description: Loopback0 address
47997       entitlement-resource-uuid:
47998         type: string
47999         description: Entitlement resource uuid
48000       port-groups:
48001         type: array
48002         items:
48003           $ref: "#/definitions/port-group"
48004       relationship-list:
48005         type: array
48006         items:
48007           $ref: "#/definitions/relationship"
48008   vces:
48009     description: |
48010       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
48011     properties:
48012       vce:
48013         type: array
48014         items:
48015           $ref: "#/definitions/vce"
48016   vf-module:
48017     description: |
48018       a deployment unit of VNFCs
48019       ###### Related Nodes
48020       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48021       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
48022       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
48023       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
48024       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
48025       - VF-MODULE cannot be deleted if linked to VNFC
48026     required:
48027     - vf-module-id
48028     - is-base-vf-module
48029     properties:
48030       vf-module-id:
48031         type: string
48032         description: Unique ID of vf-module.
48033       vf-module-name:
48034         type: string
48035         description: Name of vf-module
48036       heat-stack-id:
48037         type: string
48038         description: Heat stack id corresponding to this instance.
48039       orchestration-status:
48040         type: string
48041         description: orchestration status of this vf-module, mastered by MSO
48042       is-base-vf-module:
48043         type: boolean
48044       resource-version:
48045         type: string
48046         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48047       persona-model-id:
48048         type: string
48049         description: the ASDC model id for this resource or service model.
48050       persona-model-version:
48051         type: string
48052         description: the ASDC model version for this resource or service model.
48053       model-version-id:
48054         type: string
48055         description: the ASDC model version for this resource or service model.
48056       widget-model-id:
48057         type: string
48058         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48059       widget-model-version:
48060         type: string
48061         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48062       contrail-service-instance-fqdn:
48063         type: string
48064         description: the Contrail unique ID for a service-instance
48065       relationship-list:
48066         type: array
48067         items:
48068           $ref: "#/definitions/relationship"
48069   vf-modules:
48070     description: |
48071       Collection of vf-modules, a deployment unit of VNFCs
48072     properties:
48073       vf-module:
48074         type: array
48075         items:
48076           $ref: "#/definitions/vf-module"
48077   vig-server:
48078     description: |
48079       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
48080       ###### Related Nodes
48081       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
48082     required:
48083     - vig-address-type
48084     properties:
48085       vig-address-type:
48086         type: string
48087         description: indicates whether the VIG is for AVPN or INTERNET
48088       ipaddress-v4-vig:
48089         type: string
48090         description: v4 IP of the vig server
48091       ipaddress-v6-vig:
48092         type: string
48093         description: v6 IP of the vig server
48094       resource-version:
48095         type: string
48096         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48097       relationship-list:
48098         type: array
48099         items:
48100           $ref: "#/definitions/relationship"
48101   vig-servers:
48102     properties:
48103       vig-server:
48104         type: array
48105         items:
48106           $ref: "#/definitions/vig-server"
48107   vip-ipv4-address-list:
48108     description: |
48109       IPv4 Address Range
48110       ###### Related Nodes
48111       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48112       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48113       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
48114       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
48115     required:
48116     - vip-ipv4-address
48117     properties:
48118       vip-ipv4-address:
48119         type: string
48120         description: IP address
48121       vip-ipv4-prefix-length:
48122         type: integer
48123         format: int64
48124         description: Prefix length, 32 for single address
48125       vlan-id-inner:
48126         type: integer
48127         format: int64
48128         description: Inner VLAN tag
48129       vlan-id-outer:
48130         type: integer
48131         format: int64
48132         description: Outer VLAN tag
48133       is-floating:
48134         type: boolean
48135         description: Indicator of fixed or floating address
48136       resource-version:
48137         type: string
48138         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48139       neutron-network-id:
48140         type: string
48141         description: Neutron network id of the interface that address belongs to
48142       neutron-subnet-id:
48143         type: string
48144         description: Neutron id of subnet that address belongs to
48145       relationship-list:
48146         type: array
48147         items:
48148           $ref: "#/definitions/relationship"
48149   vip-ipv6-address-list:
48150     description: |
48151       IPv6 Address Range
48152       ###### Related Nodes
48153       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48154       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48155       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
48156       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
48157     required:
48158     - vip-ipv6-address
48159     properties:
48160       vip-ipv6-address:
48161         type: string
48162         description: IP address
48163       vip-ipv6-prefix-length:
48164         type: integer
48165         format: int64
48166         description: Prefix length, 128 for single address
48167       vlan-id-inner:
48168         type: integer
48169         format: int64
48170         description: Inner VLAN tag
48171       vlan-id-outer:
48172         type: integer
48173         format: int64
48174         description: Outer VLAN tag
48175       is-floating:
48176         type: boolean
48177         description: Indicator of fixed or floating address
48178       resource-version:
48179         type: string
48180         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48181       neutron-network-id:
48182         type: string
48183         description: Neutron network id of the interface that address belongs to
48184       neutron-subnet-id:
48185         type: string
48186         description: Neutron id of subnet that address belongs to
48187       relationship-list:
48188         type: array
48189         items:
48190           $ref: "#/definitions/relationship"
48191   virtual-data-center:
48192     description: |
48193       Virtual organization of cloud infrastructure elements in a data center context
48194       ###### Related Nodes
48195       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48196       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48197       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48198     required:
48199     - vdc-id
48200     - vdc-name
48201     properties:
48202       vdc-id:
48203         type: string
48204         description: Unique ID of the vdc
48205       vdc-name:
48206         type: string
48207         description: Name of the virtual data center
48208       resource-version:
48209         type: string
48210         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48211       relationship-list:
48212         type: array
48213         items:
48214           $ref: "#/definitions/relationship"
48215   virtual-data-centers:
48216     description: |
48217       Virtual organization of cloud infrastructure elements in a data center context
48218     properties:
48219       virtual-data-center:
48220         type: array
48221         items:
48222           $ref: "#/definitions/virtual-data-center"
48223   vlan:
48224     description: |
48225       Definition of vlan
48226       ###### Related Nodes
48227       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
48228       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
48229       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
48230       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
48231       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
48232       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
48233       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
48234       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
48235     required:
48236     - vlan-interface
48237     properties:
48238       vlan-interface:
48239         type: string
48240         description: String that identifies the interface
48241       vlan-id-inner:
48242         type: integer
48243         format: int64
48244         description: Inner VLAN tag
48245       vlan-id-outer:
48246         type: integer
48247         format: int64
48248         description: Outer VLAN tag
48249       resource-version:
48250         type: string
48251         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48252       speed-value:
48253         type: string
48254         description: Captures the numeric part of the speed
48255       speed-units:
48256         type: string
48257         description: Captures the units corresponding to the speed
48258       vlan-description:
48259         type: string
48260         description: Used to describe (the service associated with) the vlan
48261       backdoor-connection:
48262         type: string
48263         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
48264       vpn-id:
48265         type: string
48266         description: This indicates the customers VPN ID associated with this vlan
48267       relationship-list:
48268         type: array
48269         items:
48270           $ref: "#/definitions/relationship"
48271       l3-interface-ipv4-address-list:
48272         type: array
48273         items:
48274           $ref: "#/definitions/l3-interface-ipv4-address-list"
48275       l3-interface-ipv6-address-list:
48276         type: array
48277         items:
48278           $ref: "#/definitions/l3-interface-ipv6-address-list"
48279   vlans:
48280     properties:
48281       vlan:
48282         type: array
48283         items:
48284           $ref: "#/definitions/vlan"
48285   vnf:
48286     description: |
48287       Abstract vnf class
48288     required:
48289     - vnf-id
48290     properties:
48291       vnf-id:
48292         type: string
48293         description: Unique id of VNF.  This is unique across the graph.
48294   vnf-image:
48295     description: |
48296       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
48297       ###### Related Nodes
48298       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
48299       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
48300     required:
48301     - vnf-image-uuid
48302     - application
48303     - application-vendor
48304     properties:
48305       vnf-image-uuid:
48306         type: string
48307         description: Unique ID of this asset
48308       application:
48309         type: string
48310         description: The application that the image instantiates.
48311       application-vendor:
48312         type: string
48313         description: The vendor of the application.
48314       application-version:
48315         type: string
48316         description: The version of the application.
48317       selflink:
48318         type: string
48319         description: URL to endpoint where AAI can get more details
48320       resource-version:
48321         type: string
48322         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48323       relationship-list:
48324         type: array
48325         items:
48326           $ref: "#/definitions/relationship"
48327   vnf-images:
48328     description: |
48329       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
48330     properties:
48331       vnf-image:
48332         type: array
48333         items:
48334           $ref: "#/definitions/vnf-image"
48335   vnfc:
48336     description: |
48337       ###### Related Nodes
48338       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
48339       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
48340       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
48341     required:
48342     - vnfc-name
48343     - vnfc-function-code
48344     - vnfc-type
48345     - in-maint
48346     - is-closed-loop-disabled
48347     properties:
48348       vnfc-name:
48349         type: string
48350         description: Unique ID of vnfc.
48351       vnfc-function-code:
48352         type: string
48353         description: function code
48354       vnfc-type:
48355         type: string
48356         description: type
48357       prov-status:
48358         type: string
48359         description: prov status of this vnfc
48360       orchestration-status:
48361         type: string
48362         description: Orchestration status of this VNF, mastered by APP-C
48363       ipaddress-v4-oam-vip:
48364         type: string
48365         description: Oam V4 vip address of this vnfc
48366       in-maint:
48367         type: boolean
48368       is-closed-loop-disabled:
48369         type: boolean
48370       group-notation:
48371         type: string
48372         description: Group notation of VNFC
48373       resource-version:
48374         type: string
48375         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48376       relationship-list:
48377         type: array
48378         items:
48379           $ref: "#/definitions/relationship"
48380   vnfcs:
48381     description: |
48382       virtual network components associated with a vserver from application controller.
48383     properties:
48384       vnfc:
48385         type: array
48386         items:
48387           $ref: "#/definitions/vnfc"
48388   volume:
48389     description: |
48390       Ephemeral Block storage volume.
48391       ###### Related Nodes
48392       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
48393     required:
48394     - volume-id
48395     - volume-selflink
48396     properties:
48397       volume-id:
48398         type: string
48399         description: Unique ID of block storage volume relative to the vserver.
48400       volume-selflink:
48401         type: string
48402         description: URL to endpoint where AAI can get more details
48403       resource-version:
48404         type: string
48405         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48406       relationship-list:
48407         type: array
48408         items:
48409           $ref: "#/definitions/relationship"
48410   volume-group:
48411     description: |
48412       Persistent block-level storage.
48413       ###### Related Nodes
48414       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48415       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48416       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
48417       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
48418       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
48419     required:
48420     - volume-group-id
48421     - volume-group-name
48422     - vnf-type
48423     properties:
48424       volume-group-id:
48425         type: string
48426         description: Unique ID of volume-group.
48427       volume-group-name:
48428         type: string
48429         description: Name of the volume group.
48430       heat-stack-id:
48431         type: string
48432         description: Heat stack id corresponding to this volume-group
48433       vnf-type:
48434         type: string
48435         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
48436       orchestration-status:
48437         type: string
48438         description: Orchestration status of this volume-group
48439       resource-version:
48440         type: string
48441         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48442       relationship-list:
48443         type: array
48444         items:
48445           $ref: "#/definitions/relationship"
48446   volume-groups:
48447     description: |
48448       Collection of persistent block-level storage.
48449     properties:
48450       volume-group:
48451         type: array
48452         items:
48453           $ref: "#/definitions/volume-group"
48454   volumes:
48455     description: |
48456       Collection of ephemeral Block storage volumes.
48457     properties:
48458       volume:
48459         type: array
48460         items:
48461           $ref: "#/definitions/volume"
48462   vpls-pe:
48463     description: |
48464       VPLS Provider Edge routers.
48465       ###### Related Nodes
48466       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48467       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
48468       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
48469       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
48470       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
48471     required:
48472     - equipment-name
48473     properties:
48474       equipment-name:
48475         type: string
48476       prov-status:
48477         type: string
48478         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
48479       ipv4-oam-address:
48480         type: string
48481         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
48482       equipment-role:
48483         type: string
48484         description: Client should send valid enumerated value, e.g., VPLS-PE.
48485       vlan-id-outer:
48486         type: integer
48487         format: int64
48488         description: Temporary location for stag to get to VCE
48489       resource-version:
48490         type: string
48491         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48492       relationship-list:
48493         type: array
48494         items:
48495           $ref: "#/definitions/relationship"
48496       p-interfaces:
48497         type: array
48498         items:
48499           $ref: "#/definitions/p-interface"
48500       lag-interfaces:
48501         type: array
48502         items:
48503           $ref: "#/definitions/lag-interface"
48504   vpls-pes:
48505     description: |
48506       Collection of VPLS Provider Edge routers
48507     properties:
48508       vpls-pe:
48509         type: array
48510         items:
48511           $ref: "#/definitions/vpls-pe"
48512   vpn-binding:
48513     description: |
48514       VPN binding
48515       ###### Related Nodes
48516       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
48517       - VPN-BINDING cannot be deleted if linked to L3-NETWORK
48518     required:
48519     - vpn-id
48520     - vpn-name
48521     - global-route-target
48522     properties:
48523       vpn-id:
48524         type: string
48525         description: VPN ID, globally unique within A&AI
48526       vpn-name:
48527         type: string
48528         description: VPN Name
48529       global-route-target:
48530         type: string
48531         description: Number used to identify a VPN, globally unique in the network
48532       vpn-platform:
48533         type: string
48534         description: the platform associated with the VPN example AVPN, Mobility
48535       resource-version:
48536         type: string
48537         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48538       relationship-list:
48539         type: array
48540         items:
48541           $ref: "#/definitions/relationship"
48542         description: l3-networks relate to vpn-bindings
48543   vpn-bindings:
48544     properties:
48545       vpn-binding:
48546         type: array
48547         items:
48548           $ref: "#/definitions/vpn-binding"
48549   vserver:
48550     description: |
48551       Virtual Servers, aka virtual machine or VM.
48552       ###### Related Nodes
48553       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
48554       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
48555       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
48556       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
48557       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
48558       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
48559       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
48560       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
48561       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
48562       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
48563       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
48564       - VSERVER is DELETED when these are DELETED L-INTERFACE
48565       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
48566     required:
48567     - vserver-id
48568     - vserver-name
48569     - vserver-selflink
48570     - in-maint
48571     - is-closed-loop-disabled
48572     properties:
48573       vserver-id:
48574         type: string
48575         description: Unique identifier for this vserver relative to its tenant
48576       vserver-name:
48577         type: string
48578         description: Name of vserver
48579       vserver-name2:
48580         type: string
48581         description: Alternative name of vserver
48582       prov-status:
48583         type: string
48584         description: Trigger for operational monitoring of this resource by Service Assurance systems.
48585       vserver-selflink:
48586         type: string
48587         description: URL to endpoint where AAI can get more details
48588       in-maint:
48589         type: boolean
48590       is-closed-loop-disabled:
48591         type: boolean
48592       resource-version:
48593         type: string
48594         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48595       volumes:
48596         type: array
48597         items:
48598           $ref: "#/definitions/volume"
48599       relationship-list:
48600         type: array
48601         items:
48602           $ref: "#/definitions/relationship"
48603       l-interfaces:
48604         type: array
48605         items:
48606           $ref: "#/definitions/l-interface"
48607   vservers:
48608     description: |
48609       Collection of virtual Servers, aka virtual machines or VMs.
48610     properties:
48611       vserver:
48612         type: array
48613         items:
48614           $ref: "#/definitions/vserver"
48615   zone:
48616     description: |
48617       A zone is a grouping of assets in a location homing to the same connections into the CBB
48618       ###### Related Nodes
48619       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48620       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48621       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48622       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48623     required:
48624     - zone-id
48625     - zone-name
48626     - design-type
48627     - zone-context
48628     properties:
48629       zone-id:
48630         type: string
48631         description: Code assigned by AIC to the zone
48632       zone-name:
48633         type: string
48634         description: English name associated with the zone
48635       design-type:
48636         type: string
48637         description: Design of zone [Medium/Large?]
48638       zone-context:
48639         type: string
48640         description: Context of zone [production/test]
48641       status:
48642         type: string
48643         description: Status of a zone.
48644       resource-version:
48645         type: string
48646         description: Concurrency value
48647       relationship-list:
48648         type: array
48649         items:
48650           $ref: "#/definitions/relationship"
48651   zones:
48652     description: |
48653       Collection of zones
48654     properties:
48655       zone:
48656         type: array
48657         items:
48658           $ref: "#/definitions/zone"
48659 patchDefinitions:
48660   aai-internal:
48661     properties:
48662       property-name:
48663         type: string
48664       property-value:
48665         type: string
48666   action:
48667     properties:
48668       action-type:
48669         type: string
48670       action-data:
48671         type: array
48672         items:
48673           $ref: "#/patchDefinitions/action-data"
48674   action-data:
48675     properties:
48676       property-name:
48677         type: string
48678       property-value:
48679         type: string
48680   actions:
48681     description: |
48682       APIs that are more action related than REST (e.g., notify, update).
48683     properties:
48684       update:
48685         type: object
48686         $ref: "#/patchDefinitions/update"
48687       notify:
48688         type: object
48689         $ref: "#/patchDefinitions/notify"
48690   allotted-resource:
48691     description: |
48692       Represents a slice or partial piece of a resource that gets separately allotted
48693       ###### Related Nodes
48694       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
48695       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48696       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
48697       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
48698       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
48699       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
48700       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
48701       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
48702     required:
48703     - id
48704     properties:
48705       id:
48706         type: string
48707         description: Allotted Resource id UUID assigned to this instance.
48708       description:
48709         type: string
48710         description: The descriptive information assigned to this allotted resource instance
48711       selflink:
48712         type: string
48713         description: Link back to more information in the controller
48714       persona-model-id:
48715         type: string
48716         description: the ASDC model id for this resource or service model.
48717       persona-model-version:
48718         type: string
48719         description: the ASDC model version for this resource or service model.
48720       model-version-id:
48721         type: string
48722         description: the ASDC model version for this resource or service model.
48723       persona-model-customization-id:
48724         type: string
48725         description: captures the id of all the configuration used to customize the resource for the service.
48726   allotted-resources:
48727     description: |
48728       This object is used to store slices of services being offered
48729     properties:
48730       allotted-resource:
48731         type: array
48732         items:
48733           $ref: "#/patchDefinitions/allotted-resource"
48734   availability-zone:
48735     description: |
48736       Availability zone, a collection of compute hosts/pservers
48737       ###### Related Nodes
48738       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48739       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
48740       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48741       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48742       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48743       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48744       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
48745       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48746       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
48747     required:
48748     - availability-zone-name
48749     - hypervisor-type
48750     properties:
48751       availability-zone-name:
48752         type: string
48753         description: Name of the availability zone.  Unique across a cloud region
48754       hypervisor-type:
48755         type: string
48756         description: Type of hypervisor.  Source of truth should define valid values.
48757       operational-state:
48758         type: string
48759         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
48760   availability-zones:
48761     description: |
48762       Collection of availability zones
48763     properties:
48764       availability-zone:
48765         type: array
48766         items:
48767           $ref: "#/patchDefinitions/availability-zone"
48768   az-and-dvs-switches:
48769     properties:
48770       dvs-switches:
48771         type: object
48772         $ref: "#/patchDefinitions/dvs-switches"
48773       availability-zone:
48774         type: object
48775         $ref: "#/patchDefinitions/availability-zone"
48776   business:
48777     description: |
48778       Namespace for business related constructs
48779     properties:
48780       connectors:
48781         type: array
48782         items:
48783           $ref: "#/patchDefinitions/connector"
48784       customers:
48785         type: array
48786         items:
48787           $ref: "#/patchDefinitions/customer"
48788   class-of-service:
48789     description: |
48790       ###### Related Nodes
48791       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
48792     required:
48793     - cos
48794     properties:
48795       cos:
48796         type: string
48797         description: unique identifier of probe
48798       probe-id:
48799         type: string
48800         description: identifier of probe
48801       probe-type:
48802         type: string
48803         description: type of probe
48804   classes-of-service:
48805     description: |
48806       class-of-service of probe
48807     properties:
48808       class-of-service:
48809         type: array
48810         items:
48811           $ref: "#/patchDefinitions/class-of-service"
48812   cloud-infrastructure:
48813     description: |
48814       Namespace for cloud infrastructure.
48815     properties:
48816       complexes:
48817         type: array
48818         items:
48819           $ref: "#/patchDefinitions/complex"
48820       cloud-regions:
48821         type: array
48822         items:
48823           $ref: "#/patchDefinitions/cloud-region"
48824       network-profiles:
48825         type: array
48826         items:
48827           $ref: "#/patchDefinitions/network-profile"
48828       pservers:
48829         type: array
48830         items:
48831           $ref: "#/patchDefinitions/pserver"
48832       virtual-data-centers:
48833         type: array
48834         items:
48835           $ref: "#/patchDefinitions/virtual-data-center"
48836   cloud-region:
48837     description: |
48838       cloud-region designates an installation of a cloud cluster or region or instantiation.
48839       ###### Related Nodes
48840       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48841       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48842       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48843       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48844       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48845       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48846       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48847       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48848       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48849       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48850       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48851       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
48852       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
48853       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
48854     required:
48855     - cloud-owner
48856     - cloud-region-id
48857     properties:
48858       cloud-owner:
48859         type: string
48860         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
48861       cloud-region-id:
48862         type: string
48863         description: Identifier used by the vendor for the region. Second part of composite key
48864       cloud-type:
48865         type: string
48866         description: Type of the cloud (e.g., openstack)
48867       owner-defined-type:
48868         type: string
48869         description: Cloud-owner defined type indicator (e.g., DCP, LCP)
48870       cloud-region-version:
48871         type: string
48872         description: Software version employed at the site
48873       identity-url:
48874         type: string
48875         description: URL of the keystone identity service
48876       cloud-zone:
48877         type: string
48878         description: Zone where the cloud is homed
48879       complex-name:
48880         type: string
48881         description: complex name for cloud-region instance
48882   cloud-regions:
48883     properties:
48884       cloud-region:
48885         type: array
48886         items:
48887           $ref: "#/patchDefinitions/cloud-region"
48888   complex:
48889     description: |
48890       Collection of physical locations that can house cloud-regions.
48891       ###### Related Nodes
48892       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48893       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48894       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48895       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
48896       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
48897       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48898       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48899       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
48900       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48901       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48902       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
48903       - COMPLEX is DELETED when these are DELETED CTAG-POOL
48904     required:
48905     - physical-location-id
48906     - physical-location-type
48907     - street1
48908     - city
48909     - postal-code
48910     - country
48911     - region
48912     properties:
48913       physical-location-id:
48914         type: string
48915         description: Unique identifier for physical location, e.g., CLLI
48916       data-center-code:
48917         type: string
48918         description: Data center code which can be an alternate way to identify a complex
48919       complex-name:
48920         type: string
48921         description: Gamma complex name for LCP instance.
48922       identity-url:
48923         type: string
48924         description: URL of the keystone identity service
48925   complexes:
48926     description: |
48927       Collection of physical locations that can house cloud-regions.
48928     properties:
48929       complex:
48930         type: array
48931         items:
48932           $ref: "#/patchDefinitions/complex"
48933   configuration:
48934     description: |
48935       Port Mirror Configuration.
48936       ###### Related Nodes
48937       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
48938       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
48939       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
48940       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48941       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48942       - CONFIGURATION is DELETED when these are DELETED METADATUM
48943       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
48944     required:
48945     - configuration-id
48946     - configuration-type
48947     - configuration-sub-type
48948     - orchestration-status
48949     - operational-status
48950     - configuration-selflink
48951     - model-customization-id
48952     properties:
48953       configuration-id:
48954         type: string
48955         description: UUID assigned to configuration.
48956       management-option:
48957         type: string
48958         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
48959       configuration-name:
48960         type: string
48961         description: Name of the configuration.
48962       configuration-type:
48963         type: string
48964         description: port-mirroring-configuration.
48965       configuration-sub-type:
48966         type: string
48967         description: vprobe, pprobe.
48968       model-invariant-id:
48969         type: string
48970         description: the ASDC model id for this resource or service model.
48971       model-version-id:
48972         type: string
48973         description: the ASDC model version for this resource or service model.
48974       orchestration-status:
48975         type: string
48976         description: Orchestration status of the configuration.
48977       operational-status:
48978         type: string
48979         description: Indicator for whether the resource is considered operational.
48980       configuration-selflink:
48981         type: string
48982         description: URL to endpoint where AAI can get more details from SDN-GC.
48983       model-customization-id:
48984         type: string
48985         description: id of  the configuration used to customize the resource
48986   configurations:
48987     description: |
48988       Collection of configurations
48989     properties:
48990       configuration:
48991         type: array
48992         items:
48993           $ref: "#/patchDefinitions/configuration"
48994   connector:
48995     description: |
48996       Collection of resource instances used to connect a variety of disparate inventory widgets
48997       ###### Related Nodes
48998       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48999       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
49000       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
49001       - CONNECTOR is DELETED when these are DELETED METADATUM
49002     required:
49003     - resource-instance-id
49004     properties:
49005       resource-instance-id:
49006         type: string
49007         description: Unique id of resource instance.
49008   connectors:
49009     description: |
49010       Collection of resource instances used to connect a variety of disparate inventory widgets
49011     properties:
49012       connector:
49013         type: array
49014         items:
49015           $ref: "#/patchDefinitions/connector"
49016   constrained-element-set:
49017     description: |
49018       This is how we would capture constraints defining allowed sets of elements.
49019       ###### Related Nodes
49020       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
49021       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49022       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49023       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
49024     required:
49025     - constrained-element-set-uuid
49026     - constraint-type
49027     - check-type
49028     properties:
49029       constrained-element-set-uuid:
49030         type: string
49031       constraint-type:
49032         type: string
49033       check-type:
49034         type: string
49035   constrained-element-sets:
49036     properties:
49037       constrained-element-set:
49038         type: array
49039         items:
49040           $ref: "#/patchDefinitions/constrained-element-set"
49041   ctag-assignment:
49042     description: |
49043       ###### Related Nodes
49044       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49045     required:
49046     - vlan-id-inner
49047     properties:
49048       vlan-id-inner:
49049         type: integer
49050         format: int64
49051         description: id.
49052   ctag-assignments:
49053     properties:
49054       ctag-assignment:
49055         type: array
49056         items:
49057           $ref: "#/patchDefinitions/ctag-assignment"
49058   ctag-pool:
49059     description: |
49060       A collection of C tags (vlan tags) grouped for a specific purpose.
49061       ###### Related Nodes
49062       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
49063       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49064       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
49065     required:
49066     - target-pe
49067     - availability-zone-name
49068     - ctag-pool-purpose
49069     properties:
49070       target-pe:
49071         type: string
49072         description: The Target provider edge router
49073       availability-zone-name:
49074         type: string
49075         description: Name of the availability zone
49076       ctag-pool-purpose:
49077         type: string
49078         description: Describes what the intended purpose of this pool is.
49079       ctag-values:
49080         type: string
49081         description: Comma separated list of ctags
49082   ctag-pools:
49083     properties:
49084       ctag-pool:
49085         type: array
49086         items:
49087           $ref: "#/patchDefinitions/ctag-pool"
49088   customer:
49089     description: |
49090       customer identifiers to provide linkage back to BSS information.
49091       ###### Related Nodes
49092       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
49093       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
49094     required:
49095     - global-customer-id
49096     - subscriber-name
49097     - subscriber-type
49098     properties:
49099       global-customer-id:
49100         type: string
49101         description: Global customer id used across ECOMP to uniquely identify customer.
49102       subscriber-name:
49103         type: string
49104         description: Subscriber name, an alternate way to retrieve a customer.
49105       subscriber-type:
49106         type: string
49107         description: Subscriber type, a way to provide VID with only the INFRA customers.
49108   customers:
49109     description: |
49110       Collection of customer identifiers to provide linkage back to BSS information.
49111     properties:
49112       customer:
49113         type: array
49114         items:
49115           $ref: "#/patchDefinitions/customer"
49116   cvlan-tag-entry:
49117     required:
49118     - cvlan-tag
49119     properties:
49120       cvlan-tag:
49121         type: integer
49122         format: int64
49123         description: See mis-na-virtualization-platform.yang
49124   cvlan-tags:
49125     properties:
49126       cvlan-tag-entry:
49127         type: array
49128         items:
49129           $ref: "#/patchDefinitions/cvlan-tag-entry"
49130   dvs-switch:
49131     description: |
49132       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.
49133       ###### Related Nodes
49134       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49135       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49136     required:
49137     - switch-name
49138     - vcenter-url
49139     properties:
49140       switch-name:
49141         type: string
49142         description: DVS switch name
49143       vcenter-url:
49144         type: string
49145         description: URL used to reach the vcenter
49146   dvs-switches:
49147     description: |
49148       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
49149     properties:
49150       dvs-switch:
49151         type: array
49152         items:
49153           $ref: "#/patchDefinitions/dvs-switch"
49154   edge-prop-names:
49155     description: |
49156       Internal map to define the properties of an edge and interpret the map EdgeRules
49157     properties:
49158       edgeLabel:
49159         type: string
49160       direction:
49161         type: string
49162       multiplicityRule:
49163         type: string
49164       isParent:
49165         type: boolean
49166       usesResource:
49167         type: boolean
49168       hasDelTarget:
49169         type: boolean
49170       SVC-INFRA:
49171         type: boolean
49172       SVC-INFRA-REV:
49173         type: boolean
49174   edge-tag-query-request:
49175     properties:
49176       edge-tag:
49177         type: string
49178       result-detail:
49179         type: string
49180       start-node-type:
49181         type: string
49182       start-node-filter:
49183         type: array
49184         items:
49185           $ref: "#/patchDefinitions/start-node-filter"
49186       include-node-filter:
49187         type: array
49188         items:
49189           $ref: "#/patchDefinitions/include-node-filter"
49190       secondary-filter:
49191         type: array
49192         items:
49193           $ref: "#/patchDefinitions/secondary-filter"
49194   edge-tag-query-result:
49195     properties:
49196       tagged-inventory-item-list:
49197         type: array
49198         items:
49199           $ref: "#/patchDefinitions/tagged-inventory-item-list"
49200   element-choice-set:
49201     description: |
49202       This is how we would capture constraints defining allowed sets of elements.
49203       ###### Related Nodes
49204       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49205       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
49206       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
49207     required:
49208     - element-choice-set-uuid
49209     - element-choice-set-name
49210     properties:
49211       element-choice-set-uuid:
49212         type: string
49213       element-choice-set-name:
49214         type: string
49215       cardinality:
49216         type: string
49217   element-choice-sets:
49218     properties:
49219       element-choice-set:
49220         type: array
49221         items:
49222           $ref: "#/patchDefinitions/element-choice-set"
49223   entitlement:
49224     description: |
49225       Metadata for entitlement group.
49226       ###### Related Nodes
49227       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49228       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
49229     required:
49230     - group-uuid
49231     - resource-uuid
49232     properties:
49233       group-uuid:
49234         type: string
49235         description: Unique ID for the entitlement group the resource comes from, should be uuid.
49236       resource-uuid:
49237         type: string
49238         description: Unique ID of an entitlement resource.
49239   entitlements:
49240     description: |
49241       Entitlements, keyed by group-uuid and resource-uuid, related to license management
49242     properties:
49243       entitlement:
49244         type: array
49245         items:
49246           $ref: "#/patchDefinitions/entitlement"
49247   esr-ems:
49248     description: |
49249       Persist EMS address information used by EMS driver.
49250       ###### Related Nodes
49251       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
49252       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49253     required:
49254     - ems-id
49255     properties:
49256       ems-id:
49257         type: string
49258         description: Unique ID of EMS.
49259   esr-ems-list:
49260     properties:
49261       esr-ems:
49262         type: array
49263         items:
49264           $ref: "#/patchDefinitions/esr-ems"
49265   esr-system-info:
49266     description: |
49267       Persist common address information of external systems.
49268       ###### Related Nodes
49269       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
49270       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
49271       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
49272       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
49273     required:
49274     - esr-system-info-id
49275     - user-name
49276     - password
49277     - system-type
49278     properties:
49279       esr-system-info-id:
49280         type: string
49281         description: Unique ID of esr system info.
49282       system-name:
49283         type: string
49284         description: name of external system.
49285       type:
49286         type: string
49287         description: type of external systems.
49288       vendor:
49289         type: string
49290         description: vendor of external systems.
49291       version:
49292         type: string
49293         description: version of external systems.
49294       service-url:
49295         type: string
49296         description: url used to access external systems.
49297       user-name:
49298         type: string
49299         description: username used to access external systems.
49300       password:
49301         type: string
49302         description: password used to access external systems.
49303       system-type:
49304         type: string
49305         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
49306       protocol:
49307         type: string
49308         description: protocol of third party SDNC, for example netconf/snmp.
49309       ssl-cacert:
49310         type: string
49311         description: ca file content if enabled ssl on auth-url.
49312       ssl-insecure:
49313         type: boolean
49314         description: Whether to verify VIM's certificate.
49315       ip-address:
49316         type: string
49317         description: service IP of ftp server.
49318       port:
49319         type: string
49320         description: service port of ftp server.
49321       cloud-domain:
49322         type: string
49323         description: domain info for authentication.
49324       default-tenant:
49325         type: string
49326         description: default tenant of VIM.
49327       passive:
49328         type: boolean
49329         description: ftp passive mode or not.
49330       remote-path:
49331         type: string
49332         description: resource or performance data file path.
49333       system-status:
49334         type: string
49335         description: the status of external system.
49336   esr-system-info-list:
49337     description: |
49338       Collection of persistent block-level external system auth info.
49339     properties:
49340       esr-system-info:
49341         type: array
49342         items:
49343           $ref: "#/patchDefinitions/esr-system-info"
49344   esr-thirdparty-sdnc:
49345     description: |
49346       Persist SDNC address information used by ONAP SDNC.
49347       ###### Related Nodes
49348       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
49349       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
49350       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49351     required:
49352     - thirdparty-sdnc-id
49353     properties:
49354       thirdparty-sdnc-id:
49355         type: string
49356         description: Unique ID of SDNC.
49357       location:
49358         type: string
49359         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
49360       product-name:
49361         type: string
49362         description: password used to access SDNC server.
49363   esr-thirdparty-sdnc-list:
49364     properties:
49365       esr-thirdparty-sdnc:
49366         type: array
49367         items:
49368           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
49369   esr-vnfm:
49370     description: |
49371       Persist VNFM address information used by VF-C.
49372       ###### Related Nodes
49373       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
49374       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49375     required:
49376     - vnfm-id
49377     properties:
49378       vnfm-id:
49379         type: string
49380         description: Unique ID of VNFM.
49381       vim-id:
49382         type: string
49383         description: indecate the VIM to deploy VNF.
49384       certificate-url:
49385         type: string
49386         description: certificate url of VNFM.
49387   esr-vnfm-list:
49388     properties:
49389       esr-vnfm:
49390         type: array
49391         items:
49392           $ref: "#/patchDefinitions/esr-vnfm"
49393   evc:
49394     description: |
49395       evc object is an optional child object of the Configuration object.
49396       ###### Related Nodes
49397       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49398     required:
49399     - evc-id
49400     properties:
49401       evc-id:
49402         type: string
49403         description: Unique/key field for the evc object
49404       forwarding-path-topology:
49405         type: string
49406         description: Point-to-Point, Multi-Point
49407       cir-value:
49408         type: string
49409         description: Commited Information Rate
49410       cir-units:
49411         type: string
49412         description: CIR units
49413       connection-diversity-group-id:
49414         type: string
49415         description: Diversity Group ID
49416       service-hours:
49417         type: string
49418         description: formerly Performance Group
49419       esp-evc-circuit-id:
49420         type: string
49421         description: EVC Circuit ID of ESP EVC
49422       esp-evc-cir-value:
49423         type: string
49424         description: Committed Information Rate (For ESP)
49425       esp-evc-cir-units:
49426         type: string
49427         description: CIR units (For ESP)
49428       esp-itu-code:
49429         type: string
49430         description: Identifies ESP
49431       collector-pop-clli:
49432         type: string
49433         description: Collector POP CLLI (from the hostname of the access pnf)
49434       inter-connect-type-ingress:
49435         type: string
49436         description: Interconnect type on ingress side of EVC.
49437       tagmode-access-ingress:
49438         type: string
49439         description: tagode for collector side of EVC
49440       tagmode-access-egress:
49441         type: string
49442         description: tagMode for network side of EVC
49443   evcs:
49444     properties:
49445       evc:
49446         type: array
49447         items:
49448           $ref: "#/patchDefinitions/evc"
49449   external-system:
49450     description: |
49451       Namespace for external system.
49452     properties:
49453       esr-ems-list:
49454         type: object
49455         $ref: "#/patchDefinitions/esr-ems-list"
49456       esr-vnfm-list:
49457         type: object
49458         $ref: "#/patchDefinitions/esr-vnfm-list"
49459       esr-thirdparty-sdnc-list:
49460         type: object
49461         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
49462   extra-properties:
49463     description: |
49464       Extra properties for inventory item for response list
49465   extra-property:
49466     properties:
49467       property-name:
49468         type: string
49469   flavor:
49470     description: |
49471       Openstack flavor.
49472       ###### Related Nodes
49473       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49474       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
49475       - FLAVOR cannot be deleted if linked to VSERVER
49476     required:
49477     - flavor-id
49478     - flavor-name
49479     - flavor-selflink
49480     properties:
49481       flavor-id:
49482         type: string
49483         description: Flavor id, expected to be unique across cloud-region.
49484       flavor-name:
49485         type: string
49486         description: Flavor name
49487       flavor-vcpus:
49488         type: integer
49489         format: int32
49490         description: Number of CPUs
49491       flavor-ram:
49492         type: integer
49493         format: int32
49494         description: Amount of memory
49495       flavor-disk:
49496         type: integer
49497         format: int32
49498         description: Disk space
49499       flavor-ephemeral:
49500         type: integer
49501         format: int32
49502         description: Amount of ephemeral disk space
49503       flavor-swap:
49504         type: string
49505         description: amount of swap space allocation
49506       flavor-is-public:
49507         type: boolean
49508         description: whether flavor is available to all users or private to the tenant it was created in.
49509       flavor-selflink:
49510         type: string
49511         description: URL to endpoint where AAI can get more details
49512       flavor-disabled:
49513         type: boolean
49514         description: Boolean as to whether this flavor is no longer enabled
49515   flavors:
49516     description: |
49517       Collection of openstack flavors.
49518     properties:
49519       flavor:
49520         type: array
49521         items:
49522           $ref: "#/patchDefinitions/flavor"
49523   forwarder:
49524     description: |
49525       Entity describing a sequenced segment of forwarding path
49526       ###### Related Nodes
49527       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49528       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
49529       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49530       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
49531       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
49532       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
49533     required:
49534     - sequence
49535     properties:
49536       sequence:
49537         type: integer
49538         format: int32
49539         description: Unique ID of this segmentation
49540       forwarder-role:
49541         type: string
49542         description: ingress, intermediate, egress
49543   forwarder-evc:
49544     description: |
49545       forwarder object is an optional child object of the Configuration object.
49546       ###### Related Nodes
49547       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49548     required:
49549     - forwarder-evc-id
49550     properties:
49551       forwarder-evc-id:
49552         type: string
49553         description: Key for forwarder-evc object
49554       circuit-id:
49555         type: string
49556         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
49557       ivlan:
49558         type: string
49559         description: Internal VLAN.
49560       svlan:
49561         type: string
49562         description: SVLAN value for ingress of egress forwarder.
49563       cvlan:
49564         type: string
49565         description: CVLAN value for ingress of egress forwarder.
49566   forwarder-evcs:
49567     properties:
49568       forwarder-evc:
49569         type: array
49570         items:
49571           $ref: "#/patchDefinitions/forwarder-evc"
49572   forwarders:
49573     properties:
49574       forwarder:
49575         type: array
49576         items:
49577           $ref: "#/patchDefinitions/forwarder"
49578   forwarding-path:
49579     description: |
49580       Entity that describes the sequenced forwarding path between interfaces of services or resources
49581       ###### Related Nodes
49582       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
49583       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49584       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49585       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
49586       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
49587     required:
49588     - forwarding-path-id
49589     - forwarding-path-name
49590     properties:
49591       forwarding-path-id:
49592         type: string
49593         description: Unique ID of this FP
49594       forwarding-path-name:
49595         type: string
49596         description: Name of the FP
49597   forwarding-paths:
49598     properties:
49599       forwarding-path:
49600         type: array
49601         items:
49602           $ref: "#/patchDefinitions/forwarding-path"
49603   generic-vnf:
49604     description: |
49605       General purpose VNF
49606       ###### Related Nodes
49607       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
49608       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49609       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49610       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
49611       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
49612       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
49613       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
49614       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
49615       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
49616       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49617       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49618       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49619       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49620       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
49621       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49622       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49623       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
49624       - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
49625     required:
49626     - vnf-id
49627     - vnf-name
49628     - vnf-type
49629     - in-maint
49630     - is-closed-loop-disabled
49631     properties:
49632       vnf-id:
49633         type: string
49634         description: Unique id of VNF.  This is unique across the graph.
49635       vnf-name:
49636         type: string
49637         description: Name of VNF.
49638       vnf-name2:
49639         type: string
49640         description: Alternate name of VNF.
49641       vnf-type:
49642         type: string
49643         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
49644       service-id:
49645         type: string
49646         description: Unique identifier of service from ASDC
49647       regional-resource-zone:
49648         type: string
49649         description: Regional way of organizing pservers, source of truth should define values
49650       prov-status:
49651         type: string
49652         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49653       operational-state:
49654         type: string
49655         description: Indicator for whether the resource is considered operational
49656       license-key:
49657         type: string
49658         description: License key
49659       equipment-role:
49660         type: string
49661         description: Client should send valid enumerated value
49662       orchestration-status:
49663         type: string
49664         description: Orchestration status of this VNF, used by MSO.
49665       heat-stack-id:
49666         type: string
49667         description: Heat stack id corresponding to this instance, managed by MSO
49668       mso-catalog-key:
49669         type: string
49670         description: Corresponds to the SDN-C catalog id used to configure this VCE
49671       management-option:
49672         type: string
49673         description: identifier of managed by company or customer
49674       ipv4-oam-address:
49675         type: string
49676         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
49677       ipv4-loopback0-address:
49678         type: string
49679         description: v4 Loopback0 address
49680       nm-lan-v6-address:
49681         type: string
49682         description: v6 Loopback address
49683       management-v6-address:
49684         type: string
49685         description: v6 management address
49686       vcpu:
49687         type: integer
49688         format: int64
49689         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
49690       vcpu-units:
49691         type: string
49692         description: units associated with vcpu, used for VNFs with no vservers/flavors
49693       vmemory:
49694         type: integer
49695         format: int64
49696         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
49697       vmemory-units:
49698         type: string
49699         description: units associated with vmemory, used for VNFs with no vservers/flavors
49700       vdisk:
49701         type: integer
49702         format: int64
49703         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
49704       vdisk-units:
49705         type: string
49706         description: units associated with vdisk, used for VNFs with no vservers/flavors
49707       in-maint:
49708         type: boolean
49709       is-closed-loop-disabled:
49710         type: boolean
49711   generic-vnfs:
49712     description: |
49713       Collection of VNFs
49714     properties:
49715       generic-vnf:
49716         type: array
49717         items:
49718           $ref: "#/patchDefinitions/generic-vnf"
49719   group-assignment:
49720     description: |
49721       Openstack group-assignment used to store exclusivity groups (EG).
49722       ###### Related Nodes
49723       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49724       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
49725       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
49726     required:
49727     - group-id
49728     - group-type
49729     - group-name
49730     properties:
49731       group-id:
49732         type: string
49733         description: Group id, expected to be unique across cloud-region.
49734       group-type:
49735         type: string
49736         description: Group type - the type of group this instance refers to
49737       group-name:
49738         type: string
49739         description: Group name - name assigned to the group
49740       group-description:
49741         type: string
49742         description: Group description - description of the group
49743   group-assignments:
49744     description: |
49745       Collection of openstack group assignments
49746     properties:
49747       group-assignment:
49748         type: array
49749         items:
49750           $ref: "#/patchDefinitions/group-assignment"
49751   host-route:
49752     description: |
49753       ###### Related Nodes
49754       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
49755     required:
49756     - host-route-id
49757     - route-prefix
49758     - next-hop
49759     properties:
49760       host-route-id:
49761         type: string
49762         description: host-route id
49763       route-prefix:
49764         type: string
49765         description: subnet prefix
49766       next-hop:
49767         type: string
49768         description: Could be ip-address, hostname, or service-instance
49769       next-hop-type:
49770         type: string
49771         description: Should be ip-address, hostname, or service-instance to match next-hop
49772   host-routes:
49773     properties:
49774       host-route:
49775         type: array
49776         items:
49777           $ref: "#/patchDefinitions/host-route"
49778   image:
49779     description: |
49780       Openstack image.
49781       ###### Related Nodes
49782       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49783       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
49784       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
49785       - IMAGE cannot be deleted if linked to VSERVER
49786       - IMAGE is DELETED when these are DELETED METADATUM
49787     required:
49788     - image-id
49789     - image-name
49790     - image-os-distro
49791     - image-os-version
49792     - image-selflink
49793     properties:
49794       image-id:
49795         type: string
49796         description: Image id, expected to be unique across cloud region
49797       image-name:
49798         type: string
49799         description: Image name
49800       image-architecture:
49801         type: string
49802         description: Operating system architecture.
49803       image-os-distro:
49804         type: string
49805         description: The common name of the operating system distribution in lowercase
49806       image-os-version:
49807         type: string
49808         description: The operating system version as specified by the distributor.
49809       application:
49810         type: string
49811         description: The application that the image instantiates.
49812       application-vendor:
49813         type: string
49814         description: The vendor of the application.
49815       application-version:
49816         type: string
49817         description: The version of the application.
49818       image-selflink:
49819         type: string
49820         description: URL to endpoint where AAI can get more details
49821   images:
49822     description: |
49823       Collectio of Openstack images.
49824     properties:
49825       image:
49826         type: array
49827         items:
49828           $ref: "#/patchDefinitions/image"
49829   include-node-filter:
49830     properties:
49831       include-node-type:
49832         type: string
49833   instance-filter:
49834     description: |
49835       InstanceFilter for performing a named-query or model query
49836   instance-filters:
49837     description: |
49838       InstanceFilters for performing a named-query or model query
49839     properties:
49840       instance-filter:
49841         type: array
49842         items:
49843           $ref: "#/patchDefinitions/instance-filter"
49844   instance-group:
49845     description: |
49846       General mechanism for grouping instances
49847       ###### Related Nodes
49848       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
49849       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49850       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49851       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49852       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49853     required:
49854     - id
49855     - description
49856     - type
49857     properties:
49858       id:
49859         type: string
49860         description: Instance Group ID, UUID assigned to this instance.
49861       description:
49862         type: string
49863         description: Descriptive text to help identify the usage of this instance-group
49864       type:
49865         type: string
49866         description: Only valid value today is lower case ha for high availability
49867       sub-type:
49868         type: string
49869         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
49870   instance-groups:
49871     description: |
49872       Collection of openstack route table references
49873     properties:
49874       instance-group:
49875         type: array
49876         items:
49877           $ref: "#/patchDefinitions/instance-group"
49878   inventory:
49879     properties:
49880       search:
49881         type: object
49882         $ref: "#/patchDefinitions/search"
49883       actions:
49884         type: object
49885         $ref: "#/patchDefinitions/actions"
49886       cloud-infrastructure:
49887         type: object
49888         $ref: "#/patchDefinitions/cloud-infrastructure"
49889       business:
49890         type: object
49891         $ref: "#/patchDefinitions/business"
49892       service-design-and-creation:
49893         type: object
49894         $ref: "#/patchDefinitions/service-design-and-creation"
49895       network:
49896         type: object
49897         $ref: "#/patchDefinitions/network"
49898       aai-internal:
49899         type: object
49900         $ref: "#/patchDefinitions/aai-internal"
49901   inventory-item:
49902     properties:
49903       inventory-item-type:
49904         type: string
49905       inventory-item-link:
49906         type: string
49907       inventory-item-data:
49908         type: array
49909         items:
49910           $ref: "#/patchDefinitions/inventory-item-data"
49911       tagged-inventory-item-list:
49912         type: array
49913         items:
49914           $ref: "#/patchDefinitions/tagged-inventory-item-list"
49915   inventory-item-data:
49916     properties:
49917       property-name:
49918         type: string
49919       property-value:
49920         type: string
49921   inventory-response-item:
49922     description: |
49923       Inventory item for response list
49924     properties:
49925       model-name:
49926         type: string
49927       extra-properties:
49928         type: object
49929         $ref: "#/patchDefinitions/extra-properties"
49930       inventory-response-items:
49931         type: object
49932         $ref: "#/patchDefinitions/inventory-response-items"
49933   inventory-response-items:
49934     description: |
49935       Container for inventory items in response list
49936     properties:
49937       inventory-response-item:
49938         type: array
49939         items:
49940           $ref: "#/patchDefinitions/inventory-response-item"
49941   ipsec-configuration:
49942     description: |
49943       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
49944       ###### Related Nodes
49945       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49946       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
49947       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
49948     required:
49949     - ipsec-configuration-id
49950     properties:
49951       ipsec-configuration-id:
49952         type: string
49953         description: UUID of this configuration
49954       requested-vig-address-type:
49955         type: string
49956         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
49957       requested-encryption-strength:
49958         type: string
49959         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
49960       requested-dmz-type:
49961         type: string
49962         description: can offer a shared DMZ or a DMZ specific to a customer
49963       shared-dmz-network-address:
49964         type: string
49965         description: Network address of shared DMZ
49966       requested-customer-name:
49967         type: string
49968         description: If the DMZ is a custom DMZ, this field will indicate the customer information
49969       ike-version:
49970         type: string
49971         description: can be 1 or 2
49972       ikev1-authentication:
49973         type: string
49974         description: Contains values like md5, sha1, sha256, sha384
49975       ikev1-encryption:
49976         type: string
49977         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49978       ikev1-dh-group:
49979         type: string
49980         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
49981       ikev1-am-group-id:
49982         type: string
49983         description: Group name defined in VIG for clients using aggressive mode
49984       ikev1-am-password:
49985         type: string
49986         description: pre-shared key for the above group name
49987       ikev1-sa-lifetime:
49988         type: string
49989         description: Lifetime for IKEv1 SA
49990       ipsec-authentication:
49991         type: string
49992         description: md5, sha1, sha256, sha384
49993       ipsec-encryption:
49994         type: string
49995         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
49996       ipsec-sa-lifetime:
49997         type: string
49998         description: Life time for IPSec SA
49999       ipsec-pfs:
50000         type: string
50001         description: enable PFS or not
50002       xauth-userid:
50003         type: string
50004         description: user ID for xAuth, sm-user, ,nmteHostName
50005       xauth-user-password:
50006         type: string
50007         description: Encrypted using the Juniper $9$ algorithm
50008       dpd-interval:
50009         type: string
50010         description: The time between DPD probe
50011       dpd-frequency:
50012         type: string
50013         description: Maximum number of DPD before claiming the tunnel is down
50014   ipsec-configurations:
50015     properties:
50016       ipsec-configuration:
50017         type: array
50018         items:
50019           $ref: "#/patchDefinitions/ipsec-configuration"
50020   key-data:
50021     properties:
50022       key-name:
50023         type: string
50024       key-value:
50025         type: string
50026   l-interface:
50027     description: |
50028       Logical interfaces, e.g., a vnic.
50029       ###### Related Nodes
50030       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50031       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50032       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50033       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50034       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50035       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
50036       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50037       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50038       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
50039       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
50040       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
50041       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
50042     required:
50043     - interface-name
50044     properties:
50045       interface-name:
50046         type: string
50047         description: Name given to the interface
50048       interface-role:
50049         type: string
50050         description: E.g., CUSTOMER, UPLINK, etc.
50051       v6-wan-link-ip:
50052         type: string
50053         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
50054       selflink:
50055         type: string
50056         description: URL to endpoint where AAI can get more details
50057       interface-id:
50058         type: string
50059         description: ID of interface
50060       macaddr:
50061         type: string
50062         description: MAC address for the interface
50063       network-name:
50064         type: string
50065         description: Name of the network
50066       management-option:
50067         type: string
50068         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
50069   l-interfaces:
50070     description: |
50071       Collection of logical interfaces.
50072     properties:
50073       l-interface:
50074         type: array
50075         items:
50076           $ref: "#/patchDefinitions/l-interface"
50077   l3-interface-ipv4-address-list:
50078     description: |
50079       IPv4 Address Range
50080       ###### Related Nodes
50081       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50082       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50083       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50084       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50085     required:
50086     - l3-interface-ipv4-address
50087     properties:
50088       l3-interface-ipv4-address:
50089         type: string
50090         description: IP address
50091       l3-interface-ipv4-prefix-length:
50092         type: integer
50093         format: int64
50094         description: Prefix length, 32 for single address
50095       vlan-id-inner:
50096         type: integer
50097         format: int64
50098         description: Inner VLAN tag
50099       vlan-id-outer:
50100         type: integer
50101         format: int64
50102         description: Outer VLAN tag
50103       is-floating:
50104         type: boolean
50105         description: Indicator of fixed or floating address
50106   l3-interface-ipv6-address-list:
50107     description: |
50108       IPv6 Address Range
50109       ###### Related Nodes
50110       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50111       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50112       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50113       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50114     required:
50115     - l3-interface-ipv6-address
50116     properties:
50117       l3-interface-ipv6-address:
50118         type: string
50119         description: IP address
50120       l3-interface-ipv6-prefix-length:
50121         type: integer
50122         format: int64
50123         description: Prefix length, 128 for single address
50124       vlan-id-inner:
50125         type: integer
50126         format: int64
50127         description: Inner VLAN tag
50128       vlan-id-outer:
50129         type: integer
50130         format: int64
50131         description: Outer VLAN tag
50132       is-floating:
50133         type: boolean
50134         description: Indicator of fixed or floating address
50135   l3-network:
50136     description: |
50137       Generic network definition
50138       ###### Related Nodes
50139       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50140       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
50141       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
50142       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50143       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50144       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50145       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50146       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50147       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50148       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50149       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
50150       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50151       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50152       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
50153       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
50154     required:
50155     - network-id
50156     - network-name
50157     - is-bound-to-vpn
50158     - is-provider-network
50159     - is-shared-network
50160     - is-external-network
50161     properties:
50162       network-id:
50163         type: string
50164         description: Network ID, should be uuid. Unique across A&AI.
50165       network-name:
50166         type: string
50167         description: Name of the network, governed by some naming convention..
50168       network-type:
50169         type: string
50170         description: Type of the network - who defines these values?
50171       network-role:
50172         type: string
50173         description: Role the network plans - who defines these values?
50174       network-technology:
50175         type: string
50176         description: Network technology - who defines these values?
50177       neutron-network-id:
50178         type: string
50179         description: Neutron network id of this Interface
50180       is-bound-to-vpn:
50181         type: boolean
50182       service-id:
50183         type: string
50184         description: Unique identifier of service from ASDC
50185       network-role-instance:
50186         type: integer
50187         format: int64
50188         description: network role instance
50189   l3-networks:
50190     properties:
50191       l3-network:
50192         type: array
50193         items:
50194           $ref: "#/patchDefinitions/l3-network"
50195   lag-interface:
50196     description: |
50197       Link aggregate interface
50198       ###### Related Nodes
50199       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50200       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50201       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50202       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50203       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50204       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50205       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50206       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
50207       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
50208     required:
50209     - interface-name
50210     properties:
50211       interface-name:
50212         type: string
50213         description: Name that identifies the link aggregate interface
50214   lag-interfaces:
50215     description: |
50216       Collection of link aggregate interfaces.
50217     properties:
50218       lag-interface:
50219         type: array
50220         items:
50221           $ref: "#/patchDefinitions/lag-interface"
50222   lag-link:
50223     description: |
50224       LAG links can connect lag-interfaces
50225       ###### Related Nodes
50226       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50227       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50228     required:
50229     - link-name
50230     properties:
50231       link-name:
50232         type: string
50233         description: Alphabetical concatenation of lag-interface names
50234   lag-links:
50235     description: |
50236       Collection of link aggregation connections
50237     properties:
50238       lag-link:
50239         type: array
50240         items:
50241           $ref: "#/patchDefinitions/lag-link"
50242   license:
50243     description: |
50244       Metadata for license group.
50245       ###### Related Nodes
50246       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50247       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
50248     required:
50249     - group-uuid
50250     - resource-uuid
50251     properties:
50252       group-uuid:
50253         type: string
50254         description: Unique ID for the license group the resource belongs to, should be uuid.
50255       resource-uuid:
50256         type: string
50257         description: Unique ID of a license resource.
50258   licenses:
50259     description: |
50260       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
50261     properties:
50262       license:
50263         type: array
50264         items:
50265           $ref: "#/patchDefinitions/license"
50266   line-of-business:
50267     description: |
50268       describes a line-of-business
50269       ###### Related Nodes
50270       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
50271     required:
50272     - line-of-business-name
50273     properties:
50274       line-of-business-name:
50275         type: string
50276         description: Name of the line-of-business (product)
50277   lines-of-business:
50278     description: |
50279       Collection of lines-of-business
50280     properties:
50281       line-of-business:
50282         type: array
50283         items:
50284           $ref: "#/patchDefinitions/line-of-business"
50285   logical-link:
50286     description: |
50287       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
50288       ###### Related Nodes
50289       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
50290       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50291       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50292       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
50293       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
50294       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
50295       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50296       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50297       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50298       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50299       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50300     required:
50301     - link-name
50302     - link-type
50303     properties:
50304       link-name:
50305         type: string
50306         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
50307       link-type:
50308         type: string
50309         description: Type of logical link, e.g., evc
50310       speed-value:
50311         type: string
50312         description: Captures the numeric part of the speed
50313       speed-units:
50314         type: string
50315         description: Captures the units corresponding to the speed
50316       ip-version:
50317         type: string
50318         description: v4, v6, or ds for dual stack
50319       routing-protocol:
50320         type: string
50321         description: For example, static or BGP
50322   logical-links:
50323     description: |
50324       Collection of logical connections
50325     properties:
50326       logical-link:
50327         type: array
50328         items:
50329           $ref: "#/patchDefinitions/logical-link"
50330   metadata:
50331     description: |
50332       Collection of metadatum (key/value pairs)
50333     properties:
50334       metadatum:
50335         type: array
50336         items:
50337           $ref: "#/patchDefinitions/metadatum"
50338   metadatum:
50339     description: |
50340       Key/value pairs
50341       ###### Related Nodes
50342       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
50343       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
50344       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
50345       - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50346     required:
50347     - metaname
50348     - metaval
50349     properties:
50350       metaname:
50351         type: string
50352       metaval:
50353         type: string
50354   model:
50355     description: |
50356       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
50357       ###### Related Nodes
50358       - TO model( model-element isA model, MANY2ONE)
50359       - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)
50360       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50361       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50362       - FROM model-element( model-element isA model, MANY2ONE)
50363       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50364       - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT
50365       - MODEL is DELETED when these are DELETED METADATUM
50366       - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT
50367     required:
50368     - model-name-version-id
50369     - model-type
50370     - model-name
50371     - model-id
50372     - model-version
50373     properties:
50374       model-name-version-id:
50375         type: string
50376         description: Unique identifier corresponding to one version of a model in ASDC
50377       model-type:
50378         type: string
50379         description: Type of the model, e.g., service, resource, widget, etc.
50380       model-name:
50381         type: string
50382         description: Name of the model, which can change from version to version.
50383       model-id:
50384         type: string
50385         description: Invariant unique ID which does not change from version to version
50386       model-version:
50387         type: string
50388         description: Version
50389       model-description:
50390         type: string
50391         description: Description
50392   model-and-named-query-search:
50393     description: |
50394       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
50395     properties:
50396       query-parameters:
50397         type: object
50398         $ref: "#/patchDefinitions/query-parameters"
50399       instance-filters:
50400         type: object
50401         $ref: "#/patchDefinitions/instance-filters"
50402       top-node-type:
50403         type: string
50404   model-constraint:
50405     description: |
50406       This is how we would capture constraints defining allowed sets of elements.
50407       ###### Related Nodes
50408       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50409       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
50410       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
50411     required:
50412     - model-constraint-uuid
50413     - constrained-element-set-uuid-to-replace
50414     properties:
50415       model-constraint-uuid:
50416         type: string
50417       constrained-element-set-uuid-to-replace:
50418         type: string
50419       constrained-element-sets:
50420         type: array
50421         items:
50422           $ref: "#/patchDefinitions/constrained-element-set"
50423   model-constraints:
50424     properties:
50425       model-constraint:
50426         type: array
50427         items:
50428           $ref: "#/patchDefinitions/model-constraint"
50429   model-element:
50430     description: |
50431       Defines how other models combine to make up a higher-level model.
50432       ###### Related Nodes
50433       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
50434       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50435       - TO model( model-element isA model, MANY2ONE)
50436       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50437       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50438       - FROM model (PARENT of model-element, model startsWith model-element)
50439       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50440       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
50441     required:
50442     - model-element-uuid
50443     - new-data-del-flag
50444     - cardinality
50445     properties:
50446       model-element-uuid:
50447         type: string
50448       new-data-del-flag:
50449         type: string
50450         description: Indicates whether this element was created as part of instantiation from this model
50451       cardinality:
50452         type: string
50453         description: How many of this type of element are required/allowed
50454       linkage-points:
50455         type: string
50456   model-elements:
50457     properties:
50458       model-element:
50459         type: array
50460         items:
50461           $ref: "#/patchDefinitions/model-element"
50462   model-ver:
50463     description: |
50464       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50465       ###### Related Nodes
50466       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50467       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50468       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50469       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50470       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
50471       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
50472     required:
50473     - model-version-id
50474     - model-name
50475     - model-version
50476     properties:
50477       model-version-id:
50478         type: string
50479         description: Unique identifier corresponding to one version of a model in ASDC
50480       model-name:
50481         type: string
50482         description: Name of the model, which can change from version to version.
50483       model-version:
50484         type: string
50485         description: Version
50486       model-description:
50487         type: string
50488         description: Description
50489   model-vers:
50490     properties:
50491       model-ver:
50492         type: array
50493         items:
50494           $ref: "#/patchDefinitions/model-ver"
50495   models:
50496     description: |
50497       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
50498     properties:
50499       model:
50500         type: array
50501         items:
50502           $ref: "#/patchDefinitions/model"
50503   multicast-configuration:
50504     description: |
50505       ###### Related Nodes
50506       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
50507     required:
50508     - multicast-configuration-id
50509     - multicast-protocol
50510     - rp-type
50511     properties:
50512       multicast-configuration-id:
50513         type: string
50514         description: Unique id of multicast configuration.
50515       multicast-protocol:
50516         type: string
50517         description: protocol of multicast configuration
50518       rp-type:
50519         type: string
50520         description: rp type of multicast configuration
50521   multicast-configurations:
50522     description: |
50523       multicast configuration of generic-vnf ip-address
50524     properties:
50525       multicast-configuration:
50526         type: array
50527         items:
50528           $ref: "#/patchDefinitions/multicast-configuration"
50529   named-queries:
50530     properties:
50531       named-query:
50532         type: array
50533         items:
50534           $ref: "#/patchDefinitions/named-query"
50535   named-query:
50536     description: |
50537       TBD
50538       ###### Related Nodes
50539       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50540       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50541       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50542       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
50543     required:
50544     - named-query-uuid
50545     - named-query-name
50546     - named-query-version
50547     properties:
50548       named-query-uuid:
50549         type: string
50550       named-query-name:
50551         type: string
50552       named-query-version:
50553         type: string
50554       required-input-param:
50555         type: string
50556       description:
50557         type: string
50558   named-query-element:
50559     description: |
50560       TBD
50561       ###### Related Nodes
50562       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
50563       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50564       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50565       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50566       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50567       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
50568       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
50569     required:
50570     - named-query-element-uuid
50571     properties:
50572       named-query-element-uuid:
50573         type: string
50574       property-collect-list:
50575         type: string
50576   named-query-elements:
50577     properties:
50578       named-query-element:
50579         type: array
50580         items:
50581           $ref: "#/patchDefinitions/named-query-element"
50582   network:
50583     description: |
50584       Namespace for network inventory resources.
50585     properties:
50586       logical-links:
50587         type: array
50588         items:
50589           $ref: "#/patchDefinitions/logical-link"
50590       site-pair-sets:
50591         type: array
50592         items:
50593           $ref: "#/patchDefinitions/site-pair-set"
50594       vpn-bindings:
50595         type: array
50596         items:
50597           $ref: "#/patchDefinitions/vpn-binding"
50598       vpls-pes:
50599         type: array
50600         items:
50601           $ref: "#/patchDefinitions/vpls-pe"
50602       multicast-configurations:
50603         type: array
50604         items:
50605           $ref: "#/patchDefinitions/multicast-configuration"
50606       vces:
50607         type: array
50608         items:
50609           $ref: "#/patchDefinitions/vce"
50610       vnfcs:
50611         type: array
50612         items:
50613           $ref: "#/patchDefinitions/vnfc"
50614       l3-networks:
50615         type: array
50616         items:
50617           $ref: "#/patchDefinitions/l3-network"
50618       network-policies:
50619         type: array
50620         items:
50621           $ref: "#/patchDefinitions/network-policy"
50622       generic-vnfs:
50623         type: array
50624         items:
50625           $ref: "#/patchDefinitions/generic-vnf"
50626       lag-links:
50627         type: array
50628         items:
50629           $ref: "#/patchDefinitions/lag-link"
50630       newvces:
50631         type: array
50632         items:
50633           $ref: "#/patchDefinitions/newvce"
50634       pnfs:
50635         type: array
50636         items:
50637           $ref: "#/patchDefinitions/pnf"
50638       physical-links:
50639         type: array
50640         items:
50641           $ref: "#/patchDefinitions/physical-link"
50642       ipsec-configurations:
50643         type: array
50644         items:
50645           $ref: "#/patchDefinitions/ipsec-configuration"
50646       route-table-references:
50647         type: array
50648         items:
50649           $ref: "#/patchDefinitions/route-table-reference"
50650   network-policies:
50651     properties:
50652       network-policy:
50653         type: array
50654         items:
50655           $ref: "#/patchDefinitions/network-policy"
50656   network-policy:
50657     description: |
50658       ###### Related Nodes
50659       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50660     required:
50661     - network-policy-id
50662     properties:
50663       network-policy-id:
50664         type: string
50665         description: UUID representing unique key to this instance
50666       network-policy-fqdn:
50667         type: string
50668         description: Contrail FQDN for the policy
50669       heat-stack-id:
50670         type: string
50671         description: ID for the openStack Heat instance
50672   network-profile:
50673     description: |
50674       Network profile populated by SDN-GP for SNMP
50675       ###### Related Nodes
50676       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
50677     required:
50678     - nm-profile-name
50679     properties:
50680       nm-profile-name:
50681         type: string
50682         description: Unique name of network profile.
50683       community-string:
50684         type: string
50685         description: Encrypted SNMP community string
50686   network-profiles:
50687     description: |
50688       Collection of network profiles
50689     properties:
50690       network-profile:
50691         type: array
50692         items:
50693           $ref: "#/patchDefinitions/network-profile"
50694   newvce:
50695     description: |
50696       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50697       ###### Related Nodes
50698       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50699       - NEWVCE is DELETED when these are DELETED L-INTERFACE
50700     required:
50701     - vnf-id2
50702     - vnf-name
50703     - vnf-type
50704     properties:
50705       vnf-id2:
50706         type: string
50707         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
50708       vnf-name:
50709         type: string
50710         description: Name of VNF.
50711       vnf-name2:
50712         type: string
50713         description: Alternate name of VNF.
50714       vnf-type:
50715         type: string
50716         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
50717       prov-status:
50718         type: string
50719         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50720       operational-state:
50721         type: string
50722         description: Indicator for whether the resource is considered operational
50723       license-key:
50724         type: string
50725         description: License key
50726       ipv4-oam-address:
50727         type: string
50728         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
50729       equipment-role:
50730         type: string
50731         description: Client should send valid enumerated value.
50732   newvces:
50733     description: |
50734       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
50735     properties:
50736       newvce:
50737         type: array
50738         items:
50739           $ref: "#/patchDefinitions/newvce"
50740   notification-event:
50741     properties:
50742       cambria.partition:
50743         type: string
50744       notification-event-header:
50745         type: object
50746         $ref: "#/patchDefinitions/notification-event-header"
50747   notification-event-header:
50748     properties:
50749       id:
50750         type: string
50751       timestamp:
50752         type: string
50753       source-name:
50754         type: string
50755       domain:
50756         type: string
50757       sequence-number:
50758         type: string
50759       severity:
50760         type: string
50761       event-type:
50762         type: string
50763       version:
50764         type: string
50765       action:
50766         type: string
50767       entity-type:
50768         type: string
50769       top-entity-type:
50770         type: string
50771       entity-link:
50772         type: string
50773       status:
50774         type: string
50775   notify:
50776     required:
50777     - event-id
50778     properties:
50779       event-id:
50780         type: string
50781       node-type:
50782         type: string
50783       event-trigger:
50784         type: string
50785       key-data:
50786         type: array
50787         items:
50788           $ref: "#/patchDefinitions/key-data"
50789       selflink:
50790         type: string
50791   oam-network:
50792     description: |
50793       OAM network, to be deprecated shortly.  Do not use for new purposes.
50794       ###### Related Nodes
50795       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50796       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
50797       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
50798     required:
50799     - network-uuid
50800     - network-name
50801     - cvlan-tag
50802     properties:
50803       network-uuid:
50804         type: string
50805         description: UUID of the network. Unique across a cloud-region
50806       network-name:
50807         type: string
50808         description: Name of the network.
50809       cvlan-tag:
50810         type: integer
50811         format: int64
50812         description: cvlan-id
50813       ipv4-oam-gateway-address:
50814         type: string
50815         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50816       ipv4-oam-gateway-address-prefix-length:
50817         type: integer
50818         format: int32
50819         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
50820   oam-networks:
50821     description: |
50822       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
50823     properties:
50824       oam-network:
50825         type: array
50826         items:
50827           $ref: "#/patchDefinitions/oam-network"
50828   operational-environment:
50829     description: |
50830       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
50831       ###### Related Nodes
50832       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50833       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
50834     required:
50835     - operational-environment-id
50836     - operational-environment-name
50837     - operational-environment-type
50838     - operational-environment-status
50839     - tenant-context
50840     - workload-context
50841     properties:
50842       operational-environment-id:
50843         type: string
50844         description: UUID of an operational environment
50845       operational-environment-name:
50846         type: string
50847         description: Operational Environment name
50848       operational-environment-type:
50849         type: string
50850         description: Operational Environment Type.
50851       operational-environment-status:
50852         type: string
50853         description: Status
50854       tenant-context:
50855         type: string
50856         description: Tenant Context.
50857       workload-context:
50858         type: string
50859         description: Workload Context.
50860   operational-environments:
50861     description: |
50862       a logical partition of the cloud which allows to have multiple environments in the production AIC.
50863     properties:
50864       operational-environment:
50865         type: array
50866         items:
50867           $ref: "#/patchDefinitions/operational-environment"
50868   overloaded-model:
50869     description: |
50870       Allows for legacy POST of old-style and new-style models
50871     required:
50872     - model-invariant-id
50873     - model-name-version-id
50874     - model-type
50875     - model-name
50876     - model-id
50877     - model-version
50878     properties:
50879       model-invariant-id:
50880         type: string
50881         description: Unique identifier corresponding to the main definition of a model in ASDC
50882       model-name-version-id:
50883         type: string
50884         description: Unique identifier corresponding to one version of a model in ASDC
50885       model-type:
50886         type: string
50887         description: Type of the model, e.g., service, resource, widget, etc.
50888       model-name:
50889         type: string
50890         description: Name of the model, which can change from version to version.
50891       model-id:
50892         type: string
50893         description: Invariant unique ID which does not change from version to version
50894       model-version:
50895         type: string
50896         description: Version
50897       model-description:
50898         type: string
50899         description: Description
50900   owning-entities:
50901     description: |
50902       Collection of owning-entities
50903     properties:
50904       owning-entity:
50905         type: array
50906         items:
50907           $ref: "#/patchDefinitions/owning-entity"
50908   owning-entity:
50909     description: |
50910       describes an owning-entity
50911       ###### Related Nodes
50912       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
50913     required:
50914     - owning-entity-id
50915     - owning-entity-name
50916     properties:
50917       owning-entity-id:
50918         type: string
50919         description: UUID of an owning entity
50920       owning-entity-name:
50921         type: string
50922         description: Owning entity name
50923   p-interface:
50924     description: |
50925       Physical interface (e.g., nic)
50926       ###### Related Nodes
50927       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50928       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50929       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50930       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50931       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50932       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50933       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50934       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
50935       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
50936     required:
50937     - interface-name
50938     properties:
50939       interface-name:
50940         type: string
50941         description: Name that identifies the physical interface
50942       speed-value:
50943         type: string
50944         description: Captures the numeric part of the speed
50945       speed-units:
50946         type: string
50947         description: Captures the units corresponding to the speed
50948       port-description:
50949         type: string
50950         description: Nature of the services and connectivity on this port.
50951       equipment-identifier:
50952         type: string
50953         description: CLEI or other specification for p-interface hardware.
50954       interface-role:
50955         type: string
50956         description: Role specification for p-interface hardware.
50957       interface-type:
50958         type: string
50959         description: Indicates the physical properties of the interface.
50960   p-interfaces:
50961     description: |
50962       Collection of physical interfaces.
50963     properties:
50964       p-interface:
50965         type: array
50966         items:
50967           $ref: "#/patchDefinitions/p-interface"
50968   physical-link:
50969     description: |
50970       Collection of physical connections, typically between p-interfaces
50971       ###### Related Nodes
50972       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
50973     required:
50974     - link-name
50975     properties:
50976       link-name:
50977         type: string
50978         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50979       speed-value:
50980         type: string
50981         description: Captures the numeric part of the speed
50982       speed-units:
50983         type: string
50984         description: Captures the units corresponding to the speed
50985       circuit-id:
50986         type: string
50987         description: Circuit it
50988       dual-mode:
50989         type: string
50990         description: Dual access mode (e.g., primary, secondary
50991       management-option:
50992         type: string
50993         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
50994       service-provider-name:
50995         type: string
50996         description: Name of the service Provider on this link.
50997   physical-links:
50998     description: |
50999       Collection of physical connections, typically between p-interfaces
51000     properties:
51001       physical-link:
51002         type: array
51003         items:
51004           $ref: "#/patchDefinitions/physical-link"
51005   platform:
51006     description: |
51007       describes a platform
51008       ###### Related Nodes
51009       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
51010     required:
51011     - platform-name
51012     properties:
51013       platform-name:
51014         type: string
51015         description: Name of the platform
51016   platforms:
51017     description: |
51018       Collection of platforms
51019     properties:
51020       platform:
51021         type: array
51022         items:
51023           $ref: "#/patchDefinitions/platform"
51024   pnf:
51025     description: |
51026       PNF represents a physical network function. typically equipment used in the D1 world.
51027       ###### Related Nodes
51028       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51029       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
51030       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51031       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51032       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51033     required:
51034     - pnf-name
51035     - in-maint
51036     properties:
51037       pnf-name:
51038         type: string
51039         description: unique name of Physical Network Function.
51040       pnf-name2:
51041         type: string
51042         description: name of Physical Network Function.
51043       pnf-name2-source:
51044         type: string
51045         description: source of name2
51046       pnf-id:
51047         type: string
51048         description: id of pnf
51049       equip-type:
51050         type: string
51051         description: Equipment type.  Source of truth should define valid values.
51052       equip-vendor:
51053         type: string
51054         description: Equipment vendor.  Source of truth should define valid values.
51055       equip-model:
51056         type: string
51057         description: Equipment model.  Source of truth should define valid values.
51058       management-option:
51059         type: string
51060         description: identifier of managed by company or customer
51061       ipaddress-v4-oam:
51062         type: string
51063         description: ipv4-oam-address with new naming convention for IP addresses
51064       sw-version:
51065         type: string
51066         description: sw-version is the version of SW for the hosted application on the PNF.
51067       orchestration-status:
51068         type: string
51069         description: orchestration-status is the status of orchestration on the PNF.
51070       in-maint:
51071         type: boolean
51072       frame-id:
51073         type: string
51074         description: ID of the physical frame (relay rack) where pnf is installed.
51075   pnfs:
51076     description: |
51077       Collection of Physical Network Functions.
51078     properties:
51079       pnf:
51080         type: array
51081         items:
51082           $ref: "#/patchDefinitions/pnf"
51083   port-group:
51084     description: |
51085       Used to capture the network interfaces of this VCE
51086       ###### Related Nodes
51087       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51088       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
51089       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
51090     required:
51091     - interface-id
51092     - orchestration-status
51093     properties:
51094       interface-id:
51095         type: string
51096         description: Unique ID of the interface
51097       neutron-network-id:
51098         type: string
51099         description: Neutron network id of this Interface
51100       neutron-network-name:
51101         type: string
51102         description: Neutron network name of this Interface
51103       interface-role:
51104         type: string
51105         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51106   port-groups:
51107     properties:
51108       port-group:
51109         type: array
51110         items:
51111           $ref: "#/patchDefinitions/port-group"
51112   project:
51113     description: |
51114       describes the project
51115       ###### Related Nodes
51116       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
51117     required:
51118     - project-name
51119     properties:
51120       project-name:
51121         type: string
51122         description: Name of the project deploying a service
51123   projects:
51124     description: |
51125       Collection of projects
51126     properties:
51127       project:
51128         type: array
51129         items:
51130           $ref: "#/patchDefinitions/project"
51131   properties:
51132     description: |
51133       Property holder for query properties or instance properties
51134     properties:
51135       property-name:
51136         type: string
51137       property-value:
51138         type: string
51139   property-constraint:
51140     description: |
51141       TBD
51142       ###### Related Nodes
51143       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51144     required:
51145     - property-constraint-uuid
51146     - constraint-type
51147     - property-name
51148     - property-value
51149     properties:
51150       property-constraint-uuid:
51151         type: string
51152       constraint-type:
51153         type: string
51154       property-name:
51155         type: string
51156       property-value:
51157         type: string
51158   property-constraints:
51159     properties:
51160       property-constraint:
51161         type: array
51162         items:
51163           $ref: "#/patchDefinitions/property-constraint"
51164   pserver:
51165     description: |
51166       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51167       ###### Related Nodes
51168       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
51169       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
51170       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
51171       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51172       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
51173       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
51174       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51175       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51176       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
51177       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
51178       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51179       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
51180     required:
51181     - hostname
51182     - in-maint
51183     properties:
51184       hostname:
51185         type: string
51186         description: Value from executing hostname on the compute node.
51187       ptnii-equip-name:
51188         type: string
51189         description: PTNII name
51190       number-of-cpus:
51191         type: integer
51192         format: int32
51193         description: Number of cpus
51194       disk-in-gigabytes:
51195         type: integer
51196         format: int32
51197         description: Disk size, in GBs
51198       ram-in-megabytes:
51199         type: integer
51200         format: int32
51201         description: RAM size, in MBs
51202       equip-type:
51203         type: string
51204         description: Equipment type.  Source of truth should define valid values.
51205       equip-vendor:
51206         type: string
51207         description: Equipment vendor.  Source of truth should define valid values.
51208       equip-model:
51209         type: string
51210         description: Equipment model.  Source of truth should define valid values.
51211       fqdn:
51212         type: string
51213         description: Fully-qualified domain name
51214       pserver-selflink:
51215         type: string
51216         description: URL to endpoint where AAI can get more details
51217       ipv4-oam-address:
51218         type: string
51219         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51220       serial-number:
51221         type: string
51222         description: Serial number, may be queried
51223       pserver-id:
51224         type: string
51225         description: ID of Pserver
51226       internet-topology:
51227         type: string
51228         description: internet topology of Pserver
51229       in-maint:
51230         type: boolean
51231   pservers:
51232     description: |
51233       Collection of compute hosts.
51234     properties:
51235       pserver:
51236         type: array
51237         items:
51238           $ref: "#/patchDefinitions/pserver"
51239   query-parameters:
51240     description: |
51241       QueryParameters for performing a named-query or model query
51242     properties:
51243       named-query:
51244         type: object
51245         $ref: "#/patchDefinitions/named-query"
51246       model:
51247         type: object
51248         $ref: "#/patchDefinitions/model"
51249   related-lookup:
51250     description: |
51251       TBD
51252       ###### Related Nodes
51253       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51254     required:
51255     - related-lookup-uuid
51256     - source-node-type
51257     - source-node-property
51258     - target-node-type
51259     - target-node-property
51260     properties:
51261       related-lookup-uuid:
51262         type: string
51263       source-node-type:
51264         type: string
51265       source-node-property:
51266         type: string
51267       target-node-type:
51268         type: string
51269       target-node-property:
51270         type: string
51271       property-collect-list:
51272         type: string
51273   related-lookups:
51274     properties:
51275       related-lookup:
51276         type: array
51277         items:
51278           $ref: "#/patchDefinitions/related-lookup"
51279   related-to-property:
51280     properties:
51281       property-key:
51282         type: string
51283         description: Key part of a key/value pair
51284       property-value:
51285         type: string
51286         description: Value part of a key/value pair
51287   relationship:
51288     properties:
51289       related-to:
51290         type: string
51291         description: A keyword provided by A&AI to indicate type of node.
51292       related-link:
51293         type: string
51294         description: URL to the object in A&AI.
51295       relationship-data:
51296         type: array
51297         items:
51298           $ref: "#/patchDefinitions/relationship-data"
51299       related-to-property:
51300         type: array
51301         items:
51302           $ref: "#/patchDefinitions/related-to-property"
51303   relationship-data:
51304     required:
51305     - relationship-key
51306     - relationship-value
51307     properties:
51308       relationship-key:
51309         type: string
51310         description: A keyword provided by A&AI to indicate an attribute.
51311       relationship-value:
51312         type: string
51313         description: Value of the attribute.
51314   reserved-prop-names:
51315     description: |
51316       Internal map to define some reserved properties of a vertex
51317     properties:
51318       last-mod-source-of-truth:
51319         type: string
51320       aai-node-type:
51321         type: string
51322       aai-created-ts:
51323         type: integer
51324         format: int64
51325       aai-unique-key:
51326         type: string
51327       aai-last-mod-ts:
51328         type: integer
51329         format: int64
51330       source-of-truth:
51331         type: string
51332   response-list:
51333     description: |
51334       Response container for the results of a named-query or model query
51335     properties:
51336       inventory-response-items:
51337         type: object
51338         $ref: "#/patchDefinitions/inventory-response-items"
51339   result-data:
51340     properties:
51341       resource-type:
51342         type: string
51343         description: The specific type of node in the A&AI graph
51344       resource-link:
51345         type: string
51346         description: The URL to the specific resource
51347   route-table-reference:
51348     description: |
51349       Openstack route table reference.
51350       ###### Related Nodes
51351       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
51352     required:
51353     - route-table-reference-id
51354     - route-table-reference-fqdn
51355     properties:
51356       route-table-reference-id:
51357         type: string
51358         description: Route Table Reference id, UUID assigned to this instance.
51359       route-table-reference-fqdn:
51360         type: string
51361         description: FQDN entry in the route table.
51362   route-table-references:
51363     description: |
51364       Collection of openstack route table references
51365     properties:
51366       route-table-reference:
51367         type: array
51368         items:
51369           $ref: "#/patchDefinitions/route-table-reference"
51370   route-target:
51371     description: |
51372       Route target information
51373       ###### Related Nodes
51374       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
51375     required:
51376     - global-route-target
51377     - route-target-role
51378     properties:
51379       global-route-target:
51380         type: string
51381         description: Number used to identify an RT, globally unique in the network
51382       route-target-role:
51383         type: string
51384         description: Role assigned to this route target
51385   route-targets:
51386     description: |
51387       Collection of route target information
51388     properties:
51389       route-target:
51390         type: array
51391         items:
51392           $ref: "#/patchDefinitions/route-target"
51393   routing-instance:
51394     description: |
51395       ###### Related Nodes
51396       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51397       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51398       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
51399     required:
51400     - routing-instance-id
51401     properties:
51402       routing-instance-id:
51403         type: string
51404         description: Unique id of routing instance
51405       rpm-owner:
51406         type: string
51407         description: rpm owner
51408   routing-instances:
51409     description: |
51410       set of probes related to generic-vnf routing instance
51411     properties:
51412       routing-instance:
51413         type: array
51414         items:
51415           $ref: "#/patchDefinitions/routing-instance"
51416   sdn-zone-response:
51417     properties:
51418       oam-networks:
51419         type: object
51420         $ref: "#/patchDefinitions/oam-networks"
51421       az-and-dvs-switches:
51422         type: array
51423         items:
51424           $ref: "#/patchDefinitions/az-and-dvs-switches"
51425   search:
51426     properties:
51427       edge-tag-query-result:
51428         type: object
51429         $ref: "#/patchDefinitions/edge-tag-query-result"
51430       edge-tag-query-request:
51431         type: object
51432         $ref: "#/patchDefinitions/edge-tag-query-request"
51433       search-results:
51434         type: object
51435         $ref: "#/patchDefinitions/search-results"
51436       sdn-zone-response:
51437         type: object
51438         $ref: "#/patchDefinitions/sdn-zone-response"
51439   search-results:
51440     properties:
51441       result-data:
51442         type: array
51443         items:
51444           $ref: "#/patchDefinitions/result-data"
51445   secondary-filt:
51446     description: |
51447       SecondaryFilt for performing a named-query or model query
51448   secondary-filter:
51449     properties:
51450       property-name:
51451         type: string
51452       filter-type:
51453         type: string
51454       property-value:
51455         type: string
51456   secondary-filts:
51457     description: |
51458       SecondaryFilts for performing a named-query or model query
51459     properties:
51460       secondary-filt:
51461         type: array
51462         items:
51463           $ref: "#/patchDefinitions/secondary-filt"
51464   segmentation-assignment:
51465     description: |
51466       Openstack segmentation assignment.
51467       ###### Related Nodes
51468       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51469     required:
51470     - segmentation-id
51471     properties:
51472       segmentation-id:
51473         type: string
51474         description: Route Table Reference id, UUID assigned to this instance.
51475   segmentation-assignments:
51476     description: |
51477       Collection of openstack segmentation assignments
51478     properties:
51479       segmentation-assignment:
51480         type: array
51481         items:
51482           $ref: "#/patchDefinitions/segmentation-assignment"
51483   service:
51484     description: |
51485       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.
51486     required:
51487     - service-id
51488     - service-description
51489     properties:
51490       service-id:
51491         type: string
51492         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51493       service-description:
51494         type: string
51495         description: Description of the service
51496       service-selflink:
51497         type: string
51498         description: URL to endpoint where AAI can get more details
51499   service-capabilities:
51500     description: |
51501       Collection of service capabilities.
51502     properties:
51503       service-capability:
51504         type: array
51505         items:
51506           $ref: "#/patchDefinitions/service-capability"
51507   service-capability:
51508     description: |
51509       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
51510       ###### Related Nodes
51511       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51512       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51513       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
51514     required:
51515     - service-type
51516     - vnf-type
51517     properties:
51518       service-type:
51519         type: string
51520         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
51521       vnf-type:
51522         type: string
51523         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
51524   service-design-and-creation:
51525     description: |
51526       Namespace for objects managed by ASDC
51527     properties:
51528       vnf-images:
51529         type: array
51530         items:
51531           $ref: "#/patchDefinitions/vnf-image"
51532       services:
51533         type: array
51534         items:
51535           $ref: "#/patchDefinitions/service"
51536       service-capabilities:
51537         type: array
51538         items:
51539           $ref: "#/patchDefinitions/service-capability"
51540       models:
51541         type: array
51542         items:
51543           $ref: "#/patchDefinitions/model"
51544       named-queries:
51545         type: array
51546         items:
51547           $ref: "#/patchDefinitions/named-query"
51548   service-instance:
51549     description: |
51550       Instance of a service
51551       ###### Related Nodes
51552       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
51553       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
51554       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
51555       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
51556       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
51557       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51558       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
51559       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51560       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51561       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
51562       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
51563       - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM
51564       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
51565     required:
51566     - service-instance-id
51567     properties:
51568       service-instance-id:
51569         type: string
51570         description: Uniquely identifies this instance of a service
51571       service-instance-name:
51572         type: string
51573         description: This field will store a name assigned to the service-instance.
51574       persona-model-id:
51575         type: string
51576         description: the ASDC model id for this resource or service model.
51577       persona-model-version:
51578         type: string
51579         description: the ASDC model version for this resource or service model.
51580       model-version-id:
51581         type: string
51582         description: the ASDC model version for this resource or service model.
51583       widget-model-id:
51584         type: string
51585         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
51586       widget-model-version:
51587         type: string
51588         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
51589       bandwidth-total:
51590         type: string
51591         description: Indicates the total bandwidth to be used for this service.
51592       bandwidth-up-wan1:
51593         type: string
51594         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
51595       bandwidth-down-wan1:
51596         type: string
51597         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
51598       bandwidth-up-wan2:
51599         type: string
51600         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
51601       bandwidth-down-wan2:
51602         type: string
51603         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
51604       vhn-portal-url:
51605         type: string
51606         description: URL customers will use to access the vHN Portal.
51607       service-instance-location-id:
51608         type: string
51609         description: An identifier that customers assign to the location where this service is being used.
51610   service-instances:
51611     description: |
51612       Collection of service instances
51613     properties:
51614       service-instance:
51615         type: array
51616         items:
51617           $ref: "#/patchDefinitions/service-instance"
51618   service-subscription:
51619     description: |
51620       Object that group service instances.
51621       ###### Related Nodes
51622       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
51623       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51624       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
51625       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
51626     required:
51627     - service-type
51628     properties:
51629       service-type:
51630         type: string
51631         description: Value defined by orchestration to identify this service across ECOMP.
51632       temp-ub-sub-account-id:
51633         type: string
51634         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
51635   service-subscriptions:
51636     description: |
51637       Collection of objects that group service instances.
51638     properties:
51639       service-subscription:
51640         type: array
51641         items:
51642           $ref: "#/patchDefinitions/service-subscription"
51643   services:
51644     description: |
51645       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
51646     properties:
51647       service:
51648         type: array
51649         items:
51650           $ref: "#/patchDefinitions/service"
51651   site-pair:
51652     description: |
51653       ###### Related Nodes
51654       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
51655       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
51656       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
51657     required:
51658     - site-pair-id
51659     properties:
51660       site-pair-id:
51661         type: string
51662         description: unique identifier of probe
51663       source-ip:
51664         type: string
51665         description: Prefix address
51666       destination-ip:
51667         type: string
51668         description: Prefix address
51669       ip-version:
51670         type: string
51671         description: ip version, v4, v6
51672       destination-hostname:
51673         type: string
51674         description: Hostname of the destination equipment to which SLAs are measured against.
51675       destination-equip-type:
51676         type: string
51677         description: The type of destinatination equipment. Could be Router, etc.
51678   site-pair-set:
51679     description: |
51680       Set of instances for probes used to measure service level agreements
51681       ###### Related Nodes
51682       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
51683       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
51684       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
51685     required:
51686     - site-pair-set-id
51687     properties:
51688       site-pair-set-id:
51689         type: string
51690         description: Unique id of site pair set.
51691   site-pair-sets:
51692     description: |
51693       Collection of sets of instances for probes related to generic-vnf
51694     properties:
51695       site-pair-set:
51696         type: array
51697         items:
51698           $ref: "#/patchDefinitions/site-pair-set"
51699   site-pairs:
51700     description: |
51701       probe within a set
51702     properties:
51703       site-pair:
51704         type: array
51705         items:
51706           $ref: "#/patchDefinitions/site-pair"
51707   snapshot:
51708     description: |
51709       Openstack snapshot
51710       ###### Related Nodes
51711       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51712       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
51713     required:
51714     - snapshot-id
51715     properties:
51716       snapshot-id:
51717         type: string
51718         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
51719       snapshot-name:
51720         type: string
51721         description: Snapshot name
51722       snapshot-architecture:
51723         type: string
51724         description: Operating system architecture
51725       snapshot-os-distro:
51726         type: string
51727         description: The common name of the operating system distribution in lowercase
51728       snapshot-os-version:
51729         type: string
51730         description: The operating system version as specified by the distributor.
51731       application:
51732         type: string
51733         description: The application that the image instantiates.
51734       application-vendor:
51735         type: string
51736         description: The vendor of the application.
51737       application-version:
51738         type: string
51739         description: The version of the application.
51740       snapshot-selflink:
51741         type: string
51742         description: URL to endpoint where AAI can get more details
51743       prev-snapshot-id:
51744         type: string
51745         description: This field contains the UUID of the previous snapshot (if any).
51746   snapshots:
51747     description: |
51748       Collection of openstack snapshots
51749     properties:
51750       snapshot:
51751         type: array
51752         items:
51753           $ref: "#/patchDefinitions/snapshot"
51754   sriov-pf:
51755     description: |
51756       SR-IOV Physical Function
51757       ###### Related Nodes
51758       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
51759       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
51760     required:
51761     - pf-pci-id
51762     properties:
51763       pf-pci-id:
51764         type: string
51765         description: Identifier for the sriov-pf
51766   sriov-pfs:
51767     description: |
51768       Collection of SR-IOV Physical Functions.
51769     properties:
51770       sriov-pf:
51771         type: array
51772         items:
51773           $ref: "#/patchDefinitions/sriov-pf"
51774   sriov-vf:
51775     description: |
51776       SR-IOV Virtual Function (not to be confused with virtual network function)
51777       ###### Related Nodes
51778       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
51779     required:
51780     - pci-id
51781     properties:
51782       pci-id:
51783         type: string
51784         description: PCI ID used to identify the sriov-vf
51785       vf-vlan-filter:
51786         type: string
51787         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
51788       vf-mac-filter:
51789         type: string
51790         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
51791       vf-vlan-strip:
51792         type: boolean
51793         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
51794       vf-vlan-anti-spoof-check:
51795         type: boolean
51796         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.
51797       vf-mac-anti-spoof-check:
51798         type: boolean
51799         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.
51800       vf-mirrors:
51801         type: string
51802         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
51803       vf-broadcast-allow:
51804         type: boolean
51805         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
51806       vf-unknown-multicast-allow:
51807         type: boolean
51808         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
51809       vf-unknown-unicast-allow:
51810         type: boolean
51811         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
51812       vf-insert-stag:
51813         type: boolean
51814         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
51815       vf-link-status:
51816         type: string
51817         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
51818   sriov-vfs:
51819     description: |
51820       Collection of SR-IOV Virtual Functions.
51821     properties:
51822       sriov-vf:
51823         type: array
51824         items:
51825           $ref: "#/patchDefinitions/sriov-vf"
51826   start-node-filter:
51827     properties:
51828       property-name:
51829         type: string
51830       property-value:
51831         type: string
51832   subnet:
51833     description: |
51834       ###### Related Nodes
51835       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
51836       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51837       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
51838       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
51839     required:
51840     - subnet-id
51841     - dhcp-enabled
51842     properties:
51843       subnet-id:
51844         type: string
51845         description: Subnet ID, should be UUID.
51846       subnet-name:
51847         type: string
51848         description: Name associated with the subnet.
51849       neutron-subnet-id:
51850         type: string
51851         description: Neutron id of this subnet
51852       gateway-address:
51853         type: string
51854         description: gateway ip address
51855       network-start-address:
51856         type: string
51857         description: network start address
51858       cidr-mask:
51859         type: string
51860         description: cidr mask
51861       ip-version:
51862         type: string
51863         description: ip version
51864       orchestration-status:
51865         type: string
51866         description: Orchestration status of this VNF, mastered by MSO
51867       dhcp-enabled:
51868         type: boolean
51869       dhcp-start:
51870         type: string
51871         description: the start address reserved for use by dhcp
51872       dhcp-end:
51873         type: string
51874         description: the last address reserved for use by dhcp
51875   subnets:
51876     properties:
51877       subnet:
51878         type: array
51879         items:
51880           $ref: "#/patchDefinitions/subnet"
51881   tagged-inventory-item-list:
51882     properties:
51883       inventory-item:
51884         type: array
51885         items:
51886           $ref: "#/patchDefinitions/inventory-item"
51887   tenant:
51888     description: |
51889       Openstack tenant
51890       ###### Related Nodes
51891       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51892       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
51893       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
51894       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
51895       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
51896       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
51897       - TENANT cannot be deleted if linked to VSERVER
51898     required:
51899     - tenant-id
51900     - tenant-name
51901     properties:
51902       tenant-id:
51903         type: string
51904         description: Unique id relative to the cloud-region.
51905       tenant-name:
51906         type: string
51907         description: Readable name of tenant
51908   tenants:
51909     description: |
51910       Collection of openstack tenants.
51911     properties:
51912       tenant:
51913         type: array
51914         items:
51915           $ref: "#/patchDefinitions/tenant"
51916   tunnel-xconnect:
51917     description: |
51918       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
51919       ###### Related Nodes
51920       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
51921     required:
51922     - id
51923     - bandwidth-up-wan1
51924     - bandwidth-down-wan1
51925     - bandwidth-up-wan2
51926     - bandwidth-down-wan2
51927     properties:
51928       id:
51929         type: string
51930         description: Allotted Resource id UUID assigned to this instance.
51931       bandwidth-up-wan1:
51932         type: string
51933         description: The WAN uplink bandwidth for WAN1
51934       bandwidth-down-wan1:
51935         type: string
51936         description: The WAN downlink bandwidth for WAN1
51937       bandwidth-up-wan2:
51938         type: string
51939         description: The WAN uplink bandwidth for WAN2
51940       bandwidth-down-wan2:
51941         type: string
51942         description: The WAN downlink bandwidth for WAN2
51943   tunnel-xconnects:
51944     description: |
51945       This object is used to store the specific tunnel cross connect aspects of an allotted resource
51946     properties:
51947       tunnel-xconnect:
51948         type: array
51949         items:
51950           $ref: "#/patchDefinitions/tunnel-xconnect"
51951   update:
51952     description: |
51953       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
51954     required:
51955     - update-node-type
51956     properties:
51957       update-node-type:
51958         type: string
51959       update-node-key:
51960         type: array
51961         items:
51962           $ref: "#/patchDefinitions/update-node-key"
51963       update-node-uri:
51964         type: string
51965       action:
51966         type: array
51967         items:
51968           $ref: "#/patchDefinitions/action"
51969   update-node-key:
51970     properties:
51971       key-name:
51972         type: string
51973       key-value:
51974         type: string
51975   vce:
51976     description: |
51977       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
51978       ###### Related Nodes
51979       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
51980       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
51981       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
51982       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51983       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
51984       - VCE is DELETED when these are DELETED PORT-GROUP
51985     required:
51986     - vnf-id
51987     - vnf-name
51988     - vnf-type
51989     properties:
51990       vnf-id:
51991         type: string
51992         description: Unique id of VNF.  This is unique across the graph.
51993       vnf-name:
51994         type: string
51995         description: Name of VNF.
51996       vnf-name2:
51997         type: string
51998         description: Alternate name of VNF.
51999       vnf-type:
52000         type: string
52001         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
52002       service-id:
52003         type: string
52004         description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
52005       regional-resource-zone:
52006         type: string
52007         description: Regional way of organizing pservers, source of truth should define values
52008       prov-status:
52009         type: string
52010         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52011       operational-state:
52012         type: string
52013         description: Indicator for whether the resource is considered operational
52014       license-key:
52015         type: string
52016         description: License key
52017       equipment-role:
52018         type: string
52019         description: Network role being played by this VNF
52020       orchestration-status:
52021         type: string
52022         description: Orchestration status of this VNF, mastered by MSO
52023       heat-stack-id:
52024         type: string
52025         description: Heat stack id corresponding to this instance, managed by MSO
52026       mso-catalog-key:
52027         type: string
52028         description: Corresponds to the SDN-C catalog id used to configure this VCE
52029       vpe-id:
52030         type: string
52031         description: Unique ID of VPE connected to this VCE.
52032       v6-vce-wan-address:
52033         type: string
52034         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
52035       ipv4-oam-address:
52036         type: string
52037         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
52038   vces:
52039     description: |
52040       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
52041     properties:
52042       vce:
52043         type: array
52044         items:
52045           $ref: "#/patchDefinitions/vce"
52046   vf-module:
52047     description: |
52048       a deployment unit of VNFCs
52049       ###### Related Nodes
52050       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52051       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
52052       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52053       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52054       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52055       - VF-MODULE cannot be deleted if linked to VNFC
52056     required:
52057     - vf-module-id
52058     - is-base-vf-module
52059     properties:
52060       vf-module-id:
52061         type: string
52062         description: Unique ID of vf-module.
52063       vf-module-name:
52064         type: string
52065         description: Name of vf-module
52066       heat-stack-id:
52067         type: string
52068         description: Heat stack id corresponding to this instance.
52069       orchestration-status:
52070         type: string
52071         description: orchestration status of this vf-module, mastered by MSO
52072       is-base-vf-module:
52073         type: boolean
52074   vf-modules:
52075     description: |
52076       Collection of vf-modules, a deployment unit of VNFCs
52077     properties:
52078       vf-module:
52079         type: array
52080         items:
52081           $ref: "#/patchDefinitions/vf-module"
52082   vig-server:
52083     description: |
52084       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
52085       ###### Related Nodes
52086       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
52087     required:
52088     - vig-address-type
52089     properties:
52090       vig-address-type:
52091         type: string
52092         description: indicates whether the VIG is for AVPN or INTERNET
52093       ipaddress-v4-vig:
52094         type: string
52095         description: v4 IP of the vig server
52096       ipaddress-v6-vig:
52097         type: string
52098         description: v6 IP of the vig server
52099   vig-servers:
52100     properties:
52101       vig-server:
52102         type: array
52103         items:
52104           $ref: "#/patchDefinitions/vig-server"
52105   vip-ipv4-address-list:
52106     description: |
52107       IPv4 Address Range
52108       ###### Related Nodes
52109       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52110       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52111       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52112       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
52113     required:
52114     - vip-ipv4-address
52115     properties:
52116       vip-ipv4-address:
52117         type: string
52118         description: IP address
52119       vip-ipv4-prefix-length:
52120         type: integer
52121         format: int64
52122         description: Prefix length, 32 for single address
52123       vlan-id-inner:
52124         type: integer
52125         format: int64
52126         description: Inner VLAN tag
52127       vlan-id-outer:
52128         type: integer
52129         format: int64
52130         description: Outer VLAN tag
52131       is-floating:
52132         type: boolean
52133         description: Indicator of fixed or floating address
52134   vip-ipv6-address-list:
52135     description: |
52136       IPv6 Address Range
52137       ###### Related Nodes
52138       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52139       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52140       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
52141       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
52142     required:
52143     - vip-ipv6-address
52144     properties:
52145       vip-ipv6-address:
52146         type: string
52147         description: IP address
52148       vip-ipv6-prefix-length:
52149         type: integer
52150         format: int64
52151         description: Prefix length, 128 for single address
52152       vlan-id-inner:
52153         type: integer
52154         format: int64
52155         description: Inner VLAN tag
52156       vlan-id-outer:
52157         type: integer
52158         format: int64
52159         description: Outer VLAN tag
52160       is-floating:
52161         type: boolean
52162         description: Indicator of fixed or floating address
52163   virtual-data-center:
52164     description: |
52165       Virtual organization of cloud infrastructure elements in a data center context
52166       ###### Related Nodes
52167       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52168       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52169       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52170     required:
52171     - vdc-id
52172     - vdc-name
52173     properties:
52174       vdc-id:
52175         type: string
52176         description: Unique ID of the vdc
52177       vdc-name:
52178         type: string
52179         description: Name of the virtual data center
52180   virtual-data-centers:
52181     description: |
52182       Virtual organization of cloud infrastructure elements in a data center context
52183     properties:
52184       virtual-data-center:
52185         type: array
52186         items:
52187           $ref: "#/patchDefinitions/virtual-data-center"
52188   vlan:
52189     description: |
52190       Definition of vlan
52191       ###### Related Nodes
52192       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
52193       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
52194       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
52195       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
52196       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52197       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
52198       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
52199       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
52200     required:
52201     - vlan-interface
52202     properties:
52203       vlan-interface:
52204         type: string
52205         description: String that identifies the interface
52206       vlan-id-inner:
52207         type: integer
52208         format: int64
52209         description: Inner VLAN tag
52210       vlan-id-outer:
52211         type: integer
52212         format: int64
52213         description: Outer VLAN tag
52214   vlans:
52215     properties:
52216       vlan:
52217         type: array
52218         items:
52219           $ref: "#/patchDefinitions/vlan"
52220   vnf:
52221     description: |
52222       Abstract vnf class
52223     required:
52224     - vnf-id
52225     properties:
52226       vnf-id:
52227         type: string
52228         description: Unique id of VNF.  This is unique across the graph.
52229   vnf-image:
52230     description: |
52231       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52232       ###### Related Nodes
52233       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
52234       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
52235     required:
52236     - vnf-image-uuid
52237     - application
52238     - application-vendor
52239     properties:
52240       vnf-image-uuid:
52241         type: string
52242         description: Unique ID of this asset
52243       application:
52244         type: string
52245         description: The application that the image instantiates.
52246       application-vendor:
52247         type: string
52248         description: The vendor of the application.
52249       application-version:
52250         type: string
52251         description: The version of the application.
52252       selflink:
52253         type: string
52254         description: URL to endpoint where AAI can get more details
52255   vnf-images:
52256     description: |
52257       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
52258     properties:
52259       vnf-image:
52260         type: array
52261         items:
52262           $ref: "#/patchDefinitions/vnf-image"
52263   vnfc:
52264     description: |
52265       ###### Related Nodes
52266       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
52267       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52268       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
52269     required:
52270     - vnfc-name
52271     - vnfc-function-code
52272     - vnfc-type
52273     - in-maint
52274     - is-closed-loop-disabled
52275     properties:
52276       vnfc-name:
52277         type: string
52278         description: Unique ID of vnfc.
52279       vnfc-function-code:
52280         type: string
52281         description: function code
52282       vnfc-type:
52283         type: string
52284         description: type
52285       prov-status:
52286         type: string
52287         description: prov status of this vnfc
52288       orchestration-status:
52289         type: string
52290         description: Orchestration status of this VNF, mastered by APP-C
52291       ipaddress-v4-oam-vip:
52292         type: string
52293         description: Oam V4 vip address of this vnfc
52294       in-maint:
52295         type: boolean
52296       is-closed-loop-disabled:
52297         type: boolean
52298       group-notation:
52299         type: string
52300         description: Group notation of VNFC
52301   vnfcs:
52302     description: |
52303       virtual network components associated with a vserver from application controller.
52304     properties:
52305       vnfc:
52306         type: array
52307         items:
52308           $ref: "#/patchDefinitions/vnfc"
52309   volume:
52310     description: |
52311       Ephemeral Block storage volume.
52312       ###### Related Nodes
52313       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
52314     required:
52315     - volume-id
52316     - volume-selflink
52317     properties:
52318       volume-id:
52319         type: string
52320         description: Unique ID of block storage volume relative to the vserver.
52321       volume-selflink:
52322         type: string
52323         description: URL to endpoint where AAI can get more details
52324   volume-group:
52325     description: |
52326       Persistent block-level storage.
52327       ###### Related Nodes
52328       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52329       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52330       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52331       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
52332       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52333     required:
52334     - volume-group-id
52335     - volume-group-name
52336     - vnf-type
52337     properties:
52338       volume-group-id:
52339         type: string
52340         description: Unique ID of volume-group.
52341       volume-group-name:
52342         type: string
52343         description: Name of the volume group.
52344       heat-stack-id:
52345         type: string
52346         description: Heat stack id corresponding to this volume-group
52347       vnf-type:
52348         type: string
52349         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
52350       orchestration-status:
52351         type: string
52352         description: Orchestration status of this volume-group
52353   volume-groups:
52354     description: |
52355       Collection of persistent block-level storage.
52356     properties:
52357       volume-group:
52358         type: array
52359         items:
52360           $ref: "#/patchDefinitions/volume-group"
52361   volumes:
52362     description: |
52363       Collection of ephemeral Block storage volumes.
52364     properties:
52365       volume:
52366         type: array
52367         items:
52368           $ref: "#/patchDefinitions/volume"
52369   vpls-pe:
52370     description: |
52371       VPLS Provider Edge routers.
52372       ###### Related Nodes
52373       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52374       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
52375       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52376       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
52377       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
52378     required:
52379     - equipment-name
52380     properties:
52381       equipment-name:
52382         type: string
52383       prov-status:
52384         type: string
52385         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
52386       ipv4-oam-address:
52387         type: string
52388         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
52389       equipment-role:
52390         type: string
52391         description: Client should send valid enumerated value, e.g., VPLS-PE.
52392       vlan-id-outer:
52393         type: integer
52394         format: int64
52395         description: Temporary location for stag to get to VCE
52396   vpls-pes:
52397     description: |
52398       Collection of VPLS Provider Edge routers
52399     properties:
52400       vpls-pe:
52401         type: array
52402         items:
52403           $ref: "#/patchDefinitions/vpls-pe"
52404   vpn-binding:
52405     description: |
52406       VPN binding
52407       ###### Related Nodes
52408       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
52409       - VPN-BINDING cannot be deleted if linked to L3-NETWORK
52410     required:
52411     - vpn-id
52412     - vpn-name
52413     - global-route-target
52414     properties:
52415       vpn-id:
52416         type: string
52417         description: VPN ID, globally unique within A&AI
52418       vpn-name:
52419         type: string
52420         description: VPN Name
52421       global-route-target:
52422         type: string
52423         description: Number used to identify a VPN, globally unique in the network
52424       vpn-platform:
52425         type: string
52426         description: the platform associated with the VPN example AVPN, Mobility
52427   vpn-bindings:
52428     properties:
52429       vpn-binding:
52430         type: array
52431         items:
52432           $ref: "#/patchDefinitions/vpn-binding"
52433   vserver:
52434     description: |
52435       Virtual Servers, aka virtual machine or VM.
52436       ###### Related Nodes
52437       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
52438       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
52439       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
52440       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
52441       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
52442       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
52443       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
52444       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
52445       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
52446       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
52447       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
52448       - VSERVER is DELETED when these are DELETED L-INTERFACE
52449       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
52450     required:
52451     - vserver-id
52452     - vserver-name
52453     - vserver-selflink
52454     - in-maint
52455     - is-closed-loop-disabled
52456     properties:
52457       vserver-id:
52458         type: string
52459         description: Unique identifier for this vserver relative to its tenant
52460       vserver-name:
52461         type: string
52462         description: Name of vserver
52463       vserver-name2:
52464         type: string
52465         description: Alternative name of vserver
52466       prov-status:
52467         type: string
52468         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52469       vserver-selflink:
52470         type: string
52471         description: URL to endpoint where AAI can get more details
52472       in-maint:
52473         type: boolean
52474       is-closed-loop-disabled:
52475         type: boolean
52476   vservers:
52477     description: |
52478       Collection of virtual Servers, aka virtual machines or VMs.
52479     properties:
52480       vserver:
52481         type: array
52482         items:
52483           $ref: "#/patchDefinitions/vserver"
52484   zone:
52485     description: |
52486       A zone is a grouping of assets in a location homing to the same connections into the CBB
52487       ###### Related Nodes
52488       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52489       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52490       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52491       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52492     required:
52493     - zone-id
52494     - zone-name
52495     - design-type
52496     - zone-context
52497     properties:
52498       zone-id:
52499         type: string
52500         description: Code assigned by AIC to the zone
52501       zone-name:
52502         type: string
52503         description: English name associated with the zone
52504       design-type:
52505         type: string
52506         description: Design of zone [Medium/Large?]
52507       zone-context:
52508         type: string
52509         description: Context of zone [production/test]
52510       status:
52511         type: string
52512         description: Status of a zone.
52513   zones:
52514     description: |
52515       Collection of zones
52516     properties:
52517       zone:
52518         type: array
52519         items:
52520           $ref: "#/patchDefinitions/zone"
52521 getDefinitions:
52522   aai-internal:
52523     properties:
52524       property-name:
52525         type: string
52526       property-value:
52527         type: string
52528   action:
52529     properties:
52530       action-type:
52531         type: string
52532       action-data:
52533         type: array
52534         items:
52535           $ref: "#/getDefinitions/action-data"
52536   action-data:
52537     properties:
52538       property-name:
52539         type: string
52540       property-value:
52541         type: string
52542   actions:
52543     description: |
52544       APIs that are more action related than REST (e.g., notify, update).
52545     properties:
52546       update:
52547         type: object
52548         $ref: "#/getDefinitions/update"
52549       notify:
52550         type: object
52551         $ref: "#/getDefinitions/notify"
52552   allotted-resource:
52553     description: |
52554       Represents a slice or partial piece of a resource that gets separately allotted
52555       ###### Related Nodes
52556       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
52557       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52558       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
52559       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52560       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52561       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52562       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52563       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
52564     required:
52565     - id
52566     properties:
52567       id:
52568         type: string
52569         description: Allotted Resource id UUID assigned to this instance.
52570       description:
52571         type: string
52572         description: The descriptive information assigned to this allotted resource instance
52573       selflink:
52574         type: string
52575         description: Link back to more information in the controller
52576       persona-model-id:
52577         type: string
52578         description: the ASDC model id for this resource or service model.
52579       persona-model-version:
52580         type: string
52581         description: the ASDC model version for this resource or service model.
52582       model-version-id:
52583         type: string
52584         description: the ASDC model version for this resource or service model.
52585       persona-model-customization-id:
52586         type: string
52587         description: captures the id of all the configuration used to customize the resource for the service.
52588       resource-version:
52589         type: string
52590         description: Concurrency value
52591       tunnel-xconnects:
52592         type: array
52593         items:
52594           $ref: "#/getDefinitions/tunnel-xconnect"
52595       relationship-list:
52596         type: array
52597         items:
52598           $ref: "#/getDefinitions/relationship"
52599   allotted-resources:
52600     description: |
52601       This object is used to store slices of services being offered
52602     properties:
52603       allotted-resource:
52604         type: array
52605         items:
52606           $ref: "#/getDefinitions/allotted-resource"
52607   availability-zone:
52608     description: |
52609       Availability zone, a collection of compute hosts/pservers
52610       ###### Related Nodes
52611       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52612       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52613       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52614       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52615       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52616       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52617       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
52618       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52619       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52620     required:
52621     - availability-zone-name
52622     - hypervisor-type
52623     properties:
52624       availability-zone-name:
52625         type: string
52626         description: Name of the availability zone.  Unique across a cloud region
52627       hypervisor-type:
52628         type: string
52629         description: Type of hypervisor.  Source of truth should define valid values.
52630       operational-state:
52631         type: string
52632         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
52633       resource-version:
52634         type: string
52635         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52636       relationship-list:
52637         type: array
52638         items:
52639           $ref: "#/getDefinitions/relationship"
52640   availability-zones:
52641     description: |
52642       Collection of availability zones
52643     properties:
52644       availability-zone:
52645         type: array
52646         items:
52647           $ref: "#/getDefinitions/availability-zone"
52648   az-and-dvs-switches:
52649     properties:
52650       dvs-switches:
52651         type: object
52652         $ref: "#/getDefinitions/dvs-switches"
52653       availability-zone:
52654         type: object
52655         $ref: "#/getDefinitions/availability-zone"
52656   business:
52657     description: |
52658       Namespace for business related constructs
52659     properties:
52660       connectors:
52661         type: array
52662         items:
52663           $ref: "#/getDefinitions/connector"
52664       customers:
52665         type: array
52666         items:
52667           $ref: "#/getDefinitions/customer"
52668   class-of-service:
52669     description: |
52670       ###### Related Nodes
52671       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52672     required:
52673     - cos
52674     properties:
52675       cos:
52676         type: string
52677         description: unique identifier of probe
52678       probe-id:
52679         type: string
52680         description: identifier of probe
52681       probe-type:
52682         type: string
52683         description: type of probe
52684       resource-version:
52685         type: string
52686         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52687       relationship-list:
52688         type: array
52689         items:
52690           $ref: "#/getDefinitions/relationship"
52691   classes-of-service:
52692     description: |
52693       class-of-service of probe
52694     properties:
52695       class-of-service:
52696         type: array
52697         items:
52698           $ref: "#/getDefinitions/class-of-service"
52699   cloud-infrastructure:
52700     description: |
52701       Namespace for cloud infrastructure.
52702     properties:
52703       complexes:
52704         type: array
52705         items:
52706           $ref: "#/getDefinitions/complex"
52707       cloud-regions:
52708         type: array
52709         items:
52710           $ref: "#/getDefinitions/cloud-region"
52711       network-profiles:
52712         type: array
52713         items:
52714           $ref: "#/getDefinitions/network-profile"
52715       pservers:
52716         type: array
52717         items:
52718           $ref: "#/getDefinitions/pserver"
52719       virtual-data-centers:
52720         type: array
52721         items:
52722           $ref: "#/getDefinitions/virtual-data-center"
52723   cloud-region:
52724     description: |
52725       cloud-region designates an installation of a cloud cluster or region or instantiation.
52726       ###### Related Nodes
52727       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52728       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52729       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52730       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52731       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52732       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52733       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52734       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52735       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52736       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52737       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52738       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
52739       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
52740       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
52741     required:
52742     - cloud-owner
52743     - cloud-region-id
52744     properties:
52745       cloud-owner:
52746         type: string
52747         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52748       cloud-region-id:
52749         type: string
52750         description: Identifier used by the vendor for the region. Second part of composite key
52751       cloud-type:
52752         type: string
52753         description: Type of the cloud (e.g., openstack)
52754       owner-defined-type:
52755         type: string
52756         description: Cloud-owner defined type indicator (e.g., DCP, LCP)
52757       cloud-region-version:
52758         type: string
52759         description: Software version employed at the site
52760       identity-url:
52761         type: string
52762         description: URL of the keystone identity service
52763       cloud-zone:
52764         type: string
52765         description: Zone where the cloud is homed
52766       complex-name:
52767         type: string
52768         description: complex name for cloud-region instance
52769       resource-version:
52770         type: string
52771         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52772       volume-groups:
52773         type: array
52774         items:
52775           $ref: "#/getDefinitions/volume-group"
52776       tenants:
52777         type: array
52778         items:
52779           $ref: "#/getDefinitions/tenant"
52780       flavors:
52781         type: array
52782         items:
52783           $ref: "#/getDefinitions/flavor"
52784       group-assignments:
52785         type: array
52786         items:
52787           $ref: "#/getDefinitions/group-assignment"
52788       snapshots:
52789         type: array
52790         items:
52791           $ref: "#/getDefinitions/snapshot"
52792       images:
52793         type: array
52794         items:
52795           $ref: "#/getDefinitions/image"
52796       dvs-switches:
52797         type: array
52798         items:
52799           $ref: "#/getDefinitions/dvs-switch"
52800       oam-networks:
52801         type: array
52802         items:
52803           $ref: "#/getDefinitions/oam-network"
52804       availability-zones:
52805         type: array
52806         items:
52807           $ref: "#/getDefinitions/availability-zone"
52808       relationship-list:
52809         type: array
52810         items:
52811           $ref: "#/getDefinitions/relationship"
52812   cloud-regions:
52813     properties:
52814       cloud-region:
52815         type: array
52816         items:
52817           $ref: "#/getDefinitions/cloud-region"
52818   complex:
52819     description: |
52820       Collection of physical locations that can house cloud-regions.
52821       ###### Related Nodes
52822       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52823       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52824       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52825       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
52826       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
52827       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52828       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52829       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52830       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52831       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52832       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE
52833       - COMPLEX is DELETED when these are DELETED CTAG-POOL
52834     required:
52835     - physical-location-id
52836     - physical-location-type
52837     - street1
52838     - city
52839     - postal-code
52840     - country
52841     - region
52842     properties:
52843       physical-location-id:
52844         type: string
52845         description: Unique identifier for physical location, e.g., CLLI
52846       data-center-code:
52847         type: string
52848         description: Data center code which can be an alternate way to identify a complex
52849       complex-name:
52850         type: string
52851         description: Gamma complex name for LCP instance.
52852       identity-url:
52853         type: string
52854         description: URL of the keystone identity service
52855       resource-version:
52856         type: string
52857         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52858       physical-location-type:
52859         type: string
52860         description: Type, e.g., central office, data center.
52861       street1:
52862         type: string
52863       street2:
52864         type: string
52865       city:
52866         type: string
52867       state:
52868         type: string
52869       postal-code:
52870         type: string
52871       country:
52872         type: string
52873       region:
52874         type: string
52875       latitude:
52876         type: string
52877       longitude:
52878         type: string
52879       elevation:
52880         type: string
52881       lata:
52882         type: string
52883       ctag-pools:
52884         type: array
52885         items:
52886           $ref: "#/getDefinitions/ctag-pool"
52887       relationship-list:
52888         type: array
52889         items:
52890           $ref: "#/getDefinitions/relationship"
52891   complexes:
52892     description: |
52893       Collection of physical locations that can house cloud-regions.
52894     properties:
52895       complex:
52896         type: array
52897         items:
52898           $ref: "#/getDefinitions/complex"
52899   configuration:
52900     description: |
52901       Port Mirror Configuration.
52902       ###### Related Nodes
52903       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
52904       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
52905       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
52906       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52907       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52908       - CONFIGURATION is DELETED when these are DELETED METADATUM
52909       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
52910     required:
52911     - configuration-id
52912     - configuration-type
52913     - configuration-sub-type
52914     - orchestration-status
52915     - operational-status
52916     - configuration-selflink
52917     - model-customization-id
52918     properties:
52919       configuration-id:
52920         type: string
52921         description: UUID assigned to configuration.
52922       management-option:
52923         type: string
52924         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
52925       configuration-name:
52926         type: string
52927         description: Name of the configuration.
52928       configuration-type:
52929         type: string
52930         description: port-mirroring-configuration.
52931       configuration-sub-type:
52932         type: string
52933         description: vprobe, pprobe.
52934       model-invariant-id:
52935         type: string
52936         description: the ASDC model id for this resource or service model.
52937       model-version-id:
52938         type: string
52939         description: the ASDC model version for this resource or service model.
52940       orchestration-status:
52941         type: string
52942         description: Orchestration status of the configuration.
52943       operational-status:
52944         type: string
52945         description: Indicator for whether the resource is considered operational.
52946       configuration-selflink:
52947         type: string
52948         description: URL to endpoint where AAI can get more details from SDN-GC.
52949       model-customization-id:
52950         type: string
52951         description: id of  the configuration used to customize the resource
52952       resource-version:
52953         type: string
52954         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52955       relationship-list:
52956         type: array
52957         items:
52958           $ref: "#/getDefinitions/relationship"
52959       metadata:
52960         type: array
52961         items:
52962           $ref: "#/getDefinitions/metadatum"
52963   configurations:
52964     description: |
52965       Collection of configurations
52966     properties:
52967       configuration:
52968         type: array
52969         items:
52970           $ref: "#/getDefinitions/configuration"
52971   connector:
52972     description: |
52973       Collection of resource instances used to connect a variety of disparate inventory widgets
52974       ###### Related Nodes
52975       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52976       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
52977       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
52978       - CONNECTOR is DELETED when these are DELETED METADATUM
52979     required:
52980     - resource-instance-id
52981     properties:
52982       resource-instance-id:
52983         type: string
52984         description: Unique id of resource instance.
52985       resource-version:
52986         type: string
52987         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52988       persona-model-id:
52989         type: string
52990         description: the ASDC model id for this resource or service model.
52991       persona-model-version:
52992         type: string
52993         description: the ASDC model version for this resource or service model.
52994       model-version-id:
52995         type: string
52996         description: the ASDC model version for this resource or service model.
52997       widget-model-id:
52998         type: string
52999         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53000       widget-model-version:
53001         type: string
53002         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53003       relationship-list:
53004         type: array
53005         items:
53006           $ref: "#/getDefinitions/relationship"
53007       metadata:
53008         type: array
53009         items:
53010           $ref: "#/getDefinitions/metadatum"
53011   connectors:
53012     description: |
53013       Collection of resource instances used to connect a variety of disparate inventory widgets
53014     properties:
53015       connector:
53016         type: array
53017         items:
53018           $ref: "#/getDefinitions/connector"
53019   constrained-element-set:
53020     description: |
53021       This is how we would capture constraints defining allowed sets of elements.
53022       ###### Related Nodes
53023       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
53024       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
53025       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53026       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
53027     required:
53028     - constrained-element-set-uuid
53029     - constraint-type
53030     - check-type
53031     properties:
53032       constrained-element-set-uuid:
53033         type: string
53034       constraint-type:
53035         type: string
53036       check-type:
53037         type: string
53038       resource-version:
53039         type: string
53040       element-choice-sets:
53041         type: array
53042         items:
53043           $ref: "#/getDefinitions/element-choice-set"
53044       relationship-list:
53045         type: array
53046         items:
53047           $ref: "#/getDefinitions/relationship"
53048   constrained-element-sets:
53049     properties:
53050       constrained-element-set:
53051         type: array
53052         items:
53053           $ref: "#/getDefinitions/constrained-element-set"
53054   ctag-assignment:
53055     description: |
53056       ###### Related Nodes
53057       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53058     required:
53059     - vlan-id-inner
53060     properties:
53061       vlan-id-inner:
53062         type: integer
53063         format: int64
53064         description: id.
53065       resource-version:
53066         type: string
53067         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53068       relationship-list:
53069         type: array
53070         items:
53071           $ref: "#/getDefinitions/relationship"
53072   ctag-assignments:
53073     properties:
53074       ctag-assignment:
53075         type: array
53076         items:
53077           $ref: "#/getDefinitions/ctag-assignment"
53078   ctag-pool:
53079     description: |
53080       A collection of C tags (vlan tags) grouped for a specific purpose.
53081       ###### Related Nodes
53082       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53083       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53084       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53085     required:
53086     - target-pe
53087     - availability-zone-name
53088     - ctag-pool-purpose
53089     properties:
53090       target-pe:
53091         type: string
53092         description: The Target provider edge router
53093       availability-zone-name:
53094         type: string
53095         description: Name of the availability zone
53096       ctag-pool-purpose:
53097         type: string
53098         description: Describes what the intended purpose of this pool is.
53099       ctag-values:
53100         type: string
53101         description: Comma separated list of ctags
53102       resource-version:
53103         type: string
53104         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53105       relationship-list:
53106         type: array
53107         items:
53108           $ref: "#/getDefinitions/relationship"
53109   ctag-pools:
53110     properties:
53111       ctag-pool:
53112         type: array
53113         items:
53114           $ref: "#/getDefinitions/ctag-pool"
53115   customer:
53116     description: |
53117       customer identifiers to provide linkage back to BSS information.
53118       ###### Related Nodes
53119       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53120       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53121     required:
53122     - global-customer-id
53123     - subscriber-name
53124     - subscriber-type
53125     properties:
53126       global-customer-id:
53127         type: string
53128         description: Global customer id used across ECOMP to uniquely identify customer.
53129       subscriber-name:
53130         type: string
53131         description: Subscriber name, an alternate way to retrieve a customer.
53132       subscriber-type:
53133         type: string
53134         description: Subscriber type, a way to provide VID with only the INFRA customers.
53135       resource-version:
53136         type: string
53137         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53138       service-subscriptions:
53139         type: array
53140         items:
53141           $ref: "#/getDefinitions/service-subscription"
53142       relationship-list:
53143         type: array
53144         items:
53145           $ref: "#/getDefinitions/relationship"
53146   customers:
53147     description: |
53148       Collection of customer identifiers to provide linkage back to BSS information.
53149     properties:
53150       customer:
53151         type: array
53152         items:
53153           $ref: "#/getDefinitions/customer"
53154   cvlan-tag-entry:
53155     required:
53156     - cvlan-tag
53157     properties:
53158       cvlan-tag:
53159         type: integer
53160         format: int64
53161         description: See mis-na-virtualization-platform.yang
53162       resource-version:
53163         type: string
53164         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53165       relationship-list:
53166         type: array
53167         items:
53168           $ref: "#/getDefinitions/relationship"
53169   cvlan-tags:
53170     properties:
53171       cvlan-tag-entry:
53172         type: array
53173         items:
53174           $ref: "#/getDefinitions/cvlan-tag-entry"
53175   dvs-switch:
53176     description: |
53177       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.
53178       ###### Related Nodes
53179       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53180       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53181     required:
53182     - switch-name
53183     - vcenter-url
53184     properties:
53185       switch-name:
53186         type: string
53187         description: DVS switch name
53188       vcenter-url:
53189         type: string
53190         description: URL used to reach the vcenter
53191       resource-version:
53192         type: string
53193         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53194       relationship-list:
53195         type: array
53196         items:
53197           $ref: "#/getDefinitions/relationship"
53198   dvs-switches:
53199     description: |
53200       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53201     properties:
53202       dvs-switch:
53203         type: array
53204         items:
53205           $ref: "#/getDefinitions/dvs-switch"
53206   edge-prop-names:
53207     description: |
53208       Internal map to define the properties of an edge and interpret the map EdgeRules
53209     properties:
53210       edgeLabel:
53211         type: string
53212       direction:
53213         type: string
53214       multiplicityRule:
53215         type: string
53216       isParent:
53217         type: boolean
53218       usesResource:
53219         type: boolean
53220       hasDelTarget:
53221         type: boolean
53222       SVC-INFRA:
53223         type: boolean
53224       SVC-INFRA-REV:
53225         type: boolean
53226   edge-tag-query-request:
53227     properties:
53228       edge-tag:
53229         type: string
53230       result-detail:
53231         type: string
53232       start-node-type:
53233         type: string
53234       start-node-filter:
53235         type: array
53236         items:
53237           $ref: "#/getDefinitions/start-node-filter"
53238       include-node-filter:
53239         type: array
53240         items:
53241           $ref: "#/getDefinitions/include-node-filter"
53242       secondary-filter:
53243         type: array
53244         items:
53245           $ref: "#/getDefinitions/secondary-filter"
53246   edge-tag-query-result:
53247     properties:
53248       tagged-inventory-item-list:
53249         type: array
53250         items:
53251           $ref: "#/getDefinitions/tagged-inventory-item-list"
53252   element-choice-set:
53253     description: |
53254       This is how we would capture constraints defining allowed sets of elements.
53255       ###### Related Nodes
53256       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53257       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
53258       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
53259     required:
53260     - element-choice-set-uuid
53261     - element-choice-set-name
53262     properties:
53263       element-choice-set-uuid:
53264         type: string
53265       element-choice-set-name:
53266         type: string
53267       cardinality:
53268         type: string
53269       resource-version:
53270         type: string
53271       model-elements:
53272         type: array
53273         items:
53274           $ref: "#/getDefinitions/model-element"
53275       relationship-list:
53276         type: array
53277         items:
53278           $ref: "#/getDefinitions/relationship"
53279   element-choice-sets:
53280     properties:
53281       element-choice-set:
53282         type: array
53283         items:
53284           $ref: "#/getDefinitions/element-choice-set"
53285   entitlement:
53286     description: |
53287       Metadata for entitlement group.
53288       ###### Related Nodes
53289       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53290       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53291     required:
53292     - group-uuid
53293     - resource-uuid
53294     properties:
53295       group-uuid:
53296         type: string
53297         description: Unique ID for the entitlement group the resource comes from, should be uuid.
53298       resource-uuid:
53299         type: string
53300         description: Unique ID of an entitlement resource.
53301       resource-version:
53302         type: string
53303         description: Concurrency value
53304       relationship-list:
53305         type: array
53306         items:
53307           $ref: "#/getDefinitions/relationship"
53308   entitlements:
53309     description: |
53310       Entitlements, keyed by group-uuid and resource-uuid, related to license management
53311     properties:
53312       entitlement:
53313         type: array
53314         items:
53315           $ref: "#/getDefinitions/entitlement"
53316   esr-ems:
53317     description: |
53318       Persist EMS address information used by EMS driver.
53319       ###### Related Nodes
53320       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
53321       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53322     required:
53323     - ems-id
53324     properties:
53325       ems-id:
53326         type: string
53327         description: Unique ID of EMS.
53328       resource-version:
53329         type: string
53330         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53331       esr-system-info-list:
53332         type: object
53333         $ref: "#/getDefinitions/esr-system-info-list"
53334       relationship-list:
53335         type: object
53336         $ref: "#/getDefinitions/relationship-list"
53337   esr-ems-list:
53338     properties:
53339       esr-ems:
53340         type: array
53341         items:
53342           $ref: "#/getDefinitions/esr-ems"
53343   esr-system-info:
53344     description: |
53345       Persist common address information of external systems.
53346       ###### Related Nodes
53347       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
53348       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
53349       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
53350       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
53351     required:
53352     - esr-system-info-id
53353     - user-name
53354     - password
53355     - system-type
53356     properties:
53357       esr-system-info-id:
53358         type: string
53359         description: Unique ID of esr system info.
53360       system-name:
53361         type: string
53362         description: name of external system.
53363       type:
53364         type: string
53365         description: type of external systems.
53366       vendor:
53367         type: string
53368         description: vendor of external systems.
53369       version:
53370         type: string
53371         description: version of external systems.
53372       service-url:
53373         type: string
53374         description: url used to access external systems.
53375       user-name:
53376         type: string
53377         description: username used to access external systems.
53378       password:
53379         type: string
53380         description: password used to access external systems.
53381       system-type:
53382         type: string
53383         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53384       protocol:
53385         type: string
53386         description: protocol of third party SDNC, for example netconf/snmp.
53387       ssl-cacert:
53388         type: string
53389         description: ca file content if enabled ssl on auth-url.
53390       ssl-insecure:
53391         type: boolean
53392         description: Whether to verify VIM's certificate.
53393       ip-address:
53394         type: string
53395         description: service IP of ftp server.
53396       port:
53397         type: string
53398         description: service port of ftp server.
53399       cloud-domain:
53400         type: string
53401         description: domain info for authentication.
53402       default-tenant:
53403         type: string
53404         description: default tenant of VIM.
53405       passive:
53406         type: boolean
53407         description: ftp passive mode or not.
53408       remote-path:
53409         type: string
53410         description: resource or performance data file path.
53411       system-status:
53412         type: string
53413         description: the status of external system.
53414       resource-version:
53415         type: string
53416         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53417       relationship-list:
53418         type: array
53419         items:
53420           $ref: "#/getDefinitions/relationship"
53421   esr-system-info-list:
53422     description: |
53423       Collection of persistent block-level external system auth info.
53424     properties:
53425       esr-system-info:
53426         type: array
53427         items:
53428           $ref: "#/getDefinitions/esr-system-info"
53429   esr-thirdparty-sdnc:
53430     description: |
53431       Persist SDNC address information used by ONAP SDNC.
53432       ###### Related Nodes
53433       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
53434       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53435       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53436     required:
53437     - thirdparty-sdnc-id
53438     properties:
53439       thirdparty-sdnc-id:
53440         type: string
53441         description: Unique ID of SDNC.
53442       location:
53443         type: string
53444         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53445       product-name:
53446         type: string
53447         description: password used to access SDNC server.
53448       resource-version:
53449         type: string
53450         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53451       esr-system-info-list:
53452         type: object
53453         $ref: "#/getDefinitions/esr-system-info-list"
53454       relationship-list:
53455         type: object
53456         $ref: "#/getDefinitions/relationship-list"
53457   esr-thirdparty-sdnc-list:
53458     properties:
53459       esr-thirdparty-sdnc:
53460         type: array
53461         items:
53462           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
53463   esr-vnfm:
53464     description: |
53465       Persist VNFM address information used by VF-C.
53466       ###### Related Nodes
53467       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
53468       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53469     required:
53470     - vnfm-id
53471     properties:
53472       vnfm-id:
53473         type: string
53474         description: Unique ID of VNFM.
53475       vim-id:
53476         type: string
53477         description: indecate the VIM to deploy VNF.
53478       certificate-url:
53479         type: string
53480         description: certificate url of VNFM.
53481       resource-version:
53482         type: string
53483         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53484       esr-system-info-list:
53485         type: object
53486         $ref: "#/getDefinitions/esr-system-info-list"
53487       relationship-list:
53488         type: object
53489         $ref: "#/getDefinitions/relationship-list"
53490   esr-vnfm-list:
53491     properties:
53492       esr-vnfm:
53493         type: array
53494         items:
53495           $ref: "#/getDefinitions/esr-vnfm"
53496   evc:
53497     description: |
53498       evc object is an optional child object of the Configuration object.
53499       ###### Related Nodes
53500       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53501     required:
53502     - evc-id
53503     properties:
53504       evc-id:
53505         type: string
53506         description: Unique/key field for the evc object
53507       forwarding-path-topology:
53508         type: string
53509         description: Point-to-Point, Multi-Point
53510       cir-value:
53511         type: string
53512         description: Commited Information Rate
53513       cir-units:
53514         type: string
53515         description: CIR units
53516       connection-diversity-group-id:
53517         type: string
53518         description: Diversity Group ID
53519       service-hours:
53520         type: string
53521         description: formerly Performance Group
53522       esp-evc-circuit-id:
53523         type: string
53524         description: EVC Circuit ID of ESP EVC
53525       esp-evc-cir-value:
53526         type: string
53527         description: Committed Information Rate (For ESP)
53528       esp-evc-cir-units:
53529         type: string
53530         description: CIR units (For ESP)
53531       esp-itu-code:
53532         type: string
53533         description: Identifies ESP
53534       collector-pop-clli:
53535         type: string
53536         description: Collector POP CLLI (from the hostname of the access pnf)
53537       inter-connect-type-ingress:
53538         type: string
53539         description: Interconnect type on ingress side of EVC.
53540       tagmode-access-ingress:
53541         type: string
53542         description: tagode for collector side of EVC
53543       tagmode-access-egress:
53544         type: string
53545         description: tagMode for network side of EVC
53546       relationship-list:
53547         type: array
53548         items:
53549           $ref: "#/getDefinitions/relationship"
53550       resource-version:
53551         type: string
53552         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53553   evcs:
53554     properties:
53555       evc:
53556         type: array
53557         items:
53558           $ref: "#/getDefinitions/evc"
53559   external-system:
53560     description: |
53561       Namespace for external system.
53562     properties:
53563       esr-ems-list:
53564         type: object
53565         $ref: "#/getDefinitions/esr-ems-list"
53566       esr-vnfm-list:
53567         type: object
53568         $ref: "#/getDefinitions/esr-vnfm-list"
53569       esr-thirdparty-sdnc-list:
53570         type: object
53571         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
53572   extra-properties:
53573     description: |
53574       Extra properties for inventory item for response list
53575   extra-property:
53576     properties:
53577       property-name:
53578         type: string
53579   flavor:
53580     description: |
53581       Openstack flavor.
53582       ###### Related Nodes
53583       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53584       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53585       - FLAVOR cannot be deleted if linked to VSERVER
53586     required:
53587     - flavor-id
53588     - flavor-name
53589     - flavor-selflink
53590     properties:
53591       flavor-id:
53592         type: string
53593         description: Flavor id, expected to be unique across cloud-region.
53594       flavor-name:
53595         type: string
53596         description: Flavor name
53597       flavor-vcpus:
53598         type: integer
53599         format: int32
53600         description: Number of CPUs
53601       flavor-ram:
53602         type: integer
53603         format: int32
53604         description: Amount of memory
53605       flavor-disk:
53606         type: integer
53607         format: int32
53608         description: Disk space
53609       flavor-ephemeral:
53610         type: integer
53611         format: int32
53612         description: Amount of ephemeral disk space
53613       flavor-swap:
53614         type: string
53615         description: amount of swap space allocation
53616       flavor-is-public:
53617         type: boolean
53618         description: whether flavor is available to all users or private to the tenant it was created in.
53619       flavor-selflink:
53620         type: string
53621         description: URL to endpoint where AAI can get more details
53622       flavor-disabled:
53623         type: boolean
53624         description: Boolean as to whether this flavor is no longer enabled
53625       resource-version:
53626         type: string
53627         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53628       relationship-list:
53629         type: array
53630         items:
53631           $ref: "#/getDefinitions/relationship"
53632   flavors:
53633     description: |
53634       Collection of openstack flavors.
53635     properties:
53636       flavor:
53637         type: array
53638         items:
53639           $ref: "#/getDefinitions/flavor"
53640   forwarder:
53641     description: |
53642       Entity describing a sequenced segment of forwarding path
53643       ###### Related Nodes
53644       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53645       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
53646       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53647       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
53648       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
53649       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
53650     required:
53651     - sequence
53652     properties:
53653       sequence:
53654         type: integer
53655         format: int32
53656         description: Unique ID of this segmentation
53657       forwarder-role:
53658         type: string
53659         description: ingress, intermediate, egress
53660       relationship-list:
53661         type: array
53662         items:
53663           $ref: "#/getDefinitions/relationship"
53664       resource-version:
53665         type: string
53666         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53667   forwarder-evc:
53668     description: |
53669       forwarder object is an optional child object of the Configuration object.
53670       ###### Related Nodes
53671       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53672     required:
53673     - forwarder-evc-id
53674     properties:
53675       forwarder-evc-id:
53676         type: string
53677         description: Key for forwarder-evc object
53678       circuit-id:
53679         type: string
53680         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53681       ivlan:
53682         type: string
53683         description: Internal VLAN.
53684       svlan:
53685         type: string
53686         description: SVLAN value for ingress of egress forwarder.
53687       cvlan:
53688         type: string
53689         description: CVLAN value for ingress of egress forwarder.
53690       relationship-list:
53691         type: array
53692         items:
53693           $ref: "#/getDefinitions/relationship"
53694       resource-version:
53695         type: string
53696         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53697   forwarder-evcs:
53698     properties:
53699       forwarder-evc:
53700         type: array
53701         items:
53702           $ref: "#/getDefinitions/forwarder-evc"
53703   forwarders:
53704     properties:
53705       forwarder:
53706         type: array
53707         items:
53708           $ref: "#/getDefinitions/forwarder"
53709   forwarding-path:
53710     description: |
53711       Entity that describes the sequenced forwarding path between interfaces of services or resources
53712       ###### Related Nodes
53713       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
53714       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53715       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53716       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
53717       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
53718     required:
53719     - forwarding-path-id
53720     - forwarding-path-name
53721     properties:
53722       forwarding-path-id:
53723         type: string
53724         description: Unique ID of this FP
53725       forwarding-path-name:
53726         type: string
53727         description: Name of the FP
53728       relationship-list:
53729         type: array
53730         items:
53731           $ref: "#/getDefinitions/relationship"
53732       resource-version:
53733         type: string
53734         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53735       selflink:
53736         type: string
53737         description: the self link for this FP
53738       forwarders:
53739         type: array
53740         items:
53741           $ref: "#/getDefinitions/forwarder"
53742   forwarding-paths:
53743     properties:
53744       forwarding-path:
53745         type: array
53746         items:
53747           $ref: "#/getDefinitions/forwarding-path"
53748   generic-vnf:
53749     description: |
53750       General purpose VNF
53751       ###### Related Nodes
53752       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53753       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
53754       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53755       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
53756       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
53757       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53758       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53759       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53760       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53761       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53762       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53763       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53764       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53765       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
53766       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53767       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53768       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
53769       - GENERIC-VNF is DELETED when these are DELETED VNFC,LAG-INTERFACE,L-INTERFACE,VF-MODULE
53770     required:
53771     - vnf-id
53772     - vnf-name
53773     - vnf-type
53774     - in-maint
53775     - is-closed-loop-disabled
53776     properties:
53777       vnf-id:
53778         type: string
53779         description: Unique id of VNF.  This is unique across the graph.
53780       vnf-name:
53781         type: string
53782         description: Name of VNF.
53783       vnf-name2:
53784         type: string
53785         description: Alternate name of VNF.
53786       vnf-type:
53787         type: string
53788         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
53789       service-id:
53790         type: string
53791         description: Unique identifier of service from ASDC
53792       regional-resource-zone:
53793         type: string
53794         description: Regional way of organizing pservers, source of truth should define values
53795       prov-status:
53796         type: string
53797         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53798       operational-state:
53799         type: string
53800         description: Indicator for whether the resource is considered operational
53801       license-key:
53802         type: string
53803         description: License key
53804       equipment-role:
53805         type: string
53806         description: Client should send valid enumerated value
53807       orchestration-status:
53808         type: string
53809         description: Orchestration status of this VNF, used by MSO.
53810       heat-stack-id:
53811         type: string
53812         description: Heat stack id corresponding to this instance, managed by MSO
53813       mso-catalog-key:
53814         type: string
53815         description: Corresponds to the SDN-C catalog id used to configure this VCE
53816       management-option:
53817         type: string
53818         description: identifier of managed by company or customer
53819       ipv4-oam-address:
53820         type: string
53821         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53822       ipv4-loopback0-address:
53823         type: string
53824         description: v4 Loopback0 address
53825       nm-lan-v6-address:
53826         type: string
53827         description: v6 Loopback address
53828       management-v6-address:
53829         type: string
53830         description: v6 management address
53831       vcpu:
53832         type: integer
53833         format: int64
53834         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
53835       vcpu-units:
53836         type: string
53837         description: units associated with vcpu, used for VNFs with no vservers/flavors
53838       vmemory:
53839         type: integer
53840         format: int64
53841         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
53842       vmemory-units:
53843         type: string
53844         description: units associated with vmemory, used for VNFs with no vservers/flavors
53845       vdisk:
53846         type: integer
53847         format: int64
53848         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
53849       vdisk-units:
53850         type: string
53851         description: units associated with vdisk, used for VNFs with no vservers/flavors
53852       in-maint:
53853         type: boolean
53854       is-closed-loop-disabled:
53855         type: boolean
53856       resource-version:
53857         type: string
53858         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53859       summary-status:
53860         type: string
53861         description: details regarding the generic-vnf operation
53862       encrypted-access-flag:
53863         type: boolean
53864         description: indicates whether generic-vnf access uses SSH
53865       persona-model-id:
53866         type: string
53867         description: the ASDC model id for this resource or service model.
53868       persona-model-version:
53869         type: string
53870         description: the ASDC model version for this resource or service model.
53871       model-version-id:
53872         type: string
53873         description: the ASDC model version for this resource or service model.
53874       widget-model-id:
53875         type: string
53876         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53877       widget-model-version:
53878         type: string
53879         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53880       as-number:
53881         type: string
53882         description: as-number of the VNF
53883       regional-resource-subzone:
53884         type: string
53885         description: represents sub zone of the rr plane
53886       relationship-list:
53887         type: array
53888         items:
53889           $ref: "#/getDefinitions/relationship"
53890       l-interfaces:
53891         type: array
53892         items:
53893           $ref: "#/getDefinitions/l-interface"
53894       lag-interfaces:
53895         type: array
53896         items:
53897           $ref: "#/getDefinitions/lag-interface"
53898       vf-modules:
53899         type: array
53900         items:
53901           $ref: "#/getDefinitions/vf-module"
53902   generic-vnfs:
53903     description: |
53904       Collection of VNFs
53905     properties:
53906       generic-vnf:
53907         type: array
53908         items:
53909           $ref: "#/getDefinitions/generic-vnf"
53910   group-assignment:
53911     description: |
53912       Openstack group-assignment used to store exclusivity groups (EG).
53913       ###### Related Nodes
53914       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53915       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
53916       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
53917     required:
53918     - group-id
53919     - group-type
53920     - group-name
53921     properties:
53922       group-id:
53923         type: string
53924         description: Group id, expected to be unique across cloud-region.
53925       group-type:
53926         type: string
53927         description: Group type - the type of group this instance refers to
53928       group-name:
53929         type: string
53930         description: Group name - name assigned to the group
53931       group-description:
53932         type: string
53933         description: Group description - description of the group
53934       resource-version:
53935         type: string
53936         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53937       relationship-list:
53938         type: array
53939         items:
53940           $ref: "#/getDefinitions/relationship"
53941   group-assignments:
53942     description: |
53943       Collection of openstack group assignments
53944     properties:
53945       group-assignment:
53946         type: array
53947         items:
53948           $ref: "#/getDefinitions/group-assignment"
53949   host-route:
53950     description: |
53951       ###### Related Nodes
53952       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
53953     required:
53954     - host-route-id
53955     - route-prefix
53956     - next-hop
53957     properties:
53958       host-route-id:
53959         type: string
53960         description: host-route id
53961       route-prefix:
53962         type: string
53963         description: subnet prefix
53964       next-hop:
53965         type: string
53966         description: Could be ip-address, hostname, or service-instance
53967       next-hop-type:
53968         type: string
53969         description: Should be ip-address, hostname, or service-instance to match next-hop
53970       resource-version:
53971         type: string
53972         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53973       relationship-list:
53974         type: array
53975         items:
53976           $ref: "#/getDefinitions/relationship"
53977   host-routes:
53978     properties:
53979       host-route:
53980         type: array
53981         items:
53982           $ref: "#/getDefinitions/host-route"
53983   image:
53984     description: |
53985       Openstack image.
53986       ###### Related Nodes
53987       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53988       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
53989       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
53990       - IMAGE cannot be deleted if linked to VSERVER
53991       - IMAGE is DELETED when these are DELETED METADATUM
53992     required:
53993     - image-id
53994     - image-name
53995     - image-os-distro
53996     - image-os-version
53997     - image-selflink
53998     properties:
53999       image-id:
54000         type: string
54001         description: Image id, expected to be unique across cloud region
54002       image-name:
54003         type: string
54004         description: Image name
54005       image-architecture:
54006         type: string
54007         description: Operating system architecture.
54008       image-os-distro:
54009         type: string
54010         description: The common name of the operating system distribution in lowercase
54011       image-os-version:
54012         type: string
54013         description: The operating system version as specified by the distributor.
54014       application:
54015         type: string
54016         description: The application that the image instantiates.
54017       application-vendor:
54018         type: string
54019         description: The vendor of the application.
54020       application-version:
54021         type: string
54022         description: The version of the application.
54023       image-selflink:
54024         type: string
54025         description: URL to endpoint where AAI can get more details
54026       resource-version:
54027         type: string
54028         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54029       relationship-list:
54030         type: array
54031         items:
54032           $ref: "#/getDefinitions/relationship"
54033       metadata:
54034         type: array
54035         items:
54036           $ref: "#/getDefinitions/metadatum"
54037   images:
54038     description: |
54039       Collectio of Openstack images.
54040     properties:
54041       image:
54042         type: array
54043         items:
54044           $ref: "#/getDefinitions/image"
54045   include-node-filter:
54046     properties:
54047       include-node-type:
54048         type: string
54049   instance-filter:
54050     description: |
54051       InstanceFilter for performing a named-query or model query
54052   instance-filters:
54053     description: |
54054       InstanceFilters for performing a named-query or model query
54055     properties:
54056       instance-filter:
54057         type: array
54058         items:
54059           $ref: "#/getDefinitions/instance-filter"
54060   instance-group:
54061     description: |
54062       General mechanism for grouping instances
54063       ###### Related Nodes
54064       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54065       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54066       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54067       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54068       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54069     required:
54070     - id
54071     - description
54072     - type
54073     properties:
54074       id:
54075         type: string
54076         description: Instance Group ID, UUID assigned to this instance.
54077       description:
54078         type: string
54079         description: Descriptive text to help identify the usage of this instance-group
54080       type:
54081         type: string
54082         description: Only valid value today is lower case ha for high availability
54083       sub-type:
54084         type: string
54085         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54086       resource-version:
54087         type: string
54088         description: Concurrency value
54089       relationship-list:
54090         type: array
54091         items:
54092           $ref: "#/getDefinitions/relationship"
54093   instance-groups:
54094     description: |
54095       Collection of openstack route table references
54096     properties:
54097       instance-group:
54098         type: array
54099         items:
54100           $ref: "#/getDefinitions/instance-group"
54101   inventory:
54102     properties:
54103       search:
54104         type: object
54105         $ref: "#/getDefinitions/search"
54106       actions:
54107         type: object
54108         $ref: "#/getDefinitions/actions"
54109       cloud-infrastructure:
54110         type: object
54111         $ref: "#/getDefinitions/cloud-infrastructure"
54112       business:
54113         type: object
54114         $ref: "#/getDefinitions/business"
54115       service-design-and-creation:
54116         type: object
54117         $ref: "#/getDefinitions/service-design-and-creation"
54118       network:
54119         type: object
54120         $ref: "#/getDefinitions/network"
54121       aai-internal:
54122         type: object
54123         $ref: "#/getDefinitions/aai-internal"
54124   inventory-item:
54125     properties:
54126       inventory-item-type:
54127         type: string
54128       inventory-item-link:
54129         type: string
54130       inventory-item-data:
54131         type: array
54132         items:
54133           $ref: "#/getDefinitions/inventory-item-data"
54134       tagged-inventory-item-list:
54135         type: array
54136         items:
54137           $ref: "#/getDefinitions/tagged-inventory-item-list"
54138   inventory-item-data:
54139     properties:
54140       property-name:
54141         type: string
54142       property-value:
54143         type: string
54144   inventory-response-item:
54145     description: |
54146       Inventory item for response list
54147     properties:
54148       model-name:
54149         type: string
54150       extra-properties:
54151         type: object
54152         $ref: "#/getDefinitions/extra-properties"
54153       inventory-response-items:
54154         type: object
54155         $ref: "#/getDefinitions/inventory-response-items"
54156   inventory-response-items:
54157     description: |
54158       Container for inventory items in response list
54159     properties:
54160       inventory-response-item:
54161         type: array
54162         items:
54163           $ref: "#/getDefinitions/inventory-response-item"
54164   ipsec-configuration:
54165     description: |
54166       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
54167       ###### Related Nodes
54168       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54169       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
54170       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
54171     required:
54172     - ipsec-configuration-id
54173     properties:
54174       ipsec-configuration-id:
54175         type: string
54176         description: UUID of this configuration
54177       requested-vig-address-type:
54178         type: string
54179         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54180       requested-encryption-strength:
54181         type: string
54182         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54183       requested-dmz-type:
54184         type: string
54185         description: can offer a shared DMZ or a DMZ specific to a customer
54186       shared-dmz-network-address:
54187         type: string
54188         description: Network address of shared DMZ
54189       requested-customer-name:
54190         type: string
54191         description: If the DMZ is a custom DMZ, this field will indicate the customer information
54192       ike-version:
54193         type: string
54194         description: can be 1 or 2
54195       ikev1-authentication:
54196         type: string
54197         description: Contains values like md5, sha1, sha256, sha384
54198       ikev1-encryption:
54199         type: string
54200         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54201       ikev1-dh-group:
54202         type: string
54203         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54204       ikev1-am-group-id:
54205         type: string
54206         description: Group name defined in VIG for clients using aggressive mode
54207       ikev1-am-password:
54208         type: string
54209         description: pre-shared key for the above group name
54210       ikev1-sa-lifetime:
54211         type: string
54212         description: Lifetime for IKEv1 SA
54213       ipsec-authentication:
54214         type: string
54215         description: md5, sha1, sha256, sha384
54216       ipsec-encryption:
54217         type: string
54218         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54219       ipsec-sa-lifetime:
54220         type: string
54221         description: Life time for IPSec SA
54222       ipsec-pfs:
54223         type: string
54224         description: enable PFS or not
54225       xauth-userid:
54226         type: string
54227         description: user ID for xAuth, sm-user, ,nmteHostName
54228       xauth-user-password:
54229         type: string
54230         description: Encrypted using the Juniper $9$ algorithm
54231       dpd-interval:
54232         type: string
54233         description: The time between DPD probe
54234       dpd-frequency:
54235         type: string
54236         description: Maximum number of DPD before claiming the tunnel is down
54237       resource-version:
54238         type: string
54239         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54240       relationship-list:
54241         type: array
54242         items:
54243           $ref: "#/getDefinitions/relationship"
54244       vig-servers:
54245         type: array
54246         items:
54247           $ref: "#/getDefinitions/vig-server"
54248   ipsec-configurations:
54249     properties:
54250       ipsec-configuration:
54251         type: array
54252         items:
54253           $ref: "#/getDefinitions/ipsec-configuration"
54254   key-data:
54255     properties:
54256       key-name:
54257         type: string
54258       key-value:
54259         type: string
54260   l-interface:
54261     description: |
54262       Logical interfaces, e.g., a vnic.
54263       ###### Related Nodes
54264       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54265       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54266       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54267       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54268       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
54269       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
54270       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54271       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54272       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
54273       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
54274       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
54275       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
54276     required:
54277     - interface-name
54278     properties:
54279       interface-name:
54280         type: string
54281         description: Name given to the interface
54282       interface-role:
54283         type: string
54284         description: E.g., CUSTOMER, UPLINK, etc.
54285       v6-wan-link-ip:
54286         type: string
54287         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54288       selflink:
54289         type: string
54290         description: URL to endpoint where AAI can get more details
54291       interface-id:
54292         type: string
54293         description: ID of interface
54294       macaddr:
54295         type: string
54296         description: MAC address for the interface
54297       network-name:
54298         type: string
54299         description: Name of the network
54300       management-option:
54301         type: string
54302         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54303       resource-version:
54304         type: string
54305         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54306       vlans:
54307         type: array
54308         items:
54309           $ref: "#/getDefinitions/vlan"
54310       sriov-vfs:
54311         type: array
54312         items:
54313           $ref: "#/getDefinitions/sriov-vf"
54314       relationship-list:
54315         type: array
54316         items:
54317           $ref: "#/getDefinitions/relationship"
54318       l3-interface-ipv4-address-list:
54319         type: array
54320         items:
54321           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
54322       l3-interface-ipv6-address-list:
54323         type: array
54324         items:
54325           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
54326   l-interfaces:
54327     description: |
54328       Collection of logical interfaces.
54329     properties:
54330       l-interface:
54331         type: array
54332         items:
54333           $ref: "#/getDefinitions/l-interface"
54334   l3-interface-ipv4-address-list:
54335     description: |
54336       IPv4 Address Range
54337       ###### Related Nodes
54338       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54339       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54340       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54341       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54342     required:
54343     - l3-interface-ipv4-address
54344     properties:
54345       l3-interface-ipv4-address:
54346         type: string
54347         description: IP address
54348       l3-interface-ipv4-prefix-length:
54349         type: integer
54350         format: int64
54351         description: Prefix length, 32 for single address
54352       vlan-id-inner:
54353         type: integer
54354         format: int64
54355         description: Inner VLAN tag
54356       vlan-id-outer:
54357         type: integer
54358         format: int64
54359         description: Outer VLAN tag
54360       is-floating:
54361         type: boolean
54362         description: Indicator of fixed or floating address
54363       resource-version:
54364         type: string
54365         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54366       neutron-network-id:
54367         type: string
54368         description: Neutron network id of the interface that address belongs to
54369       neutron-subnet-id:
54370         type: string
54371         description: Neutron id of subnet that address belongs to
54372       relationship-list:
54373         type: array
54374         items:
54375           $ref: "#/getDefinitions/relationship"
54376   l3-interface-ipv6-address-list:
54377     description: |
54378       IPv6 Address Range
54379       ###### Related Nodes
54380       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54381       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54382       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54383       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54384     required:
54385     - l3-interface-ipv6-address
54386     properties:
54387       l3-interface-ipv6-address:
54388         type: string
54389         description: IP address
54390       l3-interface-ipv6-prefix-length:
54391         type: integer
54392         format: int64
54393         description: Prefix length, 128 for single address
54394       vlan-id-inner:
54395         type: integer
54396         format: int64
54397         description: Inner VLAN tag
54398       vlan-id-outer:
54399         type: integer
54400         format: int64
54401         description: Outer VLAN tag
54402       is-floating:
54403         type: boolean
54404         description: Indicator of fixed or floating address
54405       resource-version:
54406         type: string
54407         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54408       neutron-network-id:
54409         type: string
54410         description: Neutron network id of the interface that address belongs to
54411       neutron-subnet-id:
54412         type: string
54413         description: Neutron id of subnet that address belongs to
54414       relationship-list:
54415         type: array
54416         items:
54417           $ref: "#/getDefinitions/relationship"
54418   l3-network:
54419     description: |
54420       Generic network definition
54421       ###### Related Nodes
54422       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54423       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
54424       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54425       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54426       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54427       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54428       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54429       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54430       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54431       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54432       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
54433       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54434       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54435       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
54436       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
54437     required:
54438     - network-id
54439     - network-name
54440     - is-bound-to-vpn
54441     - is-provider-network
54442     - is-shared-network
54443     - is-external-network
54444     properties:
54445       network-id:
54446         type: string
54447         description: Network ID, should be uuid. Unique across A&AI.
54448       network-name:
54449         type: string
54450         description: Name of the network, governed by some naming convention..
54451       network-type:
54452         type: string
54453         description: Type of the network - who defines these values?
54454       network-role:
54455         type: string
54456         description: Role the network plans - who defines these values?
54457       network-technology:
54458         type: string
54459         description: Network technology - who defines these values?
54460       neutron-network-id:
54461         type: string
54462         description: Neutron network id of this Interface
54463       is-bound-to-vpn:
54464         type: boolean
54465       service-id:
54466         type: string
54467         description: Unique identifier of service from ASDC
54468       network-role-instance:
54469         type: integer
54470         format: int64
54471         description: network role instance
54472       resource-version:
54473         type: string
54474         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54475       orchestration-status:
54476         type: string
54477         description: Orchestration status of this VNF, mastered by MSO
54478       heat-stack-id:
54479         type: string
54480         description: Heat stack id corresponding to this instance, managed by MSO
54481       mso-catalog-key:
54482         type: string
54483         description: Corresponds to the SDN-C catalog id used to configure this VCE
54484       contrail-network-fqdn:
54485         type: string
54486         description: Contrail FQDN for the network
54487       persona-model-id:
54488         type: string
54489         description: the ASDC model id for this resource or service model.
54490       persona-model-version:
54491         type: string
54492         description: the ASDC model version for this resource or service model.
54493       model-version-id:
54494         type: string
54495         description: the ASDC model version for this resource or service model.
54496       widget-model-id:
54497         type: string
54498         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54499       widget-model-version:
54500         type: string
54501         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54502       physical-network-name:
54503         type: string
54504         description: Name associated with the physical network.
54505       is-provider-network:
54506         type: boolean
54507       is-shared-network:
54508         type: boolean
54509       is-external-network:
54510         type: boolean
54511       subnets:
54512         type: array
54513         items:
54514           $ref: "#/getDefinitions/subnet"
54515       ctag-assignments:
54516         type: array
54517         items:
54518           $ref: "#/getDefinitions/ctag-assignment"
54519       segmentation-assignments:
54520         type: array
54521         items:
54522           $ref: "#/getDefinitions/segmentation-assignment"
54523       relationship-list:
54524         type: array
54525         items:
54526           $ref: "#/getDefinitions/relationship"
54527         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
54528   l3-networks:
54529     properties:
54530       l3-network:
54531         type: array
54532         items:
54533           $ref: "#/getDefinitions/l3-network"
54534   lag-interface:
54535     description: |
54536       Link aggregate interface
54537       ###### Related Nodes
54538       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54539       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54540       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
54541       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
54542       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
54543       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
54544       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54545       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
54546       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK
54547     required:
54548     - interface-name
54549     properties:
54550       interface-name:
54551         type: string
54552         description: Name that identifies the link aggregate interface
54553       resource-version:
54554         type: string
54555         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54556       speed-value:
54557         type: string
54558         description: Captures the numeric part of the speed
54559       speed-units:
54560         type: string
54561         description: Captures the units corresponding to the speed
54562       relationship-list:
54563         type: array
54564         items:
54565           $ref: "#/getDefinitions/relationship"
54566       l-interfaces:
54567         type: array
54568         items:
54569           $ref: "#/getDefinitions/l-interface"
54570   lag-interfaces:
54571     description: |
54572       Collection of link aggregate interfaces.
54573     properties:
54574       lag-interface:
54575         type: array
54576         items:
54577           $ref: "#/getDefinitions/lag-interface"
54578   lag-link:
54579     description: |
54580       LAG links can connect lag-interfaces
54581       ###### Related Nodes
54582       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54583       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54584     required:
54585     - link-name
54586     properties:
54587       link-name:
54588         type: string
54589         description: Alphabetical concatenation of lag-interface names
54590       resource-version:
54591         type: string
54592         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54593       relationship-list:
54594         type: array
54595         items:
54596           $ref: "#/getDefinitions/relationship"
54597   lag-links:
54598     description: |
54599       Collection of link aggregation connections
54600     properties:
54601       lag-link:
54602         type: array
54603         items:
54604           $ref: "#/getDefinitions/lag-link"
54605   license:
54606     description: |
54607       Metadata for license group.
54608       ###### Related Nodes
54609       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54610       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54611     required:
54612     - group-uuid
54613     - resource-uuid
54614     properties:
54615       group-uuid:
54616         type: string
54617         description: Unique ID for the license group the resource belongs to, should be uuid.
54618       resource-uuid:
54619         type: string
54620         description: Unique ID of a license resource.
54621       resource-version:
54622         type: string
54623         description: Concurrency value
54624       relationship-list:
54625         type: array
54626         items:
54627           $ref: "#/getDefinitions/relationship"
54628   licenses:
54629     description: |
54630       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54631     properties:
54632       license:
54633         type: array
54634         items:
54635           $ref: "#/getDefinitions/license"
54636   line-of-business:
54637     description: |
54638       describes a line-of-business
54639       ###### Related Nodes
54640       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54641     required:
54642     - line-of-business-name
54643     properties:
54644       line-of-business-name:
54645         type: string
54646         description: Name of the line-of-business (product)
54647       resource-version:
54648         type: string
54649         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54650       relationship-list:
54651         type: array
54652         items:
54653           $ref: "#/getDefinitions/relationship"
54654   lines-of-business:
54655     description: |
54656       Collection of lines-of-business
54657     properties:
54658       line-of-business:
54659         type: array
54660         items:
54661           $ref: "#/getDefinitions/line-of-business"
54662   logical-link:
54663     description: |
54664       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54665       ###### Related Nodes
54666       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54667       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54668       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54669       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
54670       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
54671       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54672       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54673       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
54674       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54675       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54676       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54677     required:
54678     - link-name
54679     - link-type
54680     properties:
54681       link-name:
54682         type: string
54683         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54684       link-type:
54685         type: string
54686         description: Type of logical link, e.g., evc
54687       speed-value:
54688         type: string
54689         description: Captures the numeric part of the speed
54690       speed-units:
54691         type: string
54692         description: Captures the units corresponding to the speed
54693       ip-version:
54694         type: string
54695         description: v4, v6, or ds for dual stack
54696       routing-protocol:
54697         type: string
54698         description: For example, static or BGP
54699       resource-version:
54700         type: string
54701         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54702       persona-model-id:
54703         type: string
54704         description: the ASDC model id for this resource or service model.
54705       persona-model-version:
54706         type: string
54707         description: the ASDC model version for this resource or service model.
54708       model-version-id:
54709         type: string
54710         description: the ASDC model version for this resource or service model.
54711       widget-model-id:
54712         type: string
54713         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54714       widget-model-version:
54715         type: string
54716         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54717       operational-status:
54718         type: string
54719         description: Indication of operational status of the logical link.
54720       link-role:
54721         type: string
54722         description: Indication of the network use of the logical link.
54723       link-name2:
54724         type: string
54725         description: Alias or alternate name (CLCI or D1 name).
54726       link-id:
54727         type: string
54728         description: UUID of the logical-link, SDNC generates this.
54729       relationship-list:
54730         type: array
54731         items:
54732           $ref: "#/getDefinitions/relationship"
54733   logical-links:
54734     description: |
54735       Collection of logical connections
54736     properties:
54737       logical-link:
54738         type: array
54739         items:
54740           $ref: "#/getDefinitions/logical-link"
54741   metadata:
54742     description: |
54743       Collection of metadatum (key/value pairs)
54744     properties:
54745       metadatum:
54746         type: array
54747         items:
54748           $ref: "#/getDefinitions/metadatum"
54749   metadatum:
54750     description: |
54751       Key/value pairs
54752       ###### Related Nodes
54753       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54754       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54755       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54756       - TO model( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54757     required:
54758     - metaname
54759     - metaval
54760     properties:
54761       metaname:
54762         type: string
54763       metaval:
54764         type: string
54765       resource-version:
54766         type: string
54767         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54768   model:
54769     description: |
54770       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
54771       ###### Related Nodes
54772       - TO model( model-element isA model, MANY2ONE)
54773       - TO model-element (CHILD of model, model startsWith model-element, ONE2MANY)
54774       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54775       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54776       - FROM model-element( model-element isA model, MANY2ONE)
54777       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54778       - MODEL cannot be deleted if linked to NAMED-QUERY,NAMED-QUERY-ELEMENT
54779       - MODEL is DELETED when these are DELETED METADATUM
54780       - MODEL deletion means associated objects of these types are also DELETED:MODEL-ELEMENT
54781     required:
54782     - model-name-version-id
54783     - model-type
54784     - model-name
54785     - model-id
54786     - model-version
54787     properties:
54788       model-name-version-id:
54789         type: string
54790         description: Unique identifier corresponding to one version of a model in ASDC
54791       model-type:
54792         type: string
54793         description: Type of the model, e.g., service, resource, widget, etc.
54794       model-name:
54795         type: string
54796         description: Name of the model, which can change from version to version.
54797       model-id:
54798         type: string
54799         description: Invariant unique ID which does not change from version to version
54800       model-version:
54801         type: string
54802         description: Version
54803       model-description:
54804         type: string
54805         description: Description
54806       resource-version:
54807         type: string
54808         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54809       model-elements:
54810         type: array
54811         items:
54812           $ref: "#/getDefinitions/model-element"
54813       metadata:
54814         type: array
54815         items:
54816           $ref: "#/getDefinitions/metadatum"
54817       relationship-list:
54818         type: array
54819         items:
54820           $ref: "#/getDefinitions/relationship"
54821   model-and-named-query-search:
54822     description: |
54823       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54824     properties:
54825       query-parameters:
54826         type: object
54827         $ref: "#/getDefinitions/query-parameters"
54828       instance-filters:
54829         type: object
54830         $ref: "#/getDefinitions/instance-filters"
54831       top-node-type:
54832         type: string
54833   model-constraint:
54834     description: |
54835       This is how we would capture constraints defining allowed sets of elements.
54836       ###### Related Nodes
54837       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54838       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54839       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
54840     required:
54841     - model-constraint-uuid
54842     - constrained-element-set-uuid-to-replace
54843     properties:
54844       model-constraint-uuid:
54845         type: string
54846       constrained-element-set-uuid-to-replace:
54847         type: string
54848       constrained-element-sets:
54849         type: array
54850         items:
54851           $ref: "#/getDefinitions/constrained-element-set"
54852   model-constraints:
54853     properties:
54854       model-constraint:
54855         type: array
54856         items:
54857           $ref: "#/getDefinitions/model-constraint"
54858   model-element:
54859     description: |
54860       Defines how other models combine to make up a higher-level model.
54861       ###### Related Nodes
54862       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54863       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54864       - TO model( model-element isA model, MANY2ONE)
54865       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54866       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54867       - FROM model (PARENT of model-element, model startsWith model-element)
54868       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54869       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
54870     required:
54871     - model-element-uuid
54872     - new-data-del-flag
54873     - cardinality
54874     properties:
54875       model-element-uuid:
54876         type: string
54877       new-data-del-flag:
54878         type: string
54879         description: Indicates whether this element was created as part of instantiation from this model
54880       cardinality:
54881         type: string
54882         description: How many of this type of element are required/allowed
54883       linkage-points:
54884         type: string
54885       resource-version:
54886         type: string
54887         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54888       model-elements:
54889         type: array
54890         items:
54891           $ref: "#/getDefinitions/model-element"
54892         description: Defines how other models combine to make up a higher-level model
54893       model-constraints:
54894         type: array
54895         items:
54896           $ref: "#/getDefinitions/model-constraint"
54897         description: Describes new constraints on this model element that are not part of that model's definition
54898       relationship-list:
54899         type: array
54900         items:
54901           $ref: "#/getDefinitions/relationship"
54902   model-elements:
54903     properties:
54904       model-element:
54905         type: array
54906         items:
54907           $ref: "#/getDefinitions/model-element"
54908   model-ver:
54909     description: |
54910       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
54911       ###### Related Nodes
54912       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54913       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
54914       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54915       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54916       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
54917       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
54918     required:
54919     - model-version-id
54920     - model-name
54921     - model-version
54922     properties:
54923       model-version-id:
54924         type: string
54925         description: Unique identifier corresponding to one version of a model in ASDC
54926       model-name:
54927         type: string
54928         description: Name of the model, which can change from version to version.
54929       model-version:
54930         type: string
54931         description: Version
54932       model-description:
54933         type: string
54934         description: Description
54935       resource-version:
54936         type: string
54937         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54938       model-elements:
54939         type: array
54940         items:
54941           $ref: "#/getDefinitions/model-element"
54942       metadata:
54943         type: array
54944         items:
54945           $ref: "#/getDefinitions/metadatum"
54946       relationship-list:
54947         type: array
54948         items:
54949           $ref: "#/getDefinitions/relationship"
54950   model-vers:
54951     properties:
54952       model-ver:
54953         type: array
54954         items:
54955           $ref: "#/getDefinitions/model-ver"
54956   models:
54957     description: |
54958       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
54959     properties:
54960       model:
54961         type: array
54962         items:
54963           $ref: "#/getDefinitions/model"
54964   multicast-configuration:
54965     description: |
54966       ###### Related Nodes
54967       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
54968     required:
54969     - multicast-configuration-id
54970     - multicast-protocol
54971     - rp-type
54972     properties:
54973       multicast-configuration-id:
54974         type: string
54975         description: Unique id of multicast configuration.
54976       multicast-protocol:
54977         type: string
54978         description: protocol of multicast configuration
54979       rp-type:
54980         type: string
54981         description: rp type of multicast configuration
54982       resource-version:
54983         type: string
54984         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54985       relationship-list:
54986         type: array
54987         items:
54988           $ref: "#/getDefinitions/relationship"
54989   multicast-configurations:
54990     description: |
54991       multicast configuration of generic-vnf ip-address
54992     properties:
54993       multicast-configuration:
54994         type: array
54995         items:
54996           $ref: "#/getDefinitions/multicast-configuration"
54997   named-queries:
54998     properties:
54999       named-query:
55000         type: array
55001         items:
55002           $ref: "#/getDefinitions/named-query"
55003   named-query:
55004     description: |
55005       TBD
55006       ###### Related Nodes
55007       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55008       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55009       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55010       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
55011     required:
55012     - named-query-uuid
55013     - named-query-name
55014     - named-query-version
55015     properties:
55016       named-query-uuid:
55017         type: string
55018       named-query-name:
55019         type: string
55020       named-query-version:
55021         type: string
55022       required-input-param:
55023         type: string
55024       description:
55025         type: string
55026       resource-version:
55027         type: string
55028       named-query-elements:
55029         type: array
55030         items:
55031           $ref: "#/getDefinitions/named-query-element"
55032       relationship-list:
55033         type: array
55034         items:
55035           $ref: "#/getDefinitions/relationship"
55036   named-query-element:
55037     description: |
55038       TBD
55039       ###### Related Nodes
55040       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55041       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55042       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55043       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55044       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55045       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55046       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
55047     required:
55048     - named-query-element-uuid
55049     properties:
55050       named-query-element-uuid:
55051         type: string
55052       property-collect-list:
55053         type: string
55054       resource-version:
55055         type: string
55056       property-limit-desc:
55057         type: string
55058       do-not-output:
55059         type: string
55060       named-query-elements:
55061         type: array
55062         items:
55063           $ref: "#/getDefinitions/named-query-element"
55064       related-lookups:
55065         type: array
55066         items:
55067           $ref: "#/getDefinitions/related-lookup"
55068       property-constraints:
55069         type: array
55070         items:
55071           $ref: "#/getDefinitions/property-constraint"
55072       relationship-list:
55073         type: array
55074         items:
55075           $ref: "#/getDefinitions/relationship"
55076   named-query-elements:
55077     properties:
55078       named-query-element:
55079         type: array
55080         items:
55081           $ref: "#/getDefinitions/named-query-element"
55082   network:
55083     description: |
55084       Namespace for network inventory resources.
55085     properties:
55086       logical-links:
55087         type: array
55088         items:
55089           $ref: "#/getDefinitions/logical-link"
55090       site-pair-sets:
55091         type: array
55092         items:
55093           $ref: "#/getDefinitions/site-pair-set"
55094       vpn-bindings:
55095         type: array
55096         items:
55097           $ref: "#/getDefinitions/vpn-binding"
55098       vpls-pes:
55099         type: array
55100         items:
55101           $ref: "#/getDefinitions/vpls-pe"
55102       multicast-configurations:
55103         type: array
55104         items:
55105           $ref: "#/getDefinitions/multicast-configuration"
55106       vces:
55107         type: array
55108         items:
55109           $ref: "#/getDefinitions/vce"
55110       vnfcs:
55111         type: array
55112         items:
55113           $ref: "#/getDefinitions/vnfc"
55114       l3-networks:
55115         type: array
55116         items:
55117           $ref: "#/getDefinitions/l3-network"
55118       network-policies:
55119         type: array
55120         items:
55121           $ref: "#/getDefinitions/network-policy"
55122       generic-vnfs:
55123         type: array
55124         items:
55125           $ref: "#/getDefinitions/generic-vnf"
55126       lag-links:
55127         type: array
55128         items:
55129           $ref: "#/getDefinitions/lag-link"
55130       newvces:
55131         type: array
55132         items:
55133           $ref: "#/getDefinitions/newvce"
55134       pnfs:
55135         type: array
55136         items:
55137           $ref: "#/getDefinitions/pnf"
55138       physical-links:
55139         type: array
55140         items:
55141           $ref: "#/getDefinitions/physical-link"
55142       ipsec-configurations:
55143         type: array
55144         items:
55145           $ref: "#/getDefinitions/ipsec-configuration"
55146       route-table-references:
55147         type: array
55148         items:
55149           $ref: "#/getDefinitions/route-table-reference"
55150   network-policies:
55151     properties:
55152       network-policy:
55153         type: array
55154         items:
55155           $ref: "#/getDefinitions/network-policy"
55156   network-policy:
55157     description: |
55158       ###### Related Nodes
55159       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55160     required:
55161     - network-policy-id
55162     properties:
55163       network-policy-id:
55164         type: string
55165         description: UUID representing unique key to this instance
55166       network-policy-fqdn:
55167         type: string
55168         description: Contrail FQDN for the policy
55169       heat-stack-id:
55170         type: string
55171         description: ID for the openStack Heat instance
55172       resource-version:
55173         type: string
55174         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55175       relationship-list:
55176         type: array
55177         items:
55178           $ref: "#/getDefinitions/relationship"
55179   network-profile:
55180     description: |
55181       Network profile populated by SDN-GP for SNMP
55182       ###### Related Nodes
55183       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55184     required:
55185     - nm-profile-name
55186     properties:
55187       nm-profile-name:
55188         type: string
55189         description: Unique name of network profile.
55190       community-string:
55191         type: string
55192         description: Encrypted SNMP community string
55193       resource-version:
55194         type: string
55195         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55196       relationship-list:
55197         type: array
55198         items:
55199           $ref: "#/getDefinitions/relationship"
55200   network-profiles:
55201     description: |
55202       Collection of network profiles
55203     properties:
55204       network-profile:
55205         type: array
55206         items:
55207           $ref: "#/getDefinitions/network-profile"
55208   newvce:
55209     description: |
55210       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55211       ###### Related Nodes
55212       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55213       - NEWVCE is DELETED when these are DELETED L-INTERFACE
55214     required:
55215     - vnf-id2
55216     - vnf-name
55217     - vnf-type
55218     properties:
55219       vnf-id2:
55220         type: string
55221         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55222       vnf-name:
55223         type: string
55224         description: Name of VNF.
55225       vnf-name2:
55226         type: string
55227         description: Alternate name of VNF.
55228       vnf-type:
55229         type: string
55230         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
55231       prov-status:
55232         type: string
55233         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55234       operational-state:
55235         type: string
55236         description: Indicator for whether the resource is considered operational
55237       license-key:
55238         type: string
55239         description: License key
55240       ipv4-oam-address:
55241         type: string
55242         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
55243       equipment-role:
55244         type: string
55245         description: Client should send valid enumerated value.
55246       resource-version:
55247         type: string
55248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55249       ipv4-loopback0-address:
55250         type: string
55251         description: v4 Loopback0 address
55252       orchestration-status:
55253         type: string
55254         description: Orchestration status of this VNF, mastered by MSO.
55255       heat-stack-id:
55256         type: string
55257         description: Heat stack id corresponding to this instance, managed by MSO
55258       mso-catalog-key:
55259         type: string
55260         description: Corresponds to the SDN-C catalog id used to configure this VCE
55261       relationship-list:
55262         type: array
55263         items:
55264           $ref: "#/getDefinitions/relationship"
55265       l-interfaces:
55266         type: array
55267         items:
55268           $ref: "#/getDefinitions/l-interface"
55269   newvces:
55270     description: |
55271       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55272     properties:
55273       newvce:
55274         type: array
55275         items:
55276           $ref: "#/getDefinitions/newvce"
55277   notification-event:
55278     properties:
55279       cambria.partition:
55280         type: string
55281       notification-event-header:
55282         type: object
55283         $ref: "#/getDefinitions/notification-event-header"
55284   notification-event-header:
55285     properties:
55286       id:
55287         type: string
55288       timestamp:
55289         type: string
55290       source-name:
55291         type: string
55292       domain:
55293         type: string
55294       sequence-number:
55295         type: string
55296       severity:
55297         type: string
55298       event-type:
55299         type: string
55300       version:
55301         type: string
55302       action:
55303         type: string
55304       entity-type:
55305         type: string
55306       top-entity-type:
55307         type: string
55308       entity-link:
55309         type: string
55310       status:
55311         type: string
55312   notify:
55313     required:
55314     - event-id
55315     properties:
55316       event-id:
55317         type: string
55318       node-type:
55319         type: string
55320       event-trigger:
55321         type: string
55322       key-data:
55323         type: array
55324         items:
55325           $ref: "#/getDefinitions/key-data"
55326       selflink:
55327         type: string
55328   oam-network:
55329     description: |
55330       OAM network, to be deprecated shortly.  Do not use for new purposes.
55331       ###### Related Nodes
55332       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55333       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
55334       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55335     required:
55336     - network-uuid
55337     - network-name
55338     - cvlan-tag
55339     properties:
55340       network-uuid:
55341         type: string
55342         description: UUID of the network. Unique across a cloud-region
55343       network-name:
55344         type: string
55345         description: Name of the network.
55346       cvlan-tag:
55347         type: integer
55348         format: int64
55349         description: cvlan-id
55350       ipv4-oam-gateway-address:
55351         type: string
55352         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55353       ipv4-oam-gateway-address-prefix-length:
55354         type: integer
55355         format: int32
55356         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55357       resource-version:
55358         type: string
55359         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55360       relationship-list:
55361         type: array
55362         items:
55363           $ref: "#/getDefinitions/relationship"
55364   oam-networks:
55365     description: |
55366       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
55367     properties:
55368       oam-network:
55369         type: array
55370         items:
55371           $ref: "#/getDefinitions/oam-network"
55372   operational-environment:
55373     description: |
55374       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55375       ###### Related Nodes
55376       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55377       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55378     required:
55379     - operational-environment-id
55380     - operational-environment-name
55381     - operational-environment-type
55382     - operational-environment-status
55383     - tenant-context
55384     - workload-context
55385     properties:
55386       operational-environment-id:
55387         type: string
55388         description: UUID of an operational environment
55389       operational-environment-name:
55390         type: string
55391         description: Operational Environment name
55392       operational-environment-type:
55393         type: string
55394         description: Operational Environment Type.
55395       operational-environment-status:
55396         type: string
55397         description: Status
55398       tenant-context:
55399         type: string
55400         description: Tenant Context.
55401       workload-context:
55402         type: string
55403         description: Workload Context.
55404       resource-version:
55405         type: string
55406         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55407       relationship-list:
55408         type: array
55409         items:
55410           $ref: "#/getDefinitions/relationship"
55411   operational-environments:
55412     description: |
55413       a logical partition of the cloud which allows to have multiple environments in the production AIC.
55414     properties:
55415       operational-environment:
55416         type: array
55417         items:
55418           $ref: "#/getDefinitions/operational-environment"
55419   overloaded-model:
55420     description: |
55421       Allows for legacy POST of old-style and new-style models
55422     required:
55423     - model-invariant-id
55424     - model-name-version-id
55425     - model-type
55426     - model-name
55427     - model-id
55428     - model-version
55429     properties:
55430       model-invariant-id:
55431         type: string
55432         description: Unique identifier corresponding to the main definition of a model in ASDC
55433       model-name-version-id:
55434         type: string
55435         description: Unique identifier corresponding to one version of a model in ASDC
55436       model-type:
55437         type: string
55438         description: Type of the model, e.g., service, resource, widget, etc.
55439       model-name:
55440         type: string
55441         description: Name of the model, which can change from version to version.
55442       model-id:
55443         type: string
55444         description: Invariant unique ID which does not change from version to version
55445       model-version:
55446         type: string
55447         description: Version
55448       model-description:
55449         type: string
55450         description: Description
55451       resource-version:
55452         type: string
55453         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55454       model-vers:
55455         type: object
55456         $ref: "#/getDefinitions/model-vers"
55457       relationship-list:
55458         type: object
55459         $ref: "#/getDefinitions/relationship-list"
55460   owning-entities:
55461     description: |
55462       Collection of owning-entities
55463     properties:
55464       owning-entity:
55465         type: array
55466         items:
55467           $ref: "#/getDefinitions/owning-entity"
55468   owning-entity:
55469     description: |
55470       describes an owning-entity
55471       ###### Related Nodes
55472       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
55473     required:
55474     - owning-entity-id
55475     - owning-entity-name
55476     properties:
55477       owning-entity-id:
55478         type: string
55479         description: UUID of an owning entity
55480       owning-entity-name:
55481         type: string
55482         description: Owning entity name
55483       resource-version:
55484         type: string
55485         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55486       relationship-list:
55487         type: array
55488         items:
55489           $ref: "#/getDefinitions/relationship"
55490   p-interface:
55491     description: |
55492       Physical interface (e.g., nic)
55493       ###### Related Nodes
55494       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55495       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55496       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55497       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55498       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55499       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55500       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55501       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
55502       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
55503     required:
55504     - interface-name
55505     properties:
55506       interface-name:
55507         type: string
55508         description: Name that identifies the physical interface
55509       speed-value:
55510         type: string
55511         description: Captures the numeric part of the speed
55512       speed-units:
55513         type: string
55514         description: Captures the units corresponding to the speed
55515       port-description:
55516         type: string
55517         description: Nature of the services and connectivity on this port.
55518       equipment-identifier:
55519         type: string
55520         description: CLEI or other specification for p-interface hardware.
55521       interface-role:
55522         type: string
55523         description: Role specification for p-interface hardware.
55524       interface-type:
55525         type: string
55526         description: Indicates the physical properties of the interface.
55527       resource-version:
55528         type: string
55529         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55530       relationship-list:
55531         type: array
55532         items:
55533           $ref: "#/getDefinitions/relationship"
55534       l-interfaces:
55535         type: array
55536         items:
55537           $ref: "#/getDefinitions/l-interface"
55538   p-interfaces:
55539     description: |
55540       Collection of physical interfaces.
55541     properties:
55542       p-interface:
55543         type: array
55544         items:
55545           $ref: "#/getDefinitions/p-interface"
55546   physical-link:
55547     description: |
55548       Collection of physical connections, typically between p-interfaces
55549       ###### Related Nodes
55550       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55551     required:
55552     - link-name
55553     properties:
55554       link-name:
55555         type: string
55556         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55557       speed-value:
55558         type: string
55559         description: Captures the numeric part of the speed
55560       speed-units:
55561         type: string
55562         description: Captures the units corresponding to the speed
55563       circuit-id:
55564         type: string
55565         description: Circuit it
55566       dual-mode:
55567         type: string
55568         description: Dual access mode (e.g., primary, secondary
55569       management-option:
55570         type: string
55571         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55572       service-provider-name:
55573         type: string
55574         description: Name of the service Provider on this link.
55575       resource-version:
55576         type: string
55577         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55578       relationship-list:
55579         type: array
55580         items:
55581           $ref: "#/getDefinitions/relationship"
55582   physical-links:
55583     description: |
55584       Collection of physical connections, typically between p-interfaces
55585     properties:
55586       physical-link:
55587         type: array
55588         items:
55589           $ref: "#/getDefinitions/physical-link"
55590   platform:
55591     description: |
55592       describes a platform
55593       ###### Related Nodes
55594       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55595     required:
55596     - platform-name
55597     properties:
55598       platform-name:
55599         type: string
55600         description: Name of the platform
55601       resource-version:
55602         type: string
55603         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55604       relationship-list:
55605         type: array
55606         items:
55607           $ref: "#/getDefinitions/relationship"
55608   platforms:
55609     description: |
55610       Collection of platforms
55611     properties:
55612       platform:
55613         type: array
55614         items:
55615           $ref: "#/getDefinitions/platform"
55616   pnf:
55617     description: |
55618       PNF represents a physical network function. typically equipment used in the D1 world.
55619       ###### Related Nodes
55620       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55621       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55622       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55623       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55624       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55625     required:
55626     - pnf-name
55627     - in-maint
55628     properties:
55629       pnf-name:
55630         type: string
55631         description: unique name of Physical Network Function.
55632       pnf-name2:
55633         type: string
55634         description: name of Physical Network Function.
55635       pnf-name2-source:
55636         type: string
55637         description: source of name2
55638       pnf-id:
55639         type: string
55640         description: id of pnf
55641       equip-type:
55642         type: string
55643         description: Equipment type.  Source of truth should define valid values.
55644       equip-vendor:
55645         type: string
55646         description: Equipment vendor.  Source of truth should define valid values.
55647       equip-model:
55648         type: string
55649         description: Equipment model.  Source of truth should define valid values.
55650       management-option:
55651         type: string
55652         description: identifier of managed by company or customer
55653       ipaddress-v4-oam:
55654         type: string
55655         description: ipv4-oam-address with new naming convention for IP addresses
55656       sw-version:
55657         type: string
55658         description: sw-version is the version of SW for the hosted application on the PNF.
55659       orchestration-status:
55660         type: string
55661         description: orchestration-status is the status of orchestration on the PNF.
55662       in-maint:
55663         type: boolean
55664       frame-id:
55665         type: string
55666         description: ID of the physical frame (relay rack) where pnf is installed.
55667       resource-version:
55668         type: string
55669         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55670       relationship-list:
55671         type: array
55672         items:
55673           $ref: "#/getDefinitions/relationship"
55674       p-interfaces:
55675         type: array
55676         items:
55677           $ref: "#/getDefinitions/p-interface"
55678       lag-interfaces:
55679         type: array
55680         items:
55681           $ref: "#/getDefinitions/lag-interface"
55682   pnfs:
55683     description: |
55684       Collection of Physical Network Functions.
55685     properties:
55686       pnf:
55687         type: array
55688         items:
55689           $ref: "#/getDefinitions/pnf"
55690   port-group:
55691     description: |
55692       Used to capture the network interfaces of this VCE
55693       ###### Related Nodes
55694       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55695       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
55696       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
55697     required:
55698     - interface-id
55699     - orchestration-status
55700     properties:
55701       interface-id:
55702         type: string
55703         description: Unique ID of the interface
55704       neutron-network-id:
55705         type: string
55706         description: Neutron network id of this Interface
55707       neutron-network-name:
55708         type: string
55709         description: Neutron network name of this Interface
55710       interface-role:
55711         type: string
55712         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55713       resource-version:
55714         type: string
55715         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55716       port-group-id:
55717         type: string
55718         description: Unique ID for port group in vmware
55719       port-group-name:
55720         type: string
55721         description: Likely to duplicate value of neutron network name
55722       switch-name:
55723         type: string
55724         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
55725       orchestration-status:
55726         type: string
55727         description: Orchestration status of this VNF, mastered by MSO
55728       heat-stack-id:
55729         type: string
55730         description: Heat stack id corresponding to this instance, managed by MSO
55731       mso-catalog-key:
55732         type: string
55733         description: Corresponds to the SDN-C catalog id used to configure this VCE
55734       cvlan-tags:
55735         type: array
55736         items:
55737           $ref: "#/getDefinitions/cvlan-tag-entry"
55738       relationship-list:
55739         type: array
55740         items:
55741           $ref: "#/getDefinitions/relationship"
55742   port-groups:
55743     properties:
55744       port-group:
55745         type: array
55746         items:
55747           $ref: "#/getDefinitions/port-group"
55748   project:
55749     description: |
55750       describes the project
55751       ###### Related Nodes
55752       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
55753     required:
55754     - project-name
55755     properties:
55756       project-name:
55757         type: string
55758         description: Name of the project deploying a service
55759       resource-version:
55760         type: string
55761         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55762       relationship-list:
55763         type: array
55764         items:
55765           $ref: "#/getDefinitions/relationship"
55766   projects:
55767     description: |
55768       Collection of projects
55769     properties:
55770       project:
55771         type: array
55772         items:
55773           $ref: "#/getDefinitions/project"
55774   properties:
55775     description: |
55776       Property holder for query properties or instance properties
55777     properties:
55778       property-name:
55779         type: string
55780       property-value:
55781         type: string
55782   property-constraint:
55783     description: |
55784       TBD
55785       ###### Related Nodes
55786       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55787     required:
55788     - property-constraint-uuid
55789     - constraint-type
55790     - property-name
55791     - property-value
55792     properties:
55793       property-constraint-uuid:
55794         type: string
55795       constraint-type:
55796         type: string
55797       property-name:
55798         type: string
55799       property-value:
55800         type: string
55801       resource-version:
55802         type: string
55803   property-constraints:
55804     properties:
55805       property-constraint:
55806         type: array
55807         items:
55808           $ref: "#/getDefinitions/property-constraint"
55809   pserver:
55810     description: |
55811       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
55812       ###### Related Nodes
55813       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
55814       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
55815       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
55816       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55817       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
55818       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55819       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55820       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55821       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
55822       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
55823       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55824       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
55825     required:
55826     - hostname
55827     - in-maint
55828     properties:
55829       hostname:
55830         type: string
55831         description: Value from executing hostname on the compute node.
55832       ptnii-equip-name:
55833         type: string
55834         description: PTNII name
55835       number-of-cpus:
55836         type: integer
55837         format: int32
55838         description: Number of cpus
55839       disk-in-gigabytes:
55840         type: integer
55841         format: int32
55842         description: Disk size, in GBs
55843       ram-in-megabytes:
55844         type: integer
55845         format: int32
55846         description: RAM size, in MBs
55847       equip-type:
55848         type: string
55849         description: Equipment type.  Source of truth should define valid values.
55850       equip-vendor:
55851         type: string
55852         description: Equipment vendor.  Source of truth should define valid values.
55853       equip-model:
55854         type: string
55855         description: Equipment model.  Source of truth should define valid values.
55856       fqdn:
55857         type: string
55858         description: Fully-qualified domain name
55859       pserver-selflink:
55860         type: string
55861         description: URL to endpoint where AAI can get more details
55862       ipv4-oam-address:
55863         type: string
55864         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
55865       serial-number:
55866         type: string
55867         description: Serial number, may be queried
55868       pserver-id:
55869         type: string
55870         description: ID of Pserver
55871       internet-topology:
55872         type: string
55873         description: internet topology of Pserver
55874       in-maint:
55875         type: boolean
55876       resource-version:
55877         type: string
55878         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55879       pserver-name2:
55880         type: string
55881         description: alternative pserver name
55882       purpose:
55883         type: string
55884         description: purpose of pserver
55885       relationship-list:
55886         type: array
55887         items:
55888           $ref: "#/getDefinitions/relationship"
55889       p-interfaces:
55890         type: array
55891         items:
55892           $ref: "#/getDefinitions/p-interface"
55893       lag-interfaces:
55894         type: array
55895         items:
55896           $ref: "#/getDefinitions/lag-interface"
55897   pservers:
55898     description: |
55899       Collection of compute hosts.
55900     properties:
55901       pserver:
55902         type: array
55903         items:
55904           $ref: "#/getDefinitions/pserver"
55905   query-parameters:
55906     description: |
55907       QueryParameters for performing a named-query or model query
55908     properties:
55909       named-query:
55910         type: object
55911         $ref: "#/getDefinitions/named-query"
55912       model:
55913         type: object
55914         $ref: "#/getDefinitions/model"
55915   related-lookup:
55916     description: |
55917       TBD
55918       ###### Related Nodes
55919       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55920     required:
55921     - related-lookup-uuid
55922     - source-node-type
55923     - source-node-property
55924     - target-node-type
55925     - target-node-property
55926     properties:
55927       related-lookup-uuid:
55928         type: string
55929       source-node-type:
55930         type: string
55931       source-node-property:
55932         type: string
55933       target-node-type:
55934         type: string
55935       target-node-property:
55936         type: string
55937       property-collect-list:
55938         type: string
55939       resource-version:
55940         type: string
55941       relationship-list:
55942         type: array
55943         items:
55944           $ref: "#/getDefinitions/relationship"
55945   related-lookups:
55946     properties:
55947       related-lookup:
55948         type: array
55949         items:
55950           $ref: "#/getDefinitions/related-lookup"
55951   related-to-property:
55952     properties:
55953       property-key:
55954         type: string
55955         description: Key part of a key/value pair
55956       property-value:
55957         type: string
55958         description: Value part of a key/value pair
55959   relationship:
55960     properties:
55961       related-to:
55962         type: string
55963         description: A keyword provided by A&AI to indicate type of node.
55964       related-link:
55965         type: string
55966         description: URL to the object in A&AI.
55967       relationship-data:
55968         type: array
55969         items:
55970           $ref: "#/getDefinitions/relationship-data"
55971       related-to-property:
55972         type: array
55973         items:
55974           $ref: "#/getDefinitions/related-to-property"
55975   relationship-data:
55976     required:
55977     - relationship-key
55978     - relationship-value
55979     properties:
55980       relationship-key:
55981         type: string
55982         description: A keyword provided by A&AI to indicate an attribute.
55983       relationship-value:
55984         type: string
55985         description: Value of the attribute.
55986   relationship-list:
55987     properties:
55988       relationship:
55989         type: array
55990         items:
55991           $ref: "#/getDefinitions/relationship"
55992   reserved-prop-names:
55993     description: |
55994       Internal map to define some reserved properties of a vertex
55995     properties:
55996       last-mod-source-of-truth:
55997         type: string
55998       aai-node-type:
55999         type: string
56000       aai-created-ts:
56001         type: integer
56002         format: int64
56003       aai-unique-key:
56004         type: string
56005       aai-last-mod-ts:
56006         type: integer
56007         format: int64
56008       source-of-truth:
56009         type: string
56010   response-list:
56011     description: |
56012       Response container for the results of a named-query or model query
56013     properties:
56014       inventory-response-items:
56015         type: object
56016         $ref: "#/getDefinitions/inventory-response-items"
56017   result-data:
56018     properties:
56019       resource-type:
56020         type: string
56021         description: The specific type of node in the A&AI graph
56022       resource-link:
56023         type: string
56024         description: The URL to the specific resource
56025   route-table-reference:
56026     description: |
56027       Openstack route table reference.
56028       ###### Related Nodes
56029       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56030     required:
56031     - route-table-reference-id
56032     - route-table-reference-fqdn
56033     properties:
56034       route-table-reference-id:
56035         type: string
56036         description: Route Table Reference id, UUID assigned to this instance.
56037       route-table-reference-fqdn:
56038         type: string
56039         description: FQDN entry in the route table.
56040       resource-version:
56041         type: string
56042         description: Concurrency value
56043       relationship-list:
56044         type: array
56045         items:
56046           $ref: "#/getDefinitions/relationship"
56047   route-table-references:
56048     description: |
56049       Collection of openstack route table references
56050     properties:
56051       route-table-reference:
56052         type: array
56053         items:
56054           $ref: "#/getDefinitions/route-table-reference"
56055   route-target:
56056     description: |
56057       Route target information
56058       ###### Related Nodes
56059       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
56060     required:
56061     - global-route-target
56062     - route-target-role
56063     properties:
56064       global-route-target:
56065         type: string
56066         description: Number used to identify an RT, globally unique in the network
56067       route-target-role:
56068         type: string
56069         description: Role assigned to this route target
56070       resource-version:
56071         type: string
56072         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56073       relationship-list:
56074         type: array
56075         items:
56076           $ref: "#/getDefinitions/relationship"
56077   route-targets:
56078     description: |
56079       Collection of route target information
56080     properties:
56081       route-target:
56082         type: array
56083         items:
56084           $ref: "#/getDefinitions/route-target"
56085   routing-instance:
56086     description: |
56087       ###### Related Nodes
56088       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56089       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56090       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
56091     required:
56092     - routing-instance-id
56093     properties:
56094       routing-instance-id:
56095         type: string
56096         description: Unique id of routing instance
56097       rpm-owner:
56098         type: string
56099         description: rpm owner
56100       resource-version:
56101         type: string
56102         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56103       site-pairs:
56104         type: array
56105         items:
56106           $ref: "#/getDefinitions/site-pair"
56107       relationship-list:
56108         type: array
56109         items:
56110           $ref: "#/getDefinitions/relationship"
56111   routing-instances:
56112     description: |
56113       set of probes related to generic-vnf routing instance
56114     properties:
56115       routing-instance:
56116         type: array
56117         items:
56118           $ref: "#/getDefinitions/routing-instance"
56119   sdn-zone-response:
56120     properties:
56121       oam-networks:
56122         type: object
56123         $ref: "#/getDefinitions/oam-networks"
56124       az-and-dvs-switches:
56125         type: array
56126         items:
56127           $ref: "#/getDefinitions/az-and-dvs-switches"
56128   search:
56129     properties:
56130       edge-tag-query-result:
56131         type: object
56132         $ref: "#/getDefinitions/edge-tag-query-result"
56133       edge-tag-query-request:
56134         type: object
56135         $ref: "#/getDefinitions/edge-tag-query-request"
56136       search-results:
56137         type: object
56138         $ref: "#/getDefinitions/search-results"
56139       sdn-zone-response:
56140         type: object
56141         $ref: "#/getDefinitions/sdn-zone-response"
56142   search-results:
56143     properties:
56144       result-data:
56145         type: array
56146         items:
56147           $ref: "#/getDefinitions/result-data"
56148   secondary-filt:
56149     description: |
56150       SecondaryFilt for performing a named-query or model query
56151   secondary-filter:
56152     properties:
56153       property-name:
56154         type: string
56155       filter-type:
56156         type: string
56157       property-value:
56158         type: string
56159   secondary-filts:
56160     description: |
56161       SecondaryFilts for performing a named-query or model query
56162     properties:
56163       secondary-filt:
56164         type: array
56165         items:
56166           $ref: "#/getDefinitions/secondary-filt"
56167   segmentation-assignment:
56168     description: |
56169       Openstack segmentation assignment.
56170       ###### Related Nodes
56171       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56172     required:
56173     - segmentation-id
56174     properties:
56175       segmentation-id:
56176         type: string
56177         description: Route Table Reference id, UUID assigned to this instance.
56178       resource-version:
56179         type: string
56180         description: Concurrency value
56181       relationship-list:
56182         type: array
56183         items:
56184           $ref: "#/getDefinitions/relationship"
56185   segmentation-assignments:
56186     description: |
56187       Collection of openstack segmentation assignments
56188     properties:
56189       segmentation-assignment:
56190         type: array
56191         items:
56192           $ref: "#/getDefinitions/segmentation-assignment"
56193   service:
56194     description: |
56195       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.
56196     required:
56197     - service-id
56198     - service-description
56199     properties:
56200       service-id:
56201         type: string
56202         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56203       service-description:
56204         type: string
56205         description: Description of the service
56206       service-selflink:
56207         type: string
56208         description: URL to endpoint where AAI can get more details
56209       resource-version:
56210         type: string
56211         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56212       service-version:
56213         type: string
56214         description: service version
56215       relationship-list:
56216         type: array
56217         items:
56218           $ref: "#/getDefinitions/relationship"
56219   service-capabilities:
56220     description: |
56221       Collection of service capabilities.
56222     properties:
56223       service-capability:
56224         type: array
56225         items:
56226           $ref: "#/getDefinitions/service-capability"
56227   service-capability:
56228     description: |
56229       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
56230       ###### Related Nodes
56231       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56232       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56233       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
56234     required:
56235     - service-type
56236     - vnf-type
56237     properties:
56238       service-type:
56239         type: string
56240         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56241       vnf-type:
56242         type: string
56243         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
56244       resource-version:
56245         type: string
56246         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56247       relationship-list:
56248         type: array
56249         items:
56250           $ref: "#/getDefinitions/relationship"
56251   service-design-and-creation:
56252     description: |
56253       Namespace for objects managed by ASDC
56254     properties:
56255       vnf-images:
56256         type: array
56257         items:
56258           $ref: "#/getDefinitions/vnf-image"
56259       services:
56260         type: array
56261         items:
56262           $ref: "#/getDefinitions/service"
56263       service-capabilities:
56264         type: array
56265         items:
56266           $ref: "#/getDefinitions/service-capability"
56267       models:
56268         type: array
56269         items:
56270           $ref: "#/getDefinitions/model"
56271       named-queries:
56272         type: array
56273         items:
56274           $ref: "#/getDefinitions/named-query"
56275   service-instance:
56276     description: |
56277       Instance of a service
56278       ###### Related Nodes
56279       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
56280       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56281       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
56282       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
56283       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56284       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56285       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56286       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56287       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56288       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56289       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56290       - SERVICE-INSTANCE is DELETED when these are DELETED METADATUM
56291       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56292     required:
56293     - service-instance-id
56294     properties:
56295       service-instance-id:
56296         type: string
56297         description: Uniquely identifies this instance of a service
56298       service-instance-name:
56299         type: string
56300         description: This field will store a name assigned to the service-instance.
56301       persona-model-id:
56302         type: string
56303         description: the ASDC model id for this resource or service model.
56304       persona-model-version:
56305         type: string
56306         description: the ASDC model version for this resource or service model.
56307       model-version-id:
56308         type: string
56309         description: the ASDC model version for this resource or service model.
56310       widget-model-id:
56311         type: string
56312         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56313       widget-model-version:
56314         type: string
56315         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56316       bandwidth-total:
56317         type: string
56318         description: Indicates the total bandwidth to be used for this service.
56319       bandwidth-up-wan1:
56320         type: string
56321         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56322       bandwidth-down-wan1:
56323         type: string
56324         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56325       bandwidth-up-wan2:
56326         type: string
56327         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56328       bandwidth-down-wan2:
56329         type: string
56330         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56331       vhn-portal-url:
56332         type: string
56333         description: URL customers will use to access the vHN Portal.
56334       service-instance-location-id:
56335         type: string
56336         description: An identifier that customers assign to the location where this service is being used.
56337       resource-version:
56338         type: string
56339         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56340       relationship-list:
56341         type: array
56342         items:
56343           $ref: "#/getDefinitions/relationship"
56344       metadata:
56345         type: array
56346         items:
56347           $ref: "#/getDefinitions/metadatum"
56348   service-instances:
56349     description: |
56350       Collection of service instances
56351     properties:
56352       service-instance:
56353         type: array
56354         items:
56355           $ref: "#/getDefinitions/service-instance"
56356   service-subscription:
56357     description: |
56358       Object that group service instances.
56359       ###### Related Nodes
56360       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
56361       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56362       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56363       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
56364     required:
56365     - service-type
56366     properties:
56367       service-type:
56368         type: string
56369         description: Value defined by orchestration to identify this service across ECOMP.
56370       temp-ub-sub-account-id:
56371         type: string
56372         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56373       resource-version:
56374         type: string
56375         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56376       service-instances:
56377         type: array
56378         items:
56379           $ref: "#/getDefinitions/service-instance"
56380       relationship-list:
56381         type: array
56382         items:
56383           $ref: "#/getDefinitions/relationship"
56384   service-subscriptions:
56385     description: |
56386       Collection of objects that group service instances.
56387     properties:
56388       service-subscription:
56389         type: array
56390         items:
56391           $ref: "#/getDefinitions/service-subscription"
56392   services:
56393     description: |
56394       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
56395     properties:
56396       service:
56397         type: array
56398         items:
56399           $ref: "#/getDefinitions/service"
56400   site-pair:
56401     description: |
56402       ###### Related Nodes
56403       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56404       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56405       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
56406     required:
56407     - site-pair-id
56408     properties:
56409       site-pair-id:
56410         type: string
56411         description: unique identifier of probe
56412       source-ip:
56413         type: string
56414         description: Prefix address
56415       destination-ip:
56416         type: string
56417         description: Prefix address
56418       ip-version:
56419         type: string
56420         description: ip version, v4, v6
56421       destination-hostname:
56422         type: string
56423         description: Hostname of the destination equipment to which SLAs are measured against.
56424       destination-equip-type:
56425         type: string
56426         description: The type of destinatination equipment. Could be Router, etc.
56427       resource-version:
56428         type: string
56429         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56430       classes-of-service:
56431         type: array
56432         items:
56433           $ref: "#/getDefinitions/class-of-service"
56434       relationship-list:
56435         type: array
56436         items:
56437           $ref: "#/getDefinitions/relationship"
56438   site-pair-set:
56439     description: |
56440       Set of instances for probes used to measure service level agreements
56441       ###### Related Nodes
56442       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56443       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56444       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
56445     required:
56446     - site-pair-set-id
56447     properties:
56448       site-pair-set-id:
56449         type: string
56450         description: Unique id of site pair set.
56451       resource-version:
56452         type: string
56453         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56454       routing-instances:
56455         type: array
56456         items:
56457           $ref: "#/getDefinitions/routing-instance"
56458       relationship-list:
56459         type: array
56460         items:
56461           $ref: "#/getDefinitions/relationship"
56462   site-pair-sets:
56463     description: |
56464       Collection of sets of instances for probes related to generic-vnf
56465     properties:
56466       site-pair-set:
56467         type: array
56468         items:
56469           $ref: "#/getDefinitions/site-pair-set"
56470   site-pairs:
56471     description: |
56472       probe within a set
56473     properties:
56474       site-pair:
56475         type: array
56476         items:
56477           $ref: "#/getDefinitions/site-pair"
56478   snapshot:
56479     description: |
56480       Openstack snapshot
56481       ###### Related Nodes
56482       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56483       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56484     required:
56485     - snapshot-id
56486     properties:
56487       snapshot-id:
56488         type: string
56489         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56490       snapshot-name:
56491         type: string
56492         description: Snapshot name
56493       snapshot-architecture:
56494         type: string
56495         description: Operating system architecture
56496       snapshot-os-distro:
56497         type: string
56498         description: The common name of the operating system distribution in lowercase
56499       snapshot-os-version:
56500         type: string
56501         description: The operating system version as specified by the distributor.
56502       application:
56503         type: string
56504         description: The application that the image instantiates.
56505       application-vendor:
56506         type: string
56507         description: The vendor of the application.
56508       application-version:
56509         type: string
56510         description: The version of the application.
56511       snapshot-selflink:
56512         type: string
56513         description: URL to endpoint where AAI can get more details
56514       prev-snapshot-id:
56515         type: string
56516         description: This field contains the UUID of the previous snapshot (if any).
56517       resource-version:
56518         type: string
56519         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56520       relationship-list:
56521         type: array
56522         items:
56523           $ref: "#/getDefinitions/relationship"
56524   snapshots:
56525     description: |
56526       Collection of openstack snapshots
56527     properties:
56528       snapshot:
56529         type: array
56530         items:
56531           $ref: "#/getDefinitions/snapshot"
56532   sriov-pf:
56533     description: |
56534       SR-IOV Physical Function
56535       ###### Related Nodes
56536       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56537       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56538     required:
56539     - pf-pci-id
56540     properties:
56541       pf-pci-id:
56542         type: string
56543         description: Identifier for the sriov-pf
56544       resource-version:
56545         type: string
56546         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56547       relationship-list:
56548         type: array
56549         items:
56550           $ref: "#/getDefinitions/relationship"
56551   sriov-pfs:
56552     description: |
56553       Collection of SR-IOV Physical Functions.
56554     properties:
56555       sriov-pf:
56556         type: array
56557         items:
56558           $ref: "#/getDefinitions/sriov-pf"
56559   sriov-vf:
56560     description: |
56561       SR-IOV Virtual Function (not to be confused with virtual network function)
56562       ###### Related Nodes
56563       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56564     required:
56565     - pci-id
56566     properties:
56567       pci-id:
56568         type: string
56569         description: PCI ID used to identify the sriov-vf
56570       vf-vlan-filter:
56571         type: string
56572         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56573       vf-mac-filter:
56574         type: string
56575         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56576       vf-vlan-strip:
56577         type: boolean
56578         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56579       vf-vlan-anti-spoof-check:
56580         type: boolean
56581         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.
56582       vf-mac-anti-spoof-check:
56583         type: boolean
56584         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.
56585       vf-mirrors:
56586         type: string
56587         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56588       vf-broadcast-allow:
56589         type: boolean
56590         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56591       vf-unknown-multicast-allow:
56592         type: boolean
56593         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56594       vf-unknown-unicast-allow:
56595         type: boolean
56596         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56597       vf-insert-stag:
56598         type: boolean
56599         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56600       vf-link-status:
56601         type: string
56602         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
56603       resource-version:
56604         type: string
56605         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56606       neutron-network-id:
56607         type: string
56608         description: Neutron network id of the interface
56609       relationship-list:
56610         type: array
56611         items:
56612           $ref: "#/getDefinitions/relationship"
56613   sriov-vfs:
56614     description: |
56615       Collection of SR-IOV Virtual Functions.
56616     properties:
56617       sriov-vf:
56618         type: array
56619         items:
56620           $ref: "#/getDefinitions/sriov-vf"
56621   start-node-filter:
56622     properties:
56623       property-name:
56624         type: string
56625       property-value:
56626         type: string
56627   subnet:
56628     description: |
56629       ###### Related Nodes
56630       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56631       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56632       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56633       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56634     required:
56635     - subnet-id
56636     - dhcp-enabled
56637     properties:
56638       subnet-id:
56639         type: string
56640         description: Subnet ID, should be UUID.
56641       subnet-name:
56642         type: string
56643         description: Name associated with the subnet.
56644       neutron-subnet-id:
56645         type: string
56646         description: Neutron id of this subnet
56647       gateway-address:
56648         type: string
56649         description: gateway ip address
56650       network-start-address:
56651         type: string
56652         description: network start address
56653       cidr-mask:
56654         type: string
56655         description: cidr mask
56656       ip-version:
56657         type: string
56658         description: ip version
56659       orchestration-status:
56660         type: string
56661         description: Orchestration status of this VNF, mastered by MSO
56662       dhcp-enabled:
56663         type: boolean
56664       dhcp-start:
56665         type: string
56666         description: the start address reserved for use by dhcp
56667       dhcp-end:
56668         type: string
56669         description: the last address reserved for use by dhcp
56670       resource-version:
56671         type: string
56672         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56673       relationship-list:
56674         type: array
56675         items:
56676           $ref: "#/getDefinitions/relationship"
56677   subnets:
56678     properties:
56679       subnet:
56680         type: array
56681         items:
56682           $ref: "#/getDefinitions/subnet"
56683   tagged-inventory-item-list:
56684     properties:
56685       inventory-item:
56686         type: array
56687         items:
56688           $ref: "#/getDefinitions/inventory-item"
56689   tenant:
56690     description: |
56691       Openstack tenant
56692       ###### Related Nodes
56693       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56694       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
56695       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
56696       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
56697       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56698       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
56699       - TENANT cannot be deleted if linked to VSERVER
56700     required:
56701     - tenant-id
56702     - tenant-name
56703     properties:
56704       tenant-id:
56705         type: string
56706         description: Unique id relative to the cloud-region.
56707       tenant-name:
56708         type: string
56709         description: Readable name of tenant
56710       resource-version:
56711         type: string
56712         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56713       vservers:
56714         type: array
56715         items:
56716           $ref: "#/getDefinitions/vserver"
56717       relationship-list:
56718         type: array
56719         items:
56720           $ref: "#/getDefinitions/relationship"
56721   tenants:
56722     description: |
56723       Collection of openstack tenants.
56724     properties:
56725       tenant:
56726         type: array
56727         items:
56728           $ref: "#/getDefinitions/tenant"
56729   tunnel-xconnect:
56730     description: |
56731       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
56732       ###### Related Nodes
56733       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
56734     required:
56735     - id
56736     - bandwidth-up-wan1
56737     - bandwidth-down-wan1
56738     - bandwidth-up-wan2
56739     - bandwidth-down-wan2
56740     properties:
56741       id:
56742         type: string
56743         description: Allotted Resource id UUID assigned to this instance.
56744       bandwidth-up-wan1:
56745         type: string
56746         description: The WAN uplink bandwidth for WAN1
56747       bandwidth-down-wan1:
56748         type: string
56749         description: The WAN downlink bandwidth for WAN1
56750       bandwidth-up-wan2:
56751         type: string
56752         description: The WAN uplink bandwidth for WAN2
56753       bandwidth-down-wan2:
56754         type: string
56755         description: The WAN downlink bandwidth for WAN2
56756       resource-version:
56757         type: string
56758         description: Concurrency value
56759       relationship-list:
56760         type: array
56761         items:
56762           $ref: "#/getDefinitions/relationship"
56763   tunnel-xconnects:
56764     description: |
56765       This object is used to store the specific tunnel cross connect aspects of an allotted resource
56766     properties:
56767       tunnel-xconnect:
56768         type: array
56769         items:
56770           $ref: "#/getDefinitions/tunnel-xconnect"
56771   update:
56772     description: |
56773       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
56774     required:
56775     - update-node-type
56776     properties:
56777       update-node-type:
56778         type: string
56779       update-node-key:
56780         type: array
56781         items:
56782           $ref: "#/getDefinitions/update-node-key"
56783       update-node-uri:
56784         type: string
56785       action:
56786         type: array
56787         items:
56788           $ref: "#/getDefinitions/action"
56789   update-node-key:
56790     properties:
56791       key-name:
56792         type: string
56793       key-value:
56794         type: string
56795   vce:
56796     description: |
56797       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
56798       ###### Related Nodes
56799       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
56800       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
56801       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
56802       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56803       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56804       - VCE is DELETED when these are DELETED PORT-GROUP
56805     required:
56806     - vnf-id
56807     - vnf-name
56808     - vnf-type
56809     properties:
56810       vnf-id:
56811         type: string
56812         description: Unique id of VNF.  This is unique across the graph.
56813       vnf-name:
56814         type: string
56815         description: Name of VNF.
56816       vnf-name2:
56817         type: string
56818         description: Alternate name of VNF.
56819       vnf-type:
56820         type: string
56821         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
56822       service-id:
56823         type: string
56824         description: Unique identifier of service from ASDC.  Expect this to change as ASDC matures.
56825       regional-resource-zone:
56826         type: string
56827         description: Regional way of organizing pservers, source of truth should define values
56828       prov-status:
56829         type: string
56830         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56831       operational-state:
56832         type: string
56833         description: Indicator for whether the resource is considered operational
56834       license-key:
56835         type: string
56836         description: License key
56837       equipment-role:
56838         type: string
56839         description: Network role being played by this VNF
56840       orchestration-status:
56841         type: string
56842         description: Orchestration status of this VNF, mastered by MSO
56843       heat-stack-id:
56844         type: string
56845         description: Heat stack id corresponding to this instance, managed by MSO
56846       mso-catalog-key:
56847         type: string
56848         description: Corresponds to the SDN-C catalog id used to configure this VCE
56849       vpe-id:
56850         type: string
56851         description: Unique ID of VPE connected to this VCE.
56852       v6-vce-wan-address:
56853         type: string
56854         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
56855       ipv4-oam-address:
56856         type: string
56857         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
56858       resource-version:
56859         type: string
56860         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56861       ipv4-loopback0-address:
56862         type: string
56863         description: Loopback0 address
56864       entitlement-resource-uuid:
56865         type: string
56866         description: Entitlement resource uuid
56867       port-groups:
56868         type: array
56869         items:
56870           $ref: "#/getDefinitions/port-group"
56871       relationship-list:
56872         type: array
56873         items:
56874           $ref: "#/getDefinitions/relationship"
56875   vces:
56876     description: |
56877       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
56878     properties:
56879       vce:
56880         type: array
56881         items:
56882           $ref: "#/getDefinitions/vce"
56883   vf-module:
56884     description: |
56885       a deployment unit of VNFCs
56886       ###### Related Nodes
56887       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
56888       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
56889       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
56890       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
56891       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
56892       - VF-MODULE cannot be deleted if linked to VNFC
56893     required:
56894     - vf-module-id
56895     - is-base-vf-module
56896     properties:
56897       vf-module-id:
56898         type: string
56899         description: Unique ID of vf-module.
56900       vf-module-name:
56901         type: string
56902         description: Name of vf-module
56903       heat-stack-id:
56904         type: string
56905         description: Heat stack id corresponding to this instance.
56906       orchestration-status:
56907         type: string
56908         description: orchestration status of this vf-module, mastered by MSO
56909       is-base-vf-module:
56910         type: boolean
56911       resource-version:
56912         type: string
56913         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56914       persona-model-id:
56915         type: string
56916         description: the ASDC model id for this resource or service model.
56917       persona-model-version:
56918         type: string
56919         description: the ASDC model version for this resource or service model.
56920       model-version-id:
56921         type: string
56922         description: the ASDC model version for this resource or service model.
56923       widget-model-id:
56924         type: string
56925         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56926       widget-model-version:
56927         type: string
56928         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56929       contrail-service-instance-fqdn:
56930         type: string
56931         description: the Contrail unique ID for a service-instance
56932       relationship-list:
56933         type: array
56934         items:
56935           $ref: "#/getDefinitions/relationship"
56936   vf-modules:
56937     description: |
56938       Collection of vf-modules, a deployment unit of VNFCs
56939     properties:
56940       vf-module:
56941         type: array
56942         items:
56943           $ref: "#/getDefinitions/vf-module"
56944   vig-server:
56945     description: |
56946       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
56947       ###### Related Nodes
56948       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
56949     required:
56950     - vig-address-type
56951     properties:
56952       vig-address-type:
56953         type: string
56954         description: indicates whether the VIG is for AVPN or INTERNET
56955       ipaddress-v4-vig:
56956         type: string
56957         description: v4 IP of the vig server
56958       ipaddress-v6-vig:
56959         type: string
56960         description: v6 IP of the vig server
56961       resource-version:
56962         type: string
56963         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56964       relationship-list:
56965         type: array
56966         items:
56967           $ref: "#/getDefinitions/relationship"
56968   vig-servers:
56969     properties:
56970       vig-server:
56971         type: array
56972         items:
56973           $ref: "#/getDefinitions/vig-server"
56974   vip-ipv4-address-list:
56975     description: |
56976       IPv4 Address Range
56977       ###### Related Nodes
56978       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56979       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56980       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56981       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
56982     required:
56983     - vip-ipv4-address
56984     properties:
56985       vip-ipv4-address:
56986         type: string
56987         description: IP address
56988       vip-ipv4-prefix-length:
56989         type: integer
56990         format: int64
56991         description: Prefix length, 32 for single address
56992       vlan-id-inner:
56993         type: integer
56994         format: int64
56995         description: Inner VLAN tag
56996       vlan-id-outer:
56997         type: integer
56998         format: int64
56999         description: Outer VLAN tag
57000       is-floating:
57001         type: boolean
57002         description: Indicator of fixed or floating address
57003       resource-version:
57004         type: string
57005         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57006       neutron-network-id:
57007         type: string
57008         description: Neutron network id of the interface that address belongs to
57009       neutron-subnet-id:
57010         type: string
57011         description: Neutron id of subnet that address belongs to
57012       relationship-list:
57013         type: array
57014         items:
57015           $ref: "#/getDefinitions/relationship"
57016   vip-ipv6-address-list:
57017     description: |
57018       IPv6 Address Range
57019       ###### Related Nodes
57020       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57021       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57022       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57023       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57024     required:
57025     - vip-ipv6-address
57026     properties:
57027       vip-ipv6-address:
57028         type: string
57029         description: IP address
57030       vip-ipv6-prefix-length:
57031         type: integer
57032         format: int64
57033         description: Prefix length, 128 for single address
57034       vlan-id-inner:
57035         type: integer
57036         format: int64
57037         description: Inner VLAN tag
57038       vlan-id-outer:
57039         type: integer
57040         format: int64
57041         description: Outer VLAN tag
57042       is-floating:
57043         type: boolean
57044         description: Indicator of fixed or floating address
57045       resource-version:
57046         type: string
57047         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57048       neutron-network-id:
57049         type: string
57050         description: Neutron network id of the interface that address belongs to
57051       neutron-subnet-id:
57052         type: string
57053         description: Neutron id of subnet that address belongs to
57054       relationship-list:
57055         type: array
57056         items:
57057           $ref: "#/getDefinitions/relationship"
57058   virtual-data-center:
57059     description: |
57060       Virtual organization of cloud infrastructure elements in a data center context
57061       ###### Related Nodes
57062       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57063       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57064       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57065     required:
57066     - vdc-id
57067     - vdc-name
57068     properties:
57069       vdc-id:
57070         type: string
57071         description: Unique ID of the vdc
57072       vdc-name:
57073         type: string
57074         description: Name of the virtual data center
57075       resource-version:
57076         type: string
57077         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57078       relationship-list:
57079         type: array
57080         items:
57081           $ref: "#/getDefinitions/relationship"
57082   virtual-data-centers:
57083     description: |
57084       Virtual organization of cloud infrastructure elements in a data center context
57085     properties:
57086       virtual-data-center:
57087         type: array
57088         items:
57089           $ref: "#/getDefinitions/virtual-data-center"
57090   vlan:
57091     description: |
57092       Definition of vlan
57093       ###### Related Nodes
57094       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
57095       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57096       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57097       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57098       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57099       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57100       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57101       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57102     required:
57103     - vlan-interface
57104     properties:
57105       vlan-interface:
57106         type: string
57107         description: String that identifies the interface
57108       vlan-id-inner:
57109         type: integer
57110         format: int64
57111         description: Inner VLAN tag
57112       vlan-id-outer:
57113         type: integer
57114         format: int64
57115         description: Outer VLAN tag
57116       resource-version:
57117         type: string
57118         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57119       speed-value:
57120         type: string
57121         description: Captures the numeric part of the speed
57122       speed-units:
57123         type: string
57124         description: Captures the units corresponding to the speed
57125       vlan-description:
57126         type: string
57127         description: Used to describe (the service associated with) the vlan
57128       backdoor-connection:
57129         type: string
57130         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
57131       vpn-id:
57132         type: string
57133         description: This indicates the customers VPN ID associated with this vlan
57134       relationship-list:
57135         type: array
57136         items:
57137           $ref: "#/getDefinitions/relationship"
57138       l3-interface-ipv4-address-list:
57139         type: array
57140         items:
57141           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
57142       l3-interface-ipv6-address-list:
57143         type: array
57144         items:
57145           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
57146   vlans:
57147     properties:
57148       vlan:
57149         type: array
57150         items:
57151           $ref: "#/getDefinitions/vlan"
57152   vnf:
57153     description: |
57154       Abstract vnf class
57155     required:
57156     - vnf-id
57157     properties:
57158       vnf-id:
57159         type: string
57160         description: Unique id of VNF.  This is unique across the graph.
57161   vnf-image:
57162     description: |
57163       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
57164       ###### Related Nodes
57165       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57166       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
57167     required:
57168     - vnf-image-uuid
57169     - application
57170     - application-vendor
57171     properties:
57172       vnf-image-uuid:
57173         type: string
57174         description: Unique ID of this asset
57175       application:
57176         type: string
57177         description: The application that the image instantiates.
57178       application-vendor:
57179         type: string
57180         description: The vendor of the application.
57181       application-version:
57182         type: string
57183         description: The version of the application.
57184       selflink:
57185         type: string
57186         description: URL to endpoint where AAI can get more details
57187       resource-version:
57188         type: string
57189         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57190       relationship-list:
57191         type: array
57192         items:
57193           $ref: "#/getDefinitions/relationship"
57194   vnf-images:
57195     description: |
57196       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
57197     properties:
57198       vnf-image:
57199         type: array
57200         items:
57201           $ref: "#/getDefinitions/vnf-image"
57202   vnfc:
57203     description: |
57204       ###### Related Nodes
57205       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57206       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57207       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57208     required:
57209     - vnfc-name
57210     - vnfc-function-code
57211     - vnfc-type
57212     - in-maint
57213     - is-closed-loop-disabled
57214     properties:
57215       vnfc-name:
57216         type: string
57217         description: Unique ID of vnfc.
57218       vnfc-function-code:
57219         type: string
57220         description: function code
57221       vnfc-type:
57222         type: string
57223         description: type
57224       prov-status:
57225         type: string
57226         description: prov status of this vnfc
57227       orchestration-status:
57228         type: string
57229         description: Orchestration status of this VNF, mastered by APP-C
57230       ipaddress-v4-oam-vip:
57231         type: string
57232         description: Oam V4 vip address of this vnfc
57233       in-maint:
57234         type: boolean
57235       is-closed-loop-disabled:
57236         type: boolean
57237       group-notation:
57238         type: string
57239         description: Group notation of VNFC
57240       resource-version:
57241         type: string
57242         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57243       relationship-list:
57244         type: array
57245         items:
57246           $ref: "#/getDefinitions/relationship"
57247   vnfcs:
57248     description: |
57249       virtual network components associated with a vserver from application controller.
57250     properties:
57251       vnfc:
57252         type: array
57253         items:
57254           $ref: "#/getDefinitions/vnfc"
57255   volume:
57256     description: |
57257       Ephemeral Block storage volume.
57258       ###### Related Nodes
57259       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
57260     required:
57261     - volume-id
57262     - volume-selflink
57263     properties:
57264       volume-id:
57265         type: string
57266         description: Unique ID of block storage volume relative to the vserver.
57267       volume-selflink:
57268         type: string
57269         description: URL to endpoint where AAI can get more details
57270       resource-version:
57271         type: string
57272         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57273       relationship-list:
57274         type: array
57275         items:
57276           $ref: "#/getDefinitions/relationship"
57277   volume-group:
57278     description: |
57279       Persistent block-level storage.
57280       ###### Related Nodes
57281       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57282       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57283       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57284       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57285       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57286     required:
57287     - volume-group-id
57288     - volume-group-name
57289     - vnf-type
57290     properties:
57291       volume-group-id:
57292         type: string
57293         description: Unique ID of volume-group.
57294       volume-group-name:
57295         type: string
57296         description: Name of the volume group.
57297       heat-stack-id:
57298         type: string
57299         description: Heat stack id corresponding to this volume-group
57300       vnf-type:
57301         type: string
57302         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded and clients should expect changes                  to occur in the future to this field as ASDC matures.
57303       orchestration-status:
57304         type: string
57305         description: Orchestration status of this volume-group
57306       resource-version:
57307         type: string
57308         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57309       relationship-list:
57310         type: array
57311         items:
57312           $ref: "#/getDefinitions/relationship"
57313   volume-groups:
57314     description: |
57315       Collection of persistent block-level storage.
57316     properties:
57317       volume-group:
57318         type: array
57319         items:
57320           $ref: "#/getDefinitions/volume-group"
57321   volumes:
57322     description: |
57323       Collection of ephemeral Block storage volumes.
57324     properties:
57325       volume:
57326         type: array
57327         items:
57328           $ref: "#/getDefinitions/volume"
57329   vpls-pe:
57330     description: |
57331       VPLS Provider Edge routers.
57332       ###### Related Nodes
57333       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57334       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57335       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57336       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57337       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57338     required:
57339     - equipment-name
57340     properties:
57341       equipment-name:
57342         type: string
57343       prov-status:
57344         type: string
57345         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57346       ipv4-oam-address:
57347         type: string
57348         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
57349       equipment-role:
57350         type: string
57351         description: Client should send valid enumerated value, e.g., VPLS-PE.
57352       vlan-id-outer:
57353         type: integer
57354         format: int64
57355         description: Temporary location for stag to get to VCE
57356       resource-version:
57357         type: string
57358         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57359       relationship-list:
57360         type: array
57361         items:
57362           $ref: "#/getDefinitions/relationship"
57363       p-interfaces:
57364         type: array
57365         items:
57366           $ref: "#/getDefinitions/p-interface"
57367       lag-interfaces:
57368         type: array
57369         items:
57370           $ref: "#/getDefinitions/lag-interface"
57371   vpls-pes:
57372     description: |
57373       Collection of VPLS Provider Edge routers
57374     properties:
57375       vpls-pe:
57376         type: array
57377         items:
57378           $ref: "#/getDefinitions/vpls-pe"
57379   vpn-binding:
57380     description: |
57381       VPN binding
57382       ###### Related Nodes
57383       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57384       - VPN-BINDING cannot be deleted if linked to L3-NETWORK
57385     required:
57386     - vpn-id
57387     - vpn-name
57388     - global-route-target
57389     properties:
57390       vpn-id:
57391         type: string
57392         description: VPN ID, globally unique within A&AI
57393       vpn-name:
57394         type: string
57395         description: VPN Name
57396       global-route-target:
57397         type: string
57398         description: Number used to identify a VPN, globally unique in the network
57399       vpn-platform:
57400         type: string
57401         description: the platform associated with the VPN example AVPN, Mobility
57402       resource-version:
57403         type: string
57404         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57405       relationship-list:
57406         type: array
57407         items:
57408           $ref: "#/getDefinitions/relationship"
57409         description: l3-networks relate to vpn-bindings
57410   vpn-bindings:
57411     properties:
57412       vpn-binding:
57413         type: array
57414         items:
57415           $ref: "#/getDefinitions/vpn-binding"
57416   vserver:
57417     description: |
57418       Virtual Servers, aka virtual machine or VM.
57419       ###### Related Nodes
57420       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57421       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57422       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
57423       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57424       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57425       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
57426       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57427       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57428       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
57429       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57430       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57431       - VSERVER is DELETED when these are DELETED L-INTERFACE
57432       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
57433     required:
57434     - vserver-id
57435     - vserver-name
57436     - vserver-selflink
57437     - in-maint
57438     - is-closed-loop-disabled
57439     properties:
57440       vserver-id:
57441         type: string
57442         description: Unique identifier for this vserver relative to its tenant
57443       vserver-name:
57444         type: string
57445         description: Name of vserver
57446       vserver-name2:
57447         type: string
57448         description: Alternative name of vserver
57449       prov-status:
57450         type: string
57451         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57452       vserver-selflink:
57453         type: string
57454         description: URL to endpoint where AAI can get more details
57455       in-maint:
57456         type: boolean
57457       is-closed-loop-disabled:
57458         type: boolean
57459       resource-version:
57460         type: string
57461         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57462       volumes:
57463         type: array
57464         items:
57465           $ref: "#/getDefinitions/volume"
57466       relationship-list:
57467         type: array
57468         items:
57469           $ref: "#/getDefinitions/relationship"
57470       l-interfaces:
57471         type: array
57472         items:
57473           $ref: "#/getDefinitions/l-interface"
57474   vservers:
57475     description: |
57476       Collection of virtual Servers, aka virtual machines or VMs.
57477     properties:
57478       vserver:
57479         type: array
57480         items:
57481           $ref: "#/getDefinitions/vserver"
57482   zone:
57483     description: |
57484       A zone is a grouping of assets in a location homing to the same connections into the CBB
57485       ###### Related Nodes
57486       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57487       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57488       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57489       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57490     required:
57491     - zone-id
57492     - zone-name
57493     - design-type
57494     - zone-context
57495     properties:
57496       zone-id:
57497         type: string
57498         description: Code assigned by AIC to the zone
57499       zone-name:
57500         type: string
57501         description: English name associated with the zone
57502       design-type:
57503         type: string
57504         description: Design of zone [Medium/Large?]
57505       zone-context:
57506         type: string
57507         description: Context of zone [production/test]
57508       status:
57509         type: string
57510         description: Status of a zone.
57511       resource-version:
57512         type: string
57513         description: Concurrency value
57514       relationship-list:
57515         type: array
57516         items:
57517           $ref: "#/getDefinitions/relationship"
57518   zones:
57519     description: |
57520       Collection of zones
57521     properties:
57522       zone:
57523         type: array
57524         items:
57525           $ref: "#/getDefinitions/zone"