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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v10.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: "v10"
  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/v10
  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/v10/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/v10/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/v10/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/v10/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/v10/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)
 571           required: true
 572           schema:
 573             $ref: "#/definitions/relationship"
 574     delete:
 575       tags:
 576         - CloudInfrastructure
 577       summary: delete an existing relationship
 578       description: delete an existing relationship
 579       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroupRelationshipListRelationship
 580       consumes:
 581         - application/json
 582         - application/xml
 583       produces:
 584         - application/json
 585         - application/xml
 586       responses:
 587         "default":
 588           description: Response codes found in [response codes](https://wiki.onap.org/).
 589       parameters:
 590         - name: cloud-owner
 591           in: path
 592           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 593           required: true
 594           type: string
 595           example: __CLOUD-OWNER__
 596         - name: cloud-region-id
 597           in: path
 598           description: Identifier used by the vendor for the region. Second part of composite key
 599           required: true
 600           type: string
 601           example: __CLOUD-REGION-ID__
 602         - name: volume-group-id
 603           in: path
 604           description: Unique ID of volume-group.
 605           required: true
 606           type: string
 607           example: __VOLUME-GROUP-ID__
 608   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}:
 609     get:
 610       tags:
 611         - CloudInfrastructure
 612       summary: returns volume-group
 613       description: returns volume-group
 614       operationId: getCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 615       produces:
 616         - application/json
 617         - application/xml
 618       responses:
 619         "200":
 620           description: successful operation
 621           schema:
 622               $ref: "#/getDefinitions/volume-group"
 623         "default":
 624           description: Response codes found in [response codes](https://wiki.onap.org/).
 625       parameters:
 626         - name: cloud-owner
 627           in: path
 628           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 629           required: true
 630           type: string
 631           example: __CLOUD-OWNER__
 632         - name: cloud-region-id
 633           in: path
 634           description: Identifier used by the vendor for the region. Second part of composite key
 635           required: true
 636           type: string
 637           example: __CLOUD-REGION-ID__
 638         - name: volume-group-id
 639           in: path
 640           description: Unique ID of volume-group.
 641           required: true
 642           type: string
 643           example: __VOLUME-GROUP-ID__
 644         - name: cloud-type
 645           in: query
 646           description: Type of the cloud (e.g., openstack)
 647           required: false
 648           type: string
 649         - name: owner-defined-type
 650           in: query
 651           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
 652           required: false
 653           type: string
 654         - name: volume-group-name
 655           in: query
 656           description: Name of the volume group.
 657           required: false
 658           type: string
 659         - name: heat-stack-id
 660           in: query
 661           description: Heat stack id corresponding to this volume-group
 662           required: false
 663           type: string
 664         - name: vnf-type
 665           in: query
 666           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
 667           required: false
 668           type: string
 669     put:
 670       tags:
 671         - CloudInfrastructure
 672       summary: create or update an existing volume-group
 673       description: |
 674         Create or update an existing volume-group.
 675         #
 676         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
 677       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup
 678       consumes:
 679         - application/json
 680         - application/xml
 681       produces:
 682         - application/json
 683         - application/xml
 684       responses:
 685         "default":
 686           description: Response codes found in [response codes](https://wiki.onap.org/).
 687       parameters:
 688         - name: cloud-owner
 689           in: path
 690           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
 691           required: true
 692           type: string
 693           example: __CLOUD-OWNER__
 694         - name: cloud-region-id
 695           in: path
 696           description: Identifier used by the vendor for the region. Second part of composite key
 697           required: true
 698           type: string
 699           example: __CLOUD-REGION-ID__
 700         - name: volume-group-id
 701           in: path
 702           description: Unique ID of volume-group.
 703           required: true
 704           type: string
 705           example: __VOLUME-GROUP-ID__
 706         - name: body
 707           in: body
 708           description: volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/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/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8285           required: true
8286           schema:
8287             $ref: "#/definitions/relationship"
8288     delete:
8289       tags:
8290         - CloudInfrastructure
8291       summary: delete an existing relationship
8292       description: delete an existing relationship
8293       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
8294       consumes:
8295         - application/json
8296         - application/xml
8297       produces:
8298         - application/json
8299         - application/xml
8300       responses:
8301         "default":
8302           description: Response codes found in [response codes](https://wiki.onap.org/).
8303       parameters:
8304         - name: hostname
8305           in: path
8306           description: Value from executing hostname on the compute node.
8307           required: true
8308           type: string
8309           example: __HOSTNAME__
8310         - name: interface-name
8311           in: path
8312           description: Name that identifies the physical interface
8313           required: true
8314           type: string
8315           example: __INTERFACE-NAME__
8316         - name: interface-name
8317           in: path
8318           description: Name given to the interface
8319           required: true
8320           type: string
8321           example: __INTERFACE-NAME__
8322         - name: vlan-interface
8323           in: path
8324           description: String that identifies the interface
8325           required: true
8326           type: string
8327           example: __VLAN-INTERFACE__
8328         - name: l3-interface-ipv4-address
8329           in: path
8330           description: IP address
8331           required: true
8332           type: string
8333           example: __L3-INTERFACE-IPV4-ADDRESS__
8334   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
8335     get:
8336       tags:
8337         - CloudInfrastructure
8338       summary: returns l3-interface-ipv4-address-list
8339       description: returns l3-interface-ipv4-address-list
8340       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8341       produces:
8342         - application/json
8343         - application/xml
8344       responses:
8345         "200":
8346           description: successful operation
8347           schema:
8348               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
8349         "default":
8350           description: Response codes found in [response codes](https://wiki.onap.org/).
8351       parameters:
8352         - name: hostname
8353           in: path
8354           description: Value from executing hostname on the compute node.
8355           required: true
8356           type: string
8357           example: __HOSTNAME__
8358         - name: interface-name
8359           in: path
8360           description: Name that identifies the physical interface
8361           required: true
8362           type: string
8363           example: __INTERFACE-NAME__
8364         - name: interface-name
8365           in: path
8366           description: Name given to the interface
8367           required: true
8368           type: string
8369           example: __INTERFACE-NAME__
8370         - name: vlan-interface
8371           in: path
8372           description: String that identifies the interface
8373           required: true
8374           type: string
8375           example: __VLAN-INTERFACE__
8376         - name: l3-interface-ipv4-address
8377           in: path
8378           description: IP address
8379           required: true
8380           type: string
8381           example: __L3-INTERFACE-IPV4-ADDRESS__
8382         - name: inv-status
8383           in: query
8384           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
8385           required: false
8386           type: string
8387         - name: pserver-id
8388           in: query
8389           description: ID of Pserver
8390           required: false
8391           type: string
8392         - name: in-maint
8393           in: query
8394           required: false
8395           type: boolean
8396         - name: pserver-name2
8397           in: query
8398           description: alternative pserver name
8399           required: false
8400           type: string
8401         - name: prov-status
8402           in: query
8403           description: Trigger for operational monitoring of this resource by Service Assurance systems.
8404           required: false
8405           type: string
8406         - name: interface-id
8407           in: query
8408           description: ID of interface
8409           required: false
8410           type: string
8411         - name: macaddr
8412           in: query
8413           description: MAC address for the interface
8414           required: false
8415           type: string
8416         - name: network-name
8417           in: query
8418           description: Name of the network
8419           required: false
8420           type: string
8421         - name: vlan-id-inner
8422           in: query
8423           description: Inner VLAN tag
8424           required: false
8425           type: integer
8426           format: int64
8427         - name: vpn-id
8428           in: query
8429           description: This indicates the customers VPN ID associated with this vlan
8430           required: false
8431           type: string
8432         - name: vlan-id-inner
8433           in: query
8434           description: Inner VLAN tag
8435           required: false
8436           type: integer
8437           format: int64
8438         - name: neutron-network-id
8439           in: query
8440           description: Neutron network id of the interface that address belongs to
8441           required: false
8442           type: string
8443         - name: neutron-subnet-id
8444           in: query
8445           description: Neutron id of subnet that address belongs to
8446           required: false
8447           type: string
8448     put:
8449       tags:
8450         - CloudInfrastructure
8451       summary: create or update an existing l3-interface-ipv4-address-list
8452       description: |
8453         Create or update an existing l3-interface-ipv4-address-list.
8454         #
8455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8456       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8457       consumes:
8458         - application/json
8459         - application/xml
8460       produces:
8461         - application/json
8462         - application/xml
8463       responses:
8464         "default":
8465           description: Response codes found in [response codes](https://wiki.onap.org/).
8466       parameters:
8467         - name: hostname
8468           in: path
8469           description: Value from executing hostname on the compute node.
8470           required: true
8471           type: string
8472           example: __HOSTNAME__
8473         - name: interface-name
8474           in: path
8475           description: Name that identifies the physical interface
8476           required: true
8477           type: string
8478           example: __INTERFACE-NAME__
8479         - name: interface-name
8480           in: path
8481           description: Name given to the interface
8482           required: true
8483           type: string
8484           example: __INTERFACE-NAME__
8485         - name: vlan-interface
8486           in: path
8487           description: String that identifies the interface
8488           required: true
8489           type: string
8490           example: __VLAN-INTERFACE__
8491         - name: l3-interface-ipv4-address
8492           in: path
8493           description: IP address
8494           required: true
8495           type: string
8496           example: __L3-INTERFACE-IPV4-ADDRESS__
8497         - name: body
8498           in: body
8499           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
8500           required: true
8501           schema:
8502             $ref: "#/definitions/l3-interface-ipv4-address-list"
8503     patch:
8504       tags:
8505         - CloudInfrastructure
8506       summary: update an existing l3-interface-ipv4-address-list
8507       description: |
8508         Update an existing l3-interface-ipv4-address-list
8509         #
8510         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8511         The PUT operation will entirely replace an existing object.
8512         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8513         #
8514         Other differences between PUT and PATCH are:
8515         #
8516         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8517         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8518         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8519       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8520       consumes:
8521         - application/json
8522         - application/xml
8523       produces:
8524         - application/json
8525         - application/xml
8526       responses:
8527         "default":
8528           description: Response codes found in [response codes](https://wiki.onap.org/).
8529       parameters:
8530         - name: hostname
8531           in: path
8532           description: Value from executing hostname on the compute node.
8533           required: true
8534           type: string
8535           example: __HOSTNAME__
8536         - name: interface-name
8537           in: path
8538           description: Name that identifies the physical interface
8539           required: true
8540           type: string
8541           example: __INTERFACE-NAME__
8542         - name: interface-name
8543           in: path
8544           description: Name given to the interface
8545           required: true
8546           type: string
8547           example: __INTERFACE-NAME__
8548         - name: vlan-interface
8549           in: path
8550           description: String that identifies the interface
8551           required: true
8552           type: string
8553           example: __VLAN-INTERFACE__
8554         - name: l3-interface-ipv4-address
8555           in: path
8556           description: IP address
8557           required: true
8558           type: string
8559           example: __L3-INTERFACE-IPV4-ADDRESS__
8560         - name: body
8561           in: body
8562           description: l3-interface-ipv4-address-list object that needs to be created or updated.
8563           required: true
8564           schema:
8565             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
8566     delete:
8567       tags:
8568         - CloudInfrastructure
8569       summary: delete an existing l3-interface-ipv4-address-list
8570       description: delete an existing l3-interface-ipv4-address-list
8571       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
8572       consumes:
8573         - application/json
8574         - application/xml
8575       produces:
8576         - application/json
8577         - application/xml
8578       responses:
8579         "default":
8580           description: Response codes found in [response codes](https://wiki.onap.org/).
8581       parameters:
8582         - name: hostname
8583           in: path
8584           description: Value from executing hostname on the compute node.
8585           required: true
8586           type: string
8587           example: __HOSTNAME__
8588         - name: interface-name
8589           in: path
8590           description: Name that identifies the physical interface
8591           required: true
8592           type: string
8593           example: __INTERFACE-NAME__
8594         - name: interface-name
8595           in: path
8596           description: Name given to the interface
8597           required: true
8598           type: string
8599           example: __INTERFACE-NAME__
8600         - name: vlan-interface
8601           in: path
8602           description: String that identifies the interface
8603           required: true
8604           type: string
8605           example: __VLAN-INTERFACE__
8606         - name: l3-interface-ipv4-address
8607           in: path
8608           description: IP address
8609           required: true
8610           type: string
8611           example: __L3-INTERFACE-IPV4-ADDRESS__
8612         - name: resource-version
8613           in: query
8614           description: resource-version for concurrency
8615           required: true
8616           type: string
8617   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
8618     put:
8619       tags:
8620         - CloudInfrastructure
8621       summary: see node definition for valid relationships
8622       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8623       consumes:
8624         - application/json
8625         - application/xml
8626       produces:
8627         - application/json
8628         - application/xml
8629       responses:
8630         "default":
8631           description: Response codes found in [response codes](https://wiki.onap.org/).
8632       parameters:
8633         - name: hostname
8634           in: path
8635           description: Value from executing hostname on the compute node.
8636           required: true
8637           type: string
8638           example: __HOSTNAME__
8639         - name: interface-name
8640           in: path
8641           description: Name that identifies the physical interface
8642           required: true
8643           type: string
8644           example: __INTERFACE-NAME__
8645         - name: interface-name
8646           in: path
8647           description: Name given to the interface
8648           required: true
8649           type: string
8650           example: __INTERFACE-NAME__
8651         - name: vlan-interface
8652           in: path
8653           description: String that identifies the interface
8654           required: true
8655           type: string
8656           example: __VLAN-INTERFACE__
8657         - name: l3-interface-ipv6-address
8658           in: path
8659           description: IP address
8660           required: true
8661           type: string
8662           example: __L3-INTERFACE-IPV6-ADDRESS__
8663         - name: body
8664           in: body
8665           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8666           required: true
8667           schema:
8668             $ref: "#/definitions/relationship"
8669     delete:
8670       tags:
8671         - CloudInfrastructure
8672       summary: delete an existing relationship
8673       description: delete an existing relationship
8674       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
8675       consumes:
8676         - application/json
8677         - application/xml
8678       produces:
8679         - application/json
8680         - application/xml
8681       responses:
8682         "default":
8683           description: Response codes found in [response codes](https://wiki.onap.org/).
8684       parameters:
8685         - name: hostname
8686           in: path
8687           description: Value from executing hostname on the compute node.
8688           required: true
8689           type: string
8690           example: __HOSTNAME__
8691         - name: interface-name
8692           in: path
8693           description: Name that identifies the physical interface
8694           required: true
8695           type: string
8696           example: __INTERFACE-NAME__
8697         - name: interface-name
8698           in: path
8699           description: Name given to the interface
8700           required: true
8701           type: string
8702           example: __INTERFACE-NAME__
8703         - name: vlan-interface
8704           in: path
8705           description: String that identifies the interface
8706           required: true
8707           type: string
8708           example: __VLAN-INTERFACE__
8709         - name: l3-interface-ipv6-address
8710           in: path
8711           description: IP address
8712           required: true
8713           type: string
8714           example: __L3-INTERFACE-IPV6-ADDRESS__
8715   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
8716     get:
8717       tags:
8718         - CloudInfrastructure
8719       summary: returns l3-interface-ipv6-address-list
8720       description: returns l3-interface-ipv6-address-list
8721       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8722       produces:
8723         - application/json
8724         - application/xml
8725       responses:
8726         "200":
8727           description: successful operation
8728           schema:
8729               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
8730         "default":
8731           description: Response codes found in [response codes](https://wiki.onap.org/).
8732       parameters:
8733         - name: hostname
8734           in: path
8735           description: Value from executing hostname on the compute node.
8736           required: true
8737           type: string
8738           example: __HOSTNAME__
8739         - name: interface-name
8740           in: path
8741           description: Name that identifies the physical interface
8742           required: true
8743           type: string
8744           example: __INTERFACE-NAME__
8745         - name: interface-name
8746           in: path
8747           description: Name given to the interface
8748           required: true
8749           type: string
8750           example: __INTERFACE-NAME__
8751         - name: vlan-interface
8752           in: path
8753           description: String that identifies the interface
8754           required: true
8755           type: string
8756           example: __VLAN-INTERFACE__
8757         - name: l3-interface-ipv6-address
8758           in: path
8759           description: IP address
8760           required: true
8761           type: string
8762           example: __L3-INTERFACE-IPV6-ADDRESS__
8763         - name: inv-status
8764           in: query
8765           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
8766           required: false
8767           type: string
8768         - name: pserver-id
8769           in: query
8770           description: ID of Pserver
8771           required: false
8772           type: string
8773         - name: in-maint
8774           in: query
8775           required: false
8776           type: boolean
8777         - name: pserver-name2
8778           in: query
8779           description: alternative pserver name
8780           required: false
8781           type: string
8782         - name: prov-status
8783           in: query
8784           description: Trigger for operational monitoring of this resource by Service Assurance systems.
8785           required: false
8786           type: string
8787         - name: interface-id
8788           in: query
8789           description: ID of interface
8790           required: false
8791           type: string
8792         - name: macaddr
8793           in: query
8794           description: MAC address for the interface
8795           required: false
8796           type: string
8797         - name: network-name
8798           in: query
8799           description: Name of the network
8800           required: false
8801           type: string
8802         - name: vlan-id-inner
8803           in: query
8804           description: Inner VLAN tag
8805           required: false
8806           type: integer
8807           format: int64
8808         - name: vpn-id
8809           in: query
8810           description: This indicates the customers VPN ID associated with this vlan
8811           required: false
8812           type: string
8813         - name: vlan-id-inner
8814           in: query
8815           description: Inner VLAN tag
8816           required: false
8817           type: integer
8818           format: int64
8819         - name: neutron-network-id
8820           in: query
8821           description: Neutron network id of the interface that address belongs to
8822           required: false
8823           type: string
8824         - name: neutron-subnet-id
8825           in: query
8826           description: Neutron id of subnet that address belongs to
8827           required: false
8828           type: string
8829     put:
8830       tags:
8831         - CloudInfrastructure
8832       summary: create or update an existing l3-interface-ipv6-address-list
8833       description: |
8834         Create or update an existing l3-interface-ipv6-address-list.
8835         #
8836         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8837       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8838       consumes:
8839         - application/json
8840         - application/xml
8841       produces:
8842         - application/json
8843         - application/xml
8844       responses:
8845         "default":
8846           description: Response codes found in [response codes](https://wiki.onap.org/).
8847       parameters:
8848         - name: hostname
8849           in: path
8850           description: Value from executing hostname on the compute node.
8851           required: true
8852           type: string
8853           example: __HOSTNAME__
8854         - name: interface-name
8855           in: path
8856           description: Name that identifies the physical interface
8857           required: true
8858           type: string
8859           example: __INTERFACE-NAME__
8860         - name: interface-name
8861           in: path
8862           description: Name given to the interface
8863           required: true
8864           type: string
8865           example: __INTERFACE-NAME__
8866         - name: vlan-interface
8867           in: path
8868           description: String that identifies the interface
8869           required: true
8870           type: string
8871           example: __VLAN-INTERFACE__
8872         - name: l3-interface-ipv6-address
8873           in: path
8874           description: IP address
8875           required: true
8876           type: string
8877           example: __L3-INTERFACE-IPV6-ADDRESS__
8878         - name: body
8879           in: body
8880           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
8881           required: true
8882           schema:
8883             $ref: "#/definitions/l3-interface-ipv6-address-list"
8884     patch:
8885       tags:
8886         - CloudInfrastructure
8887       summary: update an existing l3-interface-ipv6-address-list
8888       description: |
8889         Update an existing l3-interface-ipv6-address-list
8890         #
8891         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8892         The PUT operation will entirely replace an existing object.
8893         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8894         #
8895         Other differences between PUT and PATCH are:
8896         #
8897         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8898         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8899         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8900       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8901       consumes:
8902         - application/json
8903         - application/xml
8904       produces:
8905         - application/json
8906         - application/xml
8907       responses:
8908         "default":
8909           description: Response codes found in [response codes](https://wiki.onap.org/).
8910       parameters:
8911         - name: hostname
8912           in: path
8913           description: Value from executing hostname on the compute node.
8914           required: true
8915           type: string
8916           example: __HOSTNAME__
8917         - name: interface-name
8918           in: path
8919           description: Name that identifies the physical interface
8920           required: true
8921           type: string
8922           example: __INTERFACE-NAME__
8923         - name: interface-name
8924           in: path
8925           description: Name given to the interface
8926           required: true
8927           type: string
8928           example: __INTERFACE-NAME__
8929         - name: vlan-interface
8930           in: path
8931           description: String that identifies the interface
8932           required: true
8933           type: string
8934           example: __VLAN-INTERFACE__
8935         - name: l3-interface-ipv6-address
8936           in: path
8937           description: IP address
8938           required: true
8939           type: string
8940           example: __L3-INTERFACE-IPV6-ADDRESS__
8941         - name: body
8942           in: body
8943           description: l3-interface-ipv6-address-list object that needs to be created or updated.
8944           required: true
8945           schema:
8946             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
8947     delete:
8948       tags:
8949         - CloudInfrastructure
8950       summary: delete an existing l3-interface-ipv6-address-list
8951       description: delete an existing l3-interface-ipv6-address-list
8952       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
8953       consumes:
8954         - application/json
8955         - application/xml
8956       produces:
8957         - application/json
8958         - application/xml
8959       responses:
8960         "default":
8961           description: Response codes found in [response codes](https://wiki.onap.org/).
8962       parameters:
8963         - name: hostname
8964           in: path
8965           description: Value from executing hostname on the compute node.
8966           required: true
8967           type: string
8968           example: __HOSTNAME__
8969         - name: interface-name
8970           in: path
8971           description: Name that identifies the physical interface
8972           required: true
8973           type: string
8974           example: __INTERFACE-NAME__
8975         - name: interface-name
8976           in: path
8977           description: Name given to the interface
8978           required: true
8979           type: string
8980           example: __INTERFACE-NAME__
8981         - name: vlan-interface
8982           in: path
8983           description: String that identifies the interface
8984           required: true
8985           type: string
8986           example: __VLAN-INTERFACE__
8987         - name: l3-interface-ipv6-address
8988           in: path
8989           description: IP address
8990           required: true
8991           type: string
8992           example: __L3-INTERFACE-IPV6-ADDRESS__
8993         - name: resource-version
8994           in: query
8995           description: resource-version for concurrency
8996           required: true
8997           type: string
8998   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
8999     get:
9000       tags:
9001         - CloudInfrastructure
9002       summary: returns vlan
9003       description: returns vlan
9004       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9005       produces:
9006         - application/json
9007         - application/xml
9008       responses:
9009         "200":
9010           description: successful operation
9011           schema:
9012               $ref: "#/getDefinitions/vlan"
9013         "default":
9014           description: Response codes found in [response codes](https://wiki.onap.org/).
9015       parameters:
9016         - name: hostname
9017           in: path
9018           description: Value from executing hostname on the compute node.
9019           required: true
9020           type: string
9021           example: __HOSTNAME__
9022         - name: interface-name
9023           in: path
9024           description: Name that identifies the physical interface
9025           required: true
9026           type: string
9027           example: __INTERFACE-NAME__
9028         - name: interface-name
9029           in: path
9030           description: Name given to the interface
9031           required: true
9032           type: string
9033           example: __INTERFACE-NAME__
9034         - name: vlan-interface
9035           in: path
9036           description: String that identifies the interface
9037           required: true
9038           type: string
9039           example: __VLAN-INTERFACE__
9040         - name: inv-status
9041           in: query
9042           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9043           required: false
9044           type: string
9045         - name: pserver-id
9046           in: query
9047           description: ID of Pserver
9048           required: false
9049           type: string
9050         - name: in-maint
9051           in: query
9052           required: false
9053           type: boolean
9054         - name: pserver-name2
9055           in: query
9056           description: alternative pserver name
9057           required: false
9058           type: string
9059         - name: prov-status
9060           in: query
9061           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9062           required: false
9063           type: string
9064         - name: interface-id
9065           in: query
9066           description: ID of interface
9067           required: false
9068           type: string
9069         - name: macaddr
9070           in: query
9071           description: MAC address for the interface
9072           required: false
9073           type: string
9074         - name: network-name
9075           in: query
9076           description: Name of the network
9077           required: false
9078           type: string
9079         - name: vlan-id-inner
9080           in: query
9081           description: Inner VLAN tag
9082           required: false
9083           type: integer
9084           format: int64
9085         - name: vpn-id
9086           in: query
9087           description: This indicates the customers VPN ID associated with this vlan
9088           required: false
9089           type: string
9090     put:
9091       tags:
9092         - CloudInfrastructure
9093       summary: create or update an existing vlan
9094       description: |
9095         Create or update an existing vlan.
9096         #
9097         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9098       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9099       consumes:
9100         - application/json
9101         - application/xml
9102       produces:
9103         - application/json
9104         - application/xml
9105       responses:
9106         "default":
9107           description: Response codes found in [response codes](https://wiki.onap.org/).
9108       parameters:
9109         - name: hostname
9110           in: path
9111           description: Value from executing hostname on the compute node.
9112           required: true
9113           type: string
9114           example: __HOSTNAME__
9115         - name: interface-name
9116           in: path
9117           description: Name that identifies the physical interface
9118           required: true
9119           type: string
9120           example: __INTERFACE-NAME__
9121         - name: interface-name
9122           in: path
9123           description: Name given to the interface
9124           required: true
9125           type: string
9126           example: __INTERFACE-NAME__
9127         - name: vlan-interface
9128           in: path
9129           description: String that identifies the interface
9130           required: true
9131           type: string
9132           example: __VLAN-INTERFACE__
9133         - name: body
9134           in: body
9135           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9136           required: true
9137           schema:
9138             $ref: "#/definitions/vlan"
9139     patch:
9140       tags:
9141         - CloudInfrastructure
9142       summary: update an existing vlan
9143       description: |
9144         Update an existing vlan
9145         #
9146         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9147         The PUT operation will entirely replace an existing object.
9148         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9149         #
9150         Other differences between PUT and PATCH are:
9151         #
9152         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9153         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9154         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9155       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9156       consumes:
9157         - application/json
9158         - application/xml
9159       produces:
9160         - application/json
9161         - application/xml
9162       responses:
9163         "default":
9164           description: Response codes found in [response codes](https://wiki.onap.org/).
9165       parameters:
9166         - name: hostname
9167           in: path
9168           description: Value from executing hostname on the compute node.
9169           required: true
9170           type: string
9171           example: __HOSTNAME__
9172         - name: interface-name
9173           in: path
9174           description: Name that identifies the physical interface
9175           required: true
9176           type: string
9177           example: __INTERFACE-NAME__
9178         - name: interface-name
9179           in: path
9180           description: Name given to the interface
9181           required: true
9182           type: string
9183           example: __INTERFACE-NAME__
9184         - name: vlan-interface
9185           in: path
9186           description: String that identifies the interface
9187           required: true
9188           type: string
9189           example: __VLAN-INTERFACE__
9190         - name: body
9191           in: body
9192           description: vlan object that needs to be created or updated.
9193           required: true
9194           schema:
9195             $ref: "#/patchDefinitions/vlan"
9196     delete:
9197       tags:
9198         - CloudInfrastructure
9199       summary: delete an existing vlan
9200       description: delete an existing vlan
9201       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
9202       consumes:
9203         - application/json
9204         - application/xml
9205       produces:
9206         - application/json
9207         - application/xml
9208       responses:
9209         "default":
9210           description: Response codes found in [response codes](https://wiki.onap.org/).
9211       parameters:
9212         - name: hostname
9213           in: path
9214           description: Value from executing hostname on the compute node.
9215           required: true
9216           type: string
9217           example: __HOSTNAME__
9218         - name: interface-name
9219           in: path
9220           description: Name that identifies the physical interface
9221           required: true
9222           type: string
9223           example: __INTERFACE-NAME__
9224         - name: interface-name
9225           in: path
9226           description: Name given to the interface
9227           required: true
9228           type: string
9229           example: __INTERFACE-NAME__
9230         - name: vlan-interface
9231           in: path
9232           description: String that identifies the interface
9233           required: true
9234           type: string
9235           example: __VLAN-INTERFACE__
9236         - name: resource-version
9237           in: query
9238           description: resource-version for concurrency
9239           required: true
9240           type: string
9241   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
9242     get:
9243       tags:
9244         - CloudInfrastructure
9245       summary: returns vlans
9246       description: returns vlans
9247       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
9248       produces:
9249         - application/json
9250         - application/xml
9251       responses:
9252         "200":
9253           description: successful operation
9254           schema:
9255               $ref: "#/getDefinitions/vlans"
9256         "default":
9257           description: Response codes found in [response codes](https://wiki.onap.org/).
9258       parameters:
9259         - name: hostname
9260           in: path
9261           description: Value from executing hostname on the compute node.
9262           required: true
9263           type: string
9264           example: __HOSTNAME__
9265         - name: interface-name
9266           in: path
9267           description: Name that identifies the physical interface
9268           required: true
9269           type: string
9270           example: __INTERFACE-NAME__
9271         - name: interface-name
9272           in: path
9273           description: Name given to the interface
9274           required: true
9275           type: string
9276           example: __INTERFACE-NAME__
9277         - name: inv-status
9278           in: query
9279           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9280           required: false
9281           type: string
9282         - name: pserver-id
9283           in: query
9284           description: ID of Pserver
9285           required: false
9286           type: string
9287         - name: in-maint
9288           in: query
9289           required: false
9290           type: boolean
9291         - name: pserver-name2
9292           in: query
9293           description: alternative pserver name
9294           required: false
9295           type: string
9296         - name: prov-status
9297           in: query
9298           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9299           required: false
9300           type: string
9301         - name: interface-id
9302           in: query
9303           description: ID of interface
9304           required: false
9305           type: string
9306         - name: macaddr
9307           in: query
9308           description: MAC address for the interface
9309           required: false
9310           type: string
9311         - name: network-name
9312           in: query
9313           description: Name of the network
9314           required: false
9315           type: string
9316   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
9317     put:
9318       tags:
9319         - CloudInfrastructure
9320       summary: see node definition for valid relationships
9321       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9322       consumes:
9323         - application/json
9324         - application/xml
9325       produces:
9326         - application/json
9327         - application/xml
9328       responses:
9329         "default":
9330           description: Response codes found in [response codes](https://wiki.onap.org/).
9331       parameters:
9332         - name: hostname
9333           in: path
9334           description: Value from executing hostname on the compute node.
9335           required: true
9336           type: string
9337           example: __HOSTNAME__
9338         - name: interface-name
9339           in: path
9340           description: Name that identifies the physical interface
9341           required: true
9342           type: string
9343           example: __INTERFACE-NAME__
9344         - name: interface-name
9345           in: path
9346           description: Name given to the interface
9347           required: true
9348           type: string
9349           example: __INTERFACE-NAME__
9350         - name: pci-id
9351           in: path
9352           description: PCI ID used to identify the sriov-vf
9353           required: true
9354           type: string
9355           example: __PCI-ID__
9356         - name: body
9357           in: body
9358           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9359           required: true
9360           schema:
9361             $ref: "#/definitions/relationship"
9362     delete:
9363       tags:
9364         - CloudInfrastructure
9365       summary: delete an existing relationship
9366       description: delete an existing relationship
9367       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
9368       consumes:
9369         - application/json
9370         - application/xml
9371       produces:
9372         - application/json
9373         - application/xml
9374       responses:
9375         "default":
9376           description: Response codes found in [response codes](https://wiki.onap.org/).
9377       parameters:
9378         - name: hostname
9379           in: path
9380           description: Value from executing hostname on the compute node.
9381           required: true
9382           type: string
9383           example: __HOSTNAME__
9384         - name: interface-name
9385           in: path
9386           description: Name that identifies the physical interface
9387           required: true
9388           type: string
9389           example: __INTERFACE-NAME__
9390         - name: interface-name
9391           in: path
9392           description: Name given to the interface
9393           required: true
9394           type: string
9395           example: __INTERFACE-NAME__
9396         - name: pci-id
9397           in: path
9398           description: PCI ID used to identify the sriov-vf
9399           required: true
9400           type: string
9401           example: __PCI-ID__
9402   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
9403     get:
9404       tags:
9405         - CloudInfrastructure
9406       summary: returns sriov-vf
9407       description: returns sriov-vf
9408       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9409       produces:
9410         - application/json
9411         - application/xml
9412       responses:
9413         "200":
9414           description: successful operation
9415           schema:
9416               $ref: "#/getDefinitions/sriov-vf"
9417         "default":
9418           description: Response codes found in [response codes](https://wiki.onap.org/).
9419       parameters:
9420         - name: hostname
9421           in: path
9422           description: Value from executing hostname on the compute node.
9423           required: true
9424           type: string
9425           example: __HOSTNAME__
9426         - name: interface-name
9427           in: path
9428           description: Name that identifies the physical interface
9429           required: true
9430           type: string
9431           example: __INTERFACE-NAME__
9432         - name: interface-name
9433           in: path
9434           description: Name given to the interface
9435           required: true
9436           type: string
9437           example: __INTERFACE-NAME__
9438         - name: pci-id
9439           in: path
9440           description: PCI ID used to identify the sriov-vf
9441           required: true
9442           type: string
9443           example: __PCI-ID__
9444         - name: inv-status
9445           in: query
9446           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9447           required: false
9448           type: string
9449         - name: pserver-id
9450           in: query
9451           description: ID of Pserver
9452           required: false
9453           type: string
9454         - name: in-maint
9455           in: query
9456           required: false
9457           type: boolean
9458         - name: pserver-name2
9459           in: query
9460           description: alternative pserver name
9461           required: false
9462           type: string
9463         - name: prov-status
9464           in: query
9465           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9466           required: false
9467           type: string
9468         - name: interface-id
9469           in: query
9470           description: ID of interface
9471           required: false
9472           type: string
9473         - name: macaddr
9474           in: query
9475           description: MAC address for the interface
9476           required: false
9477           type: string
9478         - name: network-name
9479           in: query
9480           description: Name of the network
9481           required: false
9482           type: string
9483         - name: vf-vlan-filter
9484           in: query
9485           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
9486           required: false
9487           type: string
9488         - name: vf-mac-filter
9489           in: query
9490           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
9491           required: false
9492           type: string
9493         - name: vf-vlan-strip
9494           in: query
9495           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
9496           required: false
9497           type: boolean
9498         - name: neutron-network-id
9499           in: query
9500           description: Neutron network id of the interface
9501           required: false
9502           type: string
9503     put:
9504       tags:
9505         - CloudInfrastructure
9506       summary: create or update an existing sriov-vf
9507       description: |
9508         Create or update an existing sriov-vf.
9509         #
9510         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9511       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9512       consumes:
9513         - application/json
9514         - application/xml
9515       produces:
9516         - application/json
9517         - application/xml
9518       responses:
9519         "default":
9520           description: Response codes found in [response codes](https://wiki.onap.org/).
9521       parameters:
9522         - name: hostname
9523           in: path
9524           description: Value from executing hostname on the compute node.
9525           required: true
9526           type: string
9527           example: __HOSTNAME__
9528         - name: interface-name
9529           in: path
9530           description: Name that identifies the physical interface
9531           required: true
9532           type: string
9533           example: __INTERFACE-NAME__
9534         - name: interface-name
9535           in: path
9536           description: Name given to the interface
9537           required: true
9538           type: string
9539           example: __INTERFACE-NAME__
9540         - name: pci-id
9541           in: path
9542           description: PCI ID used to identify the sriov-vf
9543           required: true
9544           type: string
9545           example: __PCI-ID__
9546         - name: body
9547           in: body
9548           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
9549           required: true
9550           schema:
9551             $ref: "#/definitions/sriov-vf"
9552     patch:
9553       tags:
9554         - CloudInfrastructure
9555       summary: update an existing sriov-vf
9556       description: |
9557         Update an existing sriov-vf
9558         #
9559         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9560         The PUT operation will entirely replace an existing object.
9561         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9562         #
9563         Other differences between PUT and PATCH are:
9564         #
9565         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9566         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9567         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9568       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9569       consumes:
9570         - application/json
9571         - application/xml
9572       produces:
9573         - application/json
9574         - application/xml
9575       responses:
9576         "default":
9577           description: Response codes found in [response codes](https://wiki.onap.org/).
9578       parameters:
9579         - name: hostname
9580           in: path
9581           description: Value from executing hostname on the compute node.
9582           required: true
9583           type: string
9584           example: __HOSTNAME__
9585         - name: interface-name
9586           in: path
9587           description: Name that identifies the physical interface
9588           required: true
9589           type: string
9590           example: __INTERFACE-NAME__
9591         - name: interface-name
9592           in: path
9593           description: Name given to the interface
9594           required: true
9595           type: string
9596           example: __INTERFACE-NAME__
9597         - name: pci-id
9598           in: path
9599           description: PCI ID used to identify the sriov-vf
9600           required: true
9601           type: string
9602           example: __PCI-ID__
9603         - name: body
9604           in: body
9605           description: sriov-vf object that needs to be created or updated.
9606           required: true
9607           schema:
9608             $ref: "#/patchDefinitions/sriov-vf"
9609     delete:
9610       tags:
9611         - CloudInfrastructure
9612       summary: delete an existing sriov-vf
9613       description: delete an existing sriov-vf
9614       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
9615       consumes:
9616         - application/json
9617         - application/xml
9618       produces:
9619         - application/json
9620         - application/xml
9621       responses:
9622         "default":
9623           description: Response codes found in [response codes](https://wiki.onap.org/).
9624       parameters:
9625         - name: hostname
9626           in: path
9627           description: Value from executing hostname on the compute node.
9628           required: true
9629           type: string
9630           example: __HOSTNAME__
9631         - name: interface-name
9632           in: path
9633           description: Name that identifies the physical interface
9634           required: true
9635           type: string
9636           example: __INTERFACE-NAME__
9637         - name: interface-name
9638           in: path
9639           description: Name given to the interface
9640           required: true
9641           type: string
9642           example: __INTERFACE-NAME__
9643         - name: pci-id
9644           in: path
9645           description: PCI ID used to identify the sriov-vf
9646           required: true
9647           type: string
9648           example: __PCI-ID__
9649         - name: resource-version
9650           in: query
9651           description: resource-version for concurrency
9652           required: true
9653           type: string
9654   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
9655     get:
9656       tags:
9657         - CloudInfrastructure
9658       summary: returns sriov-vfs
9659       description: returns sriov-vfs
9660       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
9661       produces:
9662         - application/json
9663         - application/xml
9664       responses:
9665         "200":
9666           description: successful operation
9667           schema:
9668               $ref: "#/getDefinitions/sriov-vfs"
9669         "default":
9670           description: Response codes found in [response codes](https://wiki.onap.org/).
9671       parameters:
9672         - name: hostname
9673           in: path
9674           description: Value from executing hostname on the compute node.
9675           required: true
9676           type: string
9677           example: __HOSTNAME__
9678         - name: interface-name
9679           in: path
9680           description: Name that identifies the physical interface
9681           required: true
9682           type: string
9683           example: __INTERFACE-NAME__
9684         - name: interface-name
9685           in: path
9686           description: Name given to the interface
9687           required: true
9688           type: string
9689           example: __INTERFACE-NAME__
9690         - name: inv-status
9691           in: query
9692           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9693           required: false
9694           type: string
9695         - name: pserver-id
9696           in: query
9697           description: ID of Pserver
9698           required: false
9699           type: string
9700         - name: in-maint
9701           in: query
9702           required: false
9703           type: boolean
9704         - name: pserver-name2
9705           in: query
9706           description: alternative pserver name
9707           required: false
9708           type: string
9709         - name: prov-status
9710           in: query
9711           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9712           required: false
9713           type: string
9714         - name: interface-id
9715           in: query
9716           description: ID of interface
9717           required: false
9718           type: string
9719         - name: macaddr
9720           in: query
9721           description: MAC address for the interface
9722           required: false
9723           type: string
9724         - name: network-name
9725           in: query
9726           description: Name of the network
9727           required: false
9728           type: string
9729   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
9730     put:
9731       tags:
9732         - CloudInfrastructure
9733       summary: see node definition for valid relationships
9734       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9735       consumes:
9736         - application/json
9737         - application/xml
9738       produces:
9739         - application/json
9740         - application/xml
9741       responses:
9742         "default":
9743           description: Response codes found in [response codes](https://wiki.onap.org/).
9744       parameters:
9745         - name: hostname
9746           in: path
9747           description: Value from executing hostname on the compute node.
9748           required: true
9749           type: string
9750           example: __HOSTNAME__
9751         - name: interface-name
9752           in: path
9753           description: Name that identifies the physical interface
9754           required: true
9755           type: string
9756           example: __INTERFACE-NAME__
9757         - name: interface-name
9758           in: path
9759           description: Name given to the interface
9760           required: true
9761           type: string
9762           example: __INTERFACE-NAME__
9763         - name: body
9764           in: body
9765           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
9766           required: true
9767           schema:
9768             $ref: "#/definitions/relationship"
9769     delete:
9770       tags:
9771         - CloudInfrastructure
9772       summary: delete an existing relationship
9773       description: delete an existing relationship
9774       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
9775       consumes:
9776         - application/json
9777         - application/xml
9778       produces:
9779         - application/json
9780         - application/xml
9781       responses:
9782         "default":
9783           description: Response codes found in [response codes](https://wiki.onap.org/).
9784       parameters:
9785         - name: hostname
9786           in: path
9787           description: Value from executing hostname on the compute node.
9788           required: true
9789           type: string
9790           example: __HOSTNAME__
9791         - name: interface-name
9792           in: path
9793           description: Name that identifies the physical interface
9794           required: true
9795           type: string
9796           example: __INTERFACE-NAME__
9797         - name: interface-name
9798           in: path
9799           description: Name given to the interface
9800           required: true
9801           type: string
9802           example: __INTERFACE-NAME__
9803   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
9804     put:
9805       tags:
9806         - CloudInfrastructure
9807       summary: see node definition for valid relationships
9808       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9809       consumes:
9810         - application/json
9811         - application/xml
9812       produces:
9813         - application/json
9814         - application/xml
9815       responses:
9816         "default":
9817           description: Response codes found in [response codes](https://wiki.onap.org/).
9818       parameters:
9819         - name: hostname
9820           in: path
9821           description: Value from executing hostname on the compute node.
9822           required: true
9823           type: string
9824           example: __HOSTNAME__
9825         - name: interface-name
9826           in: path
9827           description: Name that identifies the physical interface
9828           required: true
9829           type: string
9830           example: __INTERFACE-NAME__
9831         - name: interface-name
9832           in: path
9833           description: Name given to the interface
9834           required: true
9835           type: string
9836           example: __INTERFACE-NAME__
9837         - name: l3-interface-ipv4-address
9838           in: path
9839           description: IP address
9840           required: true
9841           type: string
9842           example: __L3-INTERFACE-IPV4-ADDRESS__
9843         - name: body
9844           in: body
9845           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
9846           required: true
9847           schema:
9848             $ref: "#/definitions/relationship"
9849     delete:
9850       tags:
9851         - CloudInfrastructure
9852       summary: delete an existing relationship
9853       description: delete an existing relationship
9854       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
9855       consumes:
9856         - application/json
9857         - application/xml
9858       produces:
9859         - application/json
9860         - application/xml
9861       responses:
9862         "default":
9863           description: Response codes found in [response codes](https://wiki.onap.org/).
9864       parameters:
9865         - name: hostname
9866           in: path
9867           description: Value from executing hostname on the compute node.
9868           required: true
9869           type: string
9870           example: __HOSTNAME__
9871         - name: interface-name
9872           in: path
9873           description: Name that identifies the physical interface
9874           required: true
9875           type: string
9876           example: __INTERFACE-NAME__
9877         - name: interface-name
9878           in: path
9879           description: Name given to the interface
9880           required: true
9881           type: string
9882           example: __INTERFACE-NAME__
9883         - name: l3-interface-ipv4-address
9884           in: path
9885           description: IP address
9886           required: true
9887           type: string
9888           example: __L3-INTERFACE-IPV4-ADDRESS__
9889   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
9890     get:
9891       tags:
9892         - CloudInfrastructure
9893       summary: returns l3-interface-ipv4-address-list
9894       description: returns l3-interface-ipv4-address-list
9895       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9896       produces:
9897         - application/json
9898         - application/xml
9899       responses:
9900         "200":
9901           description: successful operation
9902           schema:
9903               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9904         "default":
9905           description: Response codes found in [response codes](https://wiki.onap.org/).
9906       parameters:
9907         - name: hostname
9908           in: path
9909           description: Value from executing hostname on the compute node.
9910           required: true
9911           type: string
9912           example: __HOSTNAME__
9913         - name: interface-name
9914           in: path
9915           description: Name that identifies the physical interface
9916           required: true
9917           type: string
9918           example: __INTERFACE-NAME__
9919         - name: interface-name
9920           in: path
9921           description: Name given to the interface
9922           required: true
9923           type: string
9924           example: __INTERFACE-NAME__
9925         - name: l3-interface-ipv4-address
9926           in: path
9927           description: IP address
9928           required: true
9929           type: string
9930           example: __L3-INTERFACE-IPV4-ADDRESS__
9931         - name: inv-status
9932           in: query
9933           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9934           required: false
9935           type: string
9936         - name: pserver-id
9937           in: query
9938           description: ID of Pserver
9939           required: false
9940           type: string
9941         - name: in-maint
9942           in: query
9943           required: false
9944           type: boolean
9945         - name: pserver-name2
9946           in: query
9947           description: alternative pserver name
9948           required: false
9949           type: string
9950         - name: prov-status
9951           in: query
9952           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9953           required: false
9954           type: string
9955         - name: interface-id
9956           in: query
9957           description: ID of interface
9958           required: false
9959           type: string
9960         - name: macaddr
9961           in: query
9962           description: MAC address for the interface
9963           required: false
9964           type: string
9965         - name: network-name
9966           in: query
9967           description: Name of the network
9968           required: false
9969           type: string
9970         - name: vlan-id-inner
9971           in: query
9972           description: Inner VLAN tag
9973           required: false
9974           type: integer
9975           format: int64
9976         - name: neutron-network-id
9977           in: query
9978           description: Neutron network id of the interface that address belongs to
9979           required: false
9980           type: string
9981         - name: neutron-subnet-id
9982           in: query
9983           description: Neutron id of subnet that address belongs to
9984           required: false
9985           type: string
9986     put:
9987       tags:
9988         - CloudInfrastructure
9989       summary: create or update an existing l3-interface-ipv4-address-list
9990       description: |
9991         Create or update an existing l3-interface-ipv4-address-list.
9992         #
9993         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9994       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
9995       consumes:
9996         - application/json
9997         - application/xml
9998       produces:
9999         - application/json
10000         - application/xml
10001       responses:
10002         "default":
10003           description: Response codes found in [response codes](https://wiki.onap.org/).
10004       parameters:
10005         - name: hostname
10006           in: path
10007           description: Value from executing hostname on the compute node.
10008           required: true
10009           type: string
10010           example: __HOSTNAME__
10011         - name: interface-name
10012           in: path
10013           description: Name that identifies the physical interface
10014           required: true
10015           type: string
10016           example: __INTERFACE-NAME__
10017         - name: interface-name
10018           in: path
10019           description: Name given to the interface
10020           required: true
10021           type: string
10022           example: __INTERFACE-NAME__
10023         - name: l3-interface-ipv4-address
10024           in: path
10025           description: IP address
10026           required: true
10027           type: string
10028           example: __L3-INTERFACE-IPV4-ADDRESS__
10029         - name: body
10030           in: body
10031           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
10032           required: true
10033           schema:
10034             $ref: "#/definitions/l3-interface-ipv4-address-list"
10035     patch:
10036       tags:
10037         - CloudInfrastructure
10038       summary: update an existing l3-interface-ipv4-address-list
10039       description: |
10040         Update an existing l3-interface-ipv4-address-list
10041         #
10042         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10043         The PUT operation will entirely replace an existing object.
10044         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10045         #
10046         Other differences between PUT and PATCH are:
10047         #
10048         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10049         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10050         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10051       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10052       consumes:
10053         - application/json
10054         - application/xml
10055       produces:
10056         - application/json
10057         - application/xml
10058       responses:
10059         "default":
10060           description: Response codes found in [response codes](https://wiki.onap.org/).
10061       parameters:
10062         - name: hostname
10063           in: path
10064           description: Value from executing hostname on the compute node.
10065           required: true
10066           type: string
10067           example: __HOSTNAME__
10068         - name: interface-name
10069           in: path
10070           description: Name that identifies the physical interface
10071           required: true
10072           type: string
10073           example: __INTERFACE-NAME__
10074         - name: interface-name
10075           in: path
10076           description: Name given to the interface
10077           required: true
10078           type: string
10079           example: __INTERFACE-NAME__
10080         - name: l3-interface-ipv4-address
10081           in: path
10082           description: IP address
10083           required: true
10084           type: string
10085           example: __L3-INTERFACE-IPV4-ADDRESS__
10086         - name: body
10087           in: body
10088           description: l3-interface-ipv4-address-list object that needs to be created or updated.
10089           required: true
10090           schema:
10091             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
10092     delete:
10093       tags:
10094         - CloudInfrastructure
10095       summary: delete an existing l3-interface-ipv4-address-list
10096       description: delete an existing l3-interface-ipv4-address-list
10097       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
10098       consumes:
10099         - application/json
10100         - application/xml
10101       produces:
10102         - application/json
10103         - application/xml
10104       responses:
10105         "default":
10106           description: Response codes found in [response codes](https://wiki.onap.org/).
10107       parameters:
10108         - name: hostname
10109           in: path
10110           description: Value from executing hostname on the compute node.
10111           required: true
10112           type: string
10113           example: __HOSTNAME__
10114         - name: interface-name
10115           in: path
10116           description: Name that identifies the physical interface
10117           required: true
10118           type: string
10119           example: __INTERFACE-NAME__
10120         - name: interface-name
10121           in: path
10122           description: Name given to the interface
10123           required: true
10124           type: string
10125           example: __INTERFACE-NAME__
10126         - name: l3-interface-ipv4-address
10127           in: path
10128           description: IP address
10129           required: true
10130           type: string
10131           example: __L3-INTERFACE-IPV4-ADDRESS__
10132         - name: resource-version
10133           in: query
10134           description: resource-version for concurrency
10135           required: true
10136           type: string
10137   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
10138     put:
10139       tags:
10140         - CloudInfrastructure
10141       summary: see node definition for valid relationships
10142       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10143       consumes:
10144         - application/json
10145         - application/xml
10146       produces:
10147         - application/json
10148         - application/xml
10149       responses:
10150         "default":
10151           description: Response codes found in [response codes](https://wiki.onap.org/).
10152       parameters:
10153         - name: hostname
10154           in: path
10155           description: Value from executing hostname on the compute node.
10156           required: true
10157           type: string
10158           example: __HOSTNAME__
10159         - name: interface-name
10160           in: path
10161           description: Name that identifies the physical interface
10162           required: true
10163           type: string
10164           example: __INTERFACE-NAME__
10165         - name: interface-name
10166           in: path
10167           description: Name given to the interface
10168           required: true
10169           type: string
10170           example: __INTERFACE-NAME__
10171         - name: l3-interface-ipv6-address
10172           in: path
10173           description: IP address
10174           required: true
10175           type: string
10176           example: __L3-INTERFACE-IPV6-ADDRESS__
10177         - name: body
10178           in: body
10179           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10180           required: true
10181           schema:
10182             $ref: "#/definitions/relationship"
10183     delete:
10184       tags:
10185         - CloudInfrastructure
10186       summary: delete an existing relationship
10187       description: delete an existing relationship
10188       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
10189       consumes:
10190         - application/json
10191         - application/xml
10192       produces:
10193         - application/json
10194         - application/xml
10195       responses:
10196         "default":
10197           description: Response codes found in [response codes](https://wiki.onap.org/).
10198       parameters:
10199         - name: hostname
10200           in: path
10201           description: Value from executing hostname on the compute node.
10202           required: true
10203           type: string
10204           example: __HOSTNAME__
10205         - name: interface-name
10206           in: path
10207           description: Name that identifies the physical interface
10208           required: true
10209           type: string
10210           example: __INTERFACE-NAME__
10211         - name: interface-name
10212           in: path
10213           description: Name given to the interface
10214           required: true
10215           type: string
10216           example: __INTERFACE-NAME__
10217         - name: l3-interface-ipv6-address
10218           in: path
10219           description: IP address
10220           required: true
10221           type: string
10222           example: __L3-INTERFACE-IPV6-ADDRESS__
10223   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
10224     get:
10225       tags:
10226         - CloudInfrastructure
10227       summary: returns l3-interface-ipv6-address-list
10228       description: returns l3-interface-ipv6-address-list
10229       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10230       produces:
10231         - application/json
10232         - application/xml
10233       responses:
10234         "200":
10235           description: successful operation
10236           schema:
10237               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
10238         "default":
10239           description: Response codes found in [response codes](https://wiki.onap.org/).
10240       parameters:
10241         - name: hostname
10242           in: path
10243           description: Value from executing hostname on the compute node.
10244           required: true
10245           type: string
10246           example: __HOSTNAME__
10247         - name: interface-name
10248           in: path
10249           description: Name that identifies the physical interface
10250           required: true
10251           type: string
10252           example: __INTERFACE-NAME__
10253         - name: interface-name
10254           in: path
10255           description: Name given to the interface
10256           required: true
10257           type: string
10258           example: __INTERFACE-NAME__
10259         - name: l3-interface-ipv6-address
10260           in: path
10261           description: IP address
10262           required: true
10263           type: string
10264           example: __L3-INTERFACE-IPV6-ADDRESS__
10265         - name: inv-status
10266           in: query
10267           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10268           required: false
10269           type: string
10270         - name: pserver-id
10271           in: query
10272           description: ID of Pserver
10273           required: false
10274           type: string
10275         - name: in-maint
10276           in: query
10277           required: false
10278           type: boolean
10279         - name: pserver-name2
10280           in: query
10281           description: alternative pserver name
10282           required: false
10283           type: string
10284         - name: prov-status
10285           in: query
10286           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10287           required: false
10288           type: string
10289         - name: interface-id
10290           in: query
10291           description: ID of interface
10292           required: false
10293           type: string
10294         - name: macaddr
10295           in: query
10296           description: MAC address for the interface
10297           required: false
10298           type: string
10299         - name: network-name
10300           in: query
10301           description: Name of the network
10302           required: false
10303           type: string
10304         - name: vlan-id-inner
10305           in: query
10306           description: Inner VLAN tag
10307           required: false
10308           type: integer
10309           format: int64
10310         - name: neutron-network-id
10311           in: query
10312           description: Neutron network id of the interface that address belongs to
10313           required: false
10314           type: string
10315         - name: neutron-subnet-id
10316           in: query
10317           description: Neutron id of subnet that address belongs to
10318           required: false
10319           type: string
10320     put:
10321       tags:
10322         - CloudInfrastructure
10323       summary: create or update an existing l3-interface-ipv6-address-list
10324       description: |
10325         Create or update an existing l3-interface-ipv6-address-list.
10326         #
10327         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10328       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10329       consumes:
10330         - application/json
10331         - application/xml
10332       produces:
10333         - application/json
10334         - application/xml
10335       responses:
10336         "default":
10337           description: Response codes found in [response codes](https://wiki.onap.org/).
10338       parameters:
10339         - name: hostname
10340           in: path
10341           description: Value from executing hostname on the compute node.
10342           required: true
10343           type: string
10344           example: __HOSTNAME__
10345         - name: interface-name
10346           in: path
10347           description: Name that identifies the physical interface
10348           required: true
10349           type: string
10350           example: __INTERFACE-NAME__
10351         - name: interface-name
10352           in: path
10353           description: Name given to the interface
10354           required: true
10355           type: string
10356           example: __INTERFACE-NAME__
10357         - name: l3-interface-ipv6-address
10358           in: path
10359           description: IP address
10360           required: true
10361           type: string
10362           example: __L3-INTERFACE-IPV6-ADDRESS__
10363         - name: body
10364           in: body
10365           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
10366           required: true
10367           schema:
10368             $ref: "#/definitions/l3-interface-ipv6-address-list"
10369     patch:
10370       tags:
10371         - CloudInfrastructure
10372       summary: update an existing l3-interface-ipv6-address-list
10373       description: |
10374         Update an existing l3-interface-ipv6-address-list
10375         #
10376         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10377         The PUT operation will entirely replace an existing object.
10378         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10379         #
10380         Other differences between PUT and PATCH are:
10381         #
10382         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10383         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10384         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10385       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10386       consumes:
10387         - application/json
10388         - application/xml
10389       produces:
10390         - application/json
10391         - application/xml
10392       responses:
10393         "default":
10394           description: Response codes found in [response codes](https://wiki.onap.org/).
10395       parameters:
10396         - name: hostname
10397           in: path
10398           description: Value from executing hostname on the compute node.
10399           required: true
10400           type: string
10401           example: __HOSTNAME__
10402         - name: interface-name
10403           in: path
10404           description: Name that identifies the physical interface
10405           required: true
10406           type: string
10407           example: __INTERFACE-NAME__
10408         - name: interface-name
10409           in: path
10410           description: Name given to the interface
10411           required: true
10412           type: string
10413           example: __INTERFACE-NAME__
10414         - name: l3-interface-ipv6-address
10415           in: path
10416           description: IP address
10417           required: true
10418           type: string
10419           example: __L3-INTERFACE-IPV6-ADDRESS__
10420         - name: body
10421           in: body
10422           description: l3-interface-ipv6-address-list object that needs to be created or updated.
10423           required: true
10424           schema:
10425             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10426     delete:
10427       tags:
10428         - CloudInfrastructure
10429       summary: delete an existing l3-interface-ipv6-address-list
10430       description: delete an existing l3-interface-ipv6-address-list
10431       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
10432       consumes:
10433         - application/json
10434         - application/xml
10435       produces:
10436         - application/json
10437         - application/xml
10438       responses:
10439         "default":
10440           description: Response codes found in [response codes](https://wiki.onap.org/).
10441       parameters:
10442         - name: hostname
10443           in: path
10444           description: Value from executing hostname on the compute node.
10445           required: true
10446           type: string
10447           example: __HOSTNAME__
10448         - name: interface-name
10449           in: path
10450           description: Name that identifies the physical interface
10451           required: true
10452           type: string
10453           example: __INTERFACE-NAME__
10454         - name: interface-name
10455           in: path
10456           description: Name given to the interface
10457           required: true
10458           type: string
10459           example: __INTERFACE-NAME__
10460         - name: l3-interface-ipv6-address
10461           in: path
10462           description: IP address
10463           required: true
10464           type: string
10465           example: __L3-INTERFACE-IPV6-ADDRESS__
10466         - name: resource-version
10467           in: query
10468           description: resource-version for concurrency
10469           required: true
10470           type: string
10471   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
10472     get:
10473       tags:
10474         - CloudInfrastructure
10475       summary: returns l-interface
10476       description: returns l-interface
10477       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10478       produces:
10479         - application/json
10480         - application/xml
10481       responses:
10482         "200":
10483           description: successful operation
10484           schema:
10485               $ref: "#/getDefinitions/l-interface"
10486         "default":
10487           description: Response codes found in [response codes](https://wiki.onap.org/).
10488       parameters:
10489         - name: hostname
10490           in: path
10491           description: Value from executing hostname on the compute node.
10492           required: true
10493           type: string
10494           example: __HOSTNAME__
10495         - name: interface-name
10496           in: path
10497           description: Name that identifies the physical interface
10498           required: true
10499           type: string
10500           example: __INTERFACE-NAME__
10501         - name: interface-name
10502           in: path
10503           description: Name given to the interface
10504           required: true
10505           type: string
10506           example: __INTERFACE-NAME__
10507         - name: inv-status
10508           in: query
10509           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10510           required: false
10511           type: string
10512         - name: pserver-id
10513           in: query
10514           description: ID of Pserver
10515           required: false
10516           type: string
10517         - name: in-maint
10518           in: query
10519           required: false
10520           type: boolean
10521         - name: pserver-name2
10522           in: query
10523           description: alternative pserver name
10524           required: false
10525           type: string
10526         - name: prov-status
10527           in: query
10528           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10529           required: false
10530           type: string
10531         - name: interface-id
10532           in: query
10533           description: ID of interface
10534           required: false
10535           type: string
10536         - name: macaddr
10537           in: query
10538           description: MAC address for the interface
10539           required: false
10540           type: string
10541         - name: network-name
10542           in: query
10543           description: Name of the network
10544           required: false
10545           type: string
10546     put:
10547       tags:
10548         - CloudInfrastructure
10549       summary: create or update an existing l-interface
10550       description: |
10551         Create or update an existing l-interface.
10552         #
10553         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10554       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10555       consumes:
10556         - application/json
10557         - application/xml
10558       produces:
10559         - application/json
10560         - application/xml
10561       responses:
10562         "default":
10563           description: Response codes found in [response codes](https://wiki.onap.org/).
10564       parameters:
10565         - name: hostname
10566           in: path
10567           description: Value from executing hostname on the compute node.
10568           required: true
10569           type: string
10570           example: __HOSTNAME__
10571         - name: interface-name
10572           in: path
10573           description: Name that identifies the physical interface
10574           required: true
10575           type: string
10576           example: __INTERFACE-NAME__
10577         - name: interface-name
10578           in: path
10579           description: Name given to the interface
10580           required: true
10581           type: string
10582           example: __INTERFACE-NAME__
10583         - name: body
10584           in: body
10585           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
10586           required: true
10587           schema:
10588             $ref: "#/definitions/l-interface"
10589     patch:
10590       tags:
10591         - CloudInfrastructure
10592       summary: update an existing l-interface
10593       description: |
10594         Update an existing l-interface
10595         #
10596         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10597         The PUT operation will entirely replace an existing object.
10598         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10599         #
10600         Other differences between PUT and PATCH are:
10601         #
10602         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10603         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10604         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10605       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10606       consumes:
10607         - application/json
10608         - application/xml
10609       produces:
10610         - application/json
10611         - application/xml
10612       responses:
10613         "default":
10614           description: Response codes found in [response codes](https://wiki.onap.org/).
10615       parameters:
10616         - name: hostname
10617           in: path
10618           description: Value from executing hostname on the compute node.
10619           required: true
10620           type: string
10621           example: __HOSTNAME__
10622         - name: interface-name
10623           in: path
10624           description: Name that identifies the physical interface
10625           required: true
10626           type: string
10627           example: __INTERFACE-NAME__
10628         - name: interface-name
10629           in: path
10630           description: Name given to the interface
10631           required: true
10632           type: string
10633           example: __INTERFACE-NAME__
10634         - name: body
10635           in: body
10636           description: l-interface object that needs to be created or updated.
10637           required: true
10638           schema:
10639             $ref: "#/patchDefinitions/l-interface"
10640     delete:
10641       tags:
10642         - CloudInfrastructure
10643       summary: delete an existing l-interface
10644       description: delete an existing l-interface
10645       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
10646       consumes:
10647         - application/json
10648         - application/xml
10649       produces:
10650         - application/json
10651         - application/xml
10652       responses:
10653         "default":
10654           description: Response codes found in [response codes](https://wiki.onap.org/).
10655       parameters:
10656         - name: hostname
10657           in: path
10658           description: Value from executing hostname on the compute node.
10659           required: true
10660           type: string
10661           example: __HOSTNAME__
10662         - name: interface-name
10663           in: path
10664           description: Name that identifies the physical interface
10665           required: true
10666           type: string
10667           example: __INTERFACE-NAME__
10668         - name: interface-name
10669           in: path
10670           description: Name given to the interface
10671           required: true
10672           type: string
10673           example: __INTERFACE-NAME__
10674         - name: resource-version
10675           in: query
10676           description: resource-version for concurrency
10677           required: true
10678           type: string
10679   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
10680     get:
10681       tags:
10682         - CloudInfrastructure
10683       summary: returns l-interfaces
10684       description: returns l-interfaces
10685       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
10686       produces:
10687         - application/json
10688         - application/xml
10689       responses:
10690         "200":
10691           description: successful operation
10692           schema:
10693               $ref: "#/getDefinitions/l-interfaces"
10694         "default":
10695           description: Response codes found in [response codes](https://wiki.onap.org/).
10696       parameters:
10697         - name: hostname
10698           in: path
10699           description: Value from executing hostname on the compute node.
10700           required: true
10701           type: string
10702           example: __HOSTNAME__
10703         - name: interface-name
10704           in: path
10705           description: Name that identifies the physical interface
10706           required: true
10707           type: string
10708           example: __INTERFACE-NAME__
10709         - name: inv-status
10710           in: query
10711           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10712           required: false
10713           type: string
10714         - name: pserver-id
10715           in: query
10716           description: ID of Pserver
10717           required: false
10718           type: string
10719         - name: in-maint
10720           in: query
10721           required: false
10722           type: boolean
10723         - name: pserver-name2
10724           in: query
10725           description: alternative pserver name
10726           required: false
10727           type: string
10728         - name: prov-status
10729           in: query
10730           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10731           required: false
10732           type: string
10733   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
10734     get:
10735       tags:
10736         - CloudInfrastructure
10737       summary: returns p-interface
10738       description: returns p-interface
10739       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
10740       produces:
10741         - application/json
10742         - application/xml
10743       responses:
10744         "200":
10745           description: successful operation
10746           schema:
10747               $ref: "#/getDefinitions/p-interface"
10748         "default":
10749           description: Response codes found in [response codes](https://wiki.onap.org/).
10750       parameters:
10751         - name: hostname
10752           in: path
10753           description: Value from executing hostname on the compute node.
10754           required: true
10755           type: string
10756           example: __HOSTNAME__
10757         - name: interface-name
10758           in: path
10759           description: Name that identifies the physical interface
10760           required: true
10761           type: string
10762           example: __INTERFACE-NAME__
10763         - name: inv-status
10764           in: query
10765           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10766           required: false
10767           type: string
10768         - name: pserver-id
10769           in: query
10770           description: ID of Pserver
10771           required: false
10772           type: string
10773         - name: in-maint
10774           in: query
10775           required: false
10776           type: boolean
10777         - name: pserver-name2
10778           in: query
10779           description: alternative pserver name
10780           required: false
10781           type: string
10782         - name: prov-status
10783           in: query
10784           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10785           required: false
10786           type: string
10787     put:
10788       tags:
10789         - CloudInfrastructure
10790       summary: create or update an existing p-interface
10791       description: |
10792         Create or update an existing p-interface.
10793         #
10794         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10795       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10796       consumes:
10797         - application/json
10798         - application/xml
10799       produces:
10800         - application/json
10801         - application/xml
10802       responses:
10803         "default":
10804           description: Response codes found in [response codes](https://wiki.onap.org/).
10805       parameters:
10806         - name: hostname
10807           in: path
10808           description: Value from executing hostname on the compute node.
10809           required: true
10810           type: string
10811           example: __HOSTNAME__
10812         - name: interface-name
10813           in: path
10814           description: Name that identifies the physical interface
10815           required: true
10816           type: string
10817           example: __INTERFACE-NAME__
10818         - name: body
10819           in: body
10820           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
10821           required: true
10822           schema:
10823             $ref: "#/definitions/p-interface"
10824     patch:
10825       tags:
10826         - CloudInfrastructure
10827       summary: update an existing p-interface
10828       description: |
10829         Update an existing p-interface
10830         #
10831         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10832         The PUT operation will entirely replace an existing object.
10833         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10834         #
10835         Other differences between PUT and PATCH are:
10836         #
10837         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10838         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10839         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10840       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
10841       consumes:
10842         - application/json
10843         - application/xml
10844       produces:
10845         - application/json
10846         - application/xml
10847       responses:
10848         "default":
10849           description: Response codes found in [response codes](https://wiki.onap.org/).
10850       parameters:
10851         - name: hostname
10852           in: path
10853           description: Value from executing hostname on the compute node.
10854           required: true
10855           type: string
10856           example: __HOSTNAME__
10857         - name: interface-name
10858           in: path
10859           description: Name that identifies the physical interface
10860           required: true
10861           type: string
10862           example: __INTERFACE-NAME__
10863         - name: body
10864           in: body
10865           description: p-interface object that needs to be created or updated.
10866           required: true
10867           schema:
10868             $ref: "#/patchDefinitions/p-interface"
10869     delete:
10870       tags:
10871         - CloudInfrastructure
10872       summary: delete an existing p-interface
10873       description: delete an existing p-interface
10874       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
10875       consumes:
10876         - application/json
10877         - application/xml
10878       produces:
10879         - application/json
10880         - application/xml
10881       responses:
10882         "default":
10883           description: Response codes found in [response codes](https://wiki.onap.org/).
10884       parameters:
10885         - name: hostname
10886           in: path
10887           description: Value from executing hostname on the compute node.
10888           required: true
10889           type: string
10890           example: __HOSTNAME__
10891         - name: interface-name
10892           in: path
10893           description: Name that identifies the physical interface
10894           required: true
10895           type: string
10896           example: __INTERFACE-NAME__
10897         - name: resource-version
10898           in: query
10899           description: resource-version for concurrency
10900           required: true
10901           type: string
10902   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
10903     get:
10904       tags:
10905         - CloudInfrastructure
10906       summary: returns p-interfaces
10907       description: returns p-interfaces
10908       operationId: getCloudInfrastructurePserversPserverPInterfaces
10909       produces:
10910         - application/json
10911         - application/xml
10912       responses:
10913         "200":
10914           description: successful operation
10915           schema:
10916               $ref: "#/getDefinitions/p-interfaces"
10917         "default":
10918           description: Response codes found in [response codes](https://wiki.onap.org/).
10919       parameters:
10920         - name: hostname
10921           in: path
10922           description: Value from executing hostname on the compute node.
10923           required: true
10924           type: string
10925           example: __HOSTNAME__
10926         - name: inv-status
10927           in: query
10928           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10929           required: false
10930           type: string
10931         - name: pserver-id
10932           in: query
10933           description: ID of Pserver
10934           required: false
10935           type: string
10936         - name: in-maint
10937           in: query
10938           required: false
10939           type: boolean
10940         - name: pserver-name2
10941           in: query
10942           description: alternative pserver name
10943           required: false
10944           type: string
10945   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
10946     put:
10947       tags:
10948         - CloudInfrastructure
10949       summary: see node definition for valid relationships
10950       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10951       consumes:
10952         - application/json
10953         - application/xml
10954       produces:
10955         - application/json
10956         - application/xml
10957       responses:
10958         "default":
10959           description: Response codes found in [response codes](https://wiki.onap.org/).
10960       parameters:
10961         - name: hostname
10962           in: path
10963           description: Value from executing hostname on the compute node.
10964           required: true
10965           type: string
10966           example: __HOSTNAME__
10967         - name: interface-name
10968           in: path
10969           description: Name that identifies the link aggregate interface
10970           required: true
10971           type: string
10972           example: __INTERFACE-NAME__
10973         - name: body
10974           in: body
10975           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
10976           required: true
10977           schema:
10978             $ref: "#/definitions/relationship"
10979     delete:
10980       tags:
10981         - CloudInfrastructure
10982       summary: delete an existing relationship
10983       description: delete an existing relationship
10984       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
10985       consumes:
10986         - application/json
10987         - application/xml
10988       produces:
10989         - application/json
10990         - application/xml
10991       responses:
10992         "default":
10993           description: Response codes found in [response codes](https://wiki.onap.org/).
10994       parameters:
10995         - name: hostname
10996           in: path
10997           description: Value from executing hostname on the compute node.
10998           required: true
10999           type: string
11000           example: __HOSTNAME__
11001         - name: interface-name
11002           in: path
11003           description: Name that identifies the link aggregate interface
11004           required: true
11005           type: string
11006           example: __INTERFACE-NAME__
11007   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
11008     put:
11009       tags:
11010         - CloudInfrastructure
11011       summary: see node definition for valid relationships
11012       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11013       consumes:
11014         - application/json
11015         - application/xml
11016       produces:
11017         - application/json
11018         - application/xml
11019       responses:
11020         "default":
11021           description: Response codes found in [response codes](https://wiki.onap.org/).
11022       parameters:
11023         - name: hostname
11024           in: path
11025           description: Value from executing hostname on the compute node.
11026           required: true
11027           type: string
11028           example: __HOSTNAME__
11029         - name: interface-name
11030           in: path
11031           description: Name that identifies the link aggregate interface
11032           required: true
11033           type: string
11034           example: __INTERFACE-NAME__
11035         - name: interface-name
11036           in: path
11037           description: Name given to the interface
11038           required: true
11039           type: string
11040           example: __INTERFACE-NAME__
11041         - name: vlan-interface
11042           in: path
11043           description: String that identifies the interface
11044           required: true
11045           type: string
11046           example: __VLAN-INTERFACE__
11047         - name: body
11048           in: body
11049           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
11050           required: true
11051           schema:
11052             $ref: "#/definitions/relationship"
11053     delete:
11054       tags:
11055         - CloudInfrastructure
11056       summary: delete an existing relationship
11057       description: delete an existing relationship
11058       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
11059       consumes:
11060         - application/json
11061         - application/xml
11062       produces:
11063         - application/json
11064         - application/xml
11065       responses:
11066         "default":
11067           description: Response codes found in [response codes](https://wiki.onap.org/).
11068       parameters:
11069         - name: hostname
11070           in: path
11071           description: Value from executing hostname on the compute node.
11072           required: true
11073           type: string
11074           example: __HOSTNAME__
11075         - name: interface-name
11076           in: path
11077           description: Name that identifies the link aggregate interface
11078           required: true
11079           type: string
11080           example: __INTERFACE-NAME__
11081         - name: interface-name
11082           in: path
11083           description: Name given to the interface
11084           required: true
11085           type: string
11086           example: __INTERFACE-NAME__
11087         - name: vlan-interface
11088           in: path
11089           description: String that identifies the interface
11090           required: true
11091           type: string
11092           example: __VLAN-INTERFACE__
11093   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
11094     put:
11095       tags:
11096         - CloudInfrastructure
11097       summary: see node definition for valid relationships
11098       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11099       consumes:
11100         - application/json
11101         - application/xml
11102       produces:
11103         - application/json
11104         - application/xml
11105       responses:
11106         "default":
11107           description: Response codes found in [response codes](https://wiki.onap.org/).
11108       parameters:
11109         - name: hostname
11110           in: path
11111           description: Value from executing hostname on the compute node.
11112           required: true
11113           type: string
11114           example: __HOSTNAME__
11115         - name: interface-name
11116           in: path
11117           description: Name that identifies the link aggregate interface
11118           required: true
11119           type: string
11120           example: __INTERFACE-NAME__
11121         - name: interface-name
11122           in: path
11123           description: Name given to the interface
11124           required: true
11125           type: string
11126           example: __INTERFACE-NAME__
11127         - name: vlan-interface
11128           in: path
11129           description: String that identifies the interface
11130           required: true
11131           type: string
11132           example: __VLAN-INTERFACE__
11133         - name: l3-interface-ipv4-address
11134           in: path
11135           description: IP address
11136           required: true
11137           type: string
11138           example: __L3-INTERFACE-IPV4-ADDRESS__
11139         - name: body
11140           in: body
11141           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11142           required: true
11143           schema:
11144             $ref: "#/definitions/relationship"
11145     delete:
11146       tags:
11147         - CloudInfrastructure
11148       summary: delete an existing relationship
11149       description: delete an existing relationship
11150       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
11151       consumes:
11152         - application/json
11153         - application/xml
11154       produces:
11155         - application/json
11156         - application/xml
11157       responses:
11158         "default":
11159           description: Response codes found in [response codes](https://wiki.onap.org/).
11160       parameters:
11161         - name: hostname
11162           in: path
11163           description: Value from executing hostname on the compute node.
11164           required: true
11165           type: string
11166           example: __HOSTNAME__
11167         - name: interface-name
11168           in: path
11169           description: Name that identifies the link aggregate interface
11170           required: true
11171           type: string
11172           example: __INTERFACE-NAME__
11173         - name: interface-name
11174           in: path
11175           description: Name given to the interface
11176           required: true
11177           type: string
11178           example: __INTERFACE-NAME__
11179         - name: vlan-interface
11180           in: path
11181           description: String that identifies the interface
11182           required: true
11183           type: string
11184           example: __VLAN-INTERFACE__
11185         - name: l3-interface-ipv4-address
11186           in: path
11187           description: IP address
11188           required: true
11189           type: string
11190           example: __L3-INTERFACE-IPV4-ADDRESS__
11191   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
11192     get:
11193       tags:
11194         - CloudInfrastructure
11195       summary: returns l3-interface-ipv4-address-list
11196       description: returns l3-interface-ipv4-address-list
11197       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11198       produces:
11199         - application/json
11200         - application/xml
11201       responses:
11202         "200":
11203           description: successful operation
11204           schema:
11205               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11206         "default":
11207           description: Response codes found in [response codes](https://wiki.onap.org/).
11208       parameters:
11209         - name: hostname
11210           in: path
11211           description: Value from executing hostname on the compute node.
11212           required: true
11213           type: string
11214           example: __HOSTNAME__
11215         - name: interface-name
11216           in: path
11217           description: Name that identifies the link aggregate interface
11218           required: true
11219           type: string
11220           example: __INTERFACE-NAME__
11221         - name: interface-name
11222           in: path
11223           description: Name given to the interface
11224           required: true
11225           type: string
11226           example: __INTERFACE-NAME__
11227         - name: vlan-interface
11228           in: path
11229           description: String that identifies the interface
11230           required: true
11231           type: string
11232           example: __VLAN-INTERFACE__
11233         - name: l3-interface-ipv4-address
11234           in: path
11235           description: IP address
11236           required: true
11237           type: string
11238           example: __L3-INTERFACE-IPV4-ADDRESS__
11239         - name: inv-status
11240           in: query
11241           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11242           required: false
11243           type: string
11244         - name: pserver-id
11245           in: query
11246           description: ID of Pserver
11247           required: false
11248           type: string
11249         - name: in-maint
11250           in: query
11251           required: false
11252           type: boolean
11253         - name: pserver-name2
11254           in: query
11255           description: alternative pserver name
11256           required: false
11257           type: string
11258         - name: interface-id
11259           in: query
11260           description: ID of interface
11261           required: false
11262           type: string
11263         - name: interface-role
11264           in: query
11265           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11266           required: false
11267           type: string
11268         - name: interface-id
11269           in: query
11270           description: ID of interface
11271           required: false
11272           type: string
11273         - name: macaddr
11274           in: query
11275           description: MAC address for the interface
11276           required: false
11277           type: string
11278         - name: network-name
11279           in: query
11280           description: Name of the network
11281           required: false
11282           type: string
11283         - name: vlan-id-inner
11284           in: query
11285           description: Inner VLAN tag
11286           required: false
11287           type: integer
11288           format: int64
11289         - name: vpn-id
11290           in: query
11291           description: This indicates the customers VPN ID associated with this vlan
11292           required: false
11293           type: string
11294         - name: vlan-id-inner
11295           in: query
11296           description: Inner VLAN tag
11297           required: false
11298           type: integer
11299           format: int64
11300         - name: neutron-network-id
11301           in: query
11302           description: Neutron network id of the interface that address belongs to
11303           required: false
11304           type: string
11305         - name: neutron-subnet-id
11306           in: query
11307           description: Neutron id of subnet that address belongs to
11308           required: false
11309           type: string
11310     put:
11311       tags:
11312         - CloudInfrastructure
11313       summary: create or update an existing l3-interface-ipv4-address-list
11314       description: |
11315         Create or update an existing l3-interface-ipv4-address-list.
11316         #
11317         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11318       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11319       consumes:
11320         - application/json
11321         - application/xml
11322       produces:
11323         - application/json
11324         - application/xml
11325       responses:
11326         "default":
11327           description: Response codes found in [response codes](https://wiki.onap.org/).
11328       parameters:
11329         - name: hostname
11330           in: path
11331           description: Value from executing hostname on the compute node.
11332           required: true
11333           type: string
11334           example: __HOSTNAME__
11335         - name: interface-name
11336           in: path
11337           description: Name that identifies the link aggregate interface
11338           required: true
11339           type: string
11340           example: __INTERFACE-NAME__
11341         - name: interface-name
11342           in: path
11343           description: Name given to the interface
11344           required: true
11345           type: string
11346           example: __INTERFACE-NAME__
11347         - name: vlan-interface
11348           in: path
11349           description: String that identifies the interface
11350           required: true
11351           type: string
11352           example: __VLAN-INTERFACE__
11353         - name: l3-interface-ipv4-address
11354           in: path
11355           description: IP address
11356           required: true
11357           type: string
11358           example: __L3-INTERFACE-IPV4-ADDRESS__
11359         - name: body
11360           in: body
11361           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
11362           required: true
11363           schema:
11364             $ref: "#/definitions/l3-interface-ipv4-address-list"
11365     patch:
11366       tags:
11367         - CloudInfrastructure
11368       summary: update an existing l3-interface-ipv4-address-list
11369       description: |
11370         Update an existing l3-interface-ipv4-address-list
11371         #
11372         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11373         The PUT operation will entirely replace an existing object.
11374         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11375         #
11376         Other differences between PUT and PATCH are:
11377         #
11378         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11379         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11380         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11381       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11382       consumes:
11383         - application/json
11384         - application/xml
11385       produces:
11386         - application/json
11387         - application/xml
11388       responses:
11389         "default":
11390           description: Response codes found in [response codes](https://wiki.onap.org/).
11391       parameters:
11392         - name: hostname
11393           in: path
11394           description: Value from executing hostname on the compute node.
11395           required: true
11396           type: string
11397           example: __HOSTNAME__
11398         - name: interface-name
11399           in: path
11400           description: Name that identifies the link aggregate interface
11401           required: true
11402           type: string
11403           example: __INTERFACE-NAME__
11404         - name: interface-name
11405           in: path
11406           description: Name given to the interface
11407           required: true
11408           type: string
11409           example: __INTERFACE-NAME__
11410         - name: vlan-interface
11411           in: path
11412           description: String that identifies the interface
11413           required: true
11414           type: string
11415           example: __VLAN-INTERFACE__
11416         - name: l3-interface-ipv4-address
11417           in: path
11418           description: IP address
11419           required: true
11420           type: string
11421           example: __L3-INTERFACE-IPV4-ADDRESS__
11422         - name: body
11423           in: body
11424           description: l3-interface-ipv4-address-list object that needs to be created or updated.
11425           required: true
11426           schema:
11427             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11428     delete:
11429       tags:
11430         - CloudInfrastructure
11431       summary: delete an existing l3-interface-ipv4-address-list
11432       description: delete an existing l3-interface-ipv4-address-list
11433       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
11434       consumes:
11435         - application/json
11436         - application/xml
11437       produces:
11438         - application/json
11439         - application/xml
11440       responses:
11441         "default":
11442           description: Response codes found in [response codes](https://wiki.onap.org/).
11443       parameters:
11444         - name: hostname
11445           in: path
11446           description: Value from executing hostname on the compute node.
11447           required: true
11448           type: string
11449           example: __HOSTNAME__
11450         - name: interface-name
11451           in: path
11452           description: Name that identifies the link aggregate interface
11453           required: true
11454           type: string
11455           example: __INTERFACE-NAME__
11456         - name: interface-name
11457           in: path
11458           description: Name given to the interface
11459           required: true
11460           type: string
11461           example: __INTERFACE-NAME__
11462         - name: vlan-interface
11463           in: path
11464           description: String that identifies the interface
11465           required: true
11466           type: string
11467           example: __VLAN-INTERFACE__
11468         - name: l3-interface-ipv4-address
11469           in: path
11470           description: IP address
11471           required: true
11472           type: string
11473           example: __L3-INTERFACE-IPV4-ADDRESS__
11474         - name: resource-version
11475           in: query
11476           description: resource-version for concurrency
11477           required: true
11478           type: string
11479   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
11480     put:
11481       tags:
11482         - CloudInfrastructure
11483       summary: see node definition for valid relationships
11484       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11485       consumes:
11486         - application/json
11487         - application/xml
11488       produces:
11489         - application/json
11490         - application/xml
11491       responses:
11492         "default":
11493           description: Response codes found in [response codes](https://wiki.onap.org/).
11494       parameters:
11495         - name: hostname
11496           in: path
11497           description: Value from executing hostname on the compute node.
11498           required: true
11499           type: string
11500           example: __HOSTNAME__
11501         - name: interface-name
11502           in: path
11503           description: Name that identifies the link aggregate interface
11504           required: true
11505           type: string
11506           example: __INTERFACE-NAME__
11507         - name: interface-name
11508           in: path
11509           description: Name given to the interface
11510           required: true
11511           type: string
11512           example: __INTERFACE-NAME__
11513         - name: vlan-interface
11514           in: path
11515           description: String that identifies the interface
11516           required: true
11517           type: string
11518           example: __VLAN-INTERFACE__
11519         - name: l3-interface-ipv6-address
11520           in: path
11521           description: IP address
11522           required: true
11523           type: string
11524           example: __L3-INTERFACE-IPV6-ADDRESS__
11525         - name: body
11526           in: body
11527           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11528           required: true
11529           schema:
11530             $ref: "#/definitions/relationship"
11531     delete:
11532       tags:
11533         - CloudInfrastructure
11534       summary: delete an existing relationship
11535       description: delete an existing relationship
11536       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
11537       consumes:
11538         - application/json
11539         - application/xml
11540       produces:
11541         - application/json
11542         - application/xml
11543       responses:
11544         "default":
11545           description: Response codes found in [response codes](https://wiki.onap.org/).
11546       parameters:
11547         - name: hostname
11548           in: path
11549           description: Value from executing hostname on the compute node.
11550           required: true
11551           type: string
11552           example: __HOSTNAME__
11553         - name: interface-name
11554           in: path
11555           description: Name that identifies the link aggregate interface
11556           required: true
11557           type: string
11558           example: __INTERFACE-NAME__
11559         - name: interface-name
11560           in: path
11561           description: Name given to the interface
11562           required: true
11563           type: string
11564           example: __INTERFACE-NAME__
11565         - name: vlan-interface
11566           in: path
11567           description: String that identifies the interface
11568           required: true
11569           type: string
11570           example: __VLAN-INTERFACE__
11571         - name: l3-interface-ipv6-address
11572           in: path
11573           description: IP address
11574           required: true
11575           type: string
11576           example: __L3-INTERFACE-IPV6-ADDRESS__
11577   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
11578     get:
11579       tags:
11580         - CloudInfrastructure
11581       summary: returns l3-interface-ipv6-address-list
11582       description: returns l3-interface-ipv6-address-list
11583       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11584       produces:
11585         - application/json
11586         - application/xml
11587       responses:
11588         "200":
11589           description: successful operation
11590           schema:
11591               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11592         "default":
11593           description: Response codes found in [response codes](https://wiki.onap.org/).
11594       parameters:
11595         - name: hostname
11596           in: path
11597           description: Value from executing hostname on the compute node.
11598           required: true
11599           type: string
11600           example: __HOSTNAME__
11601         - name: interface-name
11602           in: path
11603           description: Name that identifies the link aggregate interface
11604           required: true
11605           type: string
11606           example: __INTERFACE-NAME__
11607         - name: interface-name
11608           in: path
11609           description: Name given to the interface
11610           required: true
11611           type: string
11612           example: __INTERFACE-NAME__
11613         - name: vlan-interface
11614           in: path
11615           description: String that identifies the interface
11616           required: true
11617           type: string
11618           example: __VLAN-INTERFACE__
11619         - name: l3-interface-ipv6-address
11620           in: path
11621           description: IP address
11622           required: true
11623           type: string
11624           example: __L3-INTERFACE-IPV6-ADDRESS__
11625         - name: inv-status
11626           in: query
11627           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11628           required: false
11629           type: string
11630         - name: pserver-id
11631           in: query
11632           description: ID of Pserver
11633           required: false
11634           type: string
11635         - name: in-maint
11636           in: query
11637           required: false
11638           type: boolean
11639         - name: pserver-name2
11640           in: query
11641           description: alternative pserver name
11642           required: false
11643           type: string
11644         - name: interface-id
11645           in: query
11646           description: ID of interface
11647           required: false
11648           type: string
11649         - name: interface-role
11650           in: query
11651           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11652           required: false
11653           type: string
11654         - name: interface-id
11655           in: query
11656           description: ID of interface
11657           required: false
11658           type: string
11659         - name: macaddr
11660           in: query
11661           description: MAC address for the interface
11662           required: false
11663           type: string
11664         - name: network-name
11665           in: query
11666           description: Name of the network
11667           required: false
11668           type: string
11669         - name: vlan-id-inner
11670           in: query
11671           description: Inner VLAN tag
11672           required: false
11673           type: integer
11674           format: int64
11675         - name: vpn-id
11676           in: query
11677           description: This indicates the customers VPN ID associated with this vlan
11678           required: false
11679           type: string
11680         - name: vlan-id-inner
11681           in: query
11682           description: Inner VLAN tag
11683           required: false
11684           type: integer
11685           format: int64
11686         - name: neutron-network-id
11687           in: query
11688           description: Neutron network id of the interface that address belongs to
11689           required: false
11690           type: string
11691         - name: neutron-subnet-id
11692           in: query
11693           description: Neutron id of subnet that address belongs to
11694           required: false
11695           type: string
11696     put:
11697       tags:
11698         - CloudInfrastructure
11699       summary: create or update an existing l3-interface-ipv6-address-list
11700       description: |
11701         Create or update an existing l3-interface-ipv6-address-list.
11702         #
11703         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11704       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11705       consumes:
11706         - application/json
11707         - application/xml
11708       produces:
11709         - application/json
11710         - application/xml
11711       responses:
11712         "default":
11713           description: Response codes found in [response codes](https://wiki.onap.org/).
11714       parameters:
11715         - name: hostname
11716           in: path
11717           description: Value from executing hostname on the compute node.
11718           required: true
11719           type: string
11720           example: __HOSTNAME__
11721         - name: interface-name
11722           in: path
11723           description: Name that identifies the link aggregate interface
11724           required: true
11725           type: string
11726           example: __INTERFACE-NAME__
11727         - name: interface-name
11728           in: path
11729           description: Name given to the interface
11730           required: true
11731           type: string
11732           example: __INTERFACE-NAME__
11733         - name: vlan-interface
11734           in: path
11735           description: String that identifies the interface
11736           required: true
11737           type: string
11738           example: __VLAN-INTERFACE__
11739         - name: l3-interface-ipv6-address
11740           in: path
11741           description: IP address
11742           required: true
11743           type: string
11744           example: __L3-INTERFACE-IPV6-ADDRESS__
11745         - name: body
11746           in: body
11747           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
11748           required: true
11749           schema:
11750             $ref: "#/definitions/l3-interface-ipv6-address-list"
11751     patch:
11752       tags:
11753         - CloudInfrastructure
11754       summary: update an existing l3-interface-ipv6-address-list
11755       description: |
11756         Update an existing l3-interface-ipv6-address-list
11757         #
11758         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11759         The PUT operation will entirely replace an existing object.
11760         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11761         #
11762         Other differences between PUT and PATCH are:
11763         #
11764         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11765         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11766         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11767       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11768       consumes:
11769         - application/json
11770         - application/xml
11771       produces:
11772         - application/json
11773         - application/xml
11774       responses:
11775         "default":
11776           description: Response codes found in [response codes](https://wiki.onap.org/).
11777       parameters:
11778         - name: hostname
11779           in: path
11780           description: Value from executing hostname on the compute node.
11781           required: true
11782           type: string
11783           example: __HOSTNAME__
11784         - name: interface-name
11785           in: path
11786           description: Name that identifies the link aggregate interface
11787           required: true
11788           type: string
11789           example: __INTERFACE-NAME__
11790         - name: interface-name
11791           in: path
11792           description: Name given to the interface
11793           required: true
11794           type: string
11795           example: __INTERFACE-NAME__
11796         - name: vlan-interface
11797           in: path
11798           description: String that identifies the interface
11799           required: true
11800           type: string
11801           example: __VLAN-INTERFACE__
11802         - name: l3-interface-ipv6-address
11803           in: path
11804           description: IP address
11805           required: true
11806           type: string
11807           example: __L3-INTERFACE-IPV6-ADDRESS__
11808         - name: body
11809           in: body
11810           description: l3-interface-ipv6-address-list object that needs to be created or updated.
11811           required: true
11812           schema:
11813             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11814     delete:
11815       tags:
11816         - CloudInfrastructure
11817       summary: delete an existing l3-interface-ipv6-address-list
11818       description: delete an existing l3-interface-ipv6-address-list
11819       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
11820       consumes:
11821         - application/json
11822         - application/xml
11823       produces:
11824         - application/json
11825         - application/xml
11826       responses:
11827         "default":
11828           description: Response codes found in [response codes](https://wiki.onap.org/).
11829       parameters:
11830         - name: hostname
11831           in: path
11832           description: Value from executing hostname on the compute node.
11833           required: true
11834           type: string
11835           example: __HOSTNAME__
11836         - name: interface-name
11837           in: path
11838           description: Name that identifies the link aggregate interface
11839           required: true
11840           type: string
11841           example: __INTERFACE-NAME__
11842         - name: interface-name
11843           in: path
11844           description: Name given to the interface
11845           required: true
11846           type: string
11847           example: __INTERFACE-NAME__
11848         - name: vlan-interface
11849           in: path
11850           description: String that identifies the interface
11851           required: true
11852           type: string
11853           example: __VLAN-INTERFACE__
11854         - name: l3-interface-ipv6-address
11855           in: path
11856           description: IP address
11857           required: true
11858           type: string
11859           example: __L3-INTERFACE-IPV6-ADDRESS__
11860         - name: resource-version
11861           in: query
11862           description: resource-version for concurrency
11863           required: true
11864           type: string
11865   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
11866     get:
11867       tags:
11868         - CloudInfrastructure
11869       summary: returns vlan
11870       description: returns vlan
11871       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11872       produces:
11873         - application/json
11874         - application/xml
11875       responses:
11876         "200":
11877           description: successful operation
11878           schema:
11879               $ref: "#/getDefinitions/vlan"
11880         "default":
11881           description: Response codes found in [response codes](https://wiki.onap.org/).
11882       parameters:
11883         - name: hostname
11884           in: path
11885           description: Value from executing hostname on the compute node.
11886           required: true
11887           type: string
11888           example: __HOSTNAME__
11889         - name: interface-name
11890           in: path
11891           description: Name that identifies the link aggregate interface
11892           required: true
11893           type: string
11894           example: __INTERFACE-NAME__
11895         - name: interface-name
11896           in: path
11897           description: Name given to the interface
11898           required: true
11899           type: string
11900           example: __INTERFACE-NAME__
11901         - name: vlan-interface
11902           in: path
11903           description: String that identifies the interface
11904           required: true
11905           type: string
11906           example: __VLAN-INTERFACE__
11907         - name: inv-status
11908           in: query
11909           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11910           required: false
11911           type: string
11912         - name: pserver-id
11913           in: query
11914           description: ID of Pserver
11915           required: false
11916           type: string
11917         - name: in-maint
11918           in: query
11919           required: false
11920           type: boolean
11921         - name: pserver-name2
11922           in: query
11923           description: alternative pserver name
11924           required: false
11925           type: string
11926         - name: interface-id
11927           in: query
11928           description: ID of interface
11929           required: false
11930           type: string
11931         - name: interface-role
11932           in: query
11933           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
11934           required: false
11935           type: string
11936         - name: interface-id
11937           in: query
11938           description: ID of interface
11939           required: false
11940           type: string
11941         - name: macaddr
11942           in: query
11943           description: MAC address for the interface
11944           required: false
11945           type: string
11946         - name: network-name
11947           in: query
11948           description: Name of the network
11949           required: false
11950           type: string
11951         - name: vlan-id-inner
11952           in: query
11953           description: Inner VLAN tag
11954           required: false
11955           type: integer
11956           format: int64
11957         - name: vpn-id
11958           in: query
11959           description: This indicates the customers VPN ID associated with this vlan
11960           required: false
11961           type: string
11962     put:
11963       tags:
11964         - CloudInfrastructure
11965       summary: create or update an existing vlan
11966       description: |
11967         Create or update an existing vlan.
11968         #
11969         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11970       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
11971       consumes:
11972         - application/json
11973         - application/xml
11974       produces:
11975         - application/json
11976         - application/xml
11977       responses:
11978         "default":
11979           description: Response codes found in [response codes](https://wiki.onap.org/).
11980       parameters:
11981         - name: hostname
11982           in: path
11983           description: Value from executing hostname on the compute node.
11984           required: true
11985           type: string
11986           example: __HOSTNAME__
11987         - name: interface-name
11988           in: path
11989           description: Name that identifies the link aggregate interface
11990           required: true
11991           type: string
11992           example: __INTERFACE-NAME__
11993         - name: interface-name
11994           in: path
11995           description: Name given to the interface
11996           required: true
11997           type: string
11998           example: __INTERFACE-NAME__
11999         - name: vlan-interface
12000           in: path
12001           description: String that identifies the interface
12002           required: true
12003           type: string
12004           example: __VLAN-INTERFACE__
12005         - name: body
12006           in: body
12007           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12008           required: true
12009           schema:
12010             $ref: "#/definitions/vlan"
12011     patch:
12012       tags:
12013         - CloudInfrastructure
12014       summary: update an existing vlan
12015       description: |
12016         Update an existing vlan
12017         #
12018         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12019         The PUT operation will entirely replace an existing object.
12020         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12021         #
12022         Other differences between PUT and PATCH are:
12023         #
12024         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12025         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12026         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12027       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12028       consumes:
12029         - application/json
12030         - application/xml
12031       produces:
12032         - application/json
12033         - application/xml
12034       responses:
12035         "default":
12036           description: Response codes found in [response codes](https://wiki.onap.org/).
12037       parameters:
12038         - name: hostname
12039           in: path
12040           description: Value from executing hostname on the compute node.
12041           required: true
12042           type: string
12043           example: __HOSTNAME__
12044         - name: interface-name
12045           in: path
12046           description: Name that identifies the link aggregate interface
12047           required: true
12048           type: string
12049           example: __INTERFACE-NAME__
12050         - name: interface-name
12051           in: path
12052           description: Name given to the interface
12053           required: true
12054           type: string
12055           example: __INTERFACE-NAME__
12056         - name: vlan-interface
12057           in: path
12058           description: String that identifies the interface
12059           required: true
12060           type: string
12061           example: __VLAN-INTERFACE__
12062         - name: body
12063           in: body
12064           description: vlan object that needs to be created or updated.
12065           required: true
12066           schema:
12067             $ref: "#/patchDefinitions/vlan"
12068     delete:
12069       tags:
12070         - CloudInfrastructure
12071       summary: delete an existing vlan
12072       description: delete an existing vlan
12073       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
12074       consumes:
12075         - application/json
12076         - application/xml
12077       produces:
12078         - application/json
12079         - application/xml
12080       responses:
12081         "default":
12082           description: Response codes found in [response codes](https://wiki.onap.org/).
12083       parameters:
12084         - name: hostname
12085           in: path
12086           description: Value from executing hostname on the compute node.
12087           required: true
12088           type: string
12089           example: __HOSTNAME__
12090         - name: interface-name
12091           in: path
12092           description: Name that identifies the link aggregate interface
12093           required: true
12094           type: string
12095           example: __INTERFACE-NAME__
12096         - name: interface-name
12097           in: path
12098           description: Name given to the interface
12099           required: true
12100           type: string
12101           example: __INTERFACE-NAME__
12102         - name: vlan-interface
12103           in: path
12104           description: String that identifies the interface
12105           required: true
12106           type: string
12107           example: __VLAN-INTERFACE__
12108         - name: resource-version
12109           in: query
12110           description: resource-version for concurrency
12111           required: true
12112           type: string
12113   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
12114     get:
12115       tags:
12116         - CloudInfrastructure
12117       summary: returns vlans
12118       description: returns vlans
12119       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
12120       produces:
12121         - application/json
12122         - application/xml
12123       responses:
12124         "200":
12125           description: successful operation
12126           schema:
12127               $ref: "#/getDefinitions/vlans"
12128         "default":
12129           description: Response codes found in [response codes](https://wiki.onap.org/).
12130       parameters:
12131         - name: hostname
12132           in: path
12133           description: Value from executing hostname on the compute node.
12134           required: true
12135           type: string
12136           example: __HOSTNAME__
12137         - name: interface-name
12138           in: path
12139           description: Name that identifies the link aggregate interface
12140           required: true
12141           type: string
12142           example: __INTERFACE-NAME__
12143         - name: interface-name
12144           in: path
12145           description: Name given to the interface
12146           required: true
12147           type: string
12148           example: __INTERFACE-NAME__
12149         - name: inv-status
12150           in: query
12151           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12152           required: false
12153           type: string
12154         - name: pserver-id
12155           in: query
12156           description: ID of Pserver
12157           required: false
12158           type: string
12159         - name: in-maint
12160           in: query
12161           required: false
12162           type: boolean
12163         - name: pserver-name2
12164           in: query
12165           description: alternative pserver name
12166           required: false
12167           type: string
12168         - name: interface-id
12169           in: query
12170           description: ID of interface
12171           required: false
12172           type: string
12173         - name: interface-role
12174           in: query
12175           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12176           required: false
12177           type: string
12178         - name: interface-id
12179           in: query
12180           description: ID of interface
12181           required: false
12182           type: string
12183         - name: macaddr
12184           in: query
12185           description: MAC address for the interface
12186           required: false
12187           type: string
12188         - name: network-name
12189           in: query
12190           description: Name of the network
12191           required: false
12192           type: string
12193   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
12194     put:
12195       tags:
12196         - CloudInfrastructure
12197       summary: see node definition for valid relationships
12198       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12199       consumes:
12200         - application/json
12201         - application/xml
12202       produces:
12203         - application/json
12204         - application/xml
12205       responses:
12206         "default":
12207           description: Response codes found in [response codes](https://wiki.onap.org/).
12208       parameters:
12209         - name: hostname
12210           in: path
12211           description: Value from executing hostname on the compute node.
12212           required: true
12213           type: string
12214           example: __HOSTNAME__
12215         - name: interface-name
12216           in: path
12217           description: Name that identifies the link aggregate interface
12218           required: true
12219           type: string
12220           example: __INTERFACE-NAME__
12221         - name: interface-name
12222           in: path
12223           description: Name given to the interface
12224           required: true
12225           type: string
12226           example: __INTERFACE-NAME__
12227         - name: pci-id
12228           in: path
12229           description: PCI ID used to identify the sriov-vf
12230           required: true
12231           type: string
12232           example: __PCI-ID__
12233         - name: body
12234           in: body
12235           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12236           required: true
12237           schema:
12238             $ref: "#/definitions/relationship"
12239     delete:
12240       tags:
12241         - CloudInfrastructure
12242       summary: delete an existing relationship
12243       description: delete an existing relationship
12244       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
12245       consumes:
12246         - application/json
12247         - application/xml
12248       produces:
12249         - application/json
12250         - application/xml
12251       responses:
12252         "default":
12253           description: Response codes found in [response codes](https://wiki.onap.org/).
12254       parameters:
12255         - name: hostname
12256           in: path
12257           description: Value from executing hostname on the compute node.
12258           required: true
12259           type: string
12260           example: __HOSTNAME__
12261         - name: interface-name
12262           in: path
12263           description: Name that identifies the link aggregate interface
12264           required: true
12265           type: string
12266           example: __INTERFACE-NAME__
12267         - name: interface-name
12268           in: path
12269           description: Name given to the interface
12270           required: true
12271           type: string
12272           example: __INTERFACE-NAME__
12273         - name: pci-id
12274           in: path
12275           description: PCI ID used to identify the sriov-vf
12276           required: true
12277           type: string
12278           example: __PCI-ID__
12279   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
12280     get:
12281       tags:
12282         - CloudInfrastructure
12283       summary: returns sriov-vf
12284       description: returns sriov-vf
12285       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12286       produces:
12287         - application/json
12288         - application/xml
12289       responses:
12290         "200":
12291           description: successful operation
12292           schema:
12293               $ref: "#/getDefinitions/sriov-vf"
12294         "default":
12295           description: Response codes found in [response codes](https://wiki.onap.org/).
12296       parameters:
12297         - name: hostname
12298           in: path
12299           description: Value from executing hostname on the compute node.
12300           required: true
12301           type: string
12302           example: __HOSTNAME__
12303         - name: interface-name
12304           in: path
12305           description: Name that identifies the link aggregate interface
12306           required: true
12307           type: string
12308           example: __INTERFACE-NAME__
12309         - name: interface-name
12310           in: path
12311           description: Name given to the interface
12312           required: true
12313           type: string
12314           example: __INTERFACE-NAME__
12315         - name: pci-id
12316           in: path
12317           description: PCI ID used to identify the sriov-vf
12318           required: true
12319           type: string
12320           example: __PCI-ID__
12321         - name: inv-status
12322           in: query
12323           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12324           required: false
12325           type: string
12326         - name: pserver-id
12327           in: query
12328           description: ID of Pserver
12329           required: false
12330           type: string
12331         - name: in-maint
12332           in: query
12333           required: false
12334           type: boolean
12335         - name: pserver-name2
12336           in: query
12337           description: alternative pserver name
12338           required: false
12339           type: string
12340         - name: interface-id
12341           in: query
12342           description: ID of interface
12343           required: false
12344           type: string
12345         - name: interface-role
12346           in: query
12347           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12348           required: false
12349           type: string
12350         - name: interface-id
12351           in: query
12352           description: ID of interface
12353           required: false
12354           type: string
12355         - name: macaddr
12356           in: query
12357           description: MAC address for the interface
12358           required: false
12359           type: string
12360         - name: network-name
12361           in: query
12362           description: Name of the network
12363           required: false
12364           type: string
12365         - name: vf-vlan-filter
12366           in: query
12367           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
12368           required: false
12369           type: string
12370         - name: vf-mac-filter
12371           in: query
12372           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
12373           required: false
12374           type: string
12375         - name: vf-vlan-strip
12376           in: query
12377           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
12378           required: false
12379           type: boolean
12380         - name: neutron-network-id
12381           in: query
12382           description: Neutron network id of the interface
12383           required: false
12384           type: string
12385     put:
12386       tags:
12387         - CloudInfrastructure
12388       summary: create or update an existing sriov-vf
12389       description: |
12390         Create or update an existing sriov-vf.
12391         #
12392         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12393       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12394       consumes:
12395         - application/json
12396         - application/xml
12397       produces:
12398         - application/json
12399         - application/xml
12400       responses:
12401         "default":
12402           description: Response codes found in [response codes](https://wiki.onap.org/).
12403       parameters:
12404         - name: hostname
12405           in: path
12406           description: Value from executing hostname on the compute node.
12407           required: true
12408           type: string
12409           example: __HOSTNAME__
12410         - name: interface-name
12411           in: path
12412           description: Name that identifies the link aggregate interface
12413           required: true
12414           type: string
12415           example: __INTERFACE-NAME__
12416         - name: interface-name
12417           in: path
12418           description: Name given to the interface
12419           required: true
12420           type: string
12421           example: __INTERFACE-NAME__
12422         - name: pci-id
12423           in: path
12424           description: PCI ID used to identify the sriov-vf
12425           required: true
12426           type: string
12427           example: __PCI-ID__
12428         - name: body
12429           in: body
12430           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
12431           required: true
12432           schema:
12433             $ref: "#/definitions/sriov-vf"
12434     patch:
12435       tags:
12436         - CloudInfrastructure
12437       summary: update an existing sriov-vf
12438       description: |
12439         Update an existing sriov-vf
12440         #
12441         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12442         The PUT operation will entirely replace an existing object.
12443         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12444         #
12445         Other differences between PUT and PATCH are:
12446         #
12447         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12448         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12449         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12450       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12451       consumes:
12452         - application/json
12453         - application/xml
12454       produces:
12455         - application/json
12456         - application/xml
12457       responses:
12458         "default":
12459           description: Response codes found in [response codes](https://wiki.onap.org/).
12460       parameters:
12461         - name: hostname
12462           in: path
12463           description: Value from executing hostname on the compute node.
12464           required: true
12465           type: string
12466           example: __HOSTNAME__
12467         - name: interface-name
12468           in: path
12469           description: Name that identifies the link aggregate interface
12470           required: true
12471           type: string
12472           example: __INTERFACE-NAME__
12473         - name: interface-name
12474           in: path
12475           description: Name given to the interface
12476           required: true
12477           type: string
12478           example: __INTERFACE-NAME__
12479         - name: pci-id
12480           in: path
12481           description: PCI ID used to identify the sriov-vf
12482           required: true
12483           type: string
12484           example: __PCI-ID__
12485         - name: body
12486           in: body
12487           description: sriov-vf object that needs to be created or updated.
12488           required: true
12489           schema:
12490             $ref: "#/patchDefinitions/sriov-vf"
12491     delete:
12492       tags:
12493         - CloudInfrastructure
12494       summary: delete an existing sriov-vf
12495       description: delete an existing sriov-vf
12496       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
12497       consumes:
12498         - application/json
12499         - application/xml
12500       produces:
12501         - application/json
12502         - application/xml
12503       responses:
12504         "default":
12505           description: Response codes found in [response codes](https://wiki.onap.org/).
12506       parameters:
12507         - name: hostname
12508           in: path
12509           description: Value from executing hostname on the compute node.
12510           required: true
12511           type: string
12512           example: __HOSTNAME__
12513         - name: interface-name
12514           in: path
12515           description: Name that identifies the link aggregate interface
12516           required: true
12517           type: string
12518           example: __INTERFACE-NAME__
12519         - name: interface-name
12520           in: path
12521           description: Name given to the interface
12522           required: true
12523           type: string
12524           example: __INTERFACE-NAME__
12525         - name: pci-id
12526           in: path
12527           description: PCI ID used to identify the sriov-vf
12528           required: true
12529           type: string
12530           example: __PCI-ID__
12531         - name: resource-version
12532           in: query
12533           description: resource-version for concurrency
12534           required: true
12535           type: string
12536   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
12537     get:
12538       tags:
12539         - CloudInfrastructure
12540       summary: returns sriov-vfs
12541       description: returns sriov-vfs
12542       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
12543       produces:
12544         - application/json
12545         - application/xml
12546       responses:
12547         "200":
12548           description: successful operation
12549           schema:
12550               $ref: "#/getDefinitions/sriov-vfs"
12551         "default":
12552           description: Response codes found in [response codes](https://wiki.onap.org/).
12553       parameters:
12554         - name: hostname
12555           in: path
12556           description: Value from executing hostname on the compute node.
12557           required: true
12558           type: string
12559           example: __HOSTNAME__
12560         - name: interface-name
12561           in: path
12562           description: Name that identifies the link aggregate interface
12563           required: true
12564           type: string
12565           example: __INTERFACE-NAME__
12566         - name: interface-name
12567           in: path
12568           description: Name given to the interface
12569           required: true
12570           type: string
12571           example: __INTERFACE-NAME__
12572         - name: inv-status
12573           in: query
12574           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12575           required: false
12576           type: string
12577         - name: pserver-id
12578           in: query
12579           description: ID of Pserver
12580           required: false
12581           type: string
12582         - name: in-maint
12583           in: query
12584           required: false
12585           type: boolean
12586         - name: pserver-name2
12587           in: query
12588           description: alternative pserver name
12589           required: false
12590           type: string
12591         - name: interface-id
12592           in: query
12593           description: ID of interface
12594           required: false
12595           type: string
12596         - name: interface-role
12597           in: query
12598           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12599           required: false
12600           type: string
12601         - name: interface-id
12602           in: query
12603           description: ID of interface
12604           required: false
12605           type: string
12606         - name: macaddr
12607           in: query
12608           description: MAC address for the interface
12609           required: false
12610           type: string
12611         - name: network-name
12612           in: query
12613           description: Name of the network
12614           required: false
12615           type: string
12616   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
12617     put:
12618       tags:
12619         - CloudInfrastructure
12620       summary: see node definition for valid relationships
12621       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12622       consumes:
12623         - application/json
12624         - application/xml
12625       produces:
12626         - application/json
12627         - application/xml
12628       responses:
12629         "default":
12630           description: Response codes found in [response codes](https://wiki.onap.org/).
12631       parameters:
12632         - name: hostname
12633           in: path
12634           description: Value from executing hostname on the compute node.
12635           required: true
12636           type: string
12637           example: __HOSTNAME__
12638         - name: interface-name
12639           in: path
12640           description: Name that identifies the link aggregate interface
12641           required: true
12642           type: string
12643           example: __INTERFACE-NAME__
12644         - name: interface-name
12645           in: path
12646           description: Name given to the interface
12647           required: true
12648           type: string
12649           example: __INTERFACE-NAME__
12650         - name: body
12651           in: body
12652           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
12653           required: true
12654           schema:
12655             $ref: "#/definitions/relationship"
12656     delete:
12657       tags:
12658         - CloudInfrastructure
12659       summary: delete an existing relationship
12660       description: delete an existing relationship
12661       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
12662       consumes:
12663         - application/json
12664         - application/xml
12665       produces:
12666         - application/json
12667         - application/xml
12668       responses:
12669         "default":
12670           description: Response codes found in [response codes](https://wiki.onap.org/).
12671       parameters:
12672         - name: hostname
12673           in: path
12674           description: Value from executing hostname on the compute node.
12675           required: true
12676           type: string
12677           example: __HOSTNAME__
12678         - name: interface-name
12679           in: path
12680           description: Name that identifies the link aggregate interface
12681           required: true
12682           type: string
12683           example: __INTERFACE-NAME__
12684         - name: interface-name
12685           in: path
12686           description: Name given to the interface
12687           required: true
12688           type: string
12689           example: __INTERFACE-NAME__
12690   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
12691     put:
12692       tags:
12693         - CloudInfrastructure
12694       summary: see node definition for valid relationships
12695       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12696       consumes:
12697         - application/json
12698         - application/xml
12699       produces:
12700         - application/json
12701         - application/xml
12702       responses:
12703         "default":
12704           description: Response codes found in [response codes](https://wiki.onap.org/).
12705       parameters:
12706         - name: hostname
12707           in: path
12708           description: Value from executing hostname on the compute node.
12709           required: true
12710           type: string
12711           example: __HOSTNAME__
12712         - name: interface-name
12713           in: path
12714           description: Name that identifies the link aggregate interface
12715           required: true
12716           type: string
12717           example: __INTERFACE-NAME__
12718         - name: interface-name
12719           in: path
12720           description: Name given to the interface
12721           required: true
12722           type: string
12723           example: __INTERFACE-NAME__
12724         - name: l3-interface-ipv4-address
12725           in: path
12726           description: IP address
12727           required: true
12728           type: string
12729           example: __L3-INTERFACE-IPV4-ADDRESS__
12730         - name: body
12731           in: body
12732           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12733           required: true
12734           schema:
12735             $ref: "#/definitions/relationship"
12736     delete:
12737       tags:
12738         - CloudInfrastructure
12739       summary: delete an existing relationship
12740       description: delete an existing relationship
12741       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
12742       consumes:
12743         - application/json
12744         - application/xml
12745       produces:
12746         - application/json
12747         - application/xml
12748       responses:
12749         "default":
12750           description: Response codes found in [response codes](https://wiki.onap.org/).
12751       parameters:
12752         - name: hostname
12753           in: path
12754           description: Value from executing hostname on the compute node.
12755           required: true
12756           type: string
12757           example: __HOSTNAME__
12758         - name: interface-name
12759           in: path
12760           description: Name that identifies the link aggregate interface
12761           required: true
12762           type: string
12763           example: __INTERFACE-NAME__
12764         - name: interface-name
12765           in: path
12766           description: Name given to the interface
12767           required: true
12768           type: string
12769           example: __INTERFACE-NAME__
12770         - name: l3-interface-ipv4-address
12771           in: path
12772           description: IP address
12773           required: true
12774           type: string
12775           example: __L3-INTERFACE-IPV4-ADDRESS__
12776   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
12777     get:
12778       tags:
12779         - CloudInfrastructure
12780       summary: returns l3-interface-ipv4-address-list
12781       description: returns l3-interface-ipv4-address-list
12782       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12783       produces:
12784         - application/json
12785         - application/xml
12786       responses:
12787         "200":
12788           description: successful operation
12789           schema:
12790               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12791         "default":
12792           description: Response codes found in [response codes](https://wiki.onap.org/).
12793       parameters:
12794         - name: hostname
12795           in: path
12796           description: Value from executing hostname on the compute node.
12797           required: true
12798           type: string
12799           example: __HOSTNAME__
12800         - name: interface-name
12801           in: path
12802           description: Name that identifies the link aggregate interface
12803           required: true
12804           type: string
12805           example: __INTERFACE-NAME__
12806         - name: interface-name
12807           in: path
12808           description: Name given to the interface
12809           required: true
12810           type: string
12811           example: __INTERFACE-NAME__
12812         - name: l3-interface-ipv4-address
12813           in: path
12814           description: IP address
12815           required: true
12816           type: string
12817           example: __L3-INTERFACE-IPV4-ADDRESS__
12818         - name: inv-status
12819           in: query
12820           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12821           required: false
12822           type: string
12823         - name: pserver-id
12824           in: query
12825           description: ID of Pserver
12826           required: false
12827           type: string
12828         - name: in-maint
12829           in: query
12830           required: false
12831           type: boolean
12832         - name: pserver-name2
12833           in: query
12834           description: alternative pserver name
12835           required: false
12836           type: string
12837         - name: interface-id
12838           in: query
12839           description: ID of interface
12840           required: false
12841           type: string
12842         - name: interface-role
12843           in: query
12844           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12845           required: false
12846           type: string
12847         - name: interface-id
12848           in: query
12849           description: ID of interface
12850           required: false
12851           type: string
12852         - name: macaddr
12853           in: query
12854           description: MAC address for the interface
12855           required: false
12856           type: string
12857         - name: network-name
12858           in: query
12859           description: Name of the network
12860           required: false
12861           type: string
12862         - name: vlan-id-inner
12863           in: query
12864           description: Inner VLAN tag
12865           required: false
12866           type: integer
12867           format: int64
12868         - name: neutron-network-id
12869           in: query
12870           description: Neutron network id of the interface that address belongs to
12871           required: false
12872           type: string
12873         - name: neutron-subnet-id
12874           in: query
12875           description: Neutron id of subnet that address belongs to
12876           required: false
12877           type: string
12878     put:
12879       tags:
12880         - CloudInfrastructure
12881       summary: create or update an existing l3-interface-ipv4-address-list
12882       description: |
12883         Create or update an existing l3-interface-ipv4-address-list.
12884         #
12885         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12886       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12887       consumes:
12888         - application/json
12889         - application/xml
12890       produces:
12891         - application/json
12892         - application/xml
12893       responses:
12894         "default":
12895           description: Response codes found in [response codes](https://wiki.onap.org/).
12896       parameters:
12897         - name: hostname
12898           in: path
12899           description: Value from executing hostname on the compute node.
12900           required: true
12901           type: string
12902           example: __HOSTNAME__
12903         - name: interface-name
12904           in: path
12905           description: Name that identifies the link aggregate interface
12906           required: true
12907           type: string
12908           example: __INTERFACE-NAME__
12909         - name: interface-name
12910           in: path
12911           description: Name given to the interface
12912           required: true
12913           type: string
12914           example: __INTERFACE-NAME__
12915         - name: l3-interface-ipv4-address
12916           in: path
12917           description: IP address
12918           required: true
12919           type: string
12920           example: __L3-INTERFACE-IPV4-ADDRESS__
12921         - name: body
12922           in: body
12923           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
12924           required: true
12925           schema:
12926             $ref: "#/definitions/l3-interface-ipv4-address-list"
12927     patch:
12928       tags:
12929         - CloudInfrastructure
12930       summary: update an existing l3-interface-ipv4-address-list
12931       description: |
12932         Update an existing l3-interface-ipv4-address-list
12933         #
12934         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12935         The PUT operation will entirely replace an existing object.
12936         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12937         #
12938         Other differences between PUT and PATCH are:
12939         #
12940         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12941         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12942         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12943       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12944       consumes:
12945         - application/json
12946         - application/xml
12947       produces:
12948         - application/json
12949         - application/xml
12950       responses:
12951         "default":
12952           description: Response codes found in [response codes](https://wiki.onap.org/).
12953       parameters:
12954         - name: hostname
12955           in: path
12956           description: Value from executing hostname on the compute node.
12957           required: true
12958           type: string
12959           example: __HOSTNAME__
12960         - name: interface-name
12961           in: path
12962           description: Name that identifies the link aggregate interface
12963           required: true
12964           type: string
12965           example: __INTERFACE-NAME__
12966         - name: interface-name
12967           in: path
12968           description: Name given to the interface
12969           required: true
12970           type: string
12971           example: __INTERFACE-NAME__
12972         - name: l3-interface-ipv4-address
12973           in: path
12974           description: IP address
12975           required: true
12976           type: string
12977           example: __L3-INTERFACE-IPV4-ADDRESS__
12978         - name: body
12979           in: body
12980           description: l3-interface-ipv4-address-list object that needs to be created or updated.
12981           required: true
12982           schema:
12983             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12984     delete:
12985       tags:
12986         - CloudInfrastructure
12987       summary: delete an existing l3-interface-ipv4-address-list
12988       description: delete an existing l3-interface-ipv4-address-list
12989       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
12990       consumes:
12991         - application/json
12992         - application/xml
12993       produces:
12994         - application/json
12995         - application/xml
12996       responses:
12997         "default":
12998           description: Response codes found in [response codes](https://wiki.onap.org/).
12999       parameters:
13000         - name: hostname
13001           in: path
13002           description: Value from executing hostname on the compute node.
13003           required: true
13004           type: string
13005           example: __HOSTNAME__
13006         - name: interface-name
13007           in: path
13008           description: Name that identifies the link aggregate interface
13009           required: true
13010           type: string
13011           example: __INTERFACE-NAME__
13012         - name: interface-name
13013           in: path
13014           description: Name given to the interface
13015           required: true
13016           type: string
13017           example: __INTERFACE-NAME__
13018         - name: l3-interface-ipv4-address
13019           in: path
13020           description: IP address
13021           required: true
13022           type: string
13023           example: __L3-INTERFACE-IPV4-ADDRESS__
13024         - name: resource-version
13025           in: query
13026           description: resource-version for concurrency
13027           required: true
13028           type: string
13029   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
13030     put:
13031       tags:
13032         - CloudInfrastructure
13033       summary: see node definition for valid relationships
13034       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13035       consumes:
13036         - application/json
13037         - application/xml
13038       produces:
13039         - application/json
13040         - application/xml
13041       responses:
13042         "default":
13043           description: Response codes found in [response codes](https://wiki.onap.org/).
13044       parameters:
13045         - name: hostname
13046           in: path
13047           description: Value from executing hostname on the compute node.
13048           required: true
13049           type: string
13050           example: __HOSTNAME__
13051         - name: interface-name
13052           in: path
13053           description: Name that identifies the link aggregate interface
13054           required: true
13055           type: string
13056           example: __INTERFACE-NAME__
13057         - name: interface-name
13058           in: path
13059           description: Name given to the interface
13060           required: true
13061           type: string
13062           example: __INTERFACE-NAME__
13063         - name: l3-interface-ipv6-address
13064           in: path
13065           description: IP address
13066           required: true
13067           type: string
13068           example: __L3-INTERFACE-IPV6-ADDRESS__
13069         - name: body
13070           in: body
13071           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13072           required: true
13073           schema:
13074             $ref: "#/definitions/relationship"
13075     delete:
13076       tags:
13077         - CloudInfrastructure
13078       summary: delete an existing relationship
13079       description: delete an existing relationship
13080       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
13081       consumes:
13082         - application/json
13083         - application/xml
13084       produces:
13085         - application/json
13086         - application/xml
13087       responses:
13088         "default":
13089           description: Response codes found in [response codes](https://wiki.onap.org/).
13090       parameters:
13091         - name: hostname
13092           in: path
13093           description: Value from executing hostname on the compute node.
13094           required: true
13095           type: string
13096           example: __HOSTNAME__
13097         - name: interface-name
13098           in: path
13099           description: Name that identifies the link aggregate interface
13100           required: true
13101           type: string
13102           example: __INTERFACE-NAME__
13103         - name: interface-name
13104           in: path
13105           description: Name given to the interface
13106           required: true
13107           type: string
13108           example: __INTERFACE-NAME__
13109         - name: l3-interface-ipv6-address
13110           in: path
13111           description: IP address
13112           required: true
13113           type: string
13114           example: __L3-INTERFACE-IPV6-ADDRESS__
13115   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
13116     get:
13117       tags:
13118         - CloudInfrastructure
13119       summary: returns l3-interface-ipv6-address-list
13120       description: returns l3-interface-ipv6-address-list
13121       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13122       produces:
13123         - application/json
13124         - application/xml
13125       responses:
13126         "200":
13127           description: successful operation
13128           schema:
13129               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
13130         "default":
13131           description: Response codes found in [response codes](https://wiki.onap.org/).
13132       parameters:
13133         - name: hostname
13134           in: path
13135           description: Value from executing hostname on the compute node.
13136           required: true
13137           type: string
13138           example: __HOSTNAME__
13139         - name: interface-name
13140           in: path
13141           description: Name that identifies the link aggregate interface
13142           required: true
13143           type: string
13144           example: __INTERFACE-NAME__
13145         - name: interface-name
13146           in: path
13147           description: Name given to the interface
13148           required: true
13149           type: string
13150           example: __INTERFACE-NAME__
13151         - name: l3-interface-ipv6-address
13152           in: path
13153           description: IP address
13154           required: true
13155           type: string
13156           example: __L3-INTERFACE-IPV6-ADDRESS__
13157         - name: inv-status
13158           in: query
13159           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13160           required: false
13161           type: string
13162         - name: pserver-id
13163           in: query
13164           description: ID of Pserver
13165           required: false
13166           type: string
13167         - name: in-maint
13168           in: query
13169           required: false
13170           type: boolean
13171         - name: pserver-name2
13172           in: query
13173           description: alternative pserver name
13174           required: false
13175           type: string
13176         - name: interface-id
13177           in: query
13178           description: ID of interface
13179           required: false
13180           type: string
13181         - name: interface-role
13182           in: query
13183           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13184           required: false
13185           type: string
13186         - name: interface-id
13187           in: query
13188           description: ID of interface
13189           required: false
13190           type: string
13191         - name: macaddr
13192           in: query
13193           description: MAC address for the interface
13194           required: false
13195           type: string
13196         - name: network-name
13197           in: query
13198           description: Name of the network
13199           required: false
13200           type: string
13201         - name: vlan-id-inner
13202           in: query
13203           description: Inner VLAN tag
13204           required: false
13205           type: integer
13206           format: int64
13207         - name: neutron-network-id
13208           in: query
13209           description: Neutron network id of the interface that address belongs to
13210           required: false
13211           type: string
13212         - name: neutron-subnet-id
13213           in: query
13214           description: Neutron id of subnet that address belongs to
13215           required: false
13216           type: string
13217     put:
13218       tags:
13219         - CloudInfrastructure
13220       summary: create or update an existing l3-interface-ipv6-address-list
13221       description: |
13222         Create or update an existing l3-interface-ipv6-address-list.
13223         #
13224         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13225       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13226       consumes:
13227         - application/json
13228         - application/xml
13229       produces:
13230         - application/json
13231         - application/xml
13232       responses:
13233         "default":
13234           description: Response codes found in [response codes](https://wiki.onap.org/).
13235       parameters:
13236         - name: hostname
13237           in: path
13238           description: Value from executing hostname on the compute node.
13239           required: true
13240           type: string
13241           example: __HOSTNAME__
13242         - name: interface-name
13243           in: path
13244           description: Name that identifies the link aggregate interface
13245           required: true
13246           type: string
13247           example: __INTERFACE-NAME__
13248         - name: interface-name
13249           in: path
13250           description: Name given to the interface
13251           required: true
13252           type: string
13253           example: __INTERFACE-NAME__
13254         - name: l3-interface-ipv6-address
13255           in: path
13256           description: IP address
13257           required: true
13258           type: string
13259           example: __L3-INTERFACE-IPV6-ADDRESS__
13260         - name: body
13261           in: body
13262           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
13263           required: true
13264           schema:
13265             $ref: "#/definitions/l3-interface-ipv6-address-list"
13266     patch:
13267       tags:
13268         - CloudInfrastructure
13269       summary: update an existing l3-interface-ipv6-address-list
13270       description: |
13271         Update an existing l3-interface-ipv6-address-list
13272         #
13273         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13274         The PUT operation will entirely replace an existing object.
13275         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13276         #
13277         Other differences between PUT and PATCH are:
13278         #
13279         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13280         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13281         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13282       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13283       consumes:
13284         - application/json
13285         - application/xml
13286       produces:
13287         - application/json
13288         - application/xml
13289       responses:
13290         "default":
13291           description: Response codes found in [response codes](https://wiki.onap.org/).
13292       parameters:
13293         - name: hostname
13294           in: path
13295           description: Value from executing hostname on the compute node.
13296           required: true
13297           type: string
13298           example: __HOSTNAME__
13299         - name: interface-name
13300           in: path
13301           description: Name that identifies the link aggregate interface
13302           required: true
13303           type: string
13304           example: __INTERFACE-NAME__
13305         - name: interface-name
13306           in: path
13307           description: Name given to the interface
13308           required: true
13309           type: string
13310           example: __INTERFACE-NAME__
13311         - name: l3-interface-ipv6-address
13312           in: path
13313           description: IP address
13314           required: true
13315           type: string
13316           example: __L3-INTERFACE-IPV6-ADDRESS__
13317         - name: body
13318           in: body
13319           description: l3-interface-ipv6-address-list object that needs to be created or updated.
13320           required: true
13321           schema:
13322             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13323     delete:
13324       tags:
13325         - CloudInfrastructure
13326       summary: delete an existing l3-interface-ipv6-address-list
13327       description: delete an existing l3-interface-ipv6-address-list
13328       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
13329       consumes:
13330         - application/json
13331         - application/xml
13332       produces:
13333         - application/json
13334         - application/xml
13335       responses:
13336         "default":
13337           description: Response codes found in [response codes](https://wiki.onap.org/).
13338       parameters:
13339         - name: hostname
13340           in: path
13341           description: Value from executing hostname on the compute node.
13342           required: true
13343           type: string
13344           example: __HOSTNAME__
13345         - name: interface-name
13346           in: path
13347           description: Name that identifies the link aggregate interface
13348           required: true
13349           type: string
13350           example: __INTERFACE-NAME__
13351         - name: interface-name
13352           in: path
13353           description: Name given to the interface
13354           required: true
13355           type: string
13356           example: __INTERFACE-NAME__
13357         - name: l3-interface-ipv6-address
13358           in: path
13359           description: IP address
13360           required: true
13361           type: string
13362           example: __L3-INTERFACE-IPV6-ADDRESS__
13363         - name: resource-version
13364           in: query
13365           description: resource-version for concurrency
13366           required: true
13367           type: string
13368   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
13369     get:
13370       tags:
13371         - CloudInfrastructure
13372       summary: returns l-interface
13373       description: returns l-interface
13374       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13375       produces:
13376         - application/json
13377         - application/xml
13378       responses:
13379         "200":
13380           description: successful operation
13381           schema:
13382               $ref: "#/getDefinitions/l-interface"
13383         "default":
13384           description: Response codes found in [response codes](https://wiki.onap.org/).
13385       parameters:
13386         - name: hostname
13387           in: path
13388           description: Value from executing hostname on the compute node.
13389           required: true
13390           type: string
13391           example: __HOSTNAME__
13392         - name: interface-name
13393           in: path
13394           description: Name that identifies the link aggregate interface
13395           required: true
13396           type: string
13397           example: __INTERFACE-NAME__
13398         - name: interface-name
13399           in: path
13400           description: Name given to the interface
13401           required: true
13402           type: string
13403           example: __INTERFACE-NAME__
13404         - name: inv-status
13405           in: query
13406           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13407           required: false
13408           type: string
13409         - name: pserver-id
13410           in: query
13411           description: ID of Pserver
13412           required: false
13413           type: string
13414         - name: in-maint
13415           in: query
13416           required: false
13417           type: boolean
13418         - name: pserver-name2
13419           in: query
13420           description: alternative pserver name
13421           required: false
13422           type: string
13423         - name: interface-id
13424           in: query
13425           description: ID of interface
13426           required: false
13427           type: string
13428         - name: interface-role
13429           in: query
13430           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13431           required: false
13432           type: string
13433         - name: interface-id
13434           in: query
13435           description: ID of interface
13436           required: false
13437           type: string
13438         - name: macaddr
13439           in: query
13440           description: MAC address for the interface
13441           required: false
13442           type: string
13443         - name: network-name
13444           in: query
13445           description: Name of the network
13446           required: false
13447           type: string
13448     put:
13449       tags:
13450         - CloudInfrastructure
13451       summary: create or update an existing l-interface
13452       description: |
13453         Create or update an existing l-interface.
13454         #
13455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13456       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13457       consumes:
13458         - application/json
13459         - application/xml
13460       produces:
13461         - application/json
13462         - application/xml
13463       responses:
13464         "default":
13465           description: Response codes found in [response codes](https://wiki.onap.org/).
13466       parameters:
13467         - name: hostname
13468           in: path
13469           description: Value from executing hostname on the compute node.
13470           required: true
13471           type: string
13472           example: __HOSTNAME__
13473         - name: interface-name
13474           in: path
13475           description: Name that identifies the link aggregate interface
13476           required: true
13477           type: string
13478           example: __INTERFACE-NAME__
13479         - name: interface-name
13480           in: path
13481           description: Name given to the interface
13482           required: true
13483           type: string
13484           example: __INTERFACE-NAME__
13485         - name: body
13486           in: body
13487           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13488           required: true
13489           schema:
13490             $ref: "#/definitions/l-interface"
13491     patch:
13492       tags:
13493         - CloudInfrastructure
13494       summary: update an existing l-interface
13495       description: |
13496         Update an existing l-interface
13497         #
13498         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13499         The PUT operation will entirely replace an existing object.
13500         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13501         #
13502         Other differences between PUT and PATCH are:
13503         #
13504         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13505         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13506         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13507       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13508       consumes:
13509         - application/json
13510         - application/xml
13511       produces:
13512         - application/json
13513         - application/xml
13514       responses:
13515         "default":
13516           description: Response codes found in [response codes](https://wiki.onap.org/).
13517       parameters:
13518         - name: hostname
13519           in: path
13520           description: Value from executing hostname on the compute node.
13521           required: true
13522           type: string
13523           example: __HOSTNAME__
13524         - name: interface-name
13525           in: path
13526           description: Name that identifies the link aggregate interface
13527           required: true
13528           type: string
13529           example: __INTERFACE-NAME__
13530         - name: interface-name
13531           in: path
13532           description: Name given to the interface
13533           required: true
13534           type: string
13535           example: __INTERFACE-NAME__
13536         - name: body
13537           in: body
13538           description: l-interface object that needs to be created or updated.
13539           required: true
13540           schema:
13541             $ref: "#/patchDefinitions/l-interface"
13542     delete:
13543       tags:
13544         - CloudInfrastructure
13545       summary: delete an existing l-interface
13546       description: delete an existing l-interface
13547       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
13548       consumes:
13549         - application/json
13550         - application/xml
13551       produces:
13552         - application/json
13553         - application/xml
13554       responses:
13555         "default":
13556           description: Response codes found in [response codes](https://wiki.onap.org/).
13557       parameters:
13558         - name: hostname
13559           in: path
13560           description: Value from executing hostname on the compute node.
13561           required: true
13562           type: string
13563           example: __HOSTNAME__
13564         - name: interface-name
13565           in: path
13566           description: Name that identifies the link aggregate interface
13567           required: true
13568           type: string
13569           example: __INTERFACE-NAME__
13570         - name: interface-name
13571           in: path
13572           description: Name given to the interface
13573           required: true
13574           type: string
13575           example: __INTERFACE-NAME__
13576         - name: resource-version
13577           in: query
13578           description: resource-version for concurrency
13579           required: true
13580           type: string
13581   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
13582     get:
13583       tags:
13584         - CloudInfrastructure
13585       summary: returns l-interfaces
13586       description: returns l-interfaces
13587       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
13588       produces:
13589         - application/json
13590         - application/xml
13591       responses:
13592         "200":
13593           description: successful operation
13594           schema:
13595               $ref: "#/getDefinitions/l-interfaces"
13596         "default":
13597           description: Response codes found in [response codes](https://wiki.onap.org/).
13598       parameters:
13599         - name: hostname
13600           in: path
13601           description: Value from executing hostname on the compute node.
13602           required: true
13603           type: string
13604           example: __HOSTNAME__
13605         - name: interface-name
13606           in: path
13607           description: Name that identifies the link aggregate interface
13608           required: true
13609           type: string
13610           example: __INTERFACE-NAME__
13611         - name: inv-status
13612           in: query
13613           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13614           required: false
13615           type: string
13616         - name: pserver-id
13617           in: query
13618           description: ID of Pserver
13619           required: false
13620           type: string
13621         - name: in-maint
13622           in: query
13623           required: false
13624           type: boolean
13625         - name: pserver-name2
13626           in: query
13627           description: alternative pserver name
13628           required: false
13629           type: string
13630         - name: interface-id
13631           in: query
13632           description: ID of interface
13633           required: false
13634           type: string
13635         - name: interface-role
13636           in: query
13637           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13638           required: false
13639           type: string
13640   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
13641     get:
13642       tags:
13643         - CloudInfrastructure
13644       summary: returns lag-interface
13645       description: returns lag-interface
13646       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
13647       produces:
13648         - application/json
13649         - application/xml
13650       responses:
13651         "200":
13652           description: successful operation
13653           schema:
13654               $ref: "#/getDefinitions/lag-interface"
13655         "default":
13656           description: Response codes found in [response codes](https://wiki.onap.org/).
13657       parameters:
13658         - name: hostname
13659           in: path
13660           description: Value from executing hostname on the compute node.
13661           required: true
13662           type: string
13663           example: __HOSTNAME__
13664         - name: interface-name
13665           in: path
13666           description: Name that identifies the link aggregate interface
13667           required: true
13668           type: string
13669           example: __INTERFACE-NAME__
13670         - name: inv-status
13671           in: query
13672           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13673           required: false
13674           type: string
13675         - name: pserver-id
13676           in: query
13677           description: ID of Pserver
13678           required: false
13679           type: string
13680         - name: in-maint
13681           in: query
13682           required: false
13683           type: boolean
13684         - name: pserver-name2
13685           in: query
13686           description: alternative pserver name
13687           required: false
13688           type: string
13689         - name: interface-id
13690           in: query
13691           description: ID of interface
13692           required: false
13693           type: string
13694         - name: interface-role
13695           in: query
13696           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13697           required: false
13698           type: string
13699     put:
13700       tags:
13701         - CloudInfrastructure
13702       summary: create or update an existing lag-interface
13703       description: |
13704         Create or update an existing lag-interface.
13705         #
13706         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13707       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13708       consumes:
13709         - application/json
13710         - application/xml
13711       produces:
13712         - application/json
13713         - application/xml
13714       responses:
13715         "default":
13716           description: Response codes found in [response codes](https://wiki.onap.org/).
13717       parameters:
13718         - name: hostname
13719           in: path
13720           description: Value from executing hostname on the compute node.
13721           required: true
13722           type: string
13723           example: __HOSTNAME__
13724         - name: interface-name
13725           in: path
13726           description: Name that identifies the link aggregate interface
13727           required: true
13728           type: string
13729           example: __INTERFACE-NAME__
13730         - name: body
13731           in: body
13732           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
13733           required: true
13734           schema:
13735             $ref: "#/definitions/lag-interface"
13736     patch:
13737       tags:
13738         - CloudInfrastructure
13739       summary: update an existing lag-interface
13740       description: |
13741         Update an existing lag-interface
13742         #
13743         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13744         The PUT operation will entirely replace an existing object.
13745         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13746         #
13747         Other differences between PUT and PATCH are:
13748         #
13749         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13750         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13751         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13752       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
13753       consumes:
13754         - application/json
13755         - application/xml
13756       produces:
13757         - application/json
13758         - application/xml
13759       responses:
13760         "default":
13761           description: Response codes found in [response codes](https://wiki.onap.org/).
13762       parameters:
13763         - name: hostname
13764           in: path
13765           description: Value from executing hostname on the compute node.
13766           required: true
13767           type: string
13768           example: __HOSTNAME__
13769         - name: interface-name
13770           in: path
13771           description: Name that identifies the link aggregate interface
13772           required: true
13773           type: string
13774           example: __INTERFACE-NAME__
13775         - name: body
13776           in: body
13777           description: lag-interface object that needs to be created or updated.
13778           required: true
13779           schema:
13780             $ref: "#/patchDefinitions/lag-interface"
13781     delete:
13782       tags:
13783         - CloudInfrastructure
13784       summary: delete an existing lag-interface
13785       description: delete an existing lag-interface
13786       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
13787       consumes:
13788         - application/json
13789         - application/xml
13790       produces:
13791         - application/json
13792         - application/xml
13793       responses:
13794         "default":
13795           description: Response codes found in [response codes](https://wiki.onap.org/).
13796       parameters:
13797         - name: hostname
13798           in: path
13799           description: Value from executing hostname on the compute node.
13800           required: true
13801           type: string
13802           example: __HOSTNAME__
13803         - name: interface-name
13804           in: path
13805           description: Name that identifies the link aggregate interface
13806           required: true
13807           type: string
13808           example: __INTERFACE-NAME__
13809         - name: resource-version
13810           in: query
13811           description: resource-version for concurrency
13812           required: true
13813           type: string
13814   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
13815     get:
13816       tags:
13817         - CloudInfrastructure
13818       summary: returns lag-interfaces
13819       description: returns lag-interfaces
13820       operationId: getCloudInfrastructurePserversPserverLagInterfaces
13821       produces:
13822         - application/json
13823         - application/xml
13824       responses:
13825         "200":
13826           description: successful operation
13827           schema:
13828               $ref: "#/getDefinitions/lag-interfaces"
13829         "default":
13830           description: Response codes found in [response codes](https://wiki.onap.org/).
13831       parameters:
13832         - name: hostname
13833           in: path
13834           description: Value from executing hostname on the compute node.
13835           required: true
13836           type: string
13837           example: __HOSTNAME__
13838         - name: inv-status
13839           in: query
13840           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13841           required: false
13842           type: string
13843         - name: pserver-id
13844           in: query
13845           description: ID of Pserver
13846           required: false
13847           type: string
13848         - name: in-maint
13849           in: query
13850           required: false
13851           type: boolean
13852         - name: pserver-name2
13853           in: query
13854           description: alternative pserver name
13855           required: false
13856           type: string
13857   /cloud-infrastructure/pservers/pserver/{hostname}:
13858     get:
13859       tags:
13860         - CloudInfrastructure
13861       summary: returns pserver
13862       description: returns pserver
13863       operationId: getCloudInfrastructurePserversPserver
13864       produces:
13865         - application/json
13866         - application/xml
13867       responses:
13868         "200":
13869           description: successful operation
13870           schema:
13871               $ref: "#/getDefinitions/pserver"
13872         "default":
13873           description: Response codes found in [response codes](https://wiki.onap.org/).
13874       parameters:
13875         - name: hostname
13876           in: path
13877           description: Value from executing hostname on the compute node.
13878           required: true
13879           type: string
13880           example: __HOSTNAME__
13881         - name: inv-status
13882           in: query
13883           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13884           required: false
13885           type: string
13886         - name: pserver-id
13887           in: query
13888           description: ID of Pserver
13889           required: false
13890           type: string
13891         - name: in-maint
13892           in: query
13893           required: false
13894           type: boolean
13895         - name: pserver-name2
13896           in: query
13897           description: alternative pserver name
13898           required: false
13899           type: string
13900     put:
13901       tags:
13902         - CloudInfrastructure
13903       summary: create or update an existing pserver
13904       description: |
13905         Create or update an existing pserver.
13906         #
13907         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13908       operationId: createOrUpdateCloudInfrastructurePserversPserver
13909       consumes:
13910         - application/json
13911         - application/xml
13912       produces:
13913         - application/json
13914         - application/xml
13915       responses:
13916         "default":
13917           description: Response codes found in [response codes](https://wiki.onap.org/).
13918       parameters:
13919         - name: hostname
13920           in: path
13921           description: Value from executing hostname on the compute node.
13922           required: true
13923           type: string
13924           example: __HOSTNAME__
13925         - name: body
13926           in: body
13927           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructurePserversPserver.json)
13928           required: true
13929           schema:
13930             $ref: "#/definitions/pserver"
13931     patch:
13932       tags:
13933         - CloudInfrastructure
13934       summary: update an existing pserver
13935       description: |
13936         Update an existing pserver
13937         #
13938         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13939         The PUT operation will entirely replace an existing object.
13940         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13941         #
13942         Other differences between PUT and PATCH are:
13943         #
13944         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13945         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13946         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13947       operationId: UpdateCloudInfrastructurePserversPserver
13948       consumes:
13949         - application/json
13950         - application/xml
13951       produces:
13952         - application/json
13953         - application/xml
13954       responses:
13955         "default":
13956           description: Response codes found in [response codes](https://wiki.onap.org/).
13957       parameters:
13958         - name: hostname
13959           in: path
13960           description: Value from executing hostname on the compute node.
13961           required: true
13962           type: string
13963           example: __HOSTNAME__
13964         - name: body
13965           in: body
13966           description: pserver object that needs to be created or updated.
13967           required: true
13968           schema:
13969             $ref: "#/patchDefinitions/pserver"
13970     delete:
13971       tags:
13972         - CloudInfrastructure
13973       summary: delete an existing pserver
13974       description: delete an existing pserver
13975       operationId: deleteCloudInfrastructurePserversPserver
13976       consumes:
13977         - application/json
13978         - application/xml
13979       produces:
13980         - application/json
13981         - application/xml
13982       responses:
13983         "default":
13984           description: Response codes found in [response codes](https://wiki.onap.org/).
13985       parameters:
13986         - name: hostname
13987           in: path
13988           description: Value from executing hostname on the compute node.
13989           required: true
13990           type: string
13991           example: __HOSTNAME__
13992         - name: resource-version
13993           in: query
13994           description: resource-version for concurrency
13995           required: true
13996           type: string
13997   /cloud-infrastructure/pservers:
13998     get:
13999       tags:
14000         - CloudInfrastructure
14001       summary: returns pservers
14002       description: returns pservers
14003       operationId: getCloudInfrastructurePservers
14004       produces:
14005         - application/json
14006         - application/xml
14007       responses:
14008         "200":
14009           description: successful operation
14010           schema:
14011               $ref: "#/getDefinitions/pservers"
14012         "default":
14013           description: Response codes found in [response codes](https://wiki.onap.org/).
14014   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
14015     put:
14016       tags:
14017         - CloudInfrastructure
14018       summary: see node definition for valid relationships
14019       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14020       consumes:
14021         - application/json
14022         - application/xml
14023       produces:
14024         - application/json
14025         - application/xml
14026       responses:
14027         "default":
14028           description: Response codes found in [response codes](https://wiki.onap.org/).
14029       parameters:
14030         - name: vdc-id
14031           in: path
14032           description: Unique ID of the vdc
14033           required: true
14034           type: string
14035           example: __VDC-ID__
14036         - name: body
14037           in: body
14038           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14039           required: true
14040           schema:
14041             $ref: "#/definitions/relationship"
14042     delete:
14043       tags:
14044         - CloudInfrastructure
14045       summary: delete an existing relationship
14046       description: delete an existing relationship
14047       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
14048       consumes:
14049         - application/json
14050         - application/xml
14051       produces:
14052         - application/json
14053         - application/xml
14054       responses:
14055         "default":
14056           description: Response codes found in [response codes](https://wiki.onap.org/).
14057       parameters:
14058         - name: vdc-id
14059           in: path
14060           description: Unique ID of the vdc
14061           required: true
14062           type: string
14063           example: __VDC-ID__
14064   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
14065     get:
14066       tags:
14067         - CloudInfrastructure
14068       summary: returns virtual-data-center
14069       description: returns virtual-data-center
14070       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
14071       produces:
14072         - application/json
14073         - application/xml
14074       responses:
14075         "200":
14076           description: successful operation
14077           schema:
14078               $ref: "#/getDefinitions/virtual-data-center"
14079         "default":
14080           description: Response codes found in [response codes](https://wiki.onap.org/).
14081       parameters:
14082         - name: vdc-id
14083           in: path
14084           description: Unique ID of the vdc
14085           required: true
14086           type: string
14087           example: __VDC-ID__
14088         - name: vdc-name
14089           in: query
14090           description: Name of the virtual data center
14091           required: false
14092           type: string
14093     put:
14094       tags:
14095         - CloudInfrastructure
14096       summary: create or update an existing virtual-data-center
14097       description: |
14098         Create or update an existing virtual-data-center.
14099         #
14100         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14101       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14102       consumes:
14103         - application/json
14104         - application/xml
14105       produces:
14106         - application/json
14107         - application/xml
14108       responses:
14109         "default":
14110           description: Response codes found in [response codes](https://wiki.onap.org/).
14111       parameters:
14112         - name: vdc-id
14113           in: path
14114           description: Unique ID of the vdc
14115           required: true
14116           type: string
14117           example: __VDC-ID__
14118         - name: body
14119           in: body
14120           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
14121           required: true
14122           schema:
14123             $ref: "#/definitions/virtual-data-center"
14124     patch:
14125       tags:
14126         - CloudInfrastructure
14127       summary: update an existing virtual-data-center
14128       description: |
14129         Update an existing virtual-data-center
14130         #
14131         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14132         The PUT operation will entirely replace an existing object.
14133         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14134         #
14135         Other differences between PUT and PATCH are:
14136         #
14137         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14138         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14139         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14140       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
14141       consumes:
14142         - application/json
14143         - application/xml
14144       produces:
14145         - application/json
14146         - application/xml
14147       responses:
14148         "default":
14149           description: Response codes found in [response codes](https://wiki.onap.org/).
14150       parameters:
14151         - name: vdc-id
14152           in: path
14153           description: Unique ID of the vdc
14154           required: true
14155           type: string
14156           example: __VDC-ID__
14157         - name: body
14158           in: body
14159           description: virtual-data-center object that needs to be created or updated.
14160           required: true
14161           schema:
14162             $ref: "#/patchDefinitions/virtual-data-center"
14163     delete:
14164       tags:
14165         - CloudInfrastructure
14166       summary: delete an existing virtual-data-center
14167       description: delete an existing virtual-data-center
14168       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
14169       consumes:
14170         - application/json
14171         - application/xml
14172       produces:
14173         - application/json
14174         - application/xml
14175       responses:
14176         "default":
14177           description: Response codes found in [response codes](https://wiki.onap.org/).
14178       parameters:
14179         - name: vdc-id
14180           in: path
14181           description: Unique ID of the vdc
14182           required: true
14183           type: string
14184           example: __VDC-ID__
14185         - name: resource-version
14186           in: query
14187           description: resource-version for concurrency
14188           required: true
14189           type: string
14190   /cloud-infrastructure/virtual-data-centers:
14191     get:
14192       tags:
14193         - CloudInfrastructure
14194       summary: returns virtual-data-centers
14195       description: returns virtual-data-centers
14196       operationId: getCloudInfrastructureVirtualDataCenters
14197       produces:
14198         - application/json
14199         - application/xml
14200       responses:
14201         "200":
14202           description: successful operation
14203           schema:
14204               $ref: "#/getDefinitions/virtual-data-centers"
14205         "default":
14206           description: Response codes found in [response codes](https://wiki.onap.org/).
14207   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
14208     put:
14209       tags:
14210         - Business
14211       summary: see node definition for valid relationships
14212       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
14213       consumes:
14214         - application/json
14215         - application/xml
14216       produces:
14217         - application/json
14218         - application/xml
14219       responses:
14220         "default":
14221           description: Response codes found in [response codes](https://wiki.onap.org/).
14222       parameters:
14223         - name: resource-instance-id
14224           in: path
14225           description: Unique id of resource instance.
14226           required: true
14227           type: string
14228           example: __RESOURCE-INSTANCE-ID__
14229         - name: body
14230           in: body
14231           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
14232           required: true
14233           schema:
14234             $ref: "#/definitions/relationship"
14235     delete:
14236       tags:
14237         - Business
14238       summary: delete an existing relationship
14239       description: delete an existing relationship
14240       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
14241       consumes:
14242         - application/json
14243         - application/xml
14244       produces:
14245         - application/json
14246         - application/xml
14247       responses:
14248         "default":
14249           description: Response codes found in [response codes](https://wiki.onap.org/).
14250       parameters:
14251         - name: resource-instance-id
14252           in: path
14253           description: Unique id of resource instance.
14254           required: true
14255           type: string
14256           example: __RESOURCE-INSTANCE-ID__
14257   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
14258     get:
14259       tags:
14260         - Business
14261       summary: returns metadatum
14262       description: returns metadatum
14263       operationId: getBusinessConnectorsConnectorMetadataMetadatum
14264       produces:
14265         - application/json
14266         - application/xml
14267       responses:
14268         "200":
14269           description: successful operation
14270           schema:
14271               $ref: "#/getDefinitions/metadatum"
14272         "default":
14273           description: Response codes found in [response codes](https://wiki.onap.org/).
14274       parameters:
14275         - name: resource-instance-id
14276           in: path
14277           description: Unique id of resource instance.
14278           required: true
14279           type: string
14280           example: __RESOURCE-INSTANCE-ID__
14281         - name: metaname
14282           in: path
14283           required: true
14284           type: string
14285           example: __METANAME__
14286         - name: model-invariant-id
14287           in: query
14288           description: the ASDC model id for this resource or service model.
14289           required: false
14290           type: string
14291         - name: model-version-id
14292           in: query
14293           description: the ASDC model version for this resource or service model.
14294           required: false
14295           type: string
14296         - name: widget-model-id
14297           in: query
14298           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14299           required: false
14300           type: string
14301         - name: widget-model-version
14302           in: query
14303           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14304           required: false
14305           type: string
14306     put:
14307       tags:
14308         - Business
14309       summary: create or update an existing metadatum
14310       description: |
14311         Create or update an existing metadatum.
14312         #
14313         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14314       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
14315       consumes:
14316         - application/json
14317         - application/xml
14318       produces:
14319         - application/json
14320         - application/xml
14321       responses:
14322         "default":
14323           description: Response codes found in [response codes](https://wiki.onap.org/).
14324       parameters:
14325         - name: resource-instance-id
14326           in: path
14327           description: Unique id of resource instance.
14328           required: true
14329           type: string
14330           example: __RESOURCE-INSTANCE-ID__
14331         - name: metaname
14332           in: path
14333           required: true
14334           type: string
14335           example: __METANAME__
14336         - name: body
14337           in: body
14338           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnectorMetadataMetadatum.json)
14339           required: true
14340           schema:
14341             $ref: "#/definitions/metadatum"
14342     patch:
14343       tags:
14344         - Business
14345       summary: update an existing metadatum
14346       description: |
14347         Update an existing metadatum
14348         #
14349         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14350         The PUT operation will entirely replace an existing object.
14351         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14352         #
14353         Other differences between PUT and PATCH are:
14354         #
14355         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14356         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14357         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14358       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
14359       consumes:
14360         - application/json
14361         - application/xml
14362       produces:
14363         - application/json
14364         - application/xml
14365       responses:
14366         "default":
14367           description: Response codes found in [response codes](https://wiki.onap.org/).
14368       parameters:
14369         - name: resource-instance-id
14370           in: path
14371           description: Unique id of resource instance.
14372           required: true
14373           type: string
14374           example: __RESOURCE-INSTANCE-ID__
14375         - name: metaname
14376           in: path
14377           required: true
14378           type: string
14379           example: __METANAME__
14380         - name: body
14381           in: body
14382           description: metadatum object that needs to be created or updated.
14383           required: true
14384           schema:
14385             $ref: "#/patchDefinitions/metadatum"
14386     delete:
14387       tags:
14388         - Business
14389       summary: delete an existing metadatum
14390       description: delete an existing metadatum
14391       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
14392       consumes:
14393         - application/json
14394         - application/xml
14395       produces:
14396         - application/json
14397         - application/xml
14398       responses:
14399         "default":
14400           description: Response codes found in [response codes](https://wiki.onap.org/).
14401       parameters:
14402         - name: resource-instance-id
14403           in: path
14404           description: Unique id of resource instance.
14405           required: true
14406           type: string
14407           example: __RESOURCE-INSTANCE-ID__
14408         - name: metaname
14409           in: path
14410           required: true
14411           type: string
14412           example: __METANAME__
14413         - name: resource-version
14414           in: query
14415           description: resource-version for concurrency
14416           required: true
14417           type: string
14418   /business/connectors/connector/{resource-instance-id}/metadata:
14419     get:
14420       tags:
14421         - Business
14422       summary: returns metadata
14423       description: returns metadata
14424       operationId: getBusinessConnectorsConnectorMetadata
14425       produces:
14426         - application/json
14427         - application/xml
14428       responses:
14429         "200":
14430           description: successful operation
14431           schema:
14432               $ref: "#/getDefinitions/metadata"
14433         "default":
14434           description: Response codes found in [response codes](https://wiki.onap.org/).
14435       parameters:
14436         - name: resource-instance-id
14437           in: path
14438           description: Unique id of resource instance.
14439           required: true
14440           type: string
14441           example: __RESOURCE-INSTANCE-ID__
14442         - name: model-invariant-id
14443           in: query
14444           description: the ASDC model id for this resource or service model.
14445           required: false
14446           type: string
14447         - name: model-version-id
14448           in: query
14449           description: the ASDC model version for this resource or service model.
14450           required: false
14451           type: string
14452         - name: widget-model-id
14453           in: query
14454           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14455           required: false
14456           type: string
14457         - name: widget-model-version
14458           in: query
14459           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14460           required: false
14461           type: string
14462   /business/connectors/connector/{resource-instance-id}:
14463     get:
14464       tags:
14465         - Business
14466       summary: returns connector
14467       description: returns connector
14468       operationId: getBusinessConnectorsConnector
14469       produces:
14470         - application/json
14471         - application/xml
14472       responses:
14473         "200":
14474           description: successful operation
14475           schema:
14476               $ref: "#/getDefinitions/connector"
14477         "default":
14478           description: Response codes found in [response codes](https://wiki.onap.org/).
14479       parameters:
14480         - name: resource-instance-id
14481           in: path
14482           description: Unique id of resource instance.
14483           required: true
14484           type: string
14485           example: __RESOURCE-INSTANCE-ID__
14486         - name: model-invariant-id
14487           in: query
14488           description: the ASDC model id for this resource or service model.
14489           required: false
14490           type: string
14491         - name: model-version-id
14492           in: query
14493           description: the ASDC model version for this resource or service model.
14494           required: false
14495           type: string
14496         - name: widget-model-id
14497           in: query
14498           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14499           required: false
14500           type: string
14501         - name: widget-model-version
14502           in: query
14503           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14504           required: false
14505           type: string
14506     put:
14507       tags:
14508         - Business
14509       summary: create or update an existing connector
14510       description: |
14511         Create or update an existing connector.
14512         #
14513         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14514       operationId: createOrUpdateBusinessConnectorsConnector
14515       consumes:
14516         - application/json
14517         - application/xml
14518       produces:
14519         - application/json
14520         - application/xml
14521       responses:
14522         "default":
14523           description: Response codes found in [response codes](https://wiki.onap.org/).
14524       parameters:
14525         - name: resource-instance-id
14526           in: path
14527           description: Unique id of resource instance.
14528           required: true
14529           type: string
14530           example: __RESOURCE-INSTANCE-ID__
14531         - name: body
14532           in: body
14533           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessConnectorsConnector.json)
14534           required: true
14535           schema:
14536             $ref: "#/definitions/connector"
14537     patch:
14538       tags:
14539         - Business
14540       summary: update an existing connector
14541       description: |
14542         Update an existing connector
14543         #
14544         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14545         The PUT operation will entirely replace an existing object.
14546         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14547         #
14548         Other differences between PUT and PATCH are:
14549         #
14550         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14551         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14552         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14553       operationId: UpdateBusinessConnectorsConnector
14554       consumes:
14555         - application/json
14556         - application/xml
14557       produces:
14558         - application/json
14559         - application/xml
14560       responses:
14561         "default":
14562           description: Response codes found in [response codes](https://wiki.onap.org/).
14563       parameters:
14564         - name: resource-instance-id
14565           in: path
14566           description: Unique id of resource instance.
14567           required: true
14568           type: string
14569           example: __RESOURCE-INSTANCE-ID__
14570         - name: body
14571           in: body
14572           description: connector object that needs to be created or updated.
14573           required: true
14574           schema:
14575             $ref: "#/patchDefinitions/connector"
14576     delete:
14577       tags:
14578         - Business
14579       summary: delete an existing connector
14580       description: delete an existing connector
14581       operationId: deleteBusinessConnectorsConnector
14582       consumes:
14583         - application/json
14584         - application/xml
14585       produces:
14586         - application/json
14587         - application/xml
14588       responses:
14589         "default":
14590           description: Response codes found in [response codes](https://wiki.onap.org/).
14591       parameters:
14592         - name: resource-instance-id
14593           in: path
14594           description: Unique id of resource instance.
14595           required: true
14596           type: string
14597           example: __RESOURCE-INSTANCE-ID__
14598         - name: resource-version
14599           in: query
14600           description: resource-version for concurrency
14601           required: true
14602           type: string
14603   /business/connectors:
14604     get:
14605       tags:
14606         - Business
14607       summary: returns connectors
14608       description: returns connectors
14609       operationId: getBusinessConnectors
14610       produces:
14611         - application/json
14612         - application/xml
14613       responses:
14614         "200":
14615           description: successful operation
14616           schema:
14617               $ref: "#/getDefinitions/connectors"
14618         "default":
14619           description: Response codes found in [response codes](https://wiki.onap.org/).
14620   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
14621     put:
14622       tags:
14623         - Business
14624       summary: see node definition for valid relationships
14625       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14626       consumes:
14627         - application/json
14628         - application/xml
14629       produces:
14630         - application/json
14631         - application/xml
14632       responses:
14633         "default":
14634           description: Response codes found in [response codes](https://wiki.onap.org/).
14635       parameters:
14636         - name: global-customer-id
14637           in: path
14638           description: Global customer id used across ECOMP to uniquely identify customer.
14639           required: true
14640           type: string
14641           example: __GLOBAL-CUSTOMER-ID__
14642         - name: service-type
14643           in: path
14644           description: Value defined by orchestration to identify this service across ECOMP.
14645           required: true
14646           type: string
14647           example: __SERVICE-TYPE__
14648         - name: service-instance-id
14649           in: path
14650           description: Uniquely identifies this instance of a service
14651           required: true
14652           type: string
14653           example: __SERVICE-INSTANCE-ID__
14654         - name: body
14655           in: body
14656           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
14657           required: true
14658           schema:
14659             $ref: "#/definitions/relationship"
14660     delete:
14661       tags:
14662         - Business
14663       summary: delete an existing relationship
14664       description: delete an existing relationship
14665       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
14666       consumes:
14667         - application/json
14668         - application/xml
14669       produces:
14670         - application/json
14671         - application/xml
14672       responses:
14673         "default":
14674           description: Response codes found in [response codes](https://wiki.onap.org/).
14675       parameters:
14676         - name: global-customer-id
14677           in: path
14678           description: Global customer id used across ECOMP to uniquely identify customer.
14679           required: true
14680           type: string
14681           example: __GLOBAL-CUSTOMER-ID__
14682         - name: service-type
14683           in: path
14684           description: Value defined by orchestration to identify this service across ECOMP.
14685           required: true
14686           type: string
14687           example: __SERVICE-TYPE__
14688         - name: service-instance-id
14689           in: path
14690           description: Uniquely identifies this instance of a service
14691           required: true
14692           type: string
14693           example: __SERVICE-INSTANCE-ID__
14694   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
14695     get:
14696       tags:
14697         - Business
14698       summary: returns metadatum
14699       description: returns metadatum
14700       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14701       produces:
14702         - application/json
14703         - application/xml
14704       responses:
14705         "200":
14706           description: successful operation
14707           schema:
14708               $ref: "#/getDefinitions/metadatum"
14709         "default":
14710           description: Response codes found in [response codes](https://wiki.onap.org/).
14711       parameters:
14712         - name: global-customer-id
14713           in: path
14714           description: Global customer id used across ECOMP to uniquely identify customer.
14715           required: true
14716           type: string
14717           example: __GLOBAL-CUSTOMER-ID__
14718         - name: service-type
14719           in: path
14720           description: Value defined by orchestration to identify this service across ECOMP.
14721           required: true
14722           type: string
14723           example: __SERVICE-TYPE__
14724         - name: service-instance-id
14725           in: path
14726           description: Uniquely identifies this instance of a service
14727           required: true
14728           type: string
14729           example: __SERVICE-INSTANCE-ID__
14730         - name: metaname
14731           in: path
14732           required: true
14733           type: string
14734           example: __METANAME__
14735         - name: subscriber-name
14736           in: query
14737           description: Subscriber name, an alternate way to retrieve a customer.
14738           required: false
14739           type: string
14740         - name: subscriber-type
14741           in: query
14742           description: Subscriber type, a way to provide VID with only the INFRA customers.
14743           required: false
14744           type: string
14745         - name: service-instance-name
14746           in: query
14747           description: This field will store a name assigned to the service-instance.
14748           required: false
14749           type: string
14750         - name: model-invariant-id
14751           in: query
14752           description: the ASDC model id for this resource or service model.
14753           required: false
14754           type: string
14755         - name: model-version-id
14756           in: query
14757           description: the ASDC model version for this resource or service model.
14758           required: false
14759           type: string
14760         - name: widget-model-id
14761           in: query
14762           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14763           required: false
14764           type: string
14765         - name: widget-model-version
14766           in: query
14767           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14768           required: false
14769           type: string
14770         - name: service-instance-location-id
14771           in: query
14772           description: An identifier that customers assign to the location where this service is being used.
14773           required: false
14774           type: string
14775         - name: orchestration-status
14776           in: query
14777           description: Orchestration status of this service.
14778           required: false
14779           type: string
14780     put:
14781       tags:
14782         - Business
14783       summary: create or update an existing metadatum
14784       description: |
14785         Create or update an existing metadatum.
14786         #
14787         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14788       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14789       consumes:
14790         - application/json
14791         - application/xml
14792       produces:
14793         - application/json
14794         - application/xml
14795       responses:
14796         "default":
14797           description: Response codes found in [response codes](https://wiki.onap.org/).
14798       parameters:
14799         - name: global-customer-id
14800           in: path
14801           description: Global customer id used across ECOMP to uniquely identify customer.
14802           required: true
14803           type: string
14804           example: __GLOBAL-CUSTOMER-ID__
14805         - name: service-type
14806           in: path
14807           description: Value defined by orchestration to identify this service across ECOMP.
14808           required: true
14809           type: string
14810           example: __SERVICE-TYPE__
14811         - name: service-instance-id
14812           in: path
14813           description: Uniquely identifies this instance of a service
14814           required: true
14815           type: string
14816           example: __SERVICE-INSTANCE-ID__
14817         - name: metaname
14818           in: path
14819           required: true
14820           type: string
14821           example: __METANAME__
14822         - name: body
14823           in: body
14824           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
14825           required: true
14826           schema:
14827             $ref: "#/definitions/metadatum"
14828     patch:
14829       tags:
14830         - Business
14831       summary: update an existing metadatum
14832       description: |
14833         Update an existing metadatum
14834         #
14835         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14836         The PUT operation will entirely replace an existing object.
14837         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14838         #
14839         Other differences between PUT and PATCH are:
14840         #
14841         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14842         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14843         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14844       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14845       consumes:
14846         - application/json
14847         - application/xml
14848       produces:
14849         - application/json
14850         - application/xml
14851       responses:
14852         "default":
14853           description: Response codes found in [response codes](https://wiki.onap.org/).
14854       parameters:
14855         - name: global-customer-id
14856           in: path
14857           description: Global customer id used across ECOMP to uniquely identify customer.
14858           required: true
14859           type: string
14860           example: __GLOBAL-CUSTOMER-ID__
14861         - name: service-type
14862           in: path
14863           description: Value defined by orchestration to identify this service across ECOMP.
14864           required: true
14865           type: string
14866           example: __SERVICE-TYPE__
14867         - name: service-instance-id
14868           in: path
14869           description: Uniquely identifies this instance of a service
14870           required: true
14871           type: string
14872           example: __SERVICE-INSTANCE-ID__
14873         - name: metaname
14874           in: path
14875           required: true
14876           type: string
14877           example: __METANAME__
14878         - name: body
14879           in: body
14880           description: metadatum object that needs to be created or updated.
14881           required: true
14882           schema:
14883             $ref: "#/patchDefinitions/metadatum"
14884     delete:
14885       tags:
14886         - Business
14887       summary: delete an existing metadatum
14888       description: delete an existing metadatum
14889       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
14890       consumes:
14891         - application/json
14892         - application/xml
14893       produces:
14894         - application/json
14895         - application/xml
14896       responses:
14897         "default":
14898           description: Response codes found in [response codes](https://wiki.onap.org/).
14899       parameters:
14900         - name: global-customer-id
14901           in: path
14902           description: Global customer id used across ECOMP to uniquely identify customer.
14903           required: true
14904           type: string
14905           example: __GLOBAL-CUSTOMER-ID__
14906         - name: service-type
14907           in: path
14908           description: Value defined by orchestration to identify this service across ECOMP.
14909           required: true
14910           type: string
14911           example: __SERVICE-TYPE__
14912         - name: service-instance-id
14913           in: path
14914           description: Uniquely identifies this instance of a service
14915           required: true
14916           type: string
14917           example: __SERVICE-INSTANCE-ID__
14918         - name: metaname
14919           in: path
14920           required: true
14921           type: string
14922           example: __METANAME__
14923         - name: resource-version
14924           in: query
14925           description: resource-version for concurrency
14926           required: true
14927           type: string
14928   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
14929     get:
14930       tags:
14931         - Business
14932       summary: returns metadata
14933       description: returns metadata
14934       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
14935       produces:
14936         - application/json
14937         - application/xml
14938       responses:
14939         "200":
14940           description: successful operation
14941           schema:
14942               $ref: "#/getDefinitions/metadata"
14943         "default":
14944           description: Response codes found in [response codes](https://wiki.onap.org/).
14945       parameters:
14946         - name: global-customer-id
14947           in: path
14948           description: Global customer id used across ECOMP to uniquely identify customer.
14949           required: true
14950           type: string
14951           example: __GLOBAL-CUSTOMER-ID__
14952         - name: service-type
14953           in: path
14954           description: Value defined by orchestration to identify this service across ECOMP.
14955           required: true
14956           type: string
14957           example: __SERVICE-TYPE__
14958         - name: service-instance-id
14959           in: path
14960           description: Uniquely identifies this instance of a service
14961           required: true
14962           type: string
14963           example: __SERVICE-INSTANCE-ID__
14964         - name: subscriber-name
14965           in: query
14966           description: Subscriber name, an alternate way to retrieve a customer.
14967           required: false
14968           type: string
14969         - name: subscriber-type
14970           in: query
14971           description: Subscriber type, a way to provide VID with only the INFRA customers.
14972           required: false
14973           type: string
14974         - name: service-instance-name
14975           in: query
14976           description: This field will store a name assigned to the service-instance.
14977           required: false
14978           type: string
14979         - name: model-invariant-id
14980           in: query
14981           description: the ASDC model id for this resource or service model.
14982           required: false
14983           type: string
14984         - name: model-version-id
14985           in: query
14986           description: the ASDC model version for this resource or service model.
14987           required: false
14988           type: string
14989         - name: widget-model-id
14990           in: query
14991           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
14992           required: false
14993           type: string
14994         - name: widget-model-version
14995           in: query
14996           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
14997           required: false
14998           type: string
14999         - name: service-instance-location-id
15000           in: query
15001           description: An identifier that customers assign to the location where this service is being used.
15002           required: false
15003           type: string
15004         - name: orchestration-status
15005           in: query
15006           description: Orchestration status of this service.
15007           required: false
15008           type: string
15009   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}/relationship-list/relationship:
15010     put:
15011       tags:
15012         - Business
15013       summary: see node definition for valid relationships
15014       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15015       consumes:
15016         - application/json
15017         - application/xml
15018       produces:
15019         - application/json
15020         - application/xml
15021       responses:
15022         "default":
15023           description: Response codes found in [response codes](https://wiki.onap.org/).
15024       parameters:
15025         - name: global-customer-id
15026           in: path
15027           description: Global customer id used across ECOMP to uniquely identify customer.
15028           required: true
15029           type: string
15030           example: __GLOBAL-CUSTOMER-ID__
15031         - name: service-type
15032           in: path
15033           description: Value defined by orchestration to identify this service across ECOMP.
15034           required: true
15035           type: string
15036           example: __SERVICE-TYPE__
15037         - name: service-instance-id
15038           in: path
15039           description: Uniquely identifies this instance of a service
15040           required: true
15041           type: string
15042           example: __SERVICE-INSTANCE-ID__
15043         - name: id
15044           in: path
15045           description: Allotted Resource id UUID assigned to this instance.
15046           required: true
15047           type: string
15048           example: __ID__
15049         - name: id
15050           in: path
15051           description: Allotted Resource id UUID assigned to this instance.
15052           required: true
15053           type: string
15054           example: __ID__
15055         - name: body
15056           in: body
15057           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15058           required: true
15059           schema:
15060             $ref: "#/definitions/relationship"
15061     delete:
15062       tags:
15063         - Business
15064       summary: delete an existing relationship
15065       description: delete an existing relationship
15066       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
15067       consumes:
15068         - application/json
15069         - application/xml
15070       produces:
15071         - application/json
15072         - application/xml
15073       responses:
15074         "default":
15075           description: Response codes found in [response codes](https://wiki.onap.org/).
15076       parameters:
15077         - name: global-customer-id
15078           in: path
15079           description: Global customer id used across ECOMP to uniquely identify customer.
15080           required: true
15081           type: string
15082           example: __GLOBAL-CUSTOMER-ID__
15083         - name: service-type
15084           in: path
15085           description: Value defined by orchestration to identify this service across ECOMP.
15086           required: true
15087           type: string
15088           example: __SERVICE-TYPE__
15089         - name: service-instance-id
15090           in: path
15091           description: Uniquely identifies this instance of a service
15092           required: true
15093           type: string
15094           example: __SERVICE-INSTANCE-ID__
15095         - name: id
15096           in: path
15097           description: Allotted Resource id UUID assigned to this instance.
15098           required: true
15099           type: string
15100           example: __ID__
15101         - name: id
15102           in: path
15103           description: Allotted Resource id UUID assigned to this instance.
15104           required: true
15105           type: string
15106           example: __ID__
15107   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects/tunnel-xconnect/{id}:
15108     get:
15109       tags:
15110         - Business
15111       summary: returns tunnel-xconnect
15112       description: returns tunnel-xconnect
15113       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15114       produces:
15115         - application/json
15116         - application/xml
15117       responses:
15118         "200":
15119           description: successful operation
15120           schema:
15121               $ref: "#/getDefinitions/tunnel-xconnect"
15122         "default":
15123           description: Response codes found in [response codes](https://wiki.onap.org/).
15124       parameters:
15125         - name: global-customer-id
15126           in: path
15127           description: Global customer id used across ECOMP to uniquely identify customer.
15128           required: true
15129           type: string
15130           example: __GLOBAL-CUSTOMER-ID__
15131         - name: service-type
15132           in: path
15133           description: Value defined by orchestration to identify this service across ECOMP.
15134           required: true
15135           type: string
15136           example: __SERVICE-TYPE__
15137         - name: service-instance-id
15138           in: path
15139           description: Uniquely identifies this instance of a service
15140           required: true
15141           type: string
15142           example: __SERVICE-INSTANCE-ID__
15143         - name: id
15144           in: path
15145           description: Allotted Resource id UUID assigned to this instance.
15146           required: true
15147           type: string
15148           example: __ID__
15149         - name: id
15150           in: path
15151           description: Allotted Resource id UUID assigned to this instance.
15152           required: true
15153           type: string
15154           example: __ID__
15155         - name: subscriber-name
15156           in: query
15157           description: Subscriber name, an alternate way to retrieve a customer.
15158           required: false
15159           type: string
15160         - name: subscriber-type
15161           in: query
15162           description: Subscriber type, a way to provide VID with only the INFRA customers.
15163           required: false
15164           type: string
15165         - name: service-instance-name
15166           in: query
15167           description: This field will store a name assigned to the service-instance.
15168           required: false
15169           type: string
15170         - name: model-invariant-id
15171           in: query
15172           description: the ASDC model id for this resource or service model.
15173           required: false
15174           type: string
15175         - name: model-version-id
15176           in: query
15177           description: the ASDC model version for this resource or service model.
15178           required: false
15179           type: string
15180         - name: widget-model-id
15181           in: query
15182           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15183           required: false
15184           type: string
15185         - name: widget-model-version
15186           in: query
15187           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15188           required: false
15189           type: string
15190         - name: service-instance-location-id
15191           in: query
15192           description: An identifier that customers assign to the location where this service is being used.
15193           required: false
15194           type: string
15195         - name: orchestration-status
15196           in: query
15197           description: Orchestration status of this service.
15198           required: false
15199           type: string
15200         - name: model-invariant-id
15201           in: query
15202           description: the ASDC model id for this resource or service model.
15203           required: false
15204           type: string
15205         - name: model-version-id
15206           in: query
15207           description: the ASDC model version for this resource or service model.
15208           required: false
15209           type: string
15210         - name: type
15211           in: query
15212           description: Generic description of the type of allotted resource.
15213           required: false
15214           type: string
15215         - name: role
15216           in: query
15217           description: role in the network that this resource will be providing.
15218           required: false
15219           type: string
15220     put:
15221       tags:
15222         - Business
15223       summary: create or update an existing tunnel-xconnect
15224       description: |
15225         Create or update an existing tunnel-xconnect.
15226         #
15227         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15228       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15229       consumes:
15230         - application/json
15231         - application/xml
15232       produces:
15233         - application/json
15234         - application/xml
15235       responses:
15236         "default":
15237           description: Response codes found in [response codes](https://wiki.onap.org/).
15238       parameters:
15239         - name: global-customer-id
15240           in: path
15241           description: Global customer id used across ECOMP to uniquely identify customer.
15242           required: true
15243           type: string
15244           example: __GLOBAL-CUSTOMER-ID__
15245         - name: service-type
15246           in: path
15247           description: Value defined by orchestration to identify this service across ECOMP.
15248           required: true
15249           type: string
15250           example: __SERVICE-TYPE__
15251         - name: service-instance-id
15252           in: path
15253           description: Uniquely identifies this instance of a service
15254           required: true
15255           type: string
15256           example: __SERVICE-INSTANCE-ID__
15257         - name: id
15258           in: path
15259           description: Allotted Resource id UUID assigned to this instance.
15260           required: true
15261           type: string
15262           example: __ID__
15263         - name: id
15264           in: path
15265           description: Allotted Resource id UUID assigned to this instance.
15266           required: true
15267           type: string
15268           example: __ID__
15269         - name: body
15270           in: body
15271           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
15272           required: true
15273           schema:
15274             $ref: "#/definitions/tunnel-xconnect"
15275     patch:
15276       tags:
15277         - Business
15278       summary: update an existing tunnel-xconnect
15279       description: |
15280         Update an existing tunnel-xconnect
15281         #
15282         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15283         The PUT operation will entirely replace an existing object.
15284         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15285         #
15286         Other differences between PUT and PATCH are:
15287         #
15288         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15289         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15290         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15291       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15292       consumes:
15293         - application/json
15294         - application/xml
15295       produces:
15296         - application/json
15297         - application/xml
15298       responses:
15299         "default":
15300           description: Response codes found in [response codes](https://wiki.onap.org/).
15301       parameters:
15302         - name: global-customer-id
15303           in: path
15304           description: Global customer id used across ECOMP to uniquely identify customer.
15305           required: true
15306           type: string
15307           example: __GLOBAL-CUSTOMER-ID__
15308         - name: service-type
15309           in: path
15310           description: Value defined by orchestration to identify this service across ECOMP.
15311           required: true
15312           type: string
15313           example: __SERVICE-TYPE__
15314         - name: service-instance-id
15315           in: path
15316           description: Uniquely identifies this instance of a service
15317           required: true
15318           type: string
15319           example: __SERVICE-INSTANCE-ID__
15320         - name: id
15321           in: path
15322           description: Allotted Resource id UUID assigned to this instance.
15323           required: true
15324           type: string
15325           example: __ID__
15326         - name: id
15327           in: path
15328           description: Allotted Resource id UUID assigned to this instance.
15329           required: true
15330           type: string
15331           example: __ID__
15332         - name: body
15333           in: body
15334           description: tunnel-xconnect object that needs to be created or updated.
15335           required: true
15336           schema:
15337             $ref: "#/patchDefinitions/tunnel-xconnect"
15338     delete:
15339       tags:
15340         - Business
15341       summary: delete an existing tunnel-xconnect
15342       description: delete an existing tunnel-xconnect
15343       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
15344       consumes:
15345         - application/json
15346         - application/xml
15347       produces:
15348         - application/json
15349         - application/xml
15350       responses:
15351         "default":
15352           description: Response codes found in [response codes](https://wiki.onap.org/).
15353       parameters:
15354         - name: global-customer-id
15355           in: path
15356           description: Global customer id used across ECOMP to uniquely identify customer.
15357           required: true
15358           type: string
15359           example: __GLOBAL-CUSTOMER-ID__
15360         - name: service-type
15361           in: path
15362           description: Value defined by orchestration to identify this service across ECOMP.
15363           required: true
15364           type: string
15365           example: __SERVICE-TYPE__
15366         - name: service-instance-id
15367           in: path
15368           description: Uniquely identifies this instance of a service
15369           required: true
15370           type: string
15371           example: __SERVICE-INSTANCE-ID__
15372         - name: id
15373           in: path
15374           description: Allotted Resource id UUID assigned to this instance.
15375           required: true
15376           type: string
15377           example: __ID__
15378         - name: id
15379           in: path
15380           description: Allotted Resource id UUID assigned to this instance.
15381           required: true
15382           type: string
15383           example: __ID__
15384         - name: resource-version
15385           in: query
15386           description: resource-version for concurrency
15387           required: true
15388           type: string
15389   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/tunnel-xconnects:
15390     get:
15391       tags:
15392         - Business
15393       summary: returns tunnel-xconnects
15394       description: returns tunnel-xconnects
15395       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
15396       produces:
15397         - application/json
15398         - application/xml
15399       responses:
15400         "200":
15401           description: successful operation
15402           schema:
15403               $ref: "#/getDefinitions/tunnel-xconnects"
15404         "default":
15405           description: Response codes found in [response codes](https://wiki.onap.org/).
15406       parameters:
15407         - name: global-customer-id
15408           in: path
15409           description: Global customer id used across ECOMP to uniquely identify customer.
15410           required: true
15411           type: string
15412           example: __GLOBAL-CUSTOMER-ID__
15413         - name: service-type
15414           in: path
15415           description: Value defined by orchestration to identify this service across ECOMP.
15416           required: true
15417           type: string
15418           example: __SERVICE-TYPE__
15419         - name: service-instance-id
15420           in: path
15421           description: Uniquely identifies this instance of a service
15422           required: true
15423           type: string
15424           example: __SERVICE-INSTANCE-ID__
15425         - name: id
15426           in: path
15427           description: Allotted Resource id UUID assigned to this instance.
15428           required: true
15429           type: string
15430           example: __ID__
15431         - name: subscriber-name
15432           in: query
15433           description: Subscriber name, an alternate way to retrieve a customer.
15434           required: false
15435           type: string
15436         - name: subscriber-type
15437           in: query
15438           description: Subscriber type, a way to provide VID with only the INFRA customers.
15439           required: false
15440           type: string
15441         - name: service-instance-name
15442           in: query
15443           description: This field will store a name assigned to the service-instance.
15444           required: false
15445           type: string
15446         - name: model-invariant-id
15447           in: query
15448           description: the ASDC model id for this resource or service model.
15449           required: false
15450           type: string
15451         - name: model-version-id
15452           in: query
15453           description: the ASDC model version for this resource or service model.
15454           required: false
15455           type: string
15456         - name: widget-model-id
15457           in: query
15458           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15459           required: false
15460           type: string
15461         - name: widget-model-version
15462           in: query
15463           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15464           required: false
15465           type: string
15466         - name: service-instance-location-id
15467           in: query
15468           description: An identifier that customers assign to the location where this service is being used.
15469           required: false
15470           type: string
15471         - name: orchestration-status
15472           in: query
15473           description: Orchestration status of this service.
15474           required: false
15475           type: string
15476         - name: model-invariant-id
15477           in: query
15478           description: the ASDC model id for this resource or service model.
15479           required: false
15480           type: string
15481         - name: model-version-id
15482           in: query
15483           description: the ASDC model version for this resource or service model.
15484           required: false
15485           type: string
15486         - name: type
15487           in: query
15488           description: Generic description of the type of allotted resource.
15489           required: false
15490           type: string
15491         - name: role
15492           in: query
15493           description: role in the network that this resource will be providing.
15494           required: false
15495           type: string
15496   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}/relationship-list/relationship:
15497     put:
15498       tags:
15499         - Business
15500       summary: see node definition for valid relationships
15501       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15502       consumes:
15503         - application/json
15504         - application/xml
15505       produces:
15506         - application/json
15507         - application/xml
15508       responses:
15509         "default":
15510           description: Response codes found in [response codes](https://wiki.onap.org/).
15511       parameters:
15512         - name: global-customer-id
15513           in: path
15514           description: Global customer id used across ECOMP to uniquely identify customer.
15515           required: true
15516           type: string
15517           example: __GLOBAL-CUSTOMER-ID__
15518         - name: service-type
15519           in: path
15520           description: Value defined by orchestration to identify this service across ECOMP.
15521           required: true
15522           type: string
15523           example: __SERVICE-TYPE__
15524         - name: service-instance-id
15525           in: path
15526           description: Uniquely identifies this instance of a service
15527           required: true
15528           type: string
15529           example: __SERVICE-INSTANCE-ID__
15530         - name: id
15531           in: path
15532           description: Allotted Resource id UUID assigned to this instance.
15533           required: true
15534           type: string
15535           example: __ID__
15536         - name: body
15537           in: body
15538           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15539           required: true
15540           schema:
15541             $ref: "#/definitions/relationship"
15542     delete:
15543       tags:
15544         - Business
15545       summary: delete an existing relationship
15546       description: delete an existing relationship
15547       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
15548       consumes:
15549         - application/json
15550         - application/xml
15551       produces:
15552         - application/json
15553         - application/xml
15554       responses:
15555         "default":
15556           description: Response codes found in [response codes](https://wiki.onap.org/).
15557       parameters:
15558         - name: global-customer-id
15559           in: path
15560           description: Global customer id used across ECOMP to uniquely identify customer.
15561           required: true
15562           type: string
15563           example: __GLOBAL-CUSTOMER-ID__
15564         - name: service-type
15565           in: path
15566           description: Value defined by orchestration to identify this service across ECOMP.
15567           required: true
15568           type: string
15569           example: __SERVICE-TYPE__
15570         - name: service-instance-id
15571           in: path
15572           description: Uniquely identifies this instance of a service
15573           required: true
15574           type: string
15575           example: __SERVICE-INSTANCE-ID__
15576         - name: id
15577           in: path
15578           description: Allotted Resource id UUID assigned to this instance.
15579           required: true
15580           type: string
15581           example: __ID__
15582   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
15583     get:
15584       tags:
15585         - Business
15586       summary: returns allotted-resource
15587       description: returns allotted-resource
15588       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15589       produces:
15590         - application/json
15591         - application/xml
15592       responses:
15593         "200":
15594           description: successful operation
15595           schema:
15596               $ref: "#/getDefinitions/allotted-resource"
15597         "default":
15598           description: Response codes found in [response codes](https://wiki.onap.org/).
15599       parameters:
15600         - name: global-customer-id
15601           in: path
15602           description: Global customer id used across ECOMP to uniquely identify customer.
15603           required: true
15604           type: string
15605           example: __GLOBAL-CUSTOMER-ID__
15606         - name: service-type
15607           in: path
15608           description: Value defined by orchestration to identify this service across ECOMP.
15609           required: true
15610           type: string
15611           example: __SERVICE-TYPE__
15612         - name: service-instance-id
15613           in: path
15614           description: Uniquely identifies this instance of a service
15615           required: true
15616           type: string
15617           example: __SERVICE-INSTANCE-ID__
15618         - name: id
15619           in: path
15620           description: Allotted Resource id UUID assigned to this instance.
15621           required: true
15622           type: string
15623           example: __ID__
15624         - name: subscriber-name
15625           in: query
15626           description: Subscriber name, an alternate way to retrieve a customer.
15627           required: false
15628           type: string
15629         - name: subscriber-type
15630           in: query
15631           description: Subscriber type, a way to provide VID with only the INFRA customers.
15632           required: false
15633           type: string
15634         - name: service-instance-name
15635           in: query
15636           description: This field will store a name assigned to the service-instance.
15637           required: false
15638           type: string
15639         - name: model-invariant-id
15640           in: query
15641           description: the ASDC model id for this resource or service model.
15642           required: false
15643           type: string
15644         - name: model-version-id
15645           in: query
15646           description: the ASDC model version for this resource or service model.
15647           required: false
15648           type: string
15649         - name: widget-model-id
15650           in: query
15651           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15652           required: false
15653           type: string
15654         - name: widget-model-version
15655           in: query
15656           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15657           required: false
15658           type: string
15659         - name: service-instance-location-id
15660           in: query
15661           description: An identifier that customers assign to the location where this service is being used.
15662           required: false
15663           type: string
15664         - name: orchestration-status
15665           in: query
15666           description: Orchestration status of this service.
15667           required: false
15668           type: string
15669         - name: model-invariant-id
15670           in: query
15671           description: the ASDC model id for this resource or service model.
15672           required: false
15673           type: string
15674         - name: model-version-id
15675           in: query
15676           description: the ASDC model version for this resource or service model.
15677           required: false
15678           type: string
15679         - name: type
15680           in: query
15681           description: Generic description of the type of allotted resource.
15682           required: false
15683           type: string
15684         - name: role
15685           in: query
15686           description: role in the network that this resource will be providing.
15687           required: false
15688           type: string
15689     put:
15690       tags:
15691         - Business
15692       summary: create or update an existing allotted-resource
15693       description: |
15694         Create or update an existing allotted-resource.
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: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
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: global-customer-id
15709           in: path
15710           description: Global customer id used across ECOMP to uniquely identify customer.
15711           required: true
15712           type: string
15713           example: __GLOBAL-CUSTOMER-ID__
15714         - name: service-type
15715           in: path
15716           description: Value defined by orchestration to identify this service across ECOMP.
15717           required: true
15718           type: string
15719           example: __SERVICE-TYPE__
15720         - name: service-instance-id
15721           in: path
15722           description: Uniquely identifies this instance of a service
15723           required: true
15724           type: string
15725           example: __SERVICE-INSTANCE-ID__
15726         - name: id
15727           in: path
15728           description: Allotted Resource id UUID assigned to this instance.
15729           required: true
15730           type: string
15731           example: __ID__
15732         - name: body
15733           in: body
15734           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
15735           required: true
15736           schema:
15737             $ref: "#/definitions/allotted-resource"
15738     patch:
15739       tags:
15740         - Business
15741       summary: update an existing allotted-resource
15742       description: |
15743         Update an existing allotted-resource
15744         #
15745         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15746         The PUT operation will entirely replace an existing object.
15747         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15748         #
15749         Other differences between PUT and PATCH are:
15750         #
15751         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15752         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15753         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15754       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15755       consumes:
15756         - application/json
15757         - application/xml
15758       produces:
15759         - application/json
15760         - application/xml
15761       responses:
15762         "default":
15763           description: Response codes found in [response codes](https://wiki.onap.org/).
15764       parameters:
15765         - name: global-customer-id
15766           in: path
15767           description: Global customer id used across ECOMP to uniquely identify customer.
15768           required: true
15769           type: string
15770           example: __GLOBAL-CUSTOMER-ID__
15771         - name: service-type
15772           in: path
15773           description: Value defined by orchestration to identify this service across ECOMP.
15774           required: true
15775           type: string
15776           example: __SERVICE-TYPE__
15777         - name: service-instance-id
15778           in: path
15779           description: Uniquely identifies this instance of a service
15780           required: true
15781           type: string
15782           example: __SERVICE-INSTANCE-ID__
15783         - name: id
15784           in: path
15785           description: Allotted Resource id UUID assigned to this instance.
15786           required: true
15787           type: string
15788           example: __ID__
15789         - name: body
15790           in: body
15791           description: allotted-resource object that needs to be created or updated.
15792           required: true
15793           schema:
15794             $ref: "#/patchDefinitions/allotted-resource"
15795     delete:
15796       tags:
15797         - Business
15798       summary: delete an existing allotted-resource
15799       description: delete an existing allotted-resource
15800       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
15801       consumes:
15802         - application/json
15803         - application/xml
15804       produces:
15805         - application/json
15806         - application/xml
15807       responses:
15808         "default":
15809           description: Response codes found in [response codes](https://wiki.onap.org/).
15810       parameters:
15811         - name: global-customer-id
15812           in: path
15813           description: Global customer id used across ECOMP to uniquely identify customer.
15814           required: true
15815           type: string
15816           example: __GLOBAL-CUSTOMER-ID__
15817         - name: service-type
15818           in: path
15819           description: Value defined by orchestration to identify this service across ECOMP.
15820           required: true
15821           type: string
15822           example: __SERVICE-TYPE__
15823         - name: service-instance-id
15824           in: path
15825           description: Uniquely identifies this instance of a service
15826           required: true
15827           type: string
15828           example: __SERVICE-INSTANCE-ID__
15829         - name: id
15830           in: path
15831           description: Allotted Resource id UUID assigned to this instance.
15832           required: true
15833           type: string
15834           example: __ID__
15835         - name: resource-version
15836           in: query
15837           description: resource-version for concurrency
15838           required: true
15839           type: string
15840   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
15841     get:
15842       tags:
15843         - Business
15844       summary: returns allotted-resources
15845       description: returns allotted-resources
15846       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
15847       produces:
15848         - application/json
15849         - application/xml
15850       responses:
15851         "200":
15852           description: successful operation
15853           schema:
15854               $ref: "#/getDefinitions/allotted-resources"
15855         "default":
15856           description: Response codes found in [response codes](https://wiki.onap.org/).
15857       parameters:
15858         - name: global-customer-id
15859           in: path
15860           description: Global customer id used across ECOMP to uniquely identify customer.
15861           required: true
15862           type: string
15863           example: __GLOBAL-CUSTOMER-ID__
15864         - name: service-type
15865           in: path
15866           description: Value defined by orchestration to identify this service across ECOMP.
15867           required: true
15868           type: string
15869           example: __SERVICE-TYPE__
15870         - name: service-instance-id
15871           in: path
15872           description: Uniquely identifies this instance of a service
15873           required: true
15874           type: string
15875           example: __SERVICE-INSTANCE-ID__
15876         - name: subscriber-name
15877           in: query
15878           description: Subscriber name, an alternate way to retrieve a customer.
15879           required: false
15880           type: string
15881         - name: subscriber-type
15882           in: query
15883           description: Subscriber type, a way to provide VID with only the INFRA customers.
15884           required: false
15885           type: string
15886         - name: service-instance-name
15887           in: query
15888           description: This field will store a name assigned to the service-instance.
15889           required: false
15890           type: string
15891         - name: model-invariant-id
15892           in: query
15893           description: the ASDC model id for this resource or service model.
15894           required: false
15895           type: string
15896         - name: model-version-id
15897           in: query
15898           description: the ASDC model version for this resource or service model.
15899           required: false
15900           type: string
15901         - name: widget-model-id
15902           in: query
15903           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15904           required: false
15905           type: string
15906         - name: widget-model-version
15907           in: query
15908           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15909           required: false
15910           type: string
15911         - name: service-instance-location-id
15912           in: query
15913           description: An identifier that customers assign to the location where this service is being used.
15914           required: false
15915           type: string
15916         - name: orchestration-status
15917           in: query
15918           description: Orchestration status of this service.
15919           required: false
15920           type: string
15921   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
15922     get:
15923       tags:
15924         - Business
15925       summary: returns service-instance
15926       description: returns service-instance
15927       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
15928       produces:
15929         - application/json
15930         - application/xml
15931       responses:
15932         "200":
15933           description: successful operation
15934           schema:
15935               $ref: "#/getDefinitions/service-instance"
15936         "default":
15937           description: Response codes found in [response codes](https://wiki.onap.org/).
15938       parameters:
15939         - name: global-customer-id
15940           in: path
15941           description: Global customer id used across ECOMP to uniquely identify customer.
15942           required: true
15943           type: string
15944           example: __GLOBAL-CUSTOMER-ID__
15945         - name: service-type
15946           in: path
15947           description: Value defined by orchestration to identify this service across ECOMP.
15948           required: true
15949           type: string
15950           example: __SERVICE-TYPE__
15951         - name: service-instance-id
15952           in: path
15953           description: Uniquely identifies this instance of a service
15954           required: true
15955           type: string
15956           example: __SERVICE-INSTANCE-ID__
15957         - name: subscriber-name
15958           in: query
15959           description: Subscriber name, an alternate way to retrieve a customer.
15960           required: false
15961           type: string
15962         - name: subscriber-type
15963           in: query
15964           description: Subscriber type, a way to provide VID with only the INFRA customers.
15965           required: false
15966           type: string
15967         - name: service-instance-name
15968           in: query
15969           description: This field will store a name assigned to the service-instance.
15970           required: false
15971           type: string
15972         - name: model-invariant-id
15973           in: query
15974           description: the ASDC model id for this resource or service model.
15975           required: false
15976           type: string
15977         - name: model-version-id
15978           in: query
15979           description: the ASDC model version for this resource or service model.
15980           required: false
15981           type: string
15982         - name: widget-model-id
15983           in: query
15984           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15985           required: false
15986           type: string
15987         - name: widget-model-version
15988           in: query
15989           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15990           required: false
15991           type: string
15992         - name: service-instance-location-id
15993           in: query
15994           description: An identifier that customers assign to the location where this service is being used.
15995           required: false
15996           type: string
15997         - name: orchestration-status
15998           in: query
15999           description: Orchestration status of this service.
16000           required: false
16001           type: string
16002     put:
16003       tags:
16004         - Business
16005       summary: create or update an existing service-instance
16006       description: |
16007         Create or update an existing service-instance.
16008         #
16009         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16010       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16011       consumes:
16012         - application/json
16013         - application/xml
16014       produces:
16015         - application/json
16016         - application/xml
16017       responses:
16018         "default":
16019           description: Response codes found in [response codes](https://wiki.onap.org/).
16020       parameters:
16021         - name: global-customer-id
16022           in: path
16023           description: Global customer id used across ECOMP to uniquely identify customer.
16024           required: true
16025           type: string
16026           example: __GLOBAL-CUSTOMER-ID__
16027         - name: service-type
16028           in: path
16029           description: Value defined by orchestration to identify this service across ECOMP.
16030           required: true
16031           type: string
16032           example: __SERVICE-TYPE__
16033         - name: service-instance-id
16034           in: path
16035           description: Uniquely identifies this instance of a service
16036           required: true
16037           type: string
16038           example: __SERVICE-INSTANCE-ID__
16039         - name: body
16040           in: body
16041           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
16042           required: true
16043           schema:
16044             $ref: "#/definitions/service-instance"
16045     patch:
16046       tags:
16047         - Business
16048       summary: update an existing service-instance
16049       description: |
16050         Update an existing service-instance
16051         #
16052         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16053         The PUT operation will entirely replace an existing object.
16054         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16055         #
16056         Other differences between PUT and PATCH are:
16057         #
16058         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16059         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16060         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16061       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16062       consumes:
16063         - application/json
16064         - application/xml
16065       produces:
16066         - application/json
16067         - application/xml
16068       responses:
16069         "default":
16070           description: Response codes found in [response codes](https://wiki.onap.org/).
16071       parameters:
16072         - name: global-customer-id
16073           in: path
16074           description: Global customer id used across ECOMP to uniquely identify customer.
16075           required: true
16076           type: string
16077           example: __GLOBAL-CUSTOMER-ID__
16078         - name: service-type
16079           in: path
16080           description: Value defined by orchestration to identify this service across ECOMP.
16081           required: true
16082           type: string
16083           example: __SERVICE-TYPE__
16084         - name: service-instance-id
16085           in: path
16086           description: Uniquely identifies this instance of a service
16087           required: true
16088           type: string
16089           example: __SERVICE-INSTANCE-ID__
16090         - name: body
16091           in: body
16092           description: service-instance object that needs to be created or updated.
16093           required: true
16094           schema:
16095             $ref: "#/patchDefinitions/service-instance"
16096     delete:
16097       tags:
16098         - Business
16099       summary: delete an existing service-instance
16100       description: delete an existing service-instance
16101       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
16102       consumes:
16103         - application/json
16104         - application/xml
16105       produces:
16106         - application/json
16107         - application/xml
16108       responses:
16109         "default":
16110           description: Response codes found in [response codes](https://wiki.onap.org/).
16111       parameters:
16112         - name: global-customer-id
16113           in: path
16114           description: Global customer id used across ECOMP to uniquely identify customer.
16115           required: true
16116           type: string
16117           example: __GLOBAL-CUSTOMER-ID__
16118         - name: service-type
16119           in: path
16120           description: Value defined by orchestration to identify this service across ECOMP.
16121           required: true
16122           type: string
16123           example: __SERVICE-TYPE__
16124         - name: service-instance-id
16125           in: path
16126           description: Uniquely identifies this instance of a service
16127           required: true
16128           type: string
16129           example: __SERVICE-INSTANCE-ID__
16130         - name: resource-version
16131           in: query
16132           description: resource-version for concurrency
16133           required: true
16134           type: string
16135   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
16136     get:
16137       tags:
16138         - Business
16139       summary: returns service-instances
16140       description: returns service-instances
16141       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
16142       produces:
16143         - application/json
16144         - application/xml
16145       responses:
16146         "200":
16147           description: successful operation
16148           schema:
16149               $ref: "#/getDefinitions/service-instances"
16150         "default":
16151           description: Response codes found in [response codes](https://wiki.onap.org/).
16152       parameters:
16153         - name: global-customer-id
16154           in: path
16155           description: Global customer id used across ECOMP to uniquely identify customer.
16156           required: true
16157           type: string
16158           example: __GLOBAL-CUSTOMER-ID__
16159         - name: service-type
16160           in: path
16161           description: Value defined by orchestration to identify this service across ECOMP.
16162           required: true
16163           type: string
16164           example: __SERVICE-TYPE__
16165         - name: subscriber-name
16166           in: query
16167           description: Subscriber name, an alternate way to retrieve a customer.
16168           required: false
16169           type: string
16170         - name: subscriber-type
16171           in: query
16172           description: Subscriber type, a way to provide VID with only the INFRA customers.
16173           required: false
16174           type: string
16175   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
16176     put:
16177       tags:
16178         - Business
16179       summary: see node definition for valid relationships
16180       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16181       consumes:
16182         - application/json
16183         - application/xml
16184       produces:
16185         - application/json
16186         - application/xml
16187       responses:
16188         "default":
16189           description: Response codes found in [response codes](https://wiki.onap.org/).
16190       parameters:
16191         - name: global-customer-id
16192           in: path
16193           description: Global customer id used across ECOMP to uniquely identify customer.
16194           required: true
16195           type: string
16196           example: __GLOBAL-CUSTOMER-ID__
16197         - name: service-type
16198           in: path
16199           description: Value defined by orchestration to identify this service across ECOMP.
16200           required: true
16201           type: string
16202           example: __SERVICE-TYPE__
16203         - name: body
16204           in: body
16205           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16206           required: true
16207           schema:
16208             $ref: "#/definitions/relationship"
16209     delete:
16210       tags:
16211         - Business
16212       summary: delete an existing relationship
16213       description: delete an existing relationship
16214       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
16215       consumes:
16216         - application/json
16217         - application/xml
16218       produces:
16219         - application/json
16220         - application/xml
16221       responses:
16222         "default":
16223           description: Response codes found in [response codes](https://wiki.onap.org/).
16224       parameters:
16225         - name: global-customer-id
16226           in: path
16227           description: Global customer id used across ECOMP to uniquely identify customer.
16228           required: true
16229           type: string
16230           example: __GLOBAL-CUSTOMER-ID__
16231         - name: service-type
16232           in: path
16233           description: Value defined by orchestration to identify this service across ECOMP.
16234           required: true
16235           type: string
16236           example: __SERVICE-TYPE__
16237   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
16238     get:
16239       tags:
16240         - Business
16241       summary: returns service-subscription
16242       description: returns service-subscription
16243       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16244       produces:
16245         - application/json
16246         - application/xml
16247       responses:
16248         "200":
16249           description: successful operation
16250           schema:
16251               $ref: "#/getDefinitions/service-subscription"
16252         "default":
16253           description: Response codes found in [response codes](https://wiki.onap.org/).
16254       parameters:
16255         - name: global-customer-id
16256           in: path
16257           description: Global customer id used across ECOMP to uniquely identify customer.
16258           required: true
16259           type: string
16260           example: __GLOBAL-CUSTOMER-ID__
16261         - name: service-type
16262           in: path
16263           description: Value defined by orchestration to identify this service across ECOMP.
16264           required: true
16265           type: string
16266           example: __SERVICE-TYPE__
16267         - name: subscriber-name
16268           in: query
16269           description: Subscriber name, an alternate way to retrieve a customer.
16270           required: false
16271           type: string
16272         - name: subscriber-type
16273           in: query
16274           description: Subscriber type, a way to provide VID with only the INFRA customers.
16275           required: false
16276           type: string
16277     put:
16278       tags:
16279         - Business
16280       summary: create or update an existing service-subscription
16281       description: |
16282         Create or update an existing service-subscription.
16283         #
16284         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16285       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16286       consumes:
16287         - application/json
16288         - application/xml
16289       produces:
16290         - application/json
16291         - application/xml
16292       responses:
16293         "default":
16294           description: Response codes found in [response codes](https://wiki.onap.org/).
16295       parameters:
16296         - name: global-customer-id
16297           in: path
16298           description: Global customer id used across ECOMP to uniquely identify customer.
16299           required: true
16300           type: string
16301           example: __GLOBAL-CUSTOMER-ID__
16302         - name: service-type
16303           in: path
16304           description: Value defined by orchestration to identify this service across ECOMP.
16305           required: true
16306           type: string
16307           example: __SERVICE-TYPE__
16308         - name: body
16309           in: body
16310           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
16311           required: true
16312           schema:
16313             $ref: "#/definitions/service-subscription"
16314     patch:
16315       tags:
16316         - Business
16317       summary: update an existing service-subscription
16318       description: |
16319         Update an existing service-subscription
16320         #
16321         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16322         The PUT operation will entirely replace an existing object.
16323         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16324         #
16325         Other differences between PUT and PATCH are:
16326         #
16327         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16328         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16329         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16330       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16331       consumes:
16332         - application/json
16333         - application/xml
16334       produces:
16335         - application/json
16336         - application/xml
16337       responses:
16338         "default":
16339           description: Response codes found in [response codes](https://wiki.onap.org/).
16340       parameters:
16341         - name: global-customer-id
16342           in: path
16343           description: Global customer id used across ECOMP to uniquely identify customer.
16344           required: true
16345           type: string
16346           example: __GLOBAL-CUSTOMER-ID__
16347         - name: service-type
16348           in: path
16349           description: Value defined by orchestration to identify this service across ECOMP.
16350           required: true
16351           type: string
16352           example: __SERVICE-TYPE__
16353         - name: body
16354           in: body
16355           description: service-subscription object that needs to be created or updated.
16356           required: true
16357           schema:
16358             $ref: "#/patchDefinitions/service-subscription"
16359     delete:
16360       tags:
16361         - Business
16362       summary: delete an existing service-subscription
16363       description: delete an existing service-subscription
16364       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
16365       consumes:
16366         - application/json
16367         - application/xml
16368       produces:
16369         - application/json
16370         - application/xml
16371       responses:
16372         "default":
16373           description: Response codes found in [response codes](https://wiki.onap.org/).
16374       parameters:
16375         - name: global-customer-id
16376           in: path
16377           description: Global customer id used across ECOMP to uniquely identify customer.
16378           required: true
16379           type: string
16380           example: __GLOBAL-CUSTOMER-ID__
16381         - name: service-type
16382           in: path
16383           description: Value defined by orchestration to identify this service across ECOMP.
16384           required: true
16385           type: string
16386           example: __SERVICE-TYPE__
16387         - name: resource-version
16388           in: query
16389           description: resource-version for concurrency
16390           required: true
16391           type: string
16392   /business/customers/customer/{global-customer-id}/service-subscriptions:
16393     get:
16394       tags:
16395         - Business
16396       summary: returns service-subscriptions
16397       description: returns service-subscriptions
16398       operationId: getBusinessCustomersCustomerServiceSubscriptions
16399       produces:
16400         - application/json
16401         - application/xml
16402       responses:
16403         "200":
16404           description: successful operation
16405           schema:
16406               $ref: "#/getDefinitions/service-subscriptions"
16407         "default":
16408           description: Response codes found in [response codes](https://wiki.onap.org/).
16409       parameters:
16410         - name: global-customer-id
16411           in: path
16412           description: Global customer id used across ECOMP to uniquely identify customer.
16413           required: true
16414           type: string
16415           example: __GLOBAL-CUSTOMER-ID__
16416         - name: subscriber-name
16417           in: query
16418           description: Subscriber name, an alternate way to retrieve a customer.
16419           required: false
16420           type: string
16421         - name: subscriber-type
16422           in: query
16423           description: Subscriber type, a way to provide VID with only the INFRA customers.
16424           required: false
16425           type: string
16426   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
16427     put:
16428       tags:
16429         - Business
16430       summary: see node definition for valid relationships
16431       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
16432       consumes:
16433         - application/json
16434         - application/xml
16435       produces:
16436         - application/json
16437         - application/xml
16438       responses:
16439         "default":
16440           description: Response codes found in [response codes](https://wiki.onap.org/).
16441       parameters:
16442         - name: global-customer-id
16443           in: path
16444           description: Global customer id used across ECOMP to uniquely identify customer.
16445           required: true
16446           type: string
16447           example: __GLOBAL-CUSTOMER-ID__
16448         - name: body
16449           in: body
16450           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
16451           required: true
16452           schema:
16453             $ref: "#/definitions/relationship"
16454     delete:
16455       tags:
16456         - Business
16457       summary: delete an existing relationship
16458       description: delete an existing relationship
16459       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
16460       consumes:
16461         - application/json
16462         - application/xml
16463       produces:
16464         - application/json
16465         - application/xml
16466       responses:
16467         "default":
16468           description: Response codes found in [response codes](https://wiki.onap.org/).
16469       parameters:
16470         - name: global-customer-id
16471           in: path
16472           description: Global customer id used across ECOMP to uniquely identify customer.
16473           required: true
16474           type: string
16475           example: __GLOBAL-CUSTOMER-ID__
16476   /business/customers/customer/{global-customer-id}:
16477     get:
16478       tags:
16479         - Business
16480       summary: returns customer
16481       description: returns customer
16482       operationId: getBusinessCustomersCustomer
16483       produces:
16484         - application/json
16485         - application/xml
16486       responses:
16487         "200":
16488           description: successful operation
16489           schema:
16490               $ref: "#/getDefinitions/customer"
16491         "default":
16492           description: Response codes found in [response codes](https://wiki.onap.org/).
16493       parameters:
16494         - name: global-customer-id
16495           in: path
16496           description: Global customer id used across ECOMP to uniquely identify customer.
16497           required: true
16498           type: string
16499           example: __GLOBAL-CUSTOMER-ID__
16500         - name: subscriber-name
16501           in: query
16502           description: Subscriber name, an alternate way to retrieve a customer.
16503           required: false
16504           type: string
16505         - name: subscriber-type
16506           in: query
16507           description: Subscriber type, a way to provide VID with only the INFRA customers.
16508           required: false
16509           type: string
16510     put:
16511       tags:
16512         - Business
16513       summary: create or update an existing customer
16514       description: |
16515         Create or update an existing customer.
16516         #
16517         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16518       operationId: createOrUpdateBusinessCustomersCustomer
16519       consumes:
16520         - application/json
16521         - application/xml
16522       produces:
16523         - application/json
16524         - application/xml
16525       responses:
16526         "default":
16527           description: Response codes found in [response codes](https://wiki.onap.org/).
16528       parameters:
16529         - name: global-customer-id
16530           in: path
16531           description: Global customer id used across ECOMP to uniquely identify customer.
16532           required: true
16533           type: string
16534           example: __GLOBAL-CUSTOMER-ID__
16535         - name: body
16536           in: body
16537           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/BusinessCustomersCustomer.json)
16538           required: true
16539           schema:
16540             $ref: "#/definitions/customer"
16541     patch:
16542       tags:
16543         - Business
16544       summary: update an existing customer
16545       description: |
16546         Update an existing customer
16547         #
16548         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16549         The PUT operation will entirely replace an existing object.
16550         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16551         #
16552         Other differences between PUT and PATCH are:
16553         #
16554         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16555         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16556         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16557       operationId: UpdateBusinessCustomersCustomer
16558       consumes:
16559         - application/json
16560         - application/xml
16561       produces:
16562         - application/json
16563         - application/xml
16564       responses:
16565         "default":
16566           description: Response codes found in [response codes](https://wiki.onap.org/).
16567       parameters:
16568         - name: global-customer-id
16569           in: path
16570           description: Global customer id used across ECOMP to uniquely identify customer.
16571           required: true
16572           type: string
16573           example: __GLOBAL-CUSTOMER-ID__
16574         - name: body
16575           in: body
16576           description: customer object that needs to be created or updated.
16577           required: true
16578           schema:
16579             $ref: "#/patchDefinitions/customer"
16580     delete:
16581       tags:
16582         - Business
16583       summary: delete an existing customer
16584       description: delete an existing customer
16585       operationId: deleteBusinessCustomersCustomer
16586       consumes:
16587         - application/json
16588         - application/xml
16589       produces:
16590         - application/json
16591         - application/xml
16592       responses:
16593         "default":
16594           description: Response codes found in [response codes](https://wiki.onap.org/).
16595       parameters:
16596         - name: global-customer-id
16597           in: path
16598           description: Global customer id used across ECOMP to uniquely identify customer.
16599           required: true
16600           type: string
16601           example: __GLOBAL-CUSTOMER-ID__
16602         - name: resource-version
16603           in: query
16604           description: resource-version for concurrency
16605           required: true
16606           type: string
16607   /business/customers:
16608     get:
16609       tags:
16610         - Business
16611       summary: returns customers
16612       description: returns customers
16613       operationId: getBusinessCustomers
16614       produces:
16615         - application/json
16616         - application/xml
16617       responses:
16618         "200":
16619           description: successful operation
16620           schema:
16621               $ref: "#/getDefinitions/customers"
16622         "default":
16623           description: Response codes found in [response codes](https://wiki.onap.org/).
16624   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
16625     put:
16626       tags:
16627         - ServiceDesignAndCreation
16628       summary: see node definition for valid relationships
16629       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16630       consumes:
16631         - application/json
16632         - application/xml
16633       produces:
16634         - application/json
16635         - application/xml
16636       responses:
16637         "default":
16638           description: Response codes found in [response codes](https://wiki.onap.org/).
16639       parameters:
16640         - name: vnf-image-uuid
16641           in: path
16642           description: Unique ID of this asset
16643           required: true
16644           type: string
16645           example: __VNF-IMAGE-UUID__
16646         - name: body
16647           in: body
16648           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
16649           required: true
16650           schema:
16651             $ref: "#/definitions/relationship"
16652     delete:
16653       tags:
16654         - ServiceDesignAndCreation
16655       summary: delete an existing relationship
16656       description: delete an existing relationship
16657       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
16658       consumes:
16659         - application/json
16660         - application/xml
16661       produces:
16662         - application/json
16663         - application/xml
16664       responses:
16665         "default":
16666           description: Response codes found in [response codes](https://wiki.onap.org/).
16667       parameters:
16668         - name: vnf-image-uuid
16669           in: path
16670           description: Unique ID of this asset
16671           required: true
16672           type: string
16673           example: __VNF-IMAGE-UUID__
16674   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
16675     get:
16676       tags:
16677         - ServiceDesignAndCreation
16678       summary: returns vnf-image
16679       description: returns vnf-image
16680       operationId: getServiceDesignAndCreationVnfImagesVnfImage
16681       produces:
16682         - application/json
16683         - application/xml
16684       responses:
16685         "200":
16686           description: successful operation
16687           schema:
16688               $ref: "#/getDefinitions/vnf-image"
16689         "default":
16690           description: Response codes found in [response codes](https://wiki.onap.org/).
16691       parameters:
16692         - name: vnf-image-uuid
16693           in: path
16694           description: Unique ID of this asset
16695           required: true
16696           type: string
16697           example: __VNF-IMAGE-UUID__
16698         - name: application
16699           in: query
16700           description: The application that the image instantiates.
16701           required: false
16702           type: string
16703         - name: application-vendor
16704           in: query
16705           description: The vendor of the application.
16706           required: false
16707           type: string
16708         - name: application-version
16709           in: query
16710           description: The version of the application.
16711           required: false
16712           type: string
16713     put:
16714       tags:
16715         - ServiceDesignAndCreation
16716       summary: create or update an existing vnf-image
16717       description: |
16718         Create or update an existing vnf-image.
16719         #
16720         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16721       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
16722       consumes:
16723         - application/json
16724         - application/xml
16725       produces:
16726         - application/json
16727         - application/xml
16728       responses:
16729         "default":
16730           description: Response codes found in [response codes](https://wiki.onap.org/).
16731       parameters:
16732         - name: vnf-image-uuid
16733           in: path
16734           description: Unique ID of this asset
16735           required: true
16736           type: string
16737           example: __VNF-IMAGE-UUID__
16738         - name: body
16739           in: body
16740           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationVnfImagesVnfImage.json)
16741           required: true
16742           schema:
16743             $ref: "#/definitions/vnf-image"
16744     patch:
16745       tags:
16746         - ServiceDesignAndCreation
16747       summary: update an existing vnf-image
16748       description: |
16749         Update an existing vnf-image
16750         #
16751         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16752         The PUT operation will entirely replace an existing object.
16753         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16754         #
16755         Other differences between PUT and PATCH are:
16756         #
16757         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16758         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16759         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16760       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
16761       consumes:
16762         - application/json
16763         - application/xml
16764       produces:
16765         - application/json
16766         - application/xml
16767       responses:
16768         "default":
16769           description: Response codes found in [response codes](https://wiki.onap.org/).
16770       parameters:
16771         - name: vnf-image-uuid
16772           in: path
16773           description: Unique ID of this asset
16774           required: true
16775           type: string
16776           example: __VNF-IMAGE-UUID__
16777         - name: body
16778           in: body
16779           description: vnf-image object that needs to be created or updated.
16780           required: true
16781           schema:
16782             $ref: "#/patchDefinitions/vnf-image"
16783     delete:
16784       tags:
16785         - ServiceDesignAndCreation
16786       summary: delete an existing vnf-image
16787       description: delete an existing vnf-image
16788       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
16789       consumes:
16790         - application/json
16791         - application/xml
16792       produces:
16793         - application/json
16794         - application/xml
16795       responses:
16796         "default":
16797           description: Response codes found in [response codes](https://wiki.onap.org/).
16798       parameters:
16799         - name: vnf-image-uuid
16800           in: path
16801           description: Unique ID of this asset
16802           required: true
16803           type: string
16804           example: __VNF-IMAGE-UUID__
16805         - name: resource-version
16806           in: query
16807           description: resource-version for concurrency
16808           required: true
16809           type: string
16810   /service-design-and-creation/vnf-images:
16811     get:
16812       tags:
16813         - ServiceDesignAndCreation
16814       summary: returns vnf-images
16815       description: returns vnf-images
16816       operationId: getServiceDesignAndCreationVnfImages
16817       produces:
16818         - application/json
16819         - application/xml
16820       responses:
16821         "200":
16822           description: successful operation
16823           schema:
16824               $ref: "#/getDefinitions/vnf-images"
16825         "default":
16826           description: Response codes found in [response codes](https://wiki.onap.org/).
16827   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
16828     put:
16829       tags:
16830         - ServiceDesignAndCreation
16831       summary: see node definition for valid relationships
16832       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
16833       consumes:
16834         - application/json
16835         - application/xml
16836       produces:
16837         - application/json
16838         - application/xml
16839       responses:
16840         "default":
16841           description: Response codes found in [response codes](https://wiki.onap.org/).
16842       parameters:
16843         - name: service-id
16844           in: path
16845           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16846           required: true
16847           type: string
16848           example: __SERVICE-ID__
16849         - name: body
16850           in: body
16851           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
16852           required: true
16853           schema:
16854             $ref: "#/definitions/relationship"
16855     delete:
16856       tags:
16857         - ServiceDesignAndCreation
16858       summary: delete an existing relationship
16859       description: delete an existing relationship
16860       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
16861       consumes:
16862         - application/json
16863         - application/xml
16864       produces:
16865         - application/json
16866         - application/xml
16867       responses:
16868         "default":
16869           description: Response codes found in [response codes](https://wiki.onap.org/).
16870       parameters:
16871         - name: service-id
16872           in: path
16873           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16874           required: true
16875           type: string
16876           example: __SERVICE-ID__
16877   /service-design-and-creation/services/service/{service-id}:
16878     get:
16879       tags:
16880         - ServiceDesignAndCreation
16881       summary: returns service
16882       description: returns service
16883       operationId: getServiceDesignAndCreationServicesService
16884       produces:
16885         - application/json
16886         - application/xml
16887       responses:
16888         "200":
16889           description: successful operation
16890           schema:
16891               $ref: "#/getDefinitions/service"
16892         "default":
16893           description: Response codes found in [response codes](https://wiki.onap.org/).
16894       parameters:
16895         - name: service-id
16896           in: path
16897           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16898           required: true
16899           type: string
16900           example: __SERVICE-ID__
16901         - name: service-description
16902           in: query
16903           description: Description of the service
16904           required: false
16905           type: string
16906     put:
16907       tags:
16908         - ServiceDesignAndCreation
16909       summary: create or update an existing service
16910       description: |
16911         Create or update an existing service.
16912         #
16913         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16914       operationId: createOrUpdateServiceDesignAndCreationServicesService
16915       consumes:
16916         - application/json
16917         - application/xml
16918       produces:
16919         - application/json
16920         - application/xml
16921       responses:
16922         "default":
16923           description: Response codes found in [response codes](https://wiki.onap.org/).
16924       parameters:
16925         - name: service-id
16926           in: path
16927           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16928           required: true
16929           type: string
16930           example: __SERVICE-ID__
16931         - name: body
16932           in: body
16933           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServicesService.json)
16934           required: true
16935           schema:
16936             $ref: "#/definitions/service"
16937     patch:
16938       tags:
16939         - ServiceDesignAndCreation
16940       summary: update an existing service
16941       description: |
16942         Update an existing service
16943         #
16944         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16945         The PUT operation will entirely replace an existing object.
16946         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16947         #
16948         Other differences between PUT and PATCH are:
16949         #
16950         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16951         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16952         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16953       operationId: UpdateServiceDesignAndCreationServicesService
16954       consumes:
16955         - application/json
16956         - application/xml
16957       produces:
16958         - application/json
16959         - application/xml
16960       responses:
16961         "default":
16962           description: Response codes found in [response codes](https://wiki.onap.org/).
16963       parameters:
16964         - name: service-id
16965           in: path
16966           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16967           required: true
16968           type: string
16969           example: __SERVICE-ID__
16970         - name: body
16971           in: body
16972           description: service object that needs to be created or updated.
16973           required: true
16974           schema:
16975             $ref: "#/patchDefinitions/service"
16976     delete:
16977       tags:
16978         - ServiceDesignAndCreation
16979       summary: delete an existing service
16980       description: delete an existing service
16981       operationId: deleteServiceDesignAndCreationServicesService
16982       consumes:
16983         - application/json
16984         - application/xml
16985       produces:
16986         - application/json
16987         - application/xml
16988       responses:
16989         "default":
16990           description: Response codes found in [response codes](https://wiki.onap.org/).
16991       parameters:
16992         - name: service-id
16993           in: path
16994           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
16995           required: true
16996           type: string
16997           example: __SERVICE-ID__
16998         - name: resource-version
16999           in: query
17000           description: resource-version for concurrency
17001           required: true
17002           type: string
17003   /service-design-and-creation/services:
17004     get:
17005       tags:
17006         - ServiceDesignAndCreation
17007       summary: returns services
17008       description: returns services
17009       operationId: getServiceDesignAndCreationServices
17010       produces:
17011         - application/json
17012         - application/xml
17013       responses:
17014         "200":
17015           description: successful operation
17016           schema:
17017               $ref: "#/getDefinitions/services"
17018         "default":
17019           description: Response codes found in [response codes](https://wiki.onap.org/).
17020   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
17021     put:
17022       tags:
17023         - ServiceDesignAndCreation
17024       summary: see node definition for valid relationships
17025       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17026       consumes:
17027         - application/json
17028         - application/xml
17029       produces:
17030         - application/json
17031         - application/xml
17032       responses:
17033         "default":
17034           description: Response codes found in [response codes](https://wiki.onap.org/).
17035       parameters:
17036         - name: service-type
17037           in: path
17038           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17039           required: true
17040           type: string
17041           example: __SERVICE-TYPE__
17042         - name: vnf-type
17043           in: path
17044           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17045           required: true
17046           type: string
17047           example: __VNF-TYPE__
17048         - name: body
17049           in: body
17050           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17051           required: true
17052           schema:
17053             $ref: "#/definitions/relationship"
17054     delete:
17055       tags:
17056         - ServiceDesignAndCreation
17057       summary: delete an existing relationship
17058       description: delete an existing relationship
17059       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
17060       consumes:
17061         - application/json
17062         - application/xml
17063       produces:
17064         - application/json
17065         - application/xml
17066       responses:
17067         "default":
17068           description: Response codes found in [response codes](https://wiki.onap.org/).
17069       parameters:
17070         - name: service-type
17071           in: path
17072           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17073           required: true
17074           type: string
17075           example: __SERVICE-TYPE__
17076         - name: vnf-type
17077           in: path
17078           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17079           required: true
17080           type: string
17081           example: __VNF-TYPE__
17082   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
17083     get:
17084       tags:
17085         - ServiceDesignAndCreation
17086       summary: returns service-capability
17087       description: returns service-capability
17088       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
17089       produces:
17090         - application/json
17091         - application/xml
17092       responses:
17093         "200":
17094           description: successful operation
17095           schema:
17096               $ref: "#/getDefinitions/service-capability"
17097         "default":
17098           description: Response codes found in [response codes](https://wiki.onap.org/).
17099       parameters:
17100         - name: service-type
17101           in: path
17102           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17103           required: true
17104           type: string
17105           example: __SERVICE-TYPE__
17106         - name: vnf-type
17107           in: path
17108           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17109           required: true
17110           type: string
17111           example: __VNF-TYPE__
17112     put:
17113       tags:
17114         - ServiceDesignAndCreation
17115       summary: create or update an existing service-capability
17116       description: |
17117         Create or update an existing service-capability.
17118         #
17119         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17120       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17121       consumes:
17122         - application/json
17123         - application/xml
17124       produces:
17125         - application/json
17126         - application/xml
17127       responses:
17128         "default":
17129           description: Response codes found in [response codes](https://wiki.onap.org/).
17130       parameters:
17131         - name: service-type
17132           in: path
17133           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17134           required: true
17135           type: string
17136           example: __SERVICE-TYPE__
17137         - name: vnf-type
17138           in: path
17139           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17140           required: true
17141           type: string
17142           example: __VNF-TYPE__
17143         - name: body
17144           in: body
17145           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
17146           required: true
17147           schema:
17148             $ref: "#/definitions/service-capability"
17149     patch:
17150       tags:
17151         - ServiceDesignAndCreation
17152       summary: update an existing service-capability
17153       description: |
17154         Update an existing service-capability
17155         #
17156         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17157         The PUT operation will entirely replace an existing object.
17158         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17159         #
17160         Other differences between PUT and PATCH are:
17161         #
17162         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17163         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17164         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17165       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
17166       consumes:
17167         - application/json
17168         - application/xml
17169       produces:
17170         - application/json
17171         - application/xml
17172       responses:
17173         "default":
17174           description: Response codes found in [response codes](https://wiki.onap.org/).
17175       parameters:
17176         - name: service-type
17177           in: path
17178           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17179           required: true
17180           type: string
17181           example: __SERVICE-TYPE__
17182         - name: vnf-type
17183           in: path
17184           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17185           required: true
17186           type: string
17187           example: __VNF-TYPE__
17188         - name: body
17189           in: body
17190           description: service-capability object that needs to be created or updated.
17191           required: true
17192           schema:
17193             $ref: "#/patchDefinitions/service-capability"
17194     delete:
17195       tags:
17196         - ServiceDesignAndCreation
17197       summary: delete an existing service-capability
17198       description: delete an existing service-capability
17199       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
17200       consumes:
17201         - application/json
17202         - application/xml
17203       produces:
17204         - application/json
17205         - application/xml
17206       responses:
17207         "default":
17208           description: Response codes found in [response codes](https://wiki.onap.org/).
17209       parameters:
17210         - name: service-type
17211           in: path
17212           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
17213           required: true
17214           type: string
17215           example: __SERVICE-TYPE__
17216         - name: vnf-type
17217           in: path
17218           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
17219           required: true
17220           type: string
17221           example: __VNF-TYPE__
17222         - name: resource-version
17223           in: query
17224           description: resource-version for concurrency
17225           required: true
17226           type: string
17227   /service-design-and-creation/service-capabilities:
17228     get:
17229       tags:
17230         - ServiceDesignAndCreation
17231       summary: returns service-capabilities
17232       description: returns service-capabilities
17233       operationId: getServiceDesignAndCreationServiceCapabilities
17234       produces:
17235         - application/json
17236         - application/xml
17237       responses:
17238         "200":
17239           description: successful operation
17240           schema:
17241               $ref: "#/getDefinitions/service-capabilities"
17242         "default":
17243           description: Response codes found in [response codes](https://wiki.onap.org/).
17244   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship:
17245     put:
17246       tags:
17247         - ServiceDesignAndCreation
17248       summary: see node definition for valid relationships
17249       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17250       consumes:
17251         - application/json
17252         - application/xml
17253       produces:
17254         - application/json
17255         - application/xml
17256       responses:
17257         "default":
17258           description: Response codes found in [response codes](https://wiki.onap.org/).
17259       parameters:
17260         - name: model-invariant-id
17261           in: path
17262           description: Unique identifier corresponding to the main definition of a model in ASDC
17263           required: true
17264           type: string
17265           example: __MODEL-INVARIANT-ID__
17266         - name: model-version-id
17267           in: path
17268           description: Unique identifier corresponding to one version of a model in ASDC
17269           required: true
17270           type: string
17271           example: __MODEL-VERSION-ID__
17272         - name: model-element-uuid
17273           in: path
17274           required: true
17275           type: string
17276           example: __MODEL-ELEMENT-UUID__
17277         - name: model-constraint-uuid
17278           in: path
17279           required: true
17280           type: string
17281           example: __MODEL-CONSTRAINT-UUID__
17282         - name: constrained-element-set-uuid
17283           in: path
17284           required: true
17285           type: string
17286           example: __CONSTRAINED-ELEMENT-SET-UUID__
17287         - name: element-choice-set-uuid
17288           in: path
17289           required: true
17290           type: string
17291           example: __ELEMENT-CHOICE-SET-UUID__
17292         - name: body
17293           in: body
17294           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17295           required: true
17296           schema:
17297             $ref: "#/definitions/relationship"
17298     delete:
17299       tags:
17300         - ServiceDesignAndCreation
17301       summary: delete an existing relationship
17302       description: delete an existing relationship
17303       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
17304       consumes:
17305         - application/json
17306         - application/xml
17307       produces:
17308         - application/json
17309         - application/xml
17310       responses:
17311         "default":
17312           description: Response codes found in [response codes](https://wiki.onap.org/).
17313       parameters:
17314         - name: model-invariant-id
17315           in: path
17316           description: Unique identifier corresponding to the main definition of a model in ASDC
17317           required: true
17318           type: string
17319           example: __MODEL-INVARIANT-ID__
17320         - name: model-version-id
17321           in: path
17322           description: Unique identifier corresponding to one version of a model in ASDC
17323           required: true
17324           type: string
17325           example: __MODEL-VERSION-ID__
17326         - name: model-element-uuid
17327           in: path
17328           required: true
17329           type: string
17330           example: __MODEL-ELEMENT-UUID__
17331         - name: model-constraint-uuid
17332           in: path
17333           required: true
17334           type: string
17335           example: __MODEL-CONSTRAINT-UUID__
17336         - name: constrained-element-set-uuid
17337           in: path
17338           required: true
17339           type: string
17340           example: __CONSTRAINED-ELEMENT-SET-UUID__
17341         - name: element-choice-set-uuid
17342           in: path
17343           required: true
17344           type: string
17345           example: __ELEMENT-CHOICE-SET-UUID__
17346   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}:
17347     get:
17348       tags:
17349         - ServiceDesignAndCreation
17350       summary: returns element-choice-set
17351       description: returns element-choice-set
17352       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17353       produces:
17354         - application/json
17355         - application/xml
17356       responses:
17357         "200":
17358           description: successful operation
17359           schema:
17360               $ref: "#/getDefinitions/element-choice-set"
17361         "default":
17362           description: Response codes found in [response codes](https://wiki.onap.org/).
17363       parameters:
17364         - name: model-invariant-id
17365           in: path
17366           description: Unique identifier corresponding to the main definition of a model in ASDC
17367           required: true
17368           type: string
17369           example: __MODEL-INVARIANT-ID__
17370         - name: model-version-id
17371           in: path
17372           description: Unique identifier corresponding to one version of a model in ASDC
17373           required: true
17374           type: string
17375           example: __MODEL-VERSION-ID__
17376         - name: model-element-uuid
17377           in: path
17378           required: true
17379           type: string
17380           example: __MODEL-ELEMENT-UUID__
17381         - name: model-constraint-uuid
17382           in: path
17383           required: true
17384           type: string
17385           example: __MODEL-CONSTRAINT-UUID__
17386         - name: constrained-element-set-uuid
17387           in: path
17388           required: true
17389           type: string
17390           example: __CONSTRAINED-ELEMENT-SET-UUID__
17391         - name: element-choice-set-uuid
17392           in: path
17393           required: true
17394           type: string
17395           example: __ELEMENT-CHOICE-SET-UUID__
17396         - name: model-type
17397           in: query
17398           description: Type of the model, e.g., service, resource, widget, etc.
17399           required: false
17400           type: string
17401         - name: model-name
17402           in: query
17403           description: Name of the model, which can change from version to version.
17404           required: false
17405           type: string
17406         - name: model-version
17407           in: query
17408           description: Version
17409           required: false
17410           type: string
17411     put:
17412       tags:
17413         - ServiceDesignAndCreation
17414       summary: create or update an existing element-choice-set
17415       description: |
17416         Create or update an existing element-choice-set.
17417         #
17418         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17419       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17420       consumes:
17421         - application/json
17422         - application/xml
17423       produces:
17424         - application/json
17425         - application/xml
17426       responses:
17427         "default":
17428           description: Response codes found in [response codes](https://wiki.onap.org/).
17429       parameters:
17430         - name: model-invariant-id
17431           in: path
17432           description: Unique identifier corresponding to the main definition of a model in ASDC
17433           required: true
17434           type: string
17435           example: __MODEL-INVARIANT-ID__
17436         - name: model-version-id
17437           in: path
17438           description: Unique identifier corresponding to one version of a model in ASDC
17439           required: true
17440           type: string
17441           example: __MODEL-VERSION-ID__
17442         - name: model-element-uuid
17443           in: path
17444           required: true
17445           type: string
17446           example: __MODEL-ELEMENT-UUID__
17447         - name: model-constraint-uuid
17448           in: path
17449           required: true
17450           type: string
17451           example: __MODEL-CONSTRAINT-UUID__
17452         - name: constrained-element-set-uuid
17453           in: path
17454           required: true
17455           type: string
17456           example: __CONSTRAINED-ELEMENT-SET-UUID__
17457         - name: element-choice-set-uuid
17458           in: path
17459           required: true
17460           type: string
17461           example: __ELEMENT-CHOICE-SET-UUID__
17462         - name: body
17463           in: body
17464           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
17465           required: true
17466           schema:
17467             $ref: "#/definitions/element-choice-set"
17468     patch:
17469       tags:
17470         - ServiceDesignAndCreation
17471       summary: update an existing element-choice-set
17472       description: |
17473         Update an existing element-choice-set
17474         #
17475         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17476         The PUT operation will entirely replace an existing object.
17477         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17478         #
17479         Other differences between PUT and PATCH are:
17480         #
17481         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17482         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17483         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17484       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17485       consumes:
17486         - application/json
17487         - application/xml
17488       produces:
17489         - application/json
17490         - application/xml
17491       responses:
17492         "default":
17493           description: Response codes found in [response codes](https://wiki.onap.org/).
17494       parameters:
17495         - name: model-invariant-id
17496           in: path
17497           description: Unique identifier corresponding to the main definition of a model in ASDC
17498           required: true
17499           type: string
17500           example: __MODEL-INVARIANT-ID__
17501         - name: model-version-id
17502           in: path
17503           description: Unique identifier corresponding to one version of a model in ASDC
17504           required: true
17505           type: string
17506           example: __MODEL-VERSION-ID__
17507         - name: model-element-uuid
17508           in: path
17509           required: true
17510           type: string
17511           example: __MODEL-ELEMENT-UUID__
17512         - name: model-constraint-uuid
17513           in: path
17514           required: true
17515           type: string
17516           example: __MODEL-CONSTRAINT-UUID__
17517         - name: constrained-element-set-uuid
17518           in: path
17519           required: true
17520           type: string
17521           example: __CONSTRAINED-ELEMENT-SET-UUID__
17522         - name: element-choice-set-uuid
17523           in: path
17524           required: true
17525           type: string
17526           example: __ELEMENT-CHOICE-SET-UUID__
17527         - name: body
17528           in: body
17529           description: element-choice-set object that needs to be created or updated.
17530           required: true
17531           schema:
17532             $ref: "#/patchDefinitions/element-choice-set"
17533     delete:
17534       tags:
17535         - ServiceDesignAndCreation
17536       summary: delete an existing element-choice-set
17537       description: delete an existing element-choice-set
17538       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
17539       consumes:
17540         - application/json
17541         - application/xml
17542       produces:
17543         - application/json
17544         - application/xml
17545       responses:
17546         "default":
17547           description: Response codes found in [response codes](https://wiki.onap.org/).
17548       parameters:
17549         - name: model-invariant-id
17550           in: path
17551           description: Unique identifier corresponding to the main definition of a model in ASDC
17552           required: true
17553           type: string
17554           example: __MODEL-INVARIANT-ID__
17555         - name: model-version-id
17556           in: path
17557           description: Unique identifier corresponding to one version of a model in ASDC
17558           required: true
17559           type: string
17560           example: __MODEL-VERSION-ID__
17561         - name: model-element-uuid
17562           in: path
17563           required: true
17564           type: string
17565           example: __MODEL-ELEMENT-UUID__
17566         - name: model-constraint-uuid
17567           in: path
17568           required: true
17569           type: string
17570           example: __MODEL-CONSTRAINT-UUID__
17571         - name: constrained-element-set-uuid
17572           in: path
17573           required: true
17574           type: string
17575           example: __CONSTRAINED-ELEMENT-SET-UUID__
17576         - name: element-choice-set-uuid
17577           in: path
17578           required: true
17579           type: string
17580           example: __ELEMENT-CHOICE-SET-UUID__
17581         - name: resource-version
17582           in: query
17583           description: resource-version for concurrency
17584           required: true
17585           type: string
17586   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets:
17587     get:
17588       tags:
17589         - ServiceDesignAndCreation
17590       summary: returns element-choice-sets
17591       description: returns element-choice-sets
17592       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
17593       produces:
17594         - application/json
17595         - application/xml
17596       responses:
17597         "200":
17598           description: successful operation
17599           schema:
17600               $ref: "#/getDefinitions/element-choice-sets"
17601         "default":
17602           description: Response codes found in [response codes](https://wiki.onap.org/).
17603       parameters:
17604         - name: model-invariant-id
17605           in: path
17606           description: Unique identifier corresponding to the main definition of a model in ASDC
17607           required: true
17608           type: string
17609           example: __MODEL-INVARIANT-ID__
17610         - name: model-version-id
17611           in: path
17612           description: Unique identifier corresponding to one version of a model in ASDC
17613           required: true
17614           type: string
17615           example: __MODEL-VERSION-ID__
17616         - name: model-element-uuid
17617           in: path
17618           required: true
17619           type: string
17620           example: __MODEL-ELEMENT-UUID__
17621         - name: model-constraint-uuid
17622           in: path
17623           required: true
17624           type: string
17625           example: __MODEL-CONSTRAINT-UUID__
17626         - name: constrained-element-set-uuid
17627           in: path
17628           required: true
17629           type: string
17630           example: __CONSTRAINED-ELEMENT-SET-UUID__
17631         - name: model-type
17632           in: query
17633           description: Type of the model, e.g., service, resource, widget, etc.
17634           required: false
17635           type: string
17636         - name: model-name
17637           in: query
17638           description: Name of the model, which can change from version to version.
17639           required: false
17640           type: string
17641         - name: model-version
17642           in: query
17643           description: Version
17644           required: false
17645           type: string
17646   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/relationship-list/relationship:
17647     put:
17648       tags:
17649         - ServiceDesignAndCreation
17650       summary: see node definition for valid relationships
17651       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17652       consumes:
17653         - application/json
17654         - application/xml
17655       produces:
17656         - application/json
17657         - application/xml
17658       responses:
17659         "default":
17660           description: Response codes found in [response codes](https://wiki.onap.org/).
17661       parameters:
17662         - name: model-invariant-id
17663           in: path
17664           description: Unique identifier corresponding to the main definition of a model in ASDC
17665           required: true
17666           type: string
17667           example: __MODEL-INVARIANT-ID__
17668         - name: model-version-id
17669           in: path
17670           description: Unique identifier corresponding to one version of a model in ASDC
17671           required: true
17672           type: string
17673           example: __MODEL-VERSION-ID__
17674         - name: model-element-uuid
17675           in: path
17676           required: true
17677           type: string
17678           example: __MODEL-ELEMENT-UUID__
17679         - name: model-constraint-uuid
17680           in: path
17681           required: true
17682           type: string
17683           example: __MODEL-CONSTRAINT-UUID__
17684         - name: constrained-element-set-uuid
17685           in: path
17686           required: true
17687           type: string
17688           example: __CONSTRAINED-ELEMENT-SET-UUID__
17689         - name: body
17690           in: body
17691           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17692           required: true
17693           schema:
17694             $ref: "#/definitions/relationship"
17695     delete:
17696       tags:
17697         - ServiceDesignAndCreation
17698       summary: delete an existing relationship
17699       description: delete an existing relationship
17700       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
17701       consumes:
17702         - application/json
17703         - application/xml
17704       produces:
17705         - application/json
17706         - application/xml
17707       responses:
17708         "default":
17709           description: Response codes found in [response codes](https://wiki.onap.org/).
17710       parameters:
17711         - name: model-invariant-id
17712           in: path
17713           description: Unique identifier corresponding to the main definition of a model in ASDC
17714           required: true
17715           type: string
17716           example: __MODEL-INVARIANT-ID__
17717         - name: model-version-id
17718           in: path
17719           description: Unique identifier corresponding to one version of a model in ASDC
17720           required: true
17721           type: string
17722           example: __MODEL-VERSION-ID__
17723         - name: model-element-uuid
17724           in: path
17725           required: true
17726           type: string
17727           example: __MODEL-ELEMENT-UUID__
17728         - name: model-constraint-uuid
17729           in: path
17730           required: true
17731           type: string
17732           example: __MODEL-CONSTRAINT-UUID__
17733         - name: constrained-element-set-uuid
17734           in: path
17735           required: true
17736           type: string
17737           example: __CONSTRAINED-ELEMENT-SET-UUID__
17738   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}:
17739     get:
17740       tags:
17741         - ServiceDesignAndCreation
17742       summary: returns constrained-element-set
17743       description: returns constrained-element-set
17744       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17745       produces:
17746         - application/json
17747         - application/xml
17748       responses:
17749         "200":
17750           description: successful operation
17751           schema:
17752               $ref: "#/getDefinitions/constrained-element-set"
17753         "default":
17754           description: Response codes found in [response codes](https://wiki.onap.org/).
17755       parameters:
17756         - name: model-invariant-id
17757           in: path
17758           description: Unique identifier corresponding to the main definition of a model in ASDC
17759           required: true
17760           type: string
17761           example: __MODEL-INVARIANT-ID__
17762         - name: model-version-id
17763           in: path
17764           description: Unique identifier corresponding to one version of a model in ASDC
17765           required: true
17766           type: string
17767           example: __MODEL-VERSION-ID__
17768         - name: model-element-uuid
17769           in: path
17770           required: true
17771           type: string
17772           example: __MODEL-ELEMENT-UUID__
17773         - name: model-constraint-uuid
17774           in: path
17775           required: true
17776           type: string
17777           example: __MODEL-CONSTRAINT-UUID__
17778         - name: constrained-element-set-uuid
17779           in: path
17780           required: true
17781           type: string
17782           example: __CONSTRAINED-ELEMENT-SET-UUID__
17783         - name: model-type
17784           in: query
17785           description: Type of the model, e.g., service, resource, widget, etc.
17786           required: false
17787           type: string
17788         - name: model-name
17789           in: query
17790           description: Name of the model, which can change from version to version.
17791           required: false
17792           type: string
17793         - name: model-version
17794           in: query
17795           description: Version
17796           required: false
17797           type: string
17798     put:
17799       tags:
17800         - ServiceDesignAndCreation
17801       summary: create or update an existing constrained-element-set
17802       description: |
17803         Create or update an existing constrained-element-set.
17804         #
17805         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17806       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17807       consumes:
17808         - application/json
17809         - application/xml
17810       produces:
17811         - application/json
17812         - application/xml
17813       responses:
17814         "default":
17815           description: Response codes found in [response codes](https://wiki.onap.org/).
17816       parameters:
17817         - name: model-invariant-id
17818           in: path
17819           description: Unique identifier corresponding to the main definition of a model in ASDC
17820           required: true
17821           type: string
17822           example: __MODEL-INVARIANT-ID__
17823         - name: model-version-id
17824           in: path
17825           description: Unique identifier corresponding to one version of a model in ASDC
17826           required: true
17827           type: string
17828           example: __MODEL-VERSION-ID__
17829         - name: model-element-uuid
17830           in: path
17831           required: true
17832           type: string
17833           example: __MODEL-ELEMENT-UUID__
17834         - name: model-constraint-uuid
17835           in: path
17836           required: true
17837           type: string
17838           example: __MODEL-CONSTRAINT-UUID__
17839         - name: constrained-element-set-uuid
17840           in: path
17841           required: true
17842           type: string
17843           example: __CONSTRAINED-ELEMENT-SET-UUID__
17844         - name: body
17845           in: body
17846           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
17847           required: true
17848           schema:
17849             $ref: "#/definitions/constrained-element-set"
17850     patch:
17851       tags:
17852         - ServiceDesignAndCreation
17853       summary: update an existing constrained-element-set
17854       description: |
17855         Update an existing constrained-element-set
17856         #
17857         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17858         The PUT operation will entirely replace an existing object.
17859         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17860         #
17861         Other differences between PUT and PATCH are:
17862         #
17863         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17864         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17865         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17866       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17867       consumes:
17868         - application/json
17869         - application/xml
17870       produces:
17871         - application/json
17872         - application/xml
17873       responses:
17874         "default":
17875           description: Response codes found in [response codes](https://wiki.onap.org/).
17876       parameters:
17877         - name: model-invariant-id
17878           in: path
17879           description: Unique identifier corresponding to the main definition of a model in ASDC
17880           required: true
17881           type: string
17882           example: __MODEL-INVARIANT-ID__
17883         - name: model-version-id
17884           in: path
17885           description: Unique identifier corresponding to one version of a model in ASDC
17886           required: true
17887           type: string
17888           example: __MODEL-VERSION-ID__
17889         - name: model-element-uuid
17890           in: path
17891           required: true
17892           type: string
17893           example: __MODEL-ELEMENT-UUID__
17894         - name: model-constraint-uuid
17895           in: path
17896           required: true
17897           type: string
17898           example: __MODEL-CONSTRAINT-UUID__
17899         - name: constrained-element-set-uuid
17900           in: path
17901           required: true
17902           type: string
17903           example: __CONSTRAINED-ELEMENT-SET-UUID__
17904         - name: body
17905           in: body
17906           description: constrained-element-set object that needs to be created or updated.
17907           required: true
17908           schema:
17909             $ref: "#/patchDefinitions/constrained-element-set"
17910     delete:
17911       tags:
17912         - ServiceDesignAndCreation
17913       summary: delete an existing constrained-element-set
17914       description: delete an existing constrained-element-set
17915       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
17916       consumes:
17917         - application/json
17918         - application/xml
17919       produces:
17920         - application/json
17921         - application/xml
17922       responses:
17923         "default":
17924           description: Response codes found in [response codes](https://wiki.onap.org/).
17925       parameters:
17926         - name: model-invariant-id
17927           in: path
17928           description: Unique identifier corresponding to the main definition of a model in ASDC
17929           required: true
17930           type: string
17931           example: __MODEL-INVARIANT-ID__
17932         - name: model-version-id
17933           in: path
17934           description: Unique identifier corresponding to one version of a model in ASDC
17935           required: true
17936           type: string
17937           example: __MODEL-VERSION-ID__
17938         - name: model-element-uuid
17939           in: path
17940           required: true
17941           type: string
17942           example: __MODEL-ELEMENT-UUID__
17943         - name: model-constraint-uuid
17944           in: path
17945           required: true
17946           type: string
17947           example: __MODEL-CONSTRAINT-UUID__
17948         - name: constrained-element-set-uuid
17949           in: path
17950           required: true
17951           type: string
17952           example: __CONSTRAINED-ELEMENT-SET-UUID__
17953         - name: resource-version
17954           in: query
17955           description: resource-version for concurrency
17956           required: true
17957           type: string
17958   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets:
17959     get:
17960       tags:
17961         - ServiceDesignAndCreation
17962       summary: returns constrained-element-sets
17963       description: returns constrained-element-sets
17964       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
17965       produces:
17966         - application/json
17967         - application/xml
17968       responses:
17969         "200":
17970           description: successful operation
17971           schema:
17972               $ref: "#/getDefinitions/constrained-element-sets"
17973         "default":
17974           description: Response codes found in [response codes](https://wiki.onap.org/).
17975       parameters:
17976         - name: model-invariant-id
17977           in: path
17978           description: Unique identifier corresponding to the main definition of a model in ASDC
17979           required: true
17980           type: string
17981           example: __MODEL-INVARIANT-ID__
17982         - name: model-version-id
17983           in: path
17984           description: Unique identifier corresponding to one version of a model in ASDC
17985           required: true
17986           type: string
17987           example: __MODEL-VERSION-ID__
17988         - name: model-element-uuid
17989           in: path
17990           required: true
17991           type: string
17992           example: __MODEL-ELEMENT-UUID__
17993         - name: model-constraint-uuid
17994           in: path
17995           required: true
17996           type: string
17997           example: __MODEL-CONSTRAINT-UUID__
17998         - name: model-type
17999           in: query
18000           description: Type of the model, e.g., service, resource, widget, etc.
18001           required: false
18002           type: string
18003         - name: model-name
18004           in: query
18005           description: Name of the model, which can change from version to version.
18006           required: false
18007           type: string
18008         - name: model-version
18009           in: query
18010           description: Version
18011           required: false
18012           type: string
18013   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}:
18014     get:
18015       tags:
18016         - ServiceDesignAndCreation
18017       summary: returns model-constraint
18018       description: returns model-constraint
18019       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18020       produces:
18021         - application/json
18022         - application/xml
18023       responses:
18024         "200":
18025           description: successful operation
18026           schema:
18027               $ref: "#/getDefinitions/model-constraint"
18028         "default":
18029           description: Response codes found in [response codes](https://wiki.onap.org/).
18030       parameters:
18031         - name: model-invariant-id
18032           in: path
18033           description: Unique identifier corresponding to the main definition of a model in ASDC
18034           required: true
18035           type: string
18036           example: __MODEL-INVARIANT-ID__
18037         - name: model-version-id
18038           in: path
18039           description: Unique identifier corresponding to one version of a model in ASDC
18040           required: true
18041           type: string
18042           example: __MODEL-VERSION-ID__
18043         - name: model-element-uuid
18044           in: path
18045           required: true
18046           type: string
18047           example: __MODEL-ELEMENT-UUID__
18048         - name: model-constraint-uuid
18049           in: path
18050           required: true
18051           type: string
18052           example: __MODEL-CONSTRAINT-UUID__
18053         - name: model-type
18054           in: query
18055           description: Type of the model, e.g., service, resource, widget, etc.
18056           required: false
18057           type: string
18058         - name: model-name
18059           in: query
18060           description: Name of the model, which can change from version to version.
18061           required: false
18062           type: string
18063         - name: model-version
18064           in: query
18065           description: Version
18066           required: false
18067           type: string
18068     put:
18069       tags:
18070         - ServiceDesignAndCreation
18071       summary: create or update an existing model-constraint
18072       description: |
18073         Create or update an existing model-constraint.
18074         #
18075         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18076       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18077       consumes:
18078         - application/json
18079         - application/xml
18080       produces:
18081         - application/json
18082         - application/xml
18083       responses:
18084         "default":
18085           description: Response codes found in [response codes](https://wiki.onap.org/).
18086       parameters:
18087         - name: model-invariant-id
18088           in: path
18089           description: Unique identifier corresponding to the main definition of a model in ASDC
18090           required: true
18091           type: string
18092           example: __MODEL-INVARIANT-ID__
18093         - name: model-version-id
18094           in: path
18095           description: Unique identifier corresponding to one version of a model in ASDC
18096           required: true
18097           type: string
18098           example: __MODEL-VERSION-ID__
18099         - name: model-element-uuid
18100           in: path
18101           required: true
18102           type: string
18103           example: __MODEL-ELEMENT-UUID__
18104         - name: model-constraint-uuid
18105           in: path
18106           required: true
18107           type: string
18108           example: __MODEL-CONSTRAINT-UUID__
18109         - name: body
18110           in: body
18111           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
18112           required: true
18113           schema:
18114             $ref: "#/definitions/model-constraint"
18115     patch:
18116       tags:
18117         - ServiceDesignAndCreation
18118       summary: update an existing model-constraint
18119       description: |
18120         Update an existing model-constraint
18121         #
18122         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18123         The PUT operation will entirely replace an existing object.
18124         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18125         #
18126         Other differences between PUT and PATCH are:
18127         #
18128         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18129         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18130         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18131       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
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: model-invariant-id
18143           in: path
18144           description: Unique identifier corresponding to the main definition of a model in ASDC
18145           required: true
18146           type: string
18147           example: __MODEL-INVARIANT-ID__
18148         - name: model-version-id
18149           in: path
18150           description: Unique identifier corresponding to one version of a model in ASDC
18151           required: true
18152           type: string
18153           example: __MODEL-VERSION-ID__
18154         - name: model-element-uuid
18155           in: path
18156           required: true
18157           type: string
18158           example: __MODEL-ELEMENT-UUID__
18159         - name: model-constraint-uuid
18160           in: path
18161           required: true
18162           type: string
18163           example: __MODEL-CONSTRAINT-UUID__
18164         - name: body
18165           in: body
18166           description: model-constraint object that needs to be created or updated.
18167           required: true
18168           schema:
18169             $ref: "#/patchDefinitions/model-constraint"
18170     delete:
18171       tags:
18172         - ServiceDesignAndCreation
18173       summary: delete an existing model-constraint
18174       description: delete an existing model-constraint
18175       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
18176       consumes:
18177         - application/json
18178         - application/xml
18179       produces:
18180         - application/json
18181         - application/xml
18182       responses:
18183         "default":
18184           description: Response codes found in [response codes](https://wiki.onap.org/).
18185       parameters:
18186         - name: model-invariant-id
18187           in: path
18188           description: Unique identifier corresponding to the main definition of a model in ASDC
18189           required: true
18190           type: string
18191           example: __MODEL-INVARIANT-ID__
18192         - name: model-version-id
18193           in: path
18194           description: Unique identifier corresponding to one version of a model in ASDC
18195           required: true
18196           type: string
18197           example: __MODEL-VERSION-ID__
18198         - name: model-element-uuid
18199           in: path
18200           required: true
18201           type: string
18202           example: __MODEL-ELEMENT-UUID__
18203         - name: model-constraint-uuid
18204           in: path
18205           required: true
18206           type: string
18207           example: __MODEL-CONSTRAINT-UUID__
18208         - name: resource-version
18209           in: query
18210           description: resource-version for concurrency
18211           required: true
18212           type: string
18213   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints:
18214     get:
18215       tags:
18216         - ServiceDesignAndCreation
18217       summary: returns model-constraints
18218       description: returns model-constraints
18219       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
18220       produces:
18221         - application/json
18222         - application/xml
18223       responses:
18224         "200":
18225           description: successful operation
18226           schema:
18227               $ref: "#/getDefinitions/model-constraints"
18228         "default":
18229           description: Response codes found in [response codes](https://wiki.onap.org/).
18230       parameters:
18231         - name: model-invariant-id
18232           in: path
18233           description: Unique identifier corresponding to the main definition of a model in ASDC
18234           required: true
18235           type: string
18236           example: __MODEL-INVARIANT-ID__
18237         - name: model-version-id
18238           in: path
18239           description: Unique identifier corresponding to one version of a model in ASDC
18240           required: true
18241           type: string
18242           example: __MODEL-VERSION-ID__
18243         - name: model-element-uuid
18244           in: path
18245           required: true
18246           type: string
18247           example: __MODEL-ELEMENT-UUID__
18248         - name: model-type
18249           in: query
18250           description: Type of the model, e.g., service, resource, widget, etc.
18251           required: false
18252           type: string
18253         - name: model-name
18254           in: query
18255           description: Name of the model, which can change from version to version.
18256           required: false
18257           type: string
18258         - name: model-version
18259           in: query
18260           description: Version
18261           required: false
18262           type: string
18263   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship:
18264     put:
18265       tags:
18266         - ServiceDesignAndCreation
18267       summary: see node definition for valid relationships
18268       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18269       consumes:
18270         - application/json
18271         - application/xml
18272       produces:
18273         - application/json
18274         - application/xml
18275       responses:
18276         "default":
18277           description: Response codes found in [response codes](https://wiki.onap.org/).
18278       parameters:
18279         - name: model-invariant-id
18280           in: path
18281           description: Unique identifier corresponding to the main definition of a model in ASDC
18282           required: true
18283           type: string
18284           example: __MODEL-INVARIANT-ID__
18285         - name: model-version-id
18286           in: path
18287           description: Unique identifier corresponding to one version of a model in ASDC
18288           required: true
18289           type: string
18290           example: __MODEL-VERSION-ID__
18291         - name: model-element-uuid
18292           in: path
18293           required: true
18294           type: string
18295           example: __MODEL-ELEMENT-UUID__
18296         - name: body
18297           in: body
18298           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18299           required: true
18300           schema:
18301             $ref: "#/definitions/relationship"
18302     delete:
18303       tags:
18304         - ServiceDesignAndCreation
18305       summary: delete an existing relationship
18306       description: delete an existing relationship
18307       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
18308       consumes:
18309         - application/json
18310         - application/xml
18311       produces:
18312         - application/json
18313         - application/xml
18314       responses:
18315         "default":
18316           description: Response codes found in [response codes](https://wiki.onap.org/).
18317       parameters:
18318         - name: model-invariant-id
18319           in: path
18320           description: Unique identifier corresponding to the main definition of a model in ASDC
18321           required: true
18322           type: string
18323           example: __MODEL-INVARIANT-ID__
18324         - name: model-version-id
18325           in: path
18326           description: Unique identifier corresponding to one version of a model in ASDC
18327           required: true
18328           type: string
18329           example: __MODEL-VERSION-ID__
18330         - name: model-element-uuid
18331           in: path
18332           required: true
18333           type: string
18334           example: __MODEL-ELEMENT-UUID__
18335   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
18336     get:
18337       tags:
18338         - ServiceDesignAndCreation
18339       summary: returns model-element
18340       description: returns model-element
18341       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18342       produces:
18343         - application/json
18344         - application/xml
18345       responses:
18346         "200":
18347           description: successful operation
18348           schema:
18349               $ref: "#/getDefinitions/model-element"
18350         "default":
18351           description: Response codes found in [response codes](https://wiki.onap.org/).
18352       parameters:
18353         - name: model-invariant-id
18354           in: path
18355           description: Unique identifier corresponding to the main definition of a model in ASDC
18356           required: true
18357           type: string
18358           example: __MODEL-INVARIANT-ID__
18359         - name: model-version-id
18360           in: path
18361           description: Unique identifier corresponding to one version of a model in ASDC
18362           required: true
18363           type: string
18364           example: __MODEL-VERSION-ID__
18365         - name: model-element-uuid
18366           in: path
18367           required: true
18368           type: string
18369           example: __MODEL-ELEMENT-UUID__
18370         - name: model-type
18371           in: query
18372           description: Type of the model, e.g., service, resource, widget, etc.
18373           required: false
18374           type: string
18375         - name: model-name
18376           in: query
18377           description: Name of the model, which can change from version to version.
18378           required: false
18379           type: string
18380         - name: model-version
18381           in: query
18382           description: Version
18383           required: false
18384           type: string
18385     put:
18386       tags:
18387         - ServiceDesignAndCreation
18388       summary: create or update an existing model-element
18389       description: |
18390         Create or update an existing model-element.
18391         #
18392         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18393       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18394       consumes:
18395         - application/json
18396         - application/xml
18397       produces:
18398         - application/json
18399         - application/xml
18400       responses:
18401         "default":
18402           description: Response codes found in [response codes](https://wiki.onap.org/).
18403       parameters:
18404         - name: model-invariant-id
18405           in: path
18406           description: Unique identifier corresponding to the main definition of a model in ASDC
18407           required: true
18408           type: string
18409           example: __MODEL-INVARIANT-ID__
18410         - name: model-version-id
18411           in: path
18412           description: Unique identifier corresponding to one version of a model in ASDC
18413           required: true
18414           type: string
18415           example: __MODEL-VERSION-ID__
18416         - name: model-element-uuid
18417           in: path
18418           required: true
18419           type: string
18420           example: __MODEL-ELEMENT-UUID__
18421         - name: body
18422           in: body
18423           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
18424           required: true
18425           schema:
18426             $ref: "#/definitions/model-element"
18427     patch:
18428       tags:
18429         - ServiceDesignAndCreation
18430       summary: update an existing model-element
18431       description: |
18432         Update an existing model-element
18433         #
18434         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18435         The PUT operation will entirely replace an existing object.
18436         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18437         #
18438         Other differences between PUT and PATCH are:
18439         #
18440         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18441         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18442         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18443       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18444       consumes:
18445         - application/json
18446         - application/xml
18447       produces:
18448         - application/json
18449         - application/xml
18450       responses:
18451         "default":
18452           description: Response codes found in [response codes](https://wiki.onap.org/).
18453       parameters:
18454         - name: model-invariant-id
18455           in: path
18456           description: Unique identifier corresponding to the main definition of a model in ASDC
18457           required: true
18458           type: string
18459           example: __MODEL-INVARIANT-ID__
18460         - name: model-version-id
18461           in: path
18462           description: Unique identifier corresponding to one version of a model in ASDC
18463           required: true
18464           type: string
18465           example: __MODEL-VERSION-ID__
18466         - name: model-element-uuid
18467           in: path
18468           required: true
18469           type: string
18470           example: __MODEL-ELEMENT-UUID__
18471         - name: body
18472           in: body
18473           description: model-element object that needs to be created or updated.
18474           required: true
18475           schema:
18476             $ref: "#/patchDefinitions/model-element"
18477     delete:
18478       tags:
18479         - ServiceDesignAndCreation
18480       summary: delete an existing model-element
18481       description: delete an existing model-element
18482       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
18483       consumes:
18484         - application/json
18485         - application/xml
18486       produces:
18487         - application/json
18488         - application/xml
18489       responses:
18490         "default":
18491           description: Response codes found in [response codes](https://wiki.onap.org/).
18492       parameters:
18493         - name: model-invariant-id
18494           in: path
18495           description: Unique identifier corresponding to the main definition of a model in ASDC
18496           required: true
18497           type: string
18498           example: __MODEL-INVARIANT-ID__
18499         - name: model-version-id
18500           in: path
18501           description: Unique identifier corresponding to one version of a model in ASDC
18502           required: true
18503           type: string
18504           example: __MODEL-VERSION-ID__
18505         - name: model-element-uuid
18506           in: path
18507           required: true
18508           type: string
18509           example: __MODEL-ELEMENT-UUID__
18510         - name: resource-version
18511           in: query
18512           description: resource-version for concurrency
18513           required: true
18514           type: string
18515   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
18516     get:
18517       tags:
18518         - ServiceDesignAndCreation
18519       summary: returns model-elements
18520       description: returns model-elements
18521       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
18522       produces:
18523         - application/json
18524         - application/xml
18525       responses:
18526         "200":
18527           description: successful operation
18528           schema:
18529               $ref: "#/getDefinitions/model-elements"
18530         "default":
18531           description: Response codes found in [response codes](https://wiki.onap.org/).
18532       parameters:
18533         - name: model-invariant-id
18534           in: path
18535           description: Unique identifier corresponding to the main definition of a model in ASDC
18536           required: true
18537           type: string
18538           example: __MODEL-INVARIANT-ID__
18539         - name: model-version-id
18540           in: path
18541           description: Unique identifier corresponding to one version of a model in ASDC
18542           required: true
18543           type: string
18544           example: __MODEL-VERSION-ID__
18545         - name: model-type
18546           in: query
18547           description: Type of the model, e.g., service, resource, widget, etc.
18548           required: false
18549           type: string
18550         - name: model-name
18551           in: query
18552           description: Name of the model, which can change from version to version.
18553           required: false
18554           type: string
18555         - name: model-version
18556           in: query
18557           description: Version
18558           required: false
18559           type: string
18560   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
18561     get:
18562       tags:
18563         - ServiceDesignAndCreation
18564       summary: returns metadatum
18565       description: returns metadatum
18566       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18567       produces:
18568         - application/json
18569         - application/xml
18570       responses:
18571         "200":
18572           description: successful operation
18573           schema:
18574               $ref: "#/getDefinitions/metadatum"
18575         "default":
18576           description: Response codes found in [response codes](https://wiki.onap.org/).
18577       parameters:
18578         - name: model-invariant-id
18579           in: path
18580           description: Unique identifier corresponding to the main definition of a model in ASDC
18581           required: true
18582           type: string
18583           example: __MODEL-INVARIANT-ID__
18584         - name: model-version-id
18585           in: path
18586           description: Unique identifier corresponding to one version of a model in ASDC
18587           required: true
18588           type: string
18589           example: __MODEL-VERSION-ID__
18590         - name: metaname
18591           in: path
18592           required: true
18593           type: string
18594           example: __METANAME__
18595         - name: model-type
18596           in: query
18597           description: Type of the model, e.g., service, resource, widget, etc.
18598           required: false
18599           type: string
18600         - name: model-name
18601           in: query
18602           description: Name of the model, which can change from version to version.
18603           required: false
18604           type: string
18605         - name: model-version
18606           in: query
18607           description: Version
18608           required: false
18609           type: string
18610     put:
18611       tags:
18612         - ServiceDesignAndCreation
18613       summary: create or update an existing metadatum
18614       description: |
18615         Create or update an existing metadatum.
18616         #
18617         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18618       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18619       consumes:
18620         - application/json
18621         - application/xml
18622       produces:
18623         - application/json
18624         - application/xml
18625       responses:
18626         "default":
18627           description: Response codes found in [response codes](https://wiki.onap.org/).
18628       parameters:
18629         - name: model-invariant-id
18630           in: path
18631           description: Unique identifier corresponding to the main definition of a model in ASDC
18632           required: true
18633           type: string
18634           example: __MODEL-INVARIANT-ID__
18635         - name: model-version-id
18636           in: path
18637           description: Unique identifier corresponding to one version of a model in ASDC
18638           required: true
18639           type: string
18640           example: __MODEL-VERSION-ID__
18641         - name: metaname
18642           in: path
18643           required: true
18644           type: string
18645           example: __METANAME__
18646         - name: body
18647           in: body
18648           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
18649           required: true
18650           schema:
18651             $ref: "#/definitions/metadatum"
18652     patch:
18653       tags:
18654         - ServiceDesignAndCreation
18655       summary: update an existing metadatum
18656       description: |
18657         Update an existing metadatum
18658         #
18659         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18660         The PUT operation will entirely replace an existing object.
18661         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18662         #
18663         Other differences between PUT and PATCH are:
18664         #
18665         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18666         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18667         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18668       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18669       consumes:
18670         - application/json
18671         - application/xml
18672       produces:
18673         - application/json
18674         - application/xml
18675       responses:
18676         "default":
18677           description: Response codes found in [response codes](https://wiki.onap.org/).
18678       parameters:
18679         - name: model-invariant-id
18680           in: path
18681           description: Unique identifier corresponding to the main definition of a model in ASDC
18682           required: true
18683           type: string
18684           example: __MODEL-INVARIANT-ID__
18685         - name: model-version-id
18686           in: path
18687           description: Unique identifier corresponding to one version of a model in ASDC
18688           required: true
18689           type: string
18690           example: __MODEL-VERSION-ID__
18691         - name: metaname
18692           in: path
18693           required: true
18694           type: string
18695           example: __METANAME__
18696         - name: body
18697           in: body
18698           description: metadatum object that needs to be created or updated.
18699           required: true
18700           schema:
18701             $ref: "#/patchDefinitions/metadatum"
18702     delete:
18703       tags:
18704         - ServiceDesignAndCreation
18705       summary: delete an existing metadatum
18706       description: delete an existing metadatum
18707       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
18708       consumes:
18709         - application/json
18710         - application/xml
18711       produces:
18712         - application/json
18713         - application/xml
18714       responses:
18715         "default":
18716           description: Response codes found in [response codes](https://wiki.onap.org/).
18717       parameters:
18718         - name: model-invariant-id
18719           in: path
18720           description: Unique identifier corresponding to the main definition of a model in ASDC
18721           required: true
18722           type: string
18723           example: __MODEL-INVARIANT-ID__
18724         - name: model-version-id
18725           in: path
18726           description: Unique identifier corresponding to one version of a model in ASDC
18727           required: true
18728           type: string
18729           example: __MODEL-VERSION-ID__
18730         - name: metaname
18731           in: path
18732           required: true
18733           type: string
18734           example: __METANAME__
18735         - name: resource-version
18736           in: query
18737           description: resource-version for concurrency
18738           required: true
18739           type: string
18740   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
18741     get:
18742       tags:
18743         - ServiceDesignAndCreation
18744       summary: returns metadata
18745       description: returns metadata
18746       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
18747       produces:
18748         - application/json
18749         - application/xml
18750       responses:
18751         "200":
18752           description: successful operation
18753           schema:
18754               $ref: "#/getDefinitions/metadata"
18755         "default":
18756           description: Response codes found in [response codes](https://wiki.onap.org/).
18757       parameters:
18758         - name: model-invariant-id
18759           in: path
18760           description: Unique identifier corresponding to the main definition of a model in ASDC
18761           required: true
18762           type: string
18763           example: __MODEL-INVARIANT-ID__
18764         - name: model-version-id
18765           in: path
18766           description: Unique identifier corresponding to one version of a model in ASDC
18767           required: true
18768           type: string
18769           example: __MODEL-VERSION-ID__
18770         - name: model-type
18771           in: query
18772           description: Type of the model, e.g., service, resource, widget, etc.
18773           required: false
18774           type: string
18775         - name: model-name
18776           in: query
18777           description: Name of the model, which can change from version to version.
18778           required: false
18779           type: string
18780         - name: model-version
18781           in: query
18782           description: Version
18783           required: false
18784           type: string
18785   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
18786     put:
18787       tags:
18788         - ServiceDesignAndCreation
18789       summary: see node definition for valid relationships
18790       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18791       consumes:
18792         - application/json
18793         - application/xml
18794       produces:
18795         - application/json
18796         - application/xml
18797       responses:
18798         "default":
18799           description: Response codes found in [response codes](https://wiki.onap.org/).
18800       parameters:
18801         - name: model-invariant-id
18802           in: path
18803           description: Unique identifier corresponding to the main definition of a model in ASDC
18804           required: true
18805           type: string
18806           example: __MODEL-INVARIANT-ID__
18807         - name: model-version-id
18808           in: path
18809           description: Unique identifier corresponding to one version of a model in ASDC
18810           required: true
18811           type: string
18812           example: __MODEL-VERSION-ID__
18813         - name: body
18814           in: body
18815           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18816           required: true
18817           schema:
18818             $ref: "#/definitions/relationship"
18819     delete:
18820       tags:
18821         - ServiceDesignAndCreation
18822       summary: delete an existing relationship
18823       description: delete an existing relationship
18824       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
18825       consumes:
18826         - application/json
18827         - application/xml
18828       produces:
18829         - application/json
18830         - application/xml
18831       responses:
18832         "default":
18833           description: Response codes found in [response codes](https://wiki.onap.org/).
18834       parameters:
18835         - name: model-invariant-id
18836           in: path
18837           description: Unique identifier corresponding to the main definition of a model in ASDC
18838           required: true
18839           type: string
18840           example: __MODEL-INVARIANT-ID__
18841         - name: model-version-id
18842           in: path
18843           description: Unique identifier corresponding to one version of a model in ASDC
18844           required: true
18845           type: string
18846           example: __MODEL-VERSION-ID__
18847   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
18848     get:
18849       tags:
18850         - ServiceDesignAndCreation
18851       summary: returns model-ver
18852       description: returns model-ver
18853       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
18854       produces:
18855         - application/json
18856         - application/xml
18857       responses:
18858         "200":
18859           description: successful operation
18860           schema:
18861               $ref: "#/getDefinitions/model-ver"
18862         "default":
18863           description: Response codes found in [response codes](https://wiki.onap.org/).
18864       parameters:
18865         - name: model-invariant-id
18866           in: path
18867           description: Unique identifier corresponding to the main definition of a model in ASDC
18868           required: true
18869           type: string
18870           example: __MODEL-INVARIANT-ID__
18871         - name: model-version-id
18872           in: path
18873           description: Unique identifier corresponding to one version of a model in ASDC
18874           required: true
18875           type: string
18876           example: __MODEL-VERSION-ID__
18877         - name: model-type
18878           in: query
18879           description: Type of the model, e.g., service, resource, widget, etc.
18880           required: false
18881           type: string
18882         - name: model-name
18883           in: query
18884           description: Name of the model, which can change from version to version.
18885           required: false
18886           type: string
18887         - name: model-version
18888           in: query
18889           description: Version
18890           required: false
18891           type: string
18892     put:
18893       tags:
18894         - ServiceDesignAndCreation
18895       summary: create or update an existing model-ver
18896       description: |
18897         Create or update an existing model-ver.
18898         #
18899         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18900       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
18901       consumes:
18902         - application/json
18903         - application/xml
18904       produces:
18905         - application/json
18906         - application/xml
18907       responses:
18908         "default":
18909           description: Response codes found in [response codes](https://wiki.onap.org/).
18910       parameters:
18911         - name: model-invariant-id
18912           in: path
18913           description: Unique identifier corresponding to the main definition of a model in ASDC
18914           required: true
18915           type: string
18916           example: __MODEL-INVARIANT-ID__
18917         - name: model-version-id
18918           in: path
18919           description: Unique identifier corresponding to one version of a model in ASDC
18920           required: true
18921           type: string
18922           example: __MODEL-VERSION-ID__
18923         - name: body
18924           in: body
18925           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
18926           required: true
18927           schema:
18928             $ref: "#/definitions/model-ver"
18929     patch:
18930       tags:
18931         - ServiceDesignAndCreation
18932       summary: update an existing model-ver
18933       description: |
18934         Update an existing model-ver
18935         #
18936         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18937         The PUT operation will entirely replace an existing object.
18938         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18939         #
18940         Other differences between PUT and PATCH are:
18941         #
18942         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18943         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18944         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18945       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
18946       consumes:
18947         - application/json
18948         - application/xml
18949       produces:
18950         - application/json
18951         - application/xml
18952       responses:
18953         "default":
18954           description: Response codes found in [response codes](https://wiki.onap.org/).
18955       parameters:
18956         - name: model-invariant-id
18957           in: path
18958           description: Unique identifier corresponding to the main definition of a model in ASDC
18959           required: true
18960           type: string
18961           example: __MODEL-INVARIANT-ID__
18962         - name: model-version-id
18963           in: path
18964           description: Unique identifier corresponding to one version of a model in ASDC
18965           required: true
18966           type: string
18967           example: __MODEL-VERSION-ID__
18968         - name: body
18969           in: body
18970           description: model-ver object that needs to be created or updated.
18971           required: true
18972           schema:
18973             $ref: "#/patchDefinitions/model-ver"
18974     delete:
18975       tags:
18976         - ServiceDesignAndCreation
18977       summary: delete an existing model-ver
18978       description: delete an existing model-ver
18979       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
18980       consumes:
18981         - application/json
18982         - application/xml
18983       produces:
18984         - application/json
18985         - application/xml
18986       responses:
18987         "default":
18988           description: Response codes found in [response codes](https://wiki.onap.org/).
18989       parameters:
18990         - name: model-invariant-id
18991           in: path
18992           description: Unique identifier corresponding to the main definition of a model in ASDC
18993           required: true
18994           type: string
18995           example: __MODEL-INVARIANT-ID__
18996         - name: model-version-id
18997           in: path
18998           description: Unique identifier corresponding to one version of a model in ASDC
18999           required: true
19000           type: string
19001           example: __MODEL-VERSION-ID__
19002         - name: resource-version
19003           in: query
19004           description: resource-version for concurrency
19005           required: true
19006           type: string
19007   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
19008     get:
19009       tags:
19010         - ServiceDesignAndCreation
19011       summary: returns model-vers
19012       description: returns model-vers
19013       operationId: getServiceDesignAndCreationModelsModelModelVers
19014       produces:
19015         - application/json
19016         - application/xml
19017       responses:
19018         "200":
19019           description: successful operation
19020           schema:
19021               $ref: "#/getDefinitions/model-vers"
19022         "default":
19023           description: Response codes found in [response codes](https://wiki.onap.org/).
19024       parameters:
19025         - name: model-invariant-id
19026           in: path
19027           description: Unique identifier corresponding to the main definition of a model in ASDC
19028           required: true
19029           type: string
19030           example: __MODEL-INVARIANT-ID__
19031         - name: model-type
19032           in: query
19033           description: Type of the model, e.g., service, resource, widget, etc.
19034           required: false
19035           type: string
19036   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
19037     put:
19038       tags:
19039         - ServiceDesignAndCreation
19040       summary: see node definition for valid relationships
19041       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
19042       consumes:
19043         - application/json
19044         - application/xml
19045       produces:
19046         - application/json
19047         - application/xml
19048       responses:
19049         "default":
19050           description: Response codes found in [response codes](https://wiki.onap.org/).
19051       parameters:
19052         - name: model-invariant-id
19053           in: path
19054           description: Unique identifier corresponding to the main definition of a model in ASDC
19055           required: true
19056           type: string
19057           example: __MODEL-INVARIANT-ID__
19058         - name: body
19059           in: body
19060           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
19061           required: true
19062           schema:
19063             $ref: "#/definitions/relationship"
19064     delete:
19065       tags:
19066         - ServiceDesignAndCreation
19067       summary: delete an existing relationship
19068       description: delete an existing relationship
19069       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
19070       consumes:
19071         - application/json
19072         - application/xml
19073       produces:
19074         - application/json
19075         - application/xml
19076       responses:
19077         "default":
19078           description: Response codes found in [response codes](https://wiki.onap.org/).
19079       parameters:
19080         - name: model-invariant-id
19081           in: path
19082           description: Unique identifier corresponding to the main definition of a model in ASDC
19083           required: true
19084           type: string
19085           example: __MODEL-INVARIANT-ID__
19086   /service-design-and-creation/models/model/{model-invariant-id}:
19087     get:
19088       tags:
19089         - ServiceDesignAndCreation
19090       summary: returns model
19091       description: returns model
19092       operationId: getServiceDesignAndCreationModelsModel
19093       produces:
19094         - application/json
19095         - application/xml
19096       responses:
19097         "200":
19098           description: successful operation
19099           schema:
19100               $ref: "#/getDefinitions/model"
19101         "default":
19102           description: Response codes found in [response codes](https://wiki.onap.org/).
19103       parameters:
19104         - name: model-invariant-id
19105           in: path
19106           description: Unique identifier corresponding to the main definition of a model in ASDC
19107           required: true
19108           type: string
19109           example: __MODEL-INVARIANT-ID__
19110         - name: model-type
19111           in: query
19112           description: Type of the model, e.g., service, resource, widget, etc.
19113           required: false
19114           type: string
19115     put:
19116       tags:
19117         - ServiceDesignAndCreation
19118       summary: create or update an existing model
19119       description: |
19120         Create or update an existing model.
19121         #
19122         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19123       operationId: createOrUpdateServiceDesignAndCreationModelsModel
19124       consumes:
19125         - application/json
19126         - application/xml
19127       produces:
19128         - application/json
19129         - application/xml
19130       responses:
19131         "default":
19132           description: Response codes found in [response codes](https://wiki.onap.org/).
19133       parameters:
19134         - name: model-invariant-id
19135           in: path
19136           description: Unique identifier corresponding to the main definition of a model in ASDC
19137           required: true
19138           type: string
19139           example: __MODEL-INVARIANT-ID__
19140         - name: body
19141           in: body
19142           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationModelsModel.json)
19143           required: true
19144           schema:
19145             $ref: "#/definitions/model"
19146     patch:
19147       tags:
19148         - ServiceDesignAndCreation
19149       summary: update an existing model
19150       description: |
19151         Update an existing model
19152         #
19153         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19154         The PUT operation will entirely replace an existing object.
19155         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19156         #
19157         Other differences between PUT and PATCH are:
19158         #
19159         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19160         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19161         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19162       operationId: UpdateServiceDesignAndCreationModelsModel
19163       consumes:
19164         - application/json
19165         - application/xml
19166       produces:
19167         - application/json
19168         - application/xml
19169       responses:
19170         "default":
19171           description: Response codes found in [response codes](https://wiki.onap.org/).
19172       parameters:
19173         - name: model-invariant-id
19174           in: path
19175           description: Unique identifier corresponding to the main definition of a model in ASDC
19176           required: true
19177           type: string
19178           example: __MODEL-INVARIANT-ID__
19179         - name: body
19180           in: body
19181           description: model object that needs to be created or updated.
19182           required: true
19183           schema:
19184             $ref: "#/patchDefinitions/model"
19185     delete:
19186       tags:
19187         - ServiceDesignAndCreation
19188       summary: delete an existing model
19189       description: delete an existing model
19190       operationId: deleteServiceDesignAndCreationModelsModel
19191       consumes:
19192         - application/json
19193         - application/xml
19194       produces:
19195         - application/json
19196         - application/xml
19197       responses:
19198         "default":
19199           description: Response codes found in [response codes](https://wiki.onap.org/).
19200       parameters:
19201         - name: model-invariant-id
19202           in: path
19203           description: Unique identifier corresponding to the main definition of a model in ASDC
19204           required: true
19205           type: string
19206           example: __MODEL-INVARIANT-ID__
19207         - name: resource-version
19208           in: query
19209           description: resource-version for concurrency
19210           required: true
19211           type: string
19212   /service-design-and-creation/models:
19213     get:
19214       tags:
19215         - ServiceDesignAndCreation
19216       summary: returns models
19217       description: returns models
19218       operationId: getServiceDesignAndCreationModels
19219       produces:
19220         - application/json
19221         - application/xml
19222       responses:
19223         "200":
19224           description: successful operation
19225           schema:
19226               $ref: "#/getDefinitions/models"
19227         "default":
19228           description: Response codes found in [response codes](https://wiki.onap.org/).
19229   /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:
19230     put:
19231       tags:
19232         - ServiceDesignAndCreation
19233       summary: see node definition for valid relationships
19234       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19235       consumes:
19236         - application/json
19237         - application/xml
19238       produces:
19239         - application/json
19240         - application/xml
19241       responses:
19242         "default":
19243           description: Response codes found in [response codes](https://wiki.onap.org/).
19244       parameters:
19245         - name: named-query-uuid
19246           in: path
19247           required: true
19248           type: string
19249           example: __NAMED-QUERY-UUID__
19250         - name: named-query-element-uuid
19251           in: path
19252           required: true
19253           type: string
19254           example: __NAMED-QUERY-ELEMENT-UUID__
19255         - name: related-lookup-uuid
19256           in: path
19257           required: true
19258           type: string
19259           example: __RELATED-LOOKUP-UUID__
19260         - name: body
19261           in: body
19262           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19263           required: true
19264           schema:
19265             $ref: "#/definitions/relationship"
19266     delete:
19267       tags:
19268         - ServiceDesignAndCreation
19269       summary: delete an existing relationship
19270       description: delete an existing relationship
19271       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
19272       consumes:
19273         - application/json
19274         - application/xml
19275       produces:
19276         - application/json
19277         - application/xml
19278       responses:
19279         "default":
19280           description: Response codes found in [response codes](https://wiki.onap.org/).
19281       parameters:
19282         - name: named-query-uuid
19283           in: path
19284           required: true
19285           type: string
19286           example: __NAMED-QUERY-UUID__
19287         - name: named-query-element-uuid
19288           in: path
19289           required: true
19290           type: string
19291           example: __NAMED-QUERY-ELEMENT-UUID__
19292         - name: related-lookup-uuid
19293           in: path
19294           required: true
19295           type: string
19296           example: __RELATED-LOOKUP-UUID__
19297   /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}:
19298     get:
19299       tags:
19300         - ServiceDesignAndCreation
19301       summary: returns related-lookup
19302       description: returns related-lookup
19303       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19304       produces:
19305         - application/json
19306         - application/xml
19307       responses:
19308         "200":
19309           description: successful operation
19310           schema:
19311               $ref: "#/getDefinitions/related-lookup"
19312         "default":
19313           description: Response codes found in [response codes](https://wiki.onap.org/).
19314       parameters:
19315         - name: named-query-uuid
19316           in: path
19317           required: true
19318           type: string
19319           example: __NAMED-QUERY-UUID__
19320         - name: named-query-element-uuid
19321           in: path
19322           required: true
19323           type: string
19324           example: __NAMED-QUERY-ELEMENT-UUID__
19325         - name: related-lookup-uuid
19326           in: path
19327           required: true
19328           type: string
19329           example: __RELATED-LOOKUP-UUID__
19330         - name: named-query-name
19331           in: query
19332           required: false
19333           type: string
19334     put:
19335       tags:
19336         - ServiceDesignAndCreation
19337       summary: create or update an existing related-lookup
19338       description: |
19339         Create or update an existing related-lookup.
19340         #
19341         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19342       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19343       consumes:
19344         - application/json
19345         - application/xml
19346       produces:
19347         - application/json
19348         - application/xml
19349       responses:
19350         "default":
19351           description: Response codes found in [response codes](https://wiki.onap.org/).
19352       parameters:
19353         - name: named-query-uuid
19354           in: path
19355           required: true
19356           type: string
19357           example: __NAMED-QUERY-UUID__
19358         - name: named-query-element-uuid
19359           in: path
19360           required: true
19361           type: string
19362           example: __NAMED-QUERY-ELEMENT-UUID__
19363         - name: related-lookup-uuid
19364           in: path
19365           required: true
19366           type: string
19367           example: __RELATED-LOOKUP-UUID__
19368         - name: body
19369           in: body
19370           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
19371           required: true
19372           schema:
19373             $ref: "#/definitions/related-lookup"
19374     patch:
19375       tags:
19376         - ServiceDesignAndCreation
19377       summary: update an existing related-lookup
19378       description: |
19379         Update an existing related-lookup
19380         #
19381         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19382         The PUT operation will entirely replace an existing object.
19383         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19384         #
19385         Other differences between PUT and PATCH are:
19386         #
19387         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19388         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19389         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19390       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19391       consumes:
19392         - application/json
19393         - application/xml
19394       produces:
19395         - application/json
19396         - application/xml
19397       responses:
19398         "default":
19399           description: Response codes found in [response codes](https://wiki.onap.org/).
19400       parameters:
19401         - name: named-query-uuid
19402           in: path
19403           required: true
19404           type: string
19405           example: __NAMED-QUERY-UUID__
19406         - name: named-query-element-uuid
19407           in: path
19408           required: true
19409           type: string
19410           example: __NAMED-QUERY-ELEMENT-UUID__
19411         - name: related-lookup-uuid
19412           in: path
19413           required: true
19414           type: string
19415           example: __RELATED-LOOKUP-UUID__
19416         - name: body
19417           in: body
19418           description: related-lookup object that needs to be created or updated.
19419           required: true
19420           schema:
19421             $ref: "#/patchDefinitions/related-lookup"
19422     delete:
19423       tags:
19424         - ServiceDesignAndCreation
19425       summary: delete an existing related-lookup
19426       description: delete an existing related-lookup
19427       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
19428       consumes:
19429         - application/json
19430         - application/xml
19431       produces:
19432         - application/json
19433         - application/xml
19434       responses:
19435         "default":
19436           description: Response codes found in [response codes](https://wiki.onap.org/).
19437       parameters:
19438         - name: named-query-uuid
19439           in: path
19440           required: true
19441           type: string
19442           example: __NAMED-QUERY-UUID__
19443         - name: named-query-element-uuid
19444           in: path
19445           required: true
19446           type: string
19447           example: __NAMED-QUERY-ELEMENT-UUID__
19448         - name: related-lookup-uuid
19449           in: path
19450           required: true
19451           type: string
19452           example: __RELATED-LOOKUP-UUID__
19453         - name: resource-version
19454           in: query
19455           description: resource-version for concurrency
19456           required: true
19457           type: string
19458   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
19459     get:
19460       tags:
19461         - ServiceDesignAndCreation
19462       summary: returns related-lookups
19463       description: returns related-lookups
19464       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
19465       produces:
19466         - application/json
19467         - application/xml
19468       responses:
19469         "200":
19470           description: successful operation
19471           schema:
19472               $ref: "#/getDefinitions/related-lookups"
19473         "default":
19474           description: Response codes found in [response codes](https://wiki.onap.org/).
19475       parameters:
19476         - name: named-query-uuid
19477           in: path
19478           required: true
19479           type: string
19480           example: __NAMED-QUERY-UUID__
19481         - name: named-query-element-uuid
19482           in: path
19483           required: true
19484           type: string
19485           example: __NAMED-QUERY-ELEMENT-UUID__
19486         - name: named-query-name
19487           in: query
19488           required: false
19489           type: string
19490   /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}:
19491     get:
19492       tags:
19493         - ServiceDesignAndCreation
19494       summary: returns property-constraint
19495       description: returns property-constraint
19496       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19497       produces:
19498         - application/json
19499         - application/xml
19500       responses:
19501         "200":
19502           description: successful operation
19503           schema:
19504               $ref: "#/getDefinitions/property-constraint"
19505         "default":
19506           description: Response codes found in [response codes](https://wiki.onap.org/).
19507       parameters:
19508         - name: named-query-uuid
19509           in: path
19510           required: true
19511           type: string
19512           example: __NAMED-QUERY-UUID__
19513         - name: named-query-element-uuid
19514           in: path
19515           required: true
19516           type: string
19517           example: __NAMED-QUERY-ELEMENT-UUID__
19518         - name: property-constraint-uuid
19519           in: path
19520           required: true
19521           type: string
19522           example: __PROPERTY-CONSTRAINT-UUID__
19523         - name: named-query-name
19524           in: query
19525           required: false
19526           type: string
19527     put:
19528       tags:
19529         - ServiceDesignAndCreation
19530       summary: create or update an existing property-constraint
19531       description: |
19532         Create or update an existing property-constraint.
19533         #
19534         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19535       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19536       consumes:
19537         - application/json
19538         - application/xml
19539       produces:
19540         - application/json
19541         - application/xml
19542       responses:
19543         "default":
19544           description: Response codes found in [response codes](https://wiki.onap.org/).
19545       parameters:
19546         - name: named-query-uuid
19547           in: path
19548           required: true
19549           type: string
19550           example: __NAMED-QUERY-UUID__
19551         - name: named-query-element-uuid
19552           in: path
19553           required: true
19554           type: string
19555           example: __NAMED-QUERY-ELEMENT-UUID__
19556         - name: property-constraint-uuid
19557           in: path
19558           required: true
19559           type: string
19560           example: __PROPERTY-CONSTRAINT-UUID__
19561         - name: body
19562           in: body
19563           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
19564           required: true
19565           schema:
19566             $ref: "#/definitions/property-constraint"
19567     patch:
19568       tags:
19569         - ServiceDesignAndCreation
19570       summary: update an existing property-constraint
19571       description: |
19572         Update an existing property-constraint
19573         #
19574         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19575         The PUT operation will entirely replace an existing object.
19576         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19577         #
19578         Other differences between PUT and PATCH are:
19579         #
19580         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19581         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19582         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19583       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
19584       consumes:
19585         - application/json
19586         - application/xml
19587       produces:
19588         - application/json
19589         - application/xml
19590       responses:
19591         "default":
19592           description: Response codes found in [response codes](https://wiki.onap.org/).
19593       parameters:
19594         - name: named-query-uuid
19595           in: path
19596           required: true
19597           type: string
19598           example: __NAMED-QUERY-UUID__
19599         - name: named-query-element-uuid
19600           in: path
19601           required: true
19602           type: string
19603           example: __NAMED-QUERY-ELEMENT-UUID__
19604         - name: property-constraint-uuid
19605           in: path
19606           required: true
19607           type: string
19608           example: __PROPERTY-CONSTRAINT-UUID__
19609         - name: body
19610           in: body
19611           description: property-constraint object that needs to be created or updated.
19612           required: true
19613           schema:
19614             $ref: "#/patchDefinitions/property-constraint"
19615     delete:
19616       tags:
19617         - ServiceDesignAndCreation
19618       summary: delete an existing property-constraint
19619       description: delete an existing property-constraint
19620       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
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: named-query-uuid
19632           in: path
19633           required: true
19634           type: string
19635           example: __NAMED-QUERY-UUID__
19636         - name: named-query-element-uuid
19637           in: path
19638           required: true
19639           type: string
19640           example: __NAMED-QUERY-ELEMENT-UUID__
19641         - name: property-constraint-uuid
19642           in: path
19643           required: true
19644           type: string
19645           example: __PROPERTY-CONSTRAINT-UUID__
19646         - name: resource-version
19647           in: query
19648           description: resource-version for concurrency
19649           required: true
19650           type: string
19651   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
19652     get:
19653       tags:
19654         - ServiceDesignAndCreation
19655       summary: returns property-constraints
19656       description: returns property-constraints
19657       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
19658       produces:
19659         - application/json
19660         - application/xml
19661       responses:
19662         "200":
19663           description: successful operation
19664           schema:
19665               $ref: "#/getDefinitions/property-constraints"
19666         "default":
19667           description: Response codes found in [response codes](https://wiki.onap.org/).
19668       parameters:
19669         - name: named-query-uuid
19670           in: path
19671           required: true
19672           type: string
19673           example: __NAMED-QUERY-UUID__
19674         - name: named-query-element-uuid
19675           in: path
19676           required: true
19677           type: string
19678           example: __NAMED-QUERY-ELEMENT-UUID__
19679         - name: named-query-name
19680           in: query
19681           required: false
19682           type: string
19683   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
19684     put:
19685       tags:
19686         - ServiceDesignAndCreation
19687       summary: see node definition for valid relationships
19688       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19689       consumes:
19690         - application/json
19691         - application/xml
19692       produces:
19693         - application/json
19694         - application/xml
19695       responses:
19696         "default":
19697           description: Response codes found in [response codes](https://wiki.onap.org/).
19698       parameters:
19699         - name: named-query-uuid
19700           in: path
19701           required: true
19702           type: string
19703           example: __NAMED-QUERY-UUID__
19704         - name: named-query-element-uuid
19705           in: path
19706           required: true
19707           type: string
19708           example: __NAMED-QUERY-ELEMENT-UUID__
19709         - name: body
19710           in: body
19711           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19712           required: true
19713           schema:
19714             $ref: "#/definitions/relationship"
19715     delete:
19716       tags:
19717         - ServiceDesignAndCreation
19718       summary: delete an existing relationship
19719       description: delete an existing relationship
19720       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
19721       consumes:
19722         - application/json
19723         - application/xml
19724       produces:
19725         - application/json
19726         - application/xml
19727       responses:
19728         "default":
19729           description: Response codes found in [response codes](https://wiki.onap.org/).
19730       parameters:
19731         - name: named-query-uuid
19732           in: path
19733           required: true
19734           type: string
19735           example: __NAMED-QUERY-UUID__
19736         - name: named-query-element-uuid
19737           in: path
19738           required: true
19739           type: string
19740           example: __NAMED-QUERY-ELEMENT-UUID__
19741   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
19742     get:
19743       tags:
19744         - ServiceDesignAndCreation
19745       summary: returns named-query-element
19746       description: returns named-query-element
19747       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19748       produces:
19749         - application/json
19750         - application/xml
19751       responses:
19752         "200":
19753           description: successful operation
19754           schema:
19755               $ref: "#/getDefinitions/named-query-element"
19756         "default":
19757           description: Response codes found in [response codes](https://wiki.onap.org/).
19758       parameters:
19759         - name: named-query-uuid
19760           in: path
19761           required: true
19762           type: string
19763           example: __NAMED-QUERY-UUID__
19764         - name: named-query-element-uuid
19765           in: path
19766           required: true
19767           type: string
19768           example: __NAMED-QUERY-ELEMENT-UUID__
19769         - name: named-query-name
19770           in: query
19771           required: false
19772           type: string
19773     put:
19774       tags:
19775         - ServiceDesignAndCreation
19776       summary: create or update an existing named-query-element
19777       description: |
19778         Create or update an existing named-query-element.
19779         #
19780         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19781       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19782       consumes:
19783         - application/json
19784         - application/xml
19785       produces:
19786         - application/json
19787         - application/xml
19788       responses:
19789         "default":
19790           description: Response codes found in [response codes](https://wiki.onap.org/).
19791       parameters:
19792         - name: named-query-uuid
19793           in: path
19794           required: true
19795           type: string
19796           example: __NAMED-QUERY-UUID__
19797         - name: named-query-element-uuid
19798           in: path
19799           required: true
19800           type: string
19801           example: __NAMED-QUERY-ELEMENT-UUID__
19802         - name: body
19803           in: body
19804           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
19805           required: true
19806           schema:
19807             $ref: "#/definitions/named-query-element"
19808     patch:
19809       tags:
19810         - ServiceDesignAndCreation
19811       summary: update an existing named-query-element
19812       description: |
19813         Update an existing named-query-element
19814         #
19815         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19816         The PUT operation will entirely replace an existing object.
19817         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19818         #
19819         Other differences between PUT and PATCH are:
19820         #
19821         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19822         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19823         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19824       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19825       consumes:
19826         - application/json
19827         - application/xml
19828       produces:
19829         - application/json
19830         - application/xml
19831       responses:
19832         "default":
19833           description: Response codes found in [response codes](https://wiki.onap.org/).
19834       parameters:
19835         - name: named-query-uuid
19836           in: path
19837           required: true
19838           type: string
19839           example: __NAMED-QUERY-UUID__
19840         - name: named-query-element-uuid
19841           in: path
19842           required: true
19843           type: string
19844           example: __NAMED-QUERY-ELEMENT-UUID__
19845         - name: body
19846           in: body
19847           description: named-query-element object that needs to be created or updated.
19848           required: true
19849           schema:
19850             $ref: "#/patchDefinitions/named-query-element"
19851     delete:
19852       tags:
19853         - ServiceDesignAndCreation
19854       summary: delete an existing named-query-element
19855       description: delete an existing named-query-element
19856       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
19857       consumes:
19858         - application/json
19859         - application/xml
19860       produces:
19861         - application/json
19862         - application/xml
19863       responses:
19864         "default":
19865           description: Response codes found in [response codes](https://wiki.onap.org/).
19866       parameters:
19867         - name: named-query-uuid
19868           in: path
19869           required: true
19870           type: string
19871           example: __NAMED-QUERY-UUID__
19872         - name: named-query-element-uuid
19873           in: path
19874           required: true
19875           type: string
19876           example: __NAMED-QUERY-ELEMENT-UUID__
19877         - name: resource-version
19878           in: query
19879           description: resource-version for concurrency
19880           required: true
19881           type: string
19882   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
19883     get:
19884       tags:
19885         - ServiceDesignAndCreation
19886       summary: returns named-query-elements
19887       description: returns named-query-elements
19888       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
19889       produces:
19890         - application/json
19891         - application/xml
19892       responses:
19893         "200":
19894           description: successful operation
19895           schema:
19896               $ref: "#/getDefinitions/named-query-elements"
19897         "default":
19898           description: Response codes found in [response codes](https://wiki.onap.org/).
19899       parameters:
19900         - name: named-query-uuid
19901           in: path
19902           required: true
19903           type: string
19904           example: __NAMED-QUERY-UUID__
19905         - name: named-query-name
19906           in: query
19907           required: false
19908           type: string
19909   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
19910     put:
19911       tags:
19912         - ServiceDesignAndCreation
19913       summary: see node definition for valid relationships
19914       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19915       consumes:
19916         - application/json
19917         - application/xml
19918       produces:
19919         - application/json
19920         - application/xml
19921       responses:
19922         "default":
19923           description: Response codes found in [response codes](https://wiki.onap.org/).
19924       parameters:
19925         - name: named-query-uuid
19926           in: path
19927           required: true
19928           type: string
19929           example: __NAMED-QUERY-UUID__
19930         - name: body
19931           in: body
19932           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
19933           required: true
19934           schema:
19935             $ref: "#/definitions/relationship"
19936     delete:
19937       tags:
19938         - ServiceDesignAndCreation
19939       summary: delete an existing relationship
19940       description: delete an existing relationship
19941       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
19942       consumes:
19943         - application/json
19944         - application/xml
19945       produces:
19946         - application/json
19947         - application/xml
19948       responses:
19949         "default":
19950           description: Response codes found in [response codes](https://wiki.onap.org/).
19951       parameters:
19952         - name: named-query-uuid
19953           in: path
19954           required: true
19955           type: string
19956           example: __NAMED-QUERY-UUID__
19957   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
19958     get:
19959       tags:
19960         - ServiceDesignAndCreation
19961       summary: returns named-query
19962       description: returns named-query
19963       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
19964       produces:
19965         - application/json
19966         - application/xml
19967       responses:
19968         "200":
19969           description: successful operation
19970           schema:
19971               $ref: "#/getDefinitions/named-query"
19972         "default":
19973           description: Response codes found in [response codes](https://wiki.onap.org/).
19974       parameters:
19975         - name: named-query-uuid
19976           in: path
19977           required: true
19978           type: string
19979           example: __NAMED-QUERY-UUID__
19980         - name: named-query-name
19981           in: query
19982           required: false
19983           type: string
19984     put:
19985       tags:
19986         - ServiceDesignAndCreation
19987       summary: create or update an existing named-query
19988       description: |
19989         Create or update an existing named-query.
19990         #
19991         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19992       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
19993       consumes:
19994         - application/json
19995         - application/xml
19996       produces:
19997         - application/json
19998         - application/xml
19999       responses:
20000         "default":
20001           description: Response codes found in [response codes](https://wiki.onap.org/).
20002       parameters:
20003         - name: named-query-uuid
20004           in: path
20005           required: true
20006           type: string
20007           example: __NAMED-QUERY-UUID__
20008         - name: body
20009           in: body
20010           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
20011           required: true
20012           schema:
20013             $ref: "#/definitions/named-query"
20014     patch:
20015       tags:
20016         - ServiceDesignAndCreation
20017       summary: update an existing named-query
20018       description: |
20019         Update an existing named-query
20020         #
20021         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20022         The PUT operation will entirely replace an existing object.
20023         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20024         #
20025         Other differences between PUT and PATCH are:
20026         #
20027         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20028         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20029         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20030       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
20031       consumes:
20032         - application/json
20033         - application/xml
20034       produces:
20035         - application/json
20036         - application/xml
20037       responses:
20038         "default":
20039           description: Response codes found in [response codes](https://wiki.onap.org/).
20040       parameters:
20041         - name: named-query-uuid
20042           in: path
20043           required: true
20044           type: string
20045           example: __NAMED-QUERY-UUID__
20046         - name: body
20047           in: body
20048           description: named-query object that needs to be created or updated.
20049           required: true
20050           schema:
20051             $ref: "#/patchDefinitions/named-query"
20052     delete:
20053       tags:
20054         - ServiceDesignAndCreation
20055       summary: delete an existing named-query
20056       description: delete an existing named-query
20057       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
20058       consumes:
20059         - application/json
20060         - application/xml
20061       produces:
20062         - application/json
20063         - application/xml
20064       responses:
20065         "default":
20066           description: Response codes found in [response codes](https://wiki.onap.org/).
20067       parameters:
20068         - name: named-query-uuid
20069           in: path
20070           required: true
20071           type: string
20072           example: __NAMED-QUERY-UUID__
20073         - name: resource-version
20074           in: query
20075           description: resource-version for concurrency
20076           required: true
20077           type: string
20078   /service-design-and-creation/named-queries:
20079     get:
20080       tags:
20081         - ServiceDesignAndCreation
20082       summary: returns named-queries
20083       description: returns named-queries
20084       operationId: getServiceDesignAndCreationNamedQueries
20085       produces:
20086         - application/json
20087         - application/xml
20088       responses:
20089         "200":
20090           description: successful operation
20091           schema:
20092               $ref: "#/getDefinitions/named-queries"
20093         "default":
20094           description: Response codes found in [response codes](https://wiki.onap.org/).
20095   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
20096     put:
20097       tags:
20098         - Network
20099       summary: see node definition for valid relationships
20100       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20101       consumes:
20102         - application/json
20103         - application/xml
20104       produces:
20105         - application/json
20106         - application/xml
20107       responses:
20108         "default":
20109           description: Response codes found in [response codes](https://wiki.onap.org/).
20110       parameters:
20111         - name: link-name
20112           in: path
20113           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20114           required: true
20115           type: string
20116           example: __LINK-NAME__
20117         - name: body
20118           in: body
20119           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
20120           required: true
20121           schema:
20122             $ref: "#/definitions/relationship"
20123     delete:
20124       tags:
20125         - Network
20126       summary: delete an existing relationship
20127       description: delete an existing relationship
20128       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
20129       consumes:
20130         - application/json
20131         - application/xml
20132       produces:
20133         - application/json
20134         - application/xml
20135       responses:
20136         "default":
20137           description: Response codes found in [response codes](https://wiki.onap.org/).
20138       parameters:
20139         - name: link-name
20140           in: path
20141           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20142           required: true
20143           type: string
20144           example: __LINK-NAME__
20145   /network/logical-links/logical-link/{link-name}:
20146     get:
20147       tags:
20148         - Network
20149       summary: returns logical-link
20150       description: returns logical-link
20151       operationId: getNetworkLogicalLinksLogicalLink
20152       produces:
20153         - application/json
20154         - application/xml
20155       responses:
20156         "200":
20157           description: successful operation
20158           schema:
20159               $ref: "#/getDefinitions/logical-link"
20160         "default":
20161           description: Response codes found in [response codes](https://wiki.onap.org/).
20162       parameters:
20163         - name: link-name
20164           in: path
20165           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20166           required: true
20167           type: string
20168           example: __LINK-NAME__
20169         - name: model-invariant-id
20170           in: query
20171           description: the ASDC model id for this resource or service model.
20172           required: false
20173           type: string
20174         - name: model-version-id
20175           in: query
20176           description: the ASDC model version for this resource or service model.
20177           required: false
20178           type: string
20179         - name: widget-model-id
20180           in: query
20181           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
20182           required: false
20183           type: string
20184         - name: widget-model-version
20185           in: query
20186           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
20187           required: false
20188           type: string
20189         - name: prov-status
20190           in: query
20191           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
20192           required: false
20193           type: string
20194         - name: link-id
20195           in: query
20196           description: UUID of the logical-link, SDNC generates this.
20197           required: false
20198           type: string
20199         - name: circuit-id
20200           in: query
20201           description: Circuit id
20202           required: false
20203           type: string
20204         - name: purpose
20205           in: query
20206           description: Reason for this entity, role it is playing
20207           required: false
20208           type: string
20209     put:
20210       tags:
20211         - Network
20212       summary: create or update an existing logical-link
20213       description: |
20214         Create or update an existing logical-link.
20215         #
20216         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20217       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
20218       consumes:
20219         - application/json
20220         - application/xml
20221       produces:
20222         - application/json
20223         - application/xml
20224       responses:
20225         "default":
20226           description: Response codes found in [response codes](https://wiki.onap.org/).
20227       parameters:
20228         - name: link-name
20229           in: path
20230           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20231           required: true
20232           type: string
20233           example: __LINK-NAME__
20234         - name: body
20235           in: body
20236           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLogicalLinksLogicalLink.json)
20237           required: true
20238           schema:
20239             $ref: "#/definitions/logical-link"
20240     patch:
20241       tags:
20242         - Network
20243       summary: update an existing logical-link
20244       description: |
20245         Update an existing logical-link
20246         #
20247         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20248         The PUT operation will entirely replace an existing object.
20249         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20250         #
20251         Other differences between PUT and PATCH are:
20252         #
20253         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20254         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20255         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20256       operationId: UpdateNetworkLogicalLinksLogicalLink
20257       consumes:
20258         - application/json
20259         - application/xml
20260       produces:
20261         - application/json
20262         - application/xml
20263       responses:
20264         "default":
20265           description: Response codes found in [response codes](https://wiki.onap.org/).
20266       parameters:
20267         - name: link-name
20268           in: path
20269           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20270           required: true
20271           type: string
20272           example: __LINK-NAME__
20273         - name: body
20274           in: body
20275           description: logical-link object that needs to be created or updated.
20276           required: true
20277           schema:
20278             $ref: "#/patchDefinitions/logical-link"
20279     delete:
20280       tags:
20281         - Network
20282       summary: delete an existing logical-link
20283       description: delete an existing logical-link
20284       operationId: deleteNetworkLogicalLinksLogicalLink
20285       consumes:
20286         - application/json
20287         - application/xml
20288       produces:
20289         - application/json
20290         - application/xml
20291       responses:
20292         "default":
20293           description: Response codes found in [response codes](https://wiki.onap.org/).
20294       parameters:
20295         - name: link-name
20296           in: path
20297           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
20298           required: true
20299           type: string
20300           example: __LINK-NAME__
20301         - name: resource-version
20302           in: query
20303           description: resource-version for concurrency
20304           required: true
20305           type: string
20306   /network/logical-links:
20307     get:
20308       tags:
20309         - Network
20310       summary: returns logical-links
20311       description: returns logical-links
20312       operationId: getNetworkLogicalLinks
20313       produces:
20314         - application/json
20315         - application/xml
20316       responses:
20317         "200":
20318           description: successful operation
20319           schema:
20320               $ref: "#/getDefinitions/logical-links"
20321         "default":
20322           description: Response codes found in [response codes](https://wiki.onap.org/).
20323   /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:
20324     put:
20325       tags:
20326         - Network
20327       summary: see node definition for valid relationships
20328       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20329       consumes:
20330         - application/json
20331         - application/xml
20332       produces:
20333         - application/json
20334         - application/xml
20335       responses:
20336         "default":
20337           description: Response codes found in [response codes](https://wiki.onap.org/).
20338       parameters:
20339         - name: site-pair-set-id
20340           in: path
20341           description: Unique id of site pair set.
20342           required: true
20343           type: string
20344           example: __SITE-PAIR-SET-ID__
20345         - name: routing-instance-id
20346           in: path
20347           description: Unique id of routing instance
20348           required: true
20349           type: string
20350           example: __ROUTING-INSTANCE-ID__
20351         - name: site-pair-id
20352           in: path
20353           description: unique identifier of probe
20354           required: true
20355           type: string
20356           example: __SITE-PAIR-ID__
20357         - name: cos
20358           in: path
20359           description: unique identifier of probe
20360           required: true
20361           type: string
20362           example: __COS__
20363         - name: body
20364           in: body
20365           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20366           required: true
20367           schema:
20368             $ref: "#/definitions/relationship"
20369     delete:
20370       tags:
20371         - Network
20372       summary: delete an existing relationship
20373       description: delete an existing relationship
20374       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
20375       consumes:
20376         - application/json
20377         - application/xml
20378       produces:
20379         - application/json
20380         - application/xml
20381       responses:
20382         "default":
20383           description: Response codes found in [response codes](https://wiki.onap.org/).
20384       parameters:
20385         - name: site-pair-set-id
20386           in: path
20387           description: Unique id of site pair set.
20388           required: true
20389           type: string
20390           example: __SITE-PAIR-SET-ID__
20391         - name: routing-instance-id
20392           in: path
20393           description: Unique id of routing instance
20394           required: true
20395           type: string
20396           example: __ROUTING-INSTANCE-ID__
20397         - name: site-pair-id
20398           in: path
20399           description: unique identifier of probe
20400           required: true
20401           type: string
20402           example: __SITE-PAIR-ID__
20403         - name: cos
20404           in: path
20405           description: unique identifier of probe
20406           required: true
20407           type: string
20408           example: __COS__
20409   /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}:
20410     get:
20411       tags:
20412         - Network
20413       summary: returns class-of-service
20414       description: returns class-of-service
20415       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20416       produces:
20417         - application/json
20418         - application/xml
20419       responses:
20420         "200":
20421           description: successful operation
20422           schema:
20423               $ref: "#/getDefinitions/class-of-service"
20424         "default":
20425           description: Response codes found in [response codes](https://wiki.onap.org/).
20426       parameters:
20427         - name: site-pair-set-id
20428           in: path
20429           description: Unique id of site pair set.
20430           required: true
20431           type: string
20432           example: __SITE-PAIR-SET-ID__
20433         - name: routing-instance-id
20434           in: path
20435           description: Unique id of routing instance
20436           required: true
20437           type: string
20438           example: __ROUTING-INSTANCE-ID__
20439         - name: site-pair-id
20440           in: path
20441           description: unique identifier of probe
20442           required: true
20443           type: string
20444           example: __SITE-PAIR-ID__
20445         - name: cos
20446           in: path
20447           description: unique identifier of probe
20448           required: true
20449           type: string
20450           example: __COS__
20451     put:
20452       tags:
20453         - Network
20454       summary: create or update an existing class-of-service
20455       description: |
20456         Create or update an existing class-of-service.
20457         #
20458         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20459       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20460       consumes:
20461         - application/json
20462         - application/xml
20463       produces:
20464         - application/json
20465         - application/xml
20466       responses:
20467         "default":
20468           description: Response codes found in [response codes](https://wiki.onap.org/).
20469       parameters:
20470         - name: site-pair-set-id
20471           in: path
20472           description: Unique id of site pair set.
20473           required: true
20474           type: string
20475           example: __SITE-PAIR-SET-ID__
20476         - name: routing-instance-id
20477           in: path
20478           description: Unique id of routing instance
20479           required: true
20480           type: string
20481           example: __ROUTING-INSTANCE-ID__
20482         - name: site-pair-id
20483           in: path
20484           description: unique identifier of probe
20485           required: true
20486           type: string
20487           example: __SITE-PAIR-ID__
20488         - name: cos
20489           in: path
20490           description: unique identifier of probe
20491           required: true
20492           type: string
20493           example: __COS__
20494         - name: body
20495           in: body
20496           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
20497           required: true
20498           schema:
20499             $ref: "#/definitions/class-of-service"
20500     patch:
20501       tags:
20502         - Network
20503       summary: update an existing class-of-service
20504       description: |
20505         Update an existing class-of-service
20506         #
20507         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20508         The PUT operation will entirely replace an existing object.
20509         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20510         #
20511         Other differences between PUT and PATCH are:
20512         #
20513         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20514         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20515         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20516       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20517       consumes:
20518         - application/json
20519         - application/xml
20520       produces:
20521         - application/json
20522         - application/xml
20523       responses:
20524         "default":
20525           description: Response codes found in [response codes](https://wiki.onap.org/).
20526       parameters:
20527         - name: site-pair-set-id
20528           in: path
20529           description: Unique id of site pair set.
20530           required: true
20531           type: string
20532           example: __SITE-PAIR-SET-ID__
20533         - name: routing-instance-id
20534           in: path
20535           description: Unique id of routing instance
20536           required: true
20537           type: string
20538           example: __ROUTING-INSTANCE-ID__
20539         - name: site-pair-id
20540           in: path
20541           description: unique identifier of probe
20542           required: true
20543           type: string
20544           example: __SITE-PAIR-ID__
20545         - name: cos
20546           in: path
20547           description: unique identifier of probe
20548           required: true
20549           type: string
20550           example: __COS__
20551         - name: body
20552           in: body
20553           description: class-of-service object that needs to be created or updated.
20554           required: true
20555           schema:
20556             $ref: "#/patchDefinitions/class-of-service"
20557     delete:
20558       tags:
20559         - Network
20560       summary: delete an existing class-of-service
20561       description: delete an existing class-of-service
20562       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
20563       consumes:
20564         - application/json
20565         - application/xml
20566       produces:
20567         - application/json
20568         - application/xml
20569       responses:
20570         "default":
20571           description: Response codes found in [response codes](https://wiki.onap.org/).
20572       parameters:
20573         - name: site-pair-set-id
20574           in: path
20575           description: Unique id of site pair set.
20576           required: true
20577           type: string
20578           example: __SITE-PAIR-SET-ID__
20579         - name: routing-instance-id
20580           in: path
20581           description: Unique id of routing instance
20582           required: true
20583           type: string
20584           example: __ROUTING-INSTANCE-ID__
20585         - name: site-pair-id
20586           in: path
20587           description: unique identifier of probe
20588           required: true
20589           type: string
20590           example: __SITE-PAIR-ID__
20591         - name: cos
20592           in: path
20593           description: unique identifier of probe
20594           required: true
20595           type: string
20596           example: __COS__
20597         - name: resource-version
20598           in: query
20599           description: resource-version for concurrency
20600           required: true
20601           type: string
20602   /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:
20603     get:
20604       tags:
20605         - Network
20606       summary: returns classes-of-service
20607       description: returns classes-of-service
20608       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
20609       produces:
20610         - application/json
20611         - application/xml
20612       responses:
20613         "200":
20614           description: successful operation
20615           schema:
20616               $ref: "#/getDefinitions/classes-of-service"
20617         "default":
20618           description: Response codes found in [response codes](https://wiki.onap.org/).
20619       parameters:
20620         - name: site-pair-set-id
20621           in: path
20622           description: Unique id of site pair set.
20623           required: true
20624           type: string
20625           example: __SITE-PAIR-SET-ID__
20626         - name: routing-instance-id
20627           in: path
20628           description: Unique id of routing instance
20629           required: true
20630           type: string
20631           example: __ROUTING-INSTANCE-ID__
20632         - name: site-pair-id
20633           in: path
20634           description: unique identifier of probe
20635           required: true
20636           type: string
20637           example: __SITE-PAIR-ID__
20638   /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:
20639     put:
20640       tags:
20641         - Network
20642       summary: see node definition for valid relationships
20643       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20644       consumes:
20645         - application/json
20646         - application/xml
20647       produces:
20648         - application/json
20649         - application/xml
20650       responses:
20651         "default":
20652           description: Response codes found in [response codes](https://wiki.onap.org/).
20653       parameters:
20654         - name: site-pair-set-id
20655           in: path
20656           description: Unique id of site pair set.
20657           required: true
20658           type: string
20659           example: __SITE-PAIR-SET-ID__
20660         - name: routing-instance-id
20661           in: path
20662           description: Unique id of routing instance
20663           required: true
20664           type: string
20665           example: __ROUTING-INSTANCE-ID__
20666         - name: site-pair-id
20667           in: path
20668           description: unique identifier of probe
20669           required: true
20670           type: string
20671           example: __SITE-PAIR-ID__
20672         - name: body
20673           in: body
20674           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20675           required: true
20676           schema:
20677             $ref: "#/definitions/relationship"
20678     delete:
20679       tags:
20680         - Network
20681       summary: delete an existing relationship
20682       description: delete an existing relationship
20683       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
20684       consumes:
20685         - application/json
20686         - application/xml
20687       produces:
20688         - application/json
20689         - application/xml
20690       responses:
20691         "default":
20692           description: Response codes found in [response codes](https://wiki.onap.org/).
20693       parameters:
20694         - name: site-pair-set-id
20695           in: path
20696           description: Unique id of site pair set.
20697           required: true
20698           type: string
20699           example: __SITE-PAIR-SET-ID__
20700         - name: routing-instance-id
20701           in: path
20702           description: Unique id of routing instance
20703           required: true
20704           type: string
20705           example: __ROUTING-INSTANCE-ID__
20706         - name: site-pair-id
20707           in: path
20708           description: unique identifier of probe
20709           required: true
20710           type: string
20711           example: __SITE-PAIR-ID__
20712   /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}:
20713     get:
20714       tags:
20715         - Network
20716       summary: returns site-pair
20717       description: returns site-pair
20718       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20719       produces:
20720         - application/json
20721         - application/xml
20722       responses:
20723         "200":
20724           description: successful operation
20725           schema:
20726               $ref: "#/getDefinitions/site-pair"
20727         "default":
20728           description: Response codes found in [response codes](https://wiki.onap.org/).
20729       parameters:
20730         - name: site-pair-set-id
20731           in: path
20732           description: Unique id of site pair set.
20733           required: true
20734           type: string
20735           example: __SITE-PAIR-SET-ID__
20736         - name: routing-instance-id
20737           in: path
20738           description: Unique id of routing instance
20739           required: true
20740           type: string
20741           example: __ROUTING-INSTANCE-ID__
20742         - name: site-pair-id
20743           in: path
20744           description: unique identifier of probe
20745           required: true
20746           type: string
20747           example: __SITE-PAIR-ID__
20748     put:
20749       tags:
20750         - Network
20751       summary: create or update an existing site-pair
20752       description: |
20753         Create or update an existing site-pair.
20754         #
20755         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20756       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20757       consumes:
20758         - application/json
20759         - application/xml
20760       produces:
20761         - application/json
20762         - application/xml
20763       responses:
20764         "default":
20765           description: Response codes found in [response codes](https://wiki.onap.org/).
20766       parameters:
20767         - name: site-pair-set-id
20768           in: path
20769           description: Unique id of site pair set.
20770           required: true
20771           type: string
20772           example: __SITE-PAIR-SET-ID__
20773         - name: routing-instance-id
20774           in: path
20775           description: Unique id of routing instance
20776           required: true
20777           type: string
20778           example: __ROUTING-INSTANCE-ID__
20779         - name: site-pair-id
20780           in: path
20781           description: unique identifier of probe
20782           required: true
20783           type: string
20784           example: __SITE-PAIR-ID__
20785         - name: body
20786           in: body
20787           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
20788           required: true
20789           schema:
20790             $ref: "#/definitions/site-pair"
20791     patch:
20792       tags:
20793         - Network
20794       summary: update an existing site-pair
20795       description: |
20796         Update an existing site-pair
20797         #
20798         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20799         The PUT operation will entirely replace an existing object.
20800         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20801         #
20802         Other differences between PUT and PATCH are:
20803         #
20804         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20805         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20806         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20807       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20808       consumes:
20809         - application/json
20810         - application/xml
20811       produces:
20812         - application/json
20813         - application/xml
20814       responses:
20815         "default":
20816           description: Response codes found in [response codes](https://wiki.onap.org/).
20817       parameters:
20818         - name: site-pair-set-id
20819           in: path
20820           description: Unique id of site pair set.
20821           required: true
20822           type: string
20823           example: __SITE-PAIR-SET-ID__
20824         - name: routing-instance-id
20825           in: path
20826           description: Unique id of routing instance
20827           required: true
20828           type: string
20829           example: __ROUTING-INSTANCE-ID__
20830         - name: site-pair-id
20831           in: path
20832           description: unique identifier of probe
20833           required: true
20834           type: string
20835           example: __SITE-PAIR-ID__
20836         - name: body
20837           in: body
20838           description: site-pair object that needs to be created or updated.
20839           required: true
20840           schema:
20841             $ref: "#/patchDefinitions/site-pair"
20842     delete:
20843       tags:
20844         - Network
20845       summary: delete an existing site-pair
20846       description: delete an existing site-pair
20847       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
20848       consumes:
20849         - application/json
20850         - application/xml
20851       produces:
20852         - application/json
20853         - application/xml
20854       responses:
20855         "default":
20856           description: Response codes found in [response codes](https://wiki.onap.org/).
20857       parameters:
20858         - name: site-pair-set-id
20859           in: path
20860           description: Unique id of site pair set.
20861           required: true
20862           type: string
20863           example: __SITE-PAIR-SET-ID__
20864         - name: routing-instance-id
20865           in: path
20866           description: Unique id of routing instance
20867           required: true
20868           type: string
20869           example: __ROUTING-INSTANCE-ID__
20870         - name: site-pair-id
20871           in: path
20872           description: unique identifier of probe
20873           required: true
20874           type: string
20875           example: __SITE-PAIR-ID__
20876         - name: resource-version
20877           in: query
20878           description: resource-version for concurrency
20879           required: true
20880           type: string
20881   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
20882     get:
20883       tags:
20884         - Network
20885       summary: returns site-pairs
20886       description: returns site-pairs
20887       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
20888       produces:
20889         - application/json
20890         - application/xml
20891       responses:
20892         "200":
20893           description: successful operation
20894           schema:
20895               $ref: "#/getDefinitions/site-pairs"
20896         "default":
20897           description: Response codes found in [response codes](https://wiki.onap.org/).
20898       parameters:
20899         - name: site-pair-set-id
20900           in: path
20901           description: Unique id of site pair set.
20902           required: true
20903           type: string
20904           example: __SITE-PAIR-SET-ID__
20905         - name: routing-instance-id
20906           in: path
20907           description: Unique id of routing instance
20908           required: true
20909           type: string
20910           example: __ROUTING-INSTANCE-ID__
20911   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
20912     put:
20913       tags:
20914         - Network
20915       summary: see node definition for valid relationships
20916       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20917       consumes:
20918         - application/json
20919         - application/xml
20920       produces:
20921         - application/json
20922         - application/xml
20923       responses:
20924         "default":
20925           description: Response codes found in [response codes](https://wiki.onap.org/).
20926       parameters:
20927         - name: site-pair-set-id
20928           in: path
20929           description: Unique id of site pair set.
20930           required: true
20931           type: string
20932           example: __SITE-PAIR-SET-ID__
20933         - name: routing-instance-id
20934           in: path
20935           description: Unique id of routing instance
20936           required: true
20937           type: string
20938           example: __ROUTING-INSTANCE-ID__
20939         - name: body
20940           in: body
20941           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
20942           required: true
20943           schema:
20944             $ref: "#/definitions/relationship"
20945     delete:
20946       tags:
20947         - Network
20948       summary: delete an existing relationship
20949       description: delete an existing relationship
20950       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
20951       consumes:
20952         - application/json
20953         - application/xml
20954       produces:
20955         - application/json
20956         - application/xml
20957       responses:
20958         "default":
20959           description: Response codes found in [response codes](https://wiki.onap.org/).
20960       parameters:
20961         - name: site-pair-set-id
20962           in: path
20963           description: Unique id of site pair set.
20964           required: true
20965           type: string
20966           example: __SITE-PAIR-SET-ID__
20967         - name: routing-instance-id
20968           in: path
20969           description: Unique id of routing instance
20970           required: true
20971           type: string
20972           example: __ROUTING-INSTANCE-ID__
20973   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
20974     get:
20975       tags:
20976         - Network
20977       summary: returns routing-instance
20978       description: returns routing-instance
20979       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
20980       produces:
20981         - application/json
20982         - application/xml
20983       responses:
20984         "200":
20985           description: successful operation
20986           schema:
20987               $ref: "#/getDefinitions/routing-instance"
20988         "default":
20989           description: Response codes found in [response codes](https://wiki.onap.org/).
20990       parameters:
20991         - name: site-pair-set-id
20992           in: path
20993           description: Unique id of site pair set.
20994           required: true
20995           type: string
20996           example: __SITE-PAIR-SET-ID__
20997         - name: routing-instance-id
20998           in: path
20999           description: Unique id of routing instance
21000           required: true
21001           type: string
21002           example: __ROUTING-INSTANCE-ID__
21003     put:
21004       tags:
21005         - Network
21006       summary: create or update an existing routing-instance
21007       description: |
21008         Create or update an existing routing-instance.
21009         #
21010         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21011       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21012       consumes:
21013         - application/json
21014         - application/xml
21015       produces:
21016         - application/json
21017         - application/xml
21018       responses:
21019         "default":
21020           description: Response codes found in [response codes](https://wiki.onap.org/).
21021       parameters:
21022         - name: site-pair-set-id
21023           in: path
21024           description: Unique id of site pair set.
21025           required: true
21026           type: string
21027           example: __SITE-PAIR-SET-ID__
21028         - name: routing-instance-id
21029           in: path
21030           description: Unique id of routing instance
21031           required: true
21032           type: string
21033           example: __ROUTING-INSTANCE-ID__
21034         - name: body
21035           in: body
21036           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
21037           required: true
21038           schema:
21039             $ref: "#/definitions/routing-instance"
21040     patch:
21041       tags:
21042         - Network
21043       summary: update an existing routing-instance
21044       description: |
21045         Update an existing routing-instance
21046         #
21047         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21048         The PUT operation will entirely replace an existing object.
21049         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21050         #
21051         Other differences between PUT and PATCH are:
21052         #
21053         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21054         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21055         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21056       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21057       consumes:
21058         - application/json
21059         - application/xml
21060       produces:
21061         - application/json
21062         - application/xml
21063       responses:
21064         "default":
21065           description: Response codes found in [response codes](https://wiki.onap.org/).
21066       parameters:
21067         - name: site-pair-set-id
21068           in: path
21069           description: Unique id of site pair set.
21070           required: true
21071           type: string
21072           example: __SITE-PAIR-SET-ID__
21073         - name: routing-instance-id
21074           in: path
21075           description: Unique id of routing instance
21076           required: true
21077           type: string
21078           example: __ROUTING-INSTANCE-ID__
21079         - name: body
21080           in: body
21081           description: routing-instance object that needs to be created or updated.
21082           required: true
21083           schema:
21084             $ref: "#/patchDefinitions/routing-instance"
21085     delete:
21086       tags:
21087         - Network
21088       summary: delete an existing routing-instance
21089       description: delete an existing routing-instance
21090       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
21091       consumes:
21092         - application/json
21093         - application/xml
21094       produces:
21095         - application/json
21096         - application/xml
21097       responses:
21098         "default":
21099           description: Response codes found in [response codes](https://wiki.onap.org/).
21100       parameters:
21101         - name: site-pair-set-id
21102           in: path
21103           description: Unique id of site pair set.
21104           required: true
21105           type: string
21106           example: __SITE-PAIR-SET-ID__
21107         - name: routing-instance-id
21108           in: path
21109           description: Unique id of routing instance
21110           required: true
21111           type: string
21112           example: __ROUTING-INSTANCE-ID__
21113         - name: resource-version
21114           in: query
21115           description: resource-version for concurrency
21116           required: true
21117           type: string
21118   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
21119     get:
21120       tags:
21121         - Network
21122       summary: returns routing-instances
21123       description: returns routing-instances
21124       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
21125       produces:
21126         - application/json
21127         - application/xml
21128       responses:
21129         "200":
21130           description: successful operation
21131           schema:
21132               $ref: "#/getDefinitions/routing-instances"
21133         "default":
21134           description: Response codes found in [response codes](https://wiki.onap.org/).
21135       parameters:
21136         - name: site-pair-set-id
21137           in: path
21138           description: Unique id of site pair set.
21139           required: true
21140           type: string
21141           example: __SITE-PAIR-SET-ID__
21142   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
21143     put:
21144       tags:
21145         - Network
21146       summary: see node definition for valid relationships
21147       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
21148       consumes:
21149         - application/json
21150         - application/xml
21151       produces:
21152         - application/json
21153         - application/xml
21154       responses:
21155         "default":
21156           description: Response codes found in [response codes](https://wiki.onap.org/).
21157       parameters:
21158         - name: site-pair-set-id
21159           in: path
21160           description: Unique id of site pair set.
21161           required: true
21162           type: string
21163           example: __SITE-PAIR-SET-ID__
21164         - name: body
21165           in: body
21166           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
21167           required: true
21168           schema:
21169             $ref: "#/definitions/relationship"
21170     delete:
21171       tags:
21172         - Network
21173       summary: delete an existing relationship
21174       description: delete an existing relationship
21175       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
21176       consumes:
21177         - application/json
21178         - application/xml
21179       produces:
21180         - application/json
21181         - application/xml
21182       responses:
21183         "default":
21184           description: Response codes found in [response codes](https://wiki.onap.org/).
21185       parameters:
21186         - name: site-pair-set-id
21187           in: path
21188           description: Unique id of site pair set.
21189           required: true
21190           type: string
21191           example: __SITE-PAIR-SET-ID__
21192   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
21193     get:
21194       tags:
21195         - Network
21196       summary: returns site-pair-set
21197       description: returns site-pair-set
21198       operationId: getNetworkSitePairSetsSitePairSet
21199       produces:
21200         - application/json
21201         - application/xml
21202       responses:
21203         "200":
21204           description: successful operation
21205           schema:
21206               $ref: "#/getDefinitions/site-pair-set"
21207         "default":
21208           description: Response codes found in [response codes](https://wiki.onap.org/).
21209       parameters:
21210         - name: site-pair-set-id
21211           in: path
21212           description: Unique id of site pair set.
21213           required: true
21214           type: string
21215           example: __SITE-PAIR-SET-ID__
21216     put:
21217       tags:
21218         - Network
21219       summary: create or update an existing site-pair-set
21220       description: |
21221         Create or update an existing site-pair-set.
21222         #
21223         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21224       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
21225       consumes:
21226         - application/json
21227         - application/xml
21228       produces:
21229         - application/json
21230         - application/xml
21231       responses:
21232         "default":
21233           description: Response codes found in [response codes](https://wiki.onap.org/).
21234       parameters:
21235         - name: site-pair-set-id
21236           in: path
21237           description: Unique id of site pair set.
21238           required: true
21239           type: string
21240           example: __SITE-PAIR-SET-ID__
21241         - name: body
21242           in: body
21243           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkSitePairSetsSitePairSet.json)
21244           required: true
21245           schema:
21246             $ref: "#/definitions/site-pair-set"
21247     patch:
21248       tags:
21249         - Network
21250       summary: update an existing site-pair-set
21251       description: |
21252         Update an existing site-pair-set
21253         #
21254         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21255         The PUT operation will entirely replace an existing object.
21256         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21257         #
21258         Other differences between PUT and PATCH are:
21259         #
21260         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21261         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21262         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21263       operationId: UpdateNetworkSitePairSetsSitePairSet
21264       consumes:
21265         - application/json
21266         - application/xml
21267       produces:
21268         - application/json
21269         - application/xml
21270       responses:
21271         "default":
21272           description: Response codes found in [response codes](https://wiki.onap.org/).
21273       parameters:
21274         - name: site-pair-set-id
21275           in: path
21276           description: Unique id of site pair set.
21277           required: true
21278           type: string
21279           example: __SITE-PAIR-SET-ID__
21280         - name: body
21281           in: body
21282           description: site-pair-set object that needs to be created or updated.
21283           required: true
21284           schema:
21285             $ref: "#/patchDefinitions/site-pair-set"
21286     delete:
21287       tags:
21288         - Network
21289       summary: delete an existing site-pair-set
21290       description: delete an existing site-pair-set
21291       operationId: deleteNetworkSitePairSetsSitePairSet
21292       consumes:
21293         - application/json
21294         - application/xml
21295       produces:
21296         - application/json
21297         - application/xml
21298       responses:
21299         "default":
21300           description: Response codes found in [response codes](https://wiki.onap.org/).
21301       parameters:
21302         - name: site-pair-set-id
21303           in: path
21304           description: Unique id of site pair set.
21305           required: true
21306           type: string
21307           example: __SITE-PAIR-SET-ID__
21308         - name: resource-version
21309           in: query
21310           description: resource-version for concurrency
21311           required: true
21312           type: string
21313   /network/site-pair-sets:
21314     get:
21315       tags:
21316         - Network
21317       summary: returns site-pair-sets
21318       description: returns site-pair-sets
21319       operationId: getNetworkSitePairSets
21320       produces:
21321         - application/json
21322         - application/xml
21323       responses:
21324         "200":
21325           description: successful operation
21326           schema:
21327               $ref: "#/getDefinitions/site-pair-sets"
21328         "default":
21329           description: Response codes found in [response codes](https://wiki.onap.org/).
21330   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
21331     put:
21332       tags:
21333         - Network
21334       summary: see node definition for valid relationships
21335       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
21336       consumes:
21337         - application/json
21338         - application/xml
21339       produces:
21340         - application/json
21341         - application/xml
21342       responses:
21343         "default":
21344           description: Response codes found in [response codes](https://wiki.onap.org/).
21345       parameters:
21346         - name: vpn-id
21347           in: path
21348           description: VPN ID, globally unique within A&AI
21349           required: true
21350           type: string
21351           example: __VPN-ID__
21352         - name: global-route-target
21353           in: path
21354           description: Number used to identify an RT, globally unique in the network
21355           required: true
21356           type: string
21357           example: __GLOBAL-ROUTE-TARGET__
21358         - name: route-target-role
21359           in: path
21360           description: Role assigned to this route target
21361           required: true
21362           type: string
21363           example: __ROUTE-TARGET-ROLE__
21364         - name: body
21365           in: body
21366           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
21367           required: true
21368           schema:
21369             $ref: "#/definitions/relationship"
21370     delete:
21371       tags:
21372         - Network
21373       summary: delete an existing relationship
21374       description: delete an existing relationship
21375       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
21376       consumes:
21377         - application/json
21378         - application/xml
21379       produces:
21380         - application/json
21381         - application/xml
21382       responses:
21383         "default":
21384           description: Response codes found in [response codes](https://wiki.onap.org/).
21385       parameters:
21386         - name: vpn-id
21387           in: path
21388           description: VPN ID, globally unique within A&AI
21389           required: true
21390           type: string
21391           example: __VPN-ID__
21392         - name: global-route-target
21393           in: path
21394           description: Number used to identify an RT, globally unique in the network
21395           required: true
21396           type: string
21397           example: __GLOBAL-ROUTE-TARGET__
21398         - name: route-target-role
21399           in: path
21400           description: Role assigned to this route target
21401           required: true
21402           type: string
21403           example: __ROUTE-TARGET-ROLE__
21404   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
21405     get:
21406       tags:
21407         - Network
21408       summary: returns route-target
21409       description: returns route-target
21410       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21411       produces:
21412         - application/json
21413         - application/xml
21414       responses:
21415         "200":
21416           description: successful operation
21417           schema:
21418               $ref: "#/getDefinitions/route-target"
21419         "default":
21420           description: Response codes found in [response codes](https://wiki.onap.org/).
21421       parameters:
21422         - name: vpn-id
21423           in: path
21424           description: VPN ID, globally unique within A&AI
21425           required: true
21426           type: string
21427           example: __VPN-ID__
21428         - name: global-route-target
21429           in: path
21430           description: Number used to identify an RT, globally unique in the network
21431           required: true
21432           type: string
21433           example: __GLOBAL-ROUTE-TARGET__
21434         - name: route-target-role
21435           in: path
21436           description: Role assigned to this route target
21437           required: true
21438           type: string
21439           example: __ROUTE-TARGET-ROLE__
21440         - name: vpn-name
21441           in: query
21442           description: VPN Name
21443           required: false
21444           type: string
21445         - name: vpn-type
21446           in: query
21447           description: Type of the vpn, should be taken from enumerated/valid values
21448           required: false
21449           type: string
21450     put:
21451       tags:
21452         - Network
21453       summary: create or update an existing route-target
21454       description: |
21455         Create or update an existing route-target.
21456         #
21457         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21458       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21459       consumes:
21460         - application/json
21461         - application/xml
21462       produces:
21463         - application/json
21464         - application/xml
21465       responses:
21466         "default":
21467           description: Response codes found in [response codes](https://wiki.onap.org/).
21468       parameters:
21469         - name: vpn-id
21470           in: path
21471           description: VPN ID, globally unique within A&AI
21472           required: true
21473           type: string
21474           example: __VPN-ID__
21475         - name: global-route-target
21476           in: path
21477           description: Number used to identify an RT, globally unique in the network
21478           required: true
21479           type: string
21480           example: __GLOBAL-ROUTE-TARGET__
21481         - name: route-target-role
21482           in: path
21483           description: Role assigned to this route target
21484           required: true
21485           type: string
21486           example: __ROUTE-TARGET-ROLE__
21487         - name: body
21488           in: body
21489           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
21490           required: true
21491           schema:
21492             $ref: "#/definitions/route-target"
21493     patch:
21494       tags:
21495         - Network
21496       summary: update an existing route-target
21497       description: |
21498         Update an existing route-target
21499         #
21500         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21501         The PUT operation will entirely replace an existing object.
21502         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21503         #
21504         Other differences between PUT and PATCH are:
21505         #
21506         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21507         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21508         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21509       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21510       consumes:
21511         - application/json
21512         - application/xml
21513       produces:
21514         - application/json
21515         - application/xml
21516       responses:
21517         "default":
21518           description: Response codes found in [response codes](https://wiki.onap.org/).
21519       parameters:
21520         - name: vpn-id
21521           in: path
21522           description: VPN ID, globally unique within A&AI
21523           required: true
21524           type: string
21525           example: __VPN-ID__
21526         - name: global-route-target
21527           in: path
21528           description: Number used to identify an RT, globally unique in the network
21529           required: true
21530           type: string
21531           example: __GLOBAL-ROUTE-TARGET__
21532         - name: route-target-role
21533           in: path
21534           description: Role assigned to this route target
21535           required: true
21536           type: string
21537           example: __ROUTE-TARGET-ROLE__
21538         - name: body
21539           in: body
21540           description: route-target object that needs to be created or updated.
21541           required: true
21542           schema:
21543             $ref: "#/patchDefinitions/route-target"
21544     delete:
21545       tags:
21546         - Network
21547       summary: delete an existing route-target
21548       description: delete an existing route-target
21549       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
21550       consumes:
21551         - application/json
21552         - application/xml
21553       produces:
21554         - application/json
21555         - application/xml
21556       responses:
21557         "default":
21558           description: Response codes found in [response codes](https://wiki.onap.org/).
21559       parameters:
21560         - name: vpn-id
21561           in: path
21562           description: VPN ID, globally unique within A&AI
21563           required: true
21564           type: string
21565           example: __VPN-ID__
21566         - name: global-route-target
21567           in: path
21568           description: Number used to identify an RT, globally unique in the network
21569           required: true
21570           type: string
21571           example: __GLOBAL-ROUTE-TARGET__
21572         - name: route-target-role
21573           in: path
21574           description: Role assigned to this route target
21575           required: true
21576           type: string
21577           example: __ROUTE-TARGET-ROLE__
21578         - name: resource-version
21579           in: query
21580           description: resource-version for concurrency
21581           required: true
21582           type: string
21583   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
21584     get:
21585       tags:
21586         - Network
21587       summary: returns route-targets
21588       description: returns route-targets
21589       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
21590       produces:
21591         - application/json
21592         - application/xml
21593       responses:
21594         "200":
21595           description: successful operation
21596           schema:
21597               $ref: "#/getDefinitions/route-targets"
21598         "default":
21599           description: Response codes found in [response codes](https://wiki.onap.org/).
21600       parameters:
21601         - name: vpn-id
21602           in: path
21603           description: VPN ID, globally unique within A&AI
21604           required: true
21605           type: string
21606           example: __VPN-ID__
21607         - name: vpn-name
21608           in: query
21609           description: VPN Name
21610           required: false
21611           type: string
21612         - name: vpn-type
21613           in: query
21614           description: Type of the vpn, should be taken from enumerated/valid values
21615           required: false
21616           type: string
21617   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
21618     put:
21619       tags:
21620         - Network
21621       summary: see node definition for valid relationships
21622       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
21623       consumes:
21624         - application/json
21625         - application/xml
21626       produces:
21627         - application/json
21628         - application/xml
21629       responses:
21630         "default":
21631           description: Response codes found in [response codes](https://wiki.onap.org/).
21632       parameters:
21633         - name: vpn-id
21634           in: path
21635           description: VPN ID, globally unique within A&AI
21636           required: true
21637           type: string
21638           example: __VPN-ID__
21639         - name: body
21640           in: body
21641           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
21642           required: true
21643           schema:
21644             $ref: "#/definitions/relationship"
21645     delete:
21646       tags:
21647         - Network
21648       summary: delete an existing relationship
21649       description: delete an existing relationship
21650       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
21651       consumes:
21652         - application/json
21653         - application/xml
21654       produces:
21655         - application/json
21656         - application/xml
21657       responses:
21658         "default":
21659           description: Response codes found in [response codes](https://wiki.onap.org/).
21660       parameters:
21661         - name: vpn-id
21662           in: path
21663           description: VPN ID, globally unique within A&AI
21664           required: true
21665           type: string
21666           example: __VPN-ID__
21667   /network/vpn-bindings/vpn-binding/{vpn-id}:
21668     get:
21669       tags:
21670         - Network
21671       summary: returns vpn-binding
21672       description: returns vpn-binding
21673       operationId: getNetworkVpnBindingsVpnBinding
21674       produces:
21675         - application/json
21676         - application/xml
21677       responses:
21678         "200":
21679           description: successful operation
21680           schema:
21681               $ref: "#/getDefinitions/vpn-binding"
21682         "default":
21683           description: Response codes found in [response codes](https://wiki.onap.org/).
21684       parameters:
21685         - name: vpn-id
21686           in: path
21687           description: VPN ID, globally unique within A&AI
21688           required: true
21689           type: string
21690           example: __VPN-ID__
21691         - name: vpn-name
21692           in: query
21693           description: VPN Name
21694           required: false
21695           type: string
21696         - name: vpn-type
21697           in: query
21698           description: Type of the vpn, should be taken from enumerated/valid values
21699           required: false
21700           type: string
21701     put:
21702       tags:
21703         - Network
21704       summary: create or update an existing vpn-binding
21705       description: |
21706         Create or update an existing vpn-binding.
21707         #
21708         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21709       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
21710       consumes:
21711         - application/json
21712         - application/xml
21713       produces:
21714         - application/json
21715         - application/xml
21716       responses:
21717         "default":
21718           description: Response codes found in [response codes](https://wiki.onap.org/).
21719       parameters:
21720         - name: vpn-id
21721           in: path
21722           description: VPN ID, globally unique within A&AI
21723           required: true
21724           type: string
21725           example: __VPN-ID__
21726         - name: body
21727           in: body
21728           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVpnBindingsVpnBinding.json)
21729           required: true
21730           schema:
21731             $ref: "#/definitions/vpn-binding"
21732     patch:
21733       tags:
21734         - Network
21735       summary: update an existing vpn-binding
21736       description: |
21737         Update an existing vpn-binding
21738         #
21739         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21740         The PUT operation will entirely replace an existing object.
21741         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21742         #
21743         Other differences between PUT and PATCH are:
21744         #
21745         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21746         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21747         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21748       operationId: UpdateNetworkVpnBindingsVpnBinding
21749       consumes:
21750         - application/json
21751         - application/xml
21752       produces:
21753         - application/json
21754         - application/xml
21755       responses:
21756         "default":
21757           description: Response codes found in [response codes](https://wiki.onap.org/).
21758       parameters:
21759         - name: vpn-id
21760           in: path
21761           description: VPN ID, globally unique within A&AI
21762           required: true
21763           type: string
21764           example: __VPN-ID__
21765         - name: body
21766           in: body
21767           description: vpn-binding object that needs to be created or updated.
21768           required: true
21769           schema:
21770             $ref: "#/patchDefinitions/vpn-binding"
21771     delete:
21772       tags:
21773         - Network
21774       summary: delete an existing vpn-binding
21775       description: delete an existing vpn-binding
21776       operationId: deleteNetworkVpnBindingsVpnBinding
21777       consumes:
21778         - application/json
21779         - application/xml
21780       produces:
21781         - application/json
21782         - application/xml
21783       responses:
21784         "default":
21785           description: Response codes found in [response codes](https://wiki.onap.org/).
21786       parameters:
21787         - name: vpn-id
21788           in: path
21789           description: VPN ID, globally unique within A&AI
21790           required: true
21791           type: string
21792           example: __VPN-ID__
21793         - name: resource-version
21794           in: query
21795           description: resource-version for concurrency
21796           required: true
21797           type: string
21798   /network/vpn-bindings:
21799     get:
21800       tags:
21801         - Network
21802       summary: returns vpn-bindings
21803       description: returns vpn-bindings
21804       operationId: getNetworkVpnBindings
21805       produces:
21806         - application/json
21807         - application/xml
21808       responses:
21809         "200":
21810           description: successful operation
21811           schema:
21812               $ref: "#/getDefinitions/vpn-bindings"
21813         "default":
21814           description: Response codes found in [response codes](https://wiki.onap.org/).
21815   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
21816     put:
21817       tags:
21818         - Network
21819       summary: see node definition for valid relationships
21820       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
21821       consumes:
21822         - application/json
21823         - application/xml
21824       produces:
21825         - application/json
21826         - application/xml
21827       responses:
21828         "default":
21829           description: Response codes found in [response codes](https://wiki.onap.org/).
21830       parameters:
21831         - name: equipment-name
21832           in: path
21833           required: true
21834           type: string
21835           example: __EQUIPMENT-NAME__
21836         - name: body
21837           in: body
21838           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
21839           required: true
21840           schema:
21841             $ref: "#/definitions/relationship"
21842     delete:
21843       tags:
21844         - Network
21845       summary: delete an existing relationship
21846       description: delete an existing relationship
21847       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
21848       consumes:
21849         - application/json
21850         - application/xml
21851       produces:
21852         - application/json
21853         - application/xml
21854       responses:
21855         "default":
21856           description: Response codes found in [response codes](https://wiki.onap.org/).
21857       parameters:
21858         - name: equipment-name
21859           in: path
21860           required: true
21861           type: string
21862           example: __EQUIPMENT-NAME__
21863   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
21864     put:
21865       tags:
21866         - Network
21867       summary: see node definition for valid relationships
21868       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21869       consumes:
21870         - application/json
21871         - application/xml
21872       produces:
21873         - application/json
21874         - application/xml
21875       responses:
21876         "default":
21877           description: Response codes found in [response codes](https://wiki.onap.org/).
21878       parameters:
21879         - name: equipment-name
21880           in: path
21881           required: true
21882           type: string
21883           example: __EQUIPMENT-NAME__
21884         - name: interface-name
21885           in: path
21886           description: Name that identifies the physical interface
21887           required: true
21888           type: string
21889           example: __INTERFACE-NAME__
21890         - name: body
21891           in: body
21892           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
21893           required: true
21894           schema:
21895             $ref: "#/definitions/relationship"
21896     delete:
21897       tags:
21898         - Network
21899       summary: delete an existing relationship
21900       description: delete an existing relationship
21901       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
21902       consumes:
21903         - application/json
21904         - application/xml
21905       produces:
21906         - application/json
21907         - application/xml
21908       responses:
21909         "default":
21910           description: Response codes found in [response codes](https://wiki.onap.org/).
21911       parameters:
21912         - name: equipment-name
21913           in: path
21914           required: true
21915           type: string
21916           example: __EQUIPMENT-NAME__
21917         - name: interface-name
21918           in: path
21919           description: Name that identifies the physical interface
21920           required: true
21921           type: string
21922           example: __INTERFACE-NAME__
21923   /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:
21924     put:
21925       tags:
21926         - Network
21927       summary: see node definition for valid relationships
21928       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21929       consumes:
21930         - application/json
21931         - application/xml
21932       produces:
21933         - application/json
21934         - application/xml
21935       responses:
21936         "default":
21937           description: Response codes found in [response codes](https://wiki.onap.org/).
21938       parameters:
21939         - name: equipment-name
21940           in: path
21941           required: true
21942           type: string
21943           example: __EQUIPMENT-NAME__
21944         - name: interface-name
21945           in: path
21946           description: Name that identifies the physical interface
21947           required: true
21948           type: string
21949           example: __INTERFACE-NAME__
21950         - name: interface-name
21951           in: path
21952           description: Name given to the interface
21953           required: true
21954           type: string
21955           example: __INTERFACE-NAME__
21956         - name: vlan-interface
21957           in: path
21958           description: String that identifies the interface
21959           required: true
21960           type: string
21961           example: __VLAN-INTERFACE__
21962         - name: body
21963           in: body
21964           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
21965           required: true
21966           schema:
21967             $ref: "#/definitions/relationship"
21968     delete:
21969       tags:
21970         - Network
21971       summary: delete an existing relationship
21972       description: delete an existing relationship
21973       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
21974       consumes:
21975         - application/json
21976         - application/xml
21977       produces:
21978         - application/json
21979         - application/xml
21980       responses:
21981         "default":
21982           description: Response codes found in [response codes](https://wiki.onap.org/).
21983       parameters:
21984         - name: equipment-name
21985           in: path
21986           required: true
21987           type: string
21988           example: __EQUIPMENT-NAME__
21989         - name: interface-name
21990           in: path
21991           description: Name that identifies the physical interface
21992           required: true
21993           type: string
21994           example: __INTERFACE-NAME__
21995         - name: interface-name
21996           in: path
21997           description: Name given to the interface
21998           required: true
21999           type: string
22000           example: __INTERFACE-NAME__
22001         - name: vlan-interface
22002           in: path
22003           description: String that identifies the interface
22004           required: true
22005           type: string
22006           example: __VLAN-INTERFACE__
22007   /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:
22008     put:
22009       tags:
22010         - Network
22011       summary: see node definition for valid relationships
22012       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22013       consumes:
22014         - application/json
22015         - application/xml
22016       produces:
22017         - application/json
22018         - application/xml
22019       responses:
22020         "default":
22021           description: Response codes found in [response codes](https://wiki.onap.org/).
22022       parameters:
22023         - name: equipment-name
22024           in: path
22025           required: true
22026           type: string
22027           example: __EQUIPMENT-NAME__
22028         - name: interface-name
22029           in: path
22030           description: Name that identifies the physical interface
22031           required: true
22032           type: string
22033           example: __INTERFACE-NAME__
22034         - name: interface-name
22035           in: path
22036           description: Name given to the interface
22037           required: true
22038           type: string
22039           example: __INTERFACE-NAME__
22040         - name: vlan-interface
22041           in: path
22042           description: String that identifies the interface
22043           required: true
22044           type: string
22045           example: __VLAN-INTERFACE__
22046         - name: l3-interface-ipv4-address
22047           in: path
22048           description: IP address
22049           required: true
22050           type: string
22051           example: __L3-INTERFACE-IPV4-ADDRESS__
22052         - name: body
22053           in: body
22054           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22055           required: true
22056           schema:
22057             $ref: "#/definitions/relationship"
22058     delete:
22059       tags:
22060         - Network
22061       summary: delete an existing relationship
22062       description: delete an existing relationship
22063       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
22064       consumes:
22065         - application/json
22066         - application/xml
22067       produces:
22068         - application/json
22069         - application/xml
22070       responses:
22071         "default":
22072           description: Response codes found in [response codes](https://wiki.onap.org/).
22073       parameters:
22074         - name: equipment-name
22075           in: path
22076           required: true
22077           type: string
22078           example: __EQUIPMENT-NAME__
22079         - name: interface-name
22080           in: path
22081           description: Name that identifies the physical interface
22082           required: true
22083           type: string
22084           example: __INTERFACE-NAME__
22085         - name: interface-name
22086           in: path
22087           description: Name given to the interface
22088           required: true
22089           type: string
22090           example: __INTERFACE-NAME__
22091         - name: vlan-interface
22092           in: path
22093           description: String that identifies the interface
22094           required: true
22095           type: string
22096           example: __VLAN-INTERFACE__
22097         - name: l3-interface-ipv4-address
22098           in: path
22099           description: IP address
22100           required: true
22101           type: string
22102           example: __L3-INTERFACE-IPV4-ADDRESS__
22103   /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}:
22104     get:
22105       tags:
22106         - Network
22107       summary: returns l3-interface-ipv4-address-list
22108       description: returns l3-interface-ipv4-address-list
22109       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22110       produces:
22111         - application/json
22112         - application/xml
22113       responses:
22114         "200":
22115           description: successful operation
22116           schema:
22117               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
22118         "default":
22119           description: Response codes found in [response codes](https://wiki.onap.org/).
22120       parameters:
22121         - name: equipment-name
22122           in: path
22123           required: true
22124           type: string
22125           example: __EQUIPMENT-NAME__
22126         - name: interface-name
22127           in: path
22128           description: Name that identifies the physical interface
22129           required: true
22130           type: string
22131           example: __INTERFACE-NAME__
22132         - name: interface-name
22133           in: path
22134           description: Name given to the interface
22135           required: true
22136           type: string
22137           example: __INTERFACE-NAME__
22138         - name: vlan-interface
22139           in: path
22140           description: String that identifies the interface
22141           required: true
22142           type: string
22143           example: __VLAN-INTERFACE__
22144         - name: l3-interface-ipv4-address
22145           in: path
22146           description: IP address
22147           required: true
22148           type: string
22149           example: __L3-INTERFACE-IPV4-ADDRESS__
22150         - name: prov-status
22151           in: query
22152           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22153           required: false
22154           type: string
22155         - name: prov-status
22156           in: query
22157           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22158           required: false
22159           type: string
22160         - name: interface-id
22161           in: query
22162           description: ID of interface
22163           required: false
22164           type: string
22165         - name: macaddr
22166           in: query
22167           description: MAC address for the interface
22168           required: false
22169           type: string
22170         - name: network-name
22171           in: query
22172           description: Name of the network
22173           required: false
22174           type: string
22175         - name: vlan-id-inner
22176           in: query
22177           description: Inner VLAN tag
22178           required: false
22179           type: integer
22180           format: int64
22181         - name: vpn-id
22182           in: query
22183           description: This indicates the customers VPN ID associated with this vlan
22184           required: false
22185           type: string
22186         - name: vlan-id-inner
22187           in: query
22188           description: Inner VLAN tag
22189           required: false
22190           type: integer
22191           format: int64
22192         - name: neutron-network-id
22193           in: query
22194           description: Neutron network id of the interface that address belongs to
22195           required: false
22196           type: string
22197         - name: neutron-subnet-id
22198           in: query
22199           description: Neutron id of subnet that address belongs to
22200           required: false
22201           type: string
22202     put:
22203       tags:
22204         - Network
22205       summary: create or update an existing l3-interface-ipv4-address-list
22206       description: |
22207         Create or update an existing l3-interface-ipv4-address-list.
22208         #
22209         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22210       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22211       consumes:
22212         - application/json
22213         - application/xml
22214       produces:
22215         - application/json
22216         - application/xml
22217       responses:
22218         "default":
22219           description: Response codes found in [response codes](https://wiki.onap.org/).
22220       parameters:
22221         - name: equipment-name
22222           in: path
22223           required: true
22224           type: string
22225           example: __EQUIPMENT-NAME__
22226         - name: interface-name
22227           in: path
22228           description: Name that identifies the physical interface
22229           required: true
22230           type: string
22231           example: __INTERFACE-NAME__
22232         - name: interface-name
22233           in: path
22234           description: Name given to the interface
22235           required: true
22236           type: string
22237           example: __INTERFACE-NAME__
22238         - name: vlan-interface
22239           in: path
22240           description: String that identifies the interface
22241           required: true
22242           type: string
22243           example: __VLAN-INTERFACE__
22244         - name: l3-interface-ipv4-address
22245           in: path
22246           description: IP address
22247           required: true
22248           type: string
22249           example: __L3-INTERFACE-IPV4-ADDRESS__
22250         - name: body
22251           in: body
22252           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
22253           required: true
22254           schema:
22255             $ref: "#/definitions/l3-interface-ipv4-address-list"
22256     patch:
22257       tags:
22258         - Network
22259       summary: update an existing l3-interface-ipv4-address-list
22260       description: |
22261         Update an existing l3-interface-ipv4-address-list
22262         #
22263         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22264         The PUT operation will entirely replace an existing object.
22265         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22266         #
22267         Other differences between PUT and PATCH are:
22268         #
22269         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22270         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22271         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22272       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22273       consumes:
22274         - application/json
22275         - application/xml
22276       produces:
22277         - application/json
22278         - application/xml
22279       responses:
22280         "default":
22281           description: Response codes found in [response codes](https://wiki.onap.org/).
22282       parameters:
22283         - name: equipment-name
22284           in: path
22285           required: true
22286           type: string
22287           example: __EQUIPMENT-NAME__
22288         - name: interface-name
22289           in: path
22290           description: Name that identifies the physical interface
22291           required: true
22292           type: string
22293           example: __INTERFACE-NAME__
22294         - name: interface-name
22295           in: path
22296           description: Name given to the interface
22297           required: true
22298           type: string
22299           example: __INTERFACE-NAME__
22300         - name: vlan-interface
22301           in: path
22302           description: String that identifies the interface
22303           required: true
22304           type: string
22305           example: __VLAN-INTERFACE__
22306         - name: l3-interface-ipv4-address
22307           in: path
22308           description: IP address
22309           required: true
22310           type: string
22311           example: __L3-INTERFACE-IPV4-ADDRESS__
22312         - name: body
22313           in: body
22314           description: l3-interface-ipv4-address-list object that needs to be created or updated.
22315           required: true
22316           schema:
22317             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
22318     delete:
22319       tags:
22320         - Network
22321       summary: delete an existing l3-interface-ipv4-address-list
22322       description: delete an existing l3-interface-ipv4-address-list
22323       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
22324       consumes:
22325         - application/json
22326         - application/xml
22327       produces:
22328         - application/json
22329         - application/xml
22330       responses:
22331         "default":
22332           description: Response codes found in [response codes](https://wiki.onap.org/).
22333       parameters:
22334         - name: equipment-name
22335           in: path
22336           required: true
22337           type: string
22338           example: __EQUIPMENT-NAME__
22339         - name: interface-name
22340           in: path
22341           description: Name that identifies the physical interface
22342           required: true
22343           type: string
22344           example: __INTERFACE-NAME__
22345         - name: interface-name
22346           in: path
22347           description: Name given to the interface
22348           required: true
22349           type: string
22350           example: __INTERFACE-NAME__
22351         - name: vlan-interface
22352           in: path
22353           description: String that identifies the interface
22354           required: true
22355           type: string
22356           example: __VLAN-INTERFACE__
22357         - name: l3-interface-ipv4-address
22358           in: path
22359           description: IP address
22360           required: true
22361           type: string
22362           example: __L3-INTERFACE-IPV4-ADDRESS__
22363         - name: resource-version
22364           in: query
22365           description: resource-version for concurrency
22366           required: true
22367           type: string
22368   /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:
22369     put:
22370       tags:
22371         - Network
22372       summary: see node definition for valid relationships
22373       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22374       consumes:
22375         - application/json
22376         - application/xml
22377       produces:
22378         - application/json
22379         - application/xml
22380       responses:
22381         "default":
22382           description: Response codes found in [response codes](https://wiki.onap.org/).
22383       parameters:
22384         - name: equipment-name
22385           in: path
22386           required: true
22387           type: string
22388           example: __EQUIPMENT-NAME__
22389         - name: interface-name
22390           in: path
22391           description: Name that identifies the physical interface
22392           required: true
22393           type: string
22394           example: __INTERFACE-NAME__
22395         - name: interface-name
22396           in: path
22397           description: Name given to the interface
22398           required: true
22399           type: string
22400           example: __INTERFACE-NAME__
22401         - name: vlan-interface
22402           in: path
22403           description: String that identifies the interface
22404           required: true
22405           type: string
22406           example: __VLAN-INTERFACE__
22407         - name: l3-interface-ipv6-address
22408           in: path
22409           description: IP address
22410           required: true
22411           type: string
22412           example: __L3-INTERFACE-IPV6-ADDRESS__
22413         - name: body
22414           in: body
22415           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22416           required: true
22417           schema:
22418             $ref: "#/definitions/relationship"
22419     delete:
22420       tags:
22421         - Network
22422       summary: delete an existing relationship
22423       description: delete an existing relationship
22424       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
22425       consumes:
22426         - application/json
22427         - application/xml
22428       produces:
22429         - application/json
22430         - application/xml
22431       responses:
22432         "default":
22433           description: Response codes found in [response codes](https://wiki.onap.org/).
22434       parameters:
22435         - name: equipment-name
22436           in: path
22437           required: true
22438           type: string
22439           example: __EQUIPMENT-NAME__
22440         - name: interface-name
22441           in: path
22442           description: Name that identifies the physical interface
22443           required: true
22444           type: string
22445           example: __INTERFACE-NAME__
22446         - name: interface-name
22447           in: path
22448           description: Name given to the interface
22449           required: true
22450           type: string
22451           example: __INTERFACE-NAME__
22452         - name: vlan-interface
22453           in: path
22454           description: String that identifies the interface
22455           required: true
22456           type: string
22457           example: __VLAN-INTERFACE__
22458         - name: l3-interface-ipv6-address
22459           in: path
22460           description: IP address
22461           required: true
22462           type: string
22463           example: __L3-INTERFACE-IPV6-ADDRESS__
22464   /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}:
22465     get:
22466       tags:
22467         - Network
22468       summary: returns l3-interface-ipv6-address-list
22469       description: returns l3-interface-ipv6-address-list
22470       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22471       produces:
22472         - application/json
22473         - application/xml
22474       responses:
22475         "200":
22476           description: successful operation
22477           schema:
22478               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
22479         "default":
22480           description: Response codes found in [response codes](https://wiki.onap.org/).
22481       parameters:
22482         - name: equipment-name
22483           in: path
22484           required: true
22485           type: string
22486           example: __EQUIPMENT-NAME__
22487         - name: interface-name
22488           in: path
22489           description: Name that identifies the physical interface
22490           required: true
22491           type: string
22492           example: __INTERFACE-NAME__
22493         - name: interface-name
22494           in: path
22495           description: Name given to the interface
22496           required: true
22497           type: string
22498           example: __INTERFACE-NAME__
22499         - name: vlan-interface
22500           in: path
22501           description: String that identifies the interface
22502           required: true
22503           type: string
22504           example: __VLAN-INTERFACE__
22505         - name: l3-interface-ipv6-address
22506           in: path
22507           description: IP address
22508           required: true
22509           type: string
22510           example: __L3-INTERFACE-IPV6-ADDRESS__
22511         - name: prov-status
22512           in: query
22513           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22514           required: false
22515           type: string
22516         - name: prov-status
22517           in: query
22518           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22519           required: false
22520           type: string
22521         - name: interface-id
22522           in: query
22523           description: ID of interface
22524           required: false
22525           type: string
22526         - name: macaddr
22527           in: query
22528           description: MAC address for the interface
22529           required: false
22530           type: string
22531         - name: network-name
22532           in: query
22533           description: Name of the network
22534           required: false
22535           type: string
22536         - name: vlan-id-inner
22537           in: query
22538           description: Inner VLAN tag
22539           required: false
22540           type: integer
22541           format: int64
22542         - name: vpn-id
22543           in: query
22544           description: This indicates the customers VPN ID associated with this vlan
22545           required: false
22546           type: string
22547         - name: vlan-id-inner
22548           in: query
22549           description: Inner VLAN tag
22550           required: false
22551           type: integer
22552           format: int64
22553         - name: neutron-network-id
22554           in: query
22555           description: Neutron network id of the interface that address belongs to
22556           required: false
22557           type: string
22558         - name: neutron-subnet-id
22559           in: query
22560           description: Neutron id of subnet that address belongs to
22561           required: false
22562           type: string
22563     put:
22564       tags:
22565         - Network
22566       summary: create or update an existing l3-interface-ipv6-address-list
22567       description: |
22568         Create or update an existing l3-interface-ipv6-address-list.
22569         #
22570         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22571       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22572       consumes:
22573         - application/json
22574         - application/xml
22575       produces:
22576         - application/json
22577         - application/xml
22578       responses:
22579         "default":
22580           description: Response codes found in [response codes](https://wiki.onap.org/).
22581       parameters:
22582         - name: equipment-name
22583           in: path
22584           required: true
22585           type: string
22586           example: __EQUIPMENT-NAME__
22587         - name: interface-name
22588           in: path
22589           description: Name that identifies the physical interface
22590           required: true
22591           type: string
22592           example: __INTERFACE-NAME__
22593         - name: interface-name
22594           in: path
22595           description: Name given to the interface
22596           required: true
22597           type: string
22598           example: __INTERFACE-NAME__
22599         - name: vlan-interface
22600           in: path
22601           description: String that identifies the interface
22602           required: true
22603           type: string
22604           example: __VLAN-INTERFACE__
22605         - name: l3-interface-ipv6-address
22606           in: path
22607           description: IP address
22608           required: true
22609           type: string
22610           example: __L3-INTERFACE-IPV6-ADDRESS__
22611         - name: body
22612           in: body
22613           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
22614           required: true
22615           schema:
22616             $ref: "#/definitions/l3-interface-ipv6-address-list"
22617     patch:
22618       tags:
22619         - Network
22620       summary: update an existing l3-interface-ipv6-address-list
22621       description: |
22622         Update an existing l3-interface-ipv6-address-list
22623         #
22624         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22625         The PUT operation will entirely replace an existing object.
22626         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22627         #
22628         Other differences between PUT and PATCH are:
22629         #
22630         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22631         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22632         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22633       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22634       consumes:
22635         - application/json
22636         - application/xml
22637       produces:
22638         - application/json
22639         - application/xml
22640       responses:
22641         "default":
22642           description: Response codes found in [response codes](https://wiki.onap.org/).
22643       parameters:
22644         - name: equipment-name
22645           in: path
22646           required: true
22647           type: string
22648           example: __EQUIPMENT-NAME__
22649         - name: interface-name
22650           in: path
22651           description: Name that identifies the physical interface
22652           required: true
22653           type: string
22654           example: __INTERFACE-NAME__
22655         - name: interface-name
22656           in: path
22657           description: Name given to the interface
22658           required: true
22659           type: string
22660           example: __INTERFACE-NAME__
22661         - name: vlan-interface
22662           in: path
22663           description: String that identifies the interface
22664           required: true
22665           type: string
22666           example: __VLAN-INTERFACE__
22667         - name: l3-interface-ipv6-address
22668           in: path
22669           description: IP address
22670           required: true
22671           type: string
22672           example: __L3-INTERFACE-IPV6-ADDRESS__
22673         - name: body
22674           in: body
22675           description: l3-interface-ipv6-address-list object that needs to be created or updated.
22676           required: true
22677           schema:
22678             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
22679     delete:
22680       tags:
22681         - Network
22682       summary: delete an existing l3-interface-ipv6-address-list
22683       description: delete an existing l3-interface-ipv6-address-list
22684       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
22685       consumes:
22686         - application/json
22687         - application/xml
22688       produces:
22689         - application/json
22690         - application/xml
22691       responses:
22692         "default":
22693           description: Response codes found in [response codes](https://wiki.onap.org/).
22694       parameters:
22695         - name: equipment-name
22696           in: path
22697           required: true
22698           type: string
22699           example: __EQUIPMENT-NAME__
22700         - name: interface-name
22701           in: path
22702           description: Name that identifies the physical interface
22703           required: true
22704           type: string
22705           example: __INTERFACE-NAME__
22706         - name: interface-name
22707           in: path
22708           description: Name given to the interface
22709           required: true
22710           type: string
22711           example: __INTERFACE-NAME__
22712         - name: vlan-interface
22713           in: path
22714           description: String that identifies the interface
22715           required: true
22716           type: string
22717           example: __VLAN-INTERFACE__
22718         - name: l3-interface-ipv6-address
22719           in: path
22720           description: IP address
22721           required: true
22722           type: string
22723           example: __L3-INTERFACE-IPV6-ADDRESS__
22724         - name: resource-version
22725           in: query
22726           description: resource-version for concurrency
22727           required: true
22728           type: string
22729   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
22730     get:
22731       tags:
22732         - Network
22733       summary: returns vlan
22734       description: returns vlan
22735       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22736       produces:
22737         - application/json
22738         - application/xml
22739       responses:
22740         "200":
22741           description: successful operation
22742           schema:
22743               $ref: "#/getDefinitions/vlan"
22744         "default":
22745           description: Response codes found in [response codes](https://wiki.onap.org/).
22746       parameters:
22747         - name: equipment-name
22748           in: path
22749           required: true
22750           type: string
22751           example: __EQUIPMENT-NAME__
22752         - name: interface-name
22753           in: path
22754           description: Name that identifies the physical interface
22755           required: true
22756           type: string
22757           example: __INTERFACE-NAME__
22758         - name: interface-name
22759           in: path
22760           description: Name given to the interface
22761           required: true
22762           type: string
22763           example: __INTERFACE-NAME__
22764         - name: vlan-interface
22765           in: path
22766           description: String that identifies the interface
22767           required: true
22768           type: string
22769           example: __VLAN-INTERFACE__
22770         - name: prov-status
22771           in: query
22772           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22773           required: false
22774           type: string
22775         - name: prov-status
22776           in: query
22777           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22778           required: false
22779           type: string
22780         - name: interface-id
22781           in: query
22782           description: ID of interface
22783           required: false
22784           type: string
22785         - name: macaddr
22786           in: query
22787           description: MAC address for the interface
22788           required: false
22789           type: string
22790         - name: network-name
22791           in: query
22792           description: Name of the network
22793           required: false
22794           type: string
22795         - name: vlan-id-inner
22796           in: query
22797           description: Inner VLAN tag
22798           required: false
22799           type: integer
22800           format: int64
22801         - name: vpn-id
22802           in: query
22803           description: This indicates the customers VPN ID associated with this vlan
22804           required: false
22805           type: string
22806     put:
22807       tags:
22808         - Network
22809       summary: create or update an existing vlan
22810       description: |
22811         Create or update an existing vlan.
22812         #
22813         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22814       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22815       consumes:
22816         - application/json
22817         - application/xml
22818       produces:
22819         - application/json
22820         - application/xml
22821       responses:
22822         "default":
22823           description: Response codes found in [response codes](https://wiki.onap.org/).
22824       parameters:
22825         - name: equipment-name
22826           in: path
22827           required: true
22828           type: string
22829           example: __EQUIPMENT-NAME__
22830         - name: interface-name
22831           in: path
22832           description: Name that identifies the physical interface
22833           required: true
22834           type: string
22835           example: __INTERFACE-NAME__
22836         - name: interface-name
22837           in: path
22838           description: Name given to the interface
22839           required: true
22840           type: string
22841           example: __INTERFACE-NAME__
22842         - name: vlan-interface
22843           in: path
22844           description: String that identifies the interface
22845           required: true
22846           type: string
22847           example: __VLAN-INTERFACE__
22848         - name: body
22849           in: body
22850           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
22851           required: true
22852           schema:
22853             $ref: "#/definitions/vlan"
22854     patch:
22855       tags:
22856         - Network
22857       summary: update an existing vlan
22858       description: |
22859         Update an existing vlan
22860         #
22861         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22862         The PUT operation will entirely replace an existing object.
22863         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22864         #
22865         Other differences between PUT and PATCH are:
22866         #
22867         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22868         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22869         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22870       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22871       consumes:
22872         - application/json
22873         - application/xml
22874       produces:
22875         - application/json
22876         - application/xml
22877       responses:
22878         "default":
22879           description: Response codes found in [response codes](https://wiki.onap.org/).
22880       parameters:
22881         - name: equipment-name
22882           in: path
22883           required: true
22884           type: string
22885           example: __EQUIPMENT-NAME__
22886         - name: interface-name
22887           in: path
22888           description: Name that identifies the physical interface
22889           required: true
22890           type: string
22891           example: __INTERFACE-NAME__
22892         - name: interface-name
22893           in: path
22894           description: Name given to the interface
22895           required: true
22896           type: string
22897           example: __INTERFACE-NAME__
22898         - name: vlan-interface
22899           in: path
22900           description: String that identifies the interface
22901           required: true
22902           type: string
22903           example: __VLAN-INTERFACE__
22904         - name: body
22905           in: body
22906           description: vlan object that needs to be created or updated.
22907           required: true
22908           schema:
22909             $ref: "#/patchDefinitions/vlan"
22910     delete:
22911       tags:
22912         - Network
22913       summary: delete an existing vlan
22914       description: delete an existing vlan
22915       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
22916       consumes:
22917         - application/json
22918         - application/xml
22919       produces:
22920         - application/json
22921         - application/xml
22922       responses:
22923         "default":
22924           description: Response codes found in [response codes](https://wiki.onap.org/).
22925       parameters:
22926         - name: equipment-name
22927           in: path
22928           required: true
22929           type: string
22930           example: __EQUIPMENT-NAME__
22931         - name: interface-name
22932           in: path
22933           description: Name that identifies the physical interface
22934           required: true
22935           type: string
22936           example: __INTERFACE-NAME__
22937         - name: interface-name
22938           in: path
22939           description: Name given to the interface
22940           required: true
22941           type: string
22942           example: __INTERFACE-NAME__
22943         - name: vlan-interface
22944           in: path
22945           description: String that identifies the interface
22946           required: true
22947           type: string
22948           example: __VLAN-INTERFACE__
22949         - name: resource-version
22950           in: query
22951           description: resource-version for concurrency
22952           required: true
22953           type: string
22954   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
22955     get:
22956       tags:
22957         - Network
22958       summary: returns vlans
22959       description: returns vlans
22960       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
22961       produces:
22962         - application/json
22963         - application/xml
22964       responses:
22965         "200":
22966           description: successful operation
22967           schema:
22968               $ref: "#/getDefinitions/vlans"
22969         "default":
22970           description: Response codes found in [response codes](https://wiki.onap.org/).
22971       parameters:
22972         - name: equipment-name
22973           in: path
22974           required: true
22975           type: string
22976           example: __EQUIPMENT-NAME__
22977         - name: interface-name
22978           in: path
22979           description: Name that identifies the physical interface
22980           required: true
22981           type: string
22982           example: __INTERFACE-NAME__
22983         - name: interface-name
22984           in: path
22985           description: Name given to the interface
22986           required: true
22987           type: string
22988           example: __INTERFACE-NAME__
22989         - name: prov-status
22990           in: query
22991           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22992           required: false
22993           type: string
22994         - name: prov-status
22995           in: query
22996           description: Trigger for operational monitoring of this resource by Service Assurance systems.
22997           required: false
22998           type: string
22999         - name: interface-id
23000           in: query
23001           description: ID of interface
23002           required: false
23003           type: string
23004         - name: macaddr
23005           in: query
23006           description: MAC address for the interface
23007           required: false
23008           type: string
23009         - name: network-name
23010           in: query
23011           description: Name of the network
23012           required: false
23013           type: string
23014   /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:
23015     put:
23016       tags:
23017         - Network
23018       summary: see node definition for valid relationships
23019       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23020       consumes:
23021         - application/json
23022         - application/xml
23023       produces:
23024         - application/json
23025         - application/xml
23026       responses:
23027         "default":
23028           description: Response codes found in [response codes](https://wiki.onap.org/).
23029       parameters:
23030         - name: equipment-name
23031           in: path
23032           required: true
23033           type: string
23034           example: __EQUIPMENT-NAME__
23035         - name: interface-name
23036           in: path
23037           description: Name that identifies the physical interface
23038           required: true
23039           type: string
23040           example: __INTERFACE-NAME__
23041         - name: interface-name
23042           in: path
23043           description: Name given to the interface
23044           required: true
23045           type: string
23046           example: __INTERFACE-NAME__
23047         - name: pci-id
23048           in: path
23049           description: PCI ID used to identify the sriov-vf
23050           required: true
23051           type: string
23052           example: __PCI-ID__
23053         - name: body
23054           in: body
23055           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23056           required: true
23057           schema:
23058             $ref: "#/definitions/relationship"
23059     delete:
23060       tags:
23061         - Network
23062       summary: delete an existing relationship
23063       description: delete an existing relationship
23064       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
23065       consumes:
23066         - application/json
23067         - application/xml
23068       produces:
23069         - application/json
23070         - application/xml
23071       responses:
23072         "default":
23073           description: Response codes found in [response codes](https://wiki.onap.org/).
23074       parameters:
23075         - name: equipment-name
23076           in: path
23077           required: true
23078           type: string
23079           example: __EQUIPMENT-NAME__
23080         - name: interface-name
23081           in: path
23082           description: Name that identifies the physical interface
23083           required: true
23084           type: string
23085           example: __INTERFACE-NAME__
23086         - name: interface-name
23087           in: path
23088           description: Name given to the interface
23089           required: true
23090           type: string
23091           example: __INTERFACE-NAME__
23092         - name: pci-id
23093           in: path
23094           description: PCI ID used to identify the sriov-vf
23095           required: true
23096           type: string
23097           example: __PCI-ID__
23098   /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}:
23099     get:
23100       tags:
23101         - Network
23102       summary: returns sriov-vf
23103       description: returns sriov-vf
23104       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23105       produces:
23106         - application/json
23107         - application/xml
23108       responses:
23109         "200":
23110           description: successful operation
23111           schema:
23112               $ref: "#/getDefinitions/sriov-vf"
23113         "default":
23114           description: Response codes found in [response codes](https://wiki.onap.org/).
23115       parameters:
23116         - name: equipment-name
23117           in: path
23118           required: true
23119           type: string
23120           example: __EQUIPMENT-NAME__
23121         - name: interface-name
23122           in: path
23123           description: Name that identifies the physical interface
23124           required: true
23125           type: string
23126           example: __INTERFACE-NAME__
23127         - name: interface-name
23128           in: path
23129           description: Name given to the interface
23130           required: true
23131           type: string
23132           example: __INTERFACE-NAME__
23133         - name: pci-id
23134           in: path
23135           description: PCI ID used to identify the sriov-vf
23136           required: true
23137           type: string
23138           example: __PCI-ID__
23139         - name: prov-status
23140           in: query
23141           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23142           required: false
23143           type: string
23144         - name: prov-status
23145           in: query
23146           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23147           required: false
23148           type: string
23149         - name: interface-id
23150           in: query
23151           description: ID of interface
23152           required: false
23153           type: string
23154         - name: macaddr
23155           in: query
23156           description: MAC address for the interface
23157           required: false
23158           type: string
23159         - name: network-name
23160           in: query
23161           description: Name of the network
23162           required: false
23163           type: string
23164         - name: vf-vlan-filter
23165           in: query
23166           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
23167           required: false
23168           type: string
23169         - name: vf-mac-filter
23170           in: query
23171           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
23172           required: false
23173           type: string
23174         - name: vf-vlan-strip
23175           in: query
23176           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
23177           required: false
23178           type: boolean
23179         - name: neutron-network-id
23180           in: query
23181           description: Neutron network id of the interface
23182           required: false
23183           type: string
23184     put:
23185       tags:
23186         - Network
23187       summary: create or update an existing sriov-vf
23188       description: |
23189         Create or update an existing sriov-vf.
23190         #
23191         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23192       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23193       consumes:
23194         - application/json
23195         - application/xml
23196       produces:
23197         - application/json
23198         - application/xml
23199       responses:
23200         "default":
23201           description: Response codes found in [response codes](https://wiki.onap.org/).
23202       parameters:
23203         - name: equipment-name
23204           in: path
23205           required: true
23206           type: string
23207           example: __EQUIPMENT-NAME__
23208         - name: interface-name
23209           in: path
23210           description: Name that identifies the physical interface
23211           required: true
23212           type: string
23213           example: __INTERFACE-NAME__
23214         - name: interface-name
23215           in: path
23216           description: Name given to the interface
23217           required: true
23218           type: string
23219           example: __INTERFACE-NAME__
23220         - name: pci-id
23221           in: path
23222           description: PCI ID used to identify the sriov-vf
23223           required: true
23224           type: string
23225           example: __PCI-ID__
23226         - name: body
23227           in: body
23228           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
23229           required: true
23230           schema:
23231             $ref: "#/definitions/sriov-vf"
23232     patch:
23233       tags:
23234         - Network
23235       summary: update an existing sriov-vf
23236       description: |
23237         Update an existing sriov-vf
23238         #
23239         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23240         The PUT operation will entirely replace an existing object.
23241         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23242         #
23243         Other differences between PUT and PATCH are:
23244         #
23245         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23246         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23247         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23248       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23249       consumes:
23250         - application/json
23251         - application/xml
23252       produces:
23253         - application/json
23254         - application/xml
23255       responses:
23256         "default":
23257           description: Response codes found in [response codes](https://wiki.onap.org/).
23258       parameters:
23259         - name: equipment-name
23260           in: path
23261           required: true
23262           type: string
23263           example: __EQUIPMENT-NAME__
23264         - name: interface-name
23265           in: path
23266           description: Name that identifies the physical interface
23267           required: true
23268           type: string
23269           example: __INTERFACE-NAME__
23270         - name: interface-name
23271           in: path
23272           description: Name given to the interface
23273           required: true
23274           type: string
23275           example: __INTERFACE-NAME__
23276         - name: pci-id
23277           in: path
23278           description: PCI ID used to identify the sriov-vf
23279           required: true
23280           type: string
23281           example: __PCI-ID__
23282         - name: body
23283           in: body
23284           description: sriov-vf object that needs to be created or updated.
23285           required: true
23286           schema:
23287             $ref: "#/patchDefinitions/sriov-vf"
23288     delete:
23289       tags:
23290         - Network
23291       summary: delete an existing sriov-vf
23292       description: delete an existing sriov-vf
23293       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
23294       consumes:
23295         - application/json
23296         - application/xml
23297       produces:
23298         - application/json
23299         - application/xml
23300       responses:
23301         "default":
23302           description: Response codes found in [response codes](https://wiki.onap.org/).
23303       parameters:
23304         - name: equipment-name
23305           in: path
23306           required: true
23307           type: string
23308           example: __EQUIPMENT-NAME__
23309         - name: interface-name
23310           in: path
23311           description: Name that identifies the physical interface
23312           required: true
23313           type: string
23314           example: __INTERFACE-NAME__
23315         - name: interface-name
23316           in: path
23317           description: Name given to the interface
23318           required: true
23319           type: string
23320           example: __INTERFACE-NAME__
23321         - name: pci-id
23322           in: path
23323           description: PCI ID used to identify the sriov-vf
23324           required: true
23325           type: string
23326           example: __PCI-ID__
23327         - name: resource-version
23328           in: query
23329           description: resource-version for concurrency
23330           required: true
23331           type: string
23332   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
23333     get:
23334       tags:
23335         - Network
23336       summary: returns sriov-vfs
23337       description: returns sriov-vfs
23338       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
23339       produces:
23340         - application/json
23341         - application/xml
23342       responses:
23343         "200":
23344           description: successful operation
23345           schema:
23346               $ref: "#/getDefinitions/sriov-vfs"
23347         "default":
23348           description: Response codes found in [response codes](https://wiki.onap.org/).
23349       parameters:
23350         - name: equipment-name
23351           in: path
23352           required: true
23353           type: string
23354           example: __EQUIPMENT-NAME__
23355         - name: interface-name
23356           in: path
23357           description: Name that identifies the physical interface
23358           required: true
23359           type: string
23360           example: __INTERFACE-NAME__
23361         - name: interface-name
23362           in: path
23363           description: Name given to the interface
23364           required: true
23365           type: string
23366           example: __INTERFACE-NAME__
23367         - name: prov-status
23368           in: query
23369           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23370           required: false
23371           type: string
23372         - name: prov-status
23373           in: query
23374           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23375           required: false
23376           type: string
23377         - name: interface-id
23378           in: query
23379           description: ID of interface
23380           required: false
23381           type: string
23382         - name: macaddr
23383           in: query
23384           description: MAC address for the interface
23385           required: false
23386           type: string
23387         - name: network-name
23388           in: query
23389           description: Name of the network
23390           required: false
23391           type: string
23392   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
23393     put:
23394       tags:
23395         - Network
23396       summary: see node definition for valid relationships
23397       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23398       consumes:
23399         - application/json
23400         - application/xml
23401       produces:
23402         - application/json
23403         - application/xml
23404       responses:
23405         "default":
23406           description: Response codes found in [response codes](https://wiki.onap.org/).
23407       parameters:
23408         - name: equipment-name
23409           in: path
23410           required: true
23411           type: string
23412           example: __EQUIPMENT-NAME__
23413         - name: interface-name
23414           in: path
23415           description: Name that identifies the physical interface
23416           required: true
23417           type: string
23418           example: __INTERFACE-NAME__
23419         - name: interface-name
23420           in: path
23421           description: Name given to the interface
23422           required: true
23423           type: string
23424           example: __INTERFACE-NAME__
23425         - name: body
23426           in: body
23427           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
23428           required: true
23429           schema:
23430             $ref: "#/definitions/relationship"
23431     delete:
23432       tags:
23433         - Network
23434       summary: delete an existing relationship
23435       description: delete an existing relationship
23436       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
23437       consumes:
23438         - application/json
23439         - application/xml
23440       produces:
23441         - application/json
23442         - application/xml
23443       responses:
23444         "default":
23445           description: Response codes found in [response codes](https://wiki.onap.org/).
23446       parameters:
23447         - name: equipment-name
23448           in: path
23449           required: true
23450           type: string
23451           example: __EQUIPMENT-NAME__
23452         - name: interface-name
23453           in: path
23454           description: Name that identifies the physical interface
23455           required: true
23456           type: string
23457           example: __INTERFACE-NAME__
23458         - name: interface-name
23459           in: path
23460           description: Name given to the interface
23461           required: true
23462           type: string
23463           example: __INTERFACE-NAME__
23464   /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:
23465     put:
23466       tags:
23467         - Network
23468       summary: see node definition for valid relationships
23469       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23470       consumes:
23471         - application/json
23472         - application/xml
23473       produces:
23474         - application/json
23475         - application/xml
23476       responses:
23477         "default":
23478           description: Response codes found in [response codes](https://wiki.onap.org/).
23479       parameters:
23480         - name: equipment-name
23481           in: path
23482           required: true
23483           type: string
23484           example: __EQUIPMENT-NAME__
23485         - name: interface-name
23486           in: path
23487           description: Name that identifies the physical interface
23488           required: true
23489           type: string
23490           example: __INTERFACE-NAME__
23491         - name: interface-name
23492           in: path
23493           description: Name given to the interface
23494           required: true
23495           type: string
23496           example: __INTERFACE-NAME__
23497         - name: l3-interface-ipv4-address
23498           in: path
23499           description: IP address
23500           required: true
23501           type: string
23502           example: __L3-INTERFACE-IPV4-ADDRESS__
23503         - name: body
23504           in: body
23505           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23506           required: true
23507           schema:
23508             $ref: "#/definitions/relationship"
23509     delete:
23510       tags:
23511         - Network
23512       summary: delete an existing relationship
23513       description: delete an existing relationship
23514       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
23515       consumes:
23516         - application/json
23517         - application/xml
23518       produces:
23519         - application/json
23520         - application/xml
23521       responses:
23522         "default":
23523           description: Response codes found in [response codes](https://wiki.onap.org/).
23524       parameters:
23525         - name: equipment-name
23526           in: path
23527           required: true
23528           type: string
23529           example: __EQUIPMENT-NAME__
23530         - name: interface-name
23531           in: path
23532           description: Name that identifies the physical interface
23533           required: true
23534           type: string
23535           example: __INTERFACE-NAME__
23536         - name: interface-name
23537           in: path
23538           description: Name given to the interface
23539           required: true
23540           type: string
23541           example: __INTERFACE-NAME__
23542         - name: l3-interface-ipv4-address
23543           in: path
23544           description: IP address
23545           required: true
23546           type: string
23547           example: __L3-INTERFACE-IPV4-ADDRESS__
23548   /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}:
23549     get:
23550       tags:
23551         - Network
23552       summary: returns l3-interface-ipv4-address-list
23553       description: returns l3-interface-ipv4-address-list
23554       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23555       produces:
23556         - application/json
23557         - application/xml
23558       responses:
23559         "200":
23560           description: successful operation
23561           schema:
23562               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
23563         "default":
23564           description: Response codes found in [response codes](https://wiki.onap.org/).
23565       parameters:
23566         - name: equipment-name
23567           in: path
23568           required: true
23569           type: string
23570           example: __EQUIPMENT-NAME__
23571         - name: interface-name
23572           in: path
23573           description: Name that identifies the physical interface
23574           required: true
23575           type: string
23576           example: __INTERFACE-NAME__
23577         - name: interface-name
23578           in: path
23579           description: Name given to the interface
23580           required: true
23581           type: string
23582           example: __INTERFACE-NAME__
23583         - name: l3-interface-ipv4-address
23584           in: path
23585           description: IP address
23586           required: true
23587           type: string
23588           example: __L3-INTERFACE-IPV4-ADDRESS__
23589         - name: prov-status
23590           in: query
23591           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23592           required: false
23593           type: string
23594         - name: prov-status
23595           in: query
23596           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23597           required: false
23598           type: string
23599         - name: interface-id
23600           in: query
23601           description: ID of interface
23602           required: false
23603           type: string
23604         - name: macaddr
23605           in: query
23606           description: MAC address for the interface
23607           required: false
23608           type: string
23609         - name: network-name
23610           in: query
23611           description: Name of the network
23612           required: false
23613           type: string
23614         - name: vlan-id-inner
23615           in: query
23616           description: Inner VLAN tag
23617           required: false
23618           type: integer
23619           format: int64
23620         - name: neutron-network-id
23621           in: query
23622           description: Neutron network id of the interface that address belongs to
23623           required: false
23624           type: string
23625         - name: neutron-subnet-id
23626           in: query
23627           description: Neutron id of subnet that address belongs to
23628           required: false
23629           type: string
23630     put:
23631       tags:
23632         - Network
23633       summary: create or update an existing l3-interface-ipv4-address-list
23634       description: |
23635         Create or update an existing l3-interface-ipv4-address-list.
23636         #
23637         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23638       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23639       consumes:
23640         - application/json
23641         - application/xml
23642       produces:
23643         - application/json
23644         - application/xml
23645       responses:
23646         "default":
23647           description: Response codes found in [response codes](https://wiki.onap.org/).
23648       parameters:
23649         - name: equipment-name
23650           in: path
23651           required: true
23652           type: string
23653           example: __EQUIPMENT-NAME__
23654         - name: interface-name
23655           in: path
23656           description: Name that identifies the physical interface
23657           required: true
23658           type: string
23659           example: __INTERFACE-NAME__
23660         - name: interface-name
23661           in: path
23662           description: Name given to the interface
23663           required: true
23664           type: string
23665           example: __INTERFACE-NAME__
23666         - name: l3-interface-ipv4-address
23667           in: path
23668           description: IP address
23669           required: true
23670           type: string
23671           example: __L3-INTERFACE-IPV4-ADDRESS__
23672         - name: body
23673           in: body
23674           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
23675           required: true
23676           schema:
23677             $ref: "#/definitions/l3-interface-ipv4-address-list"
23678     patch:
23679       tags:
23680         - Network
23681       summary: update an existing l3-interface-ipv4-address-list
23682       description: |
23683         Update an existing l3-interface-ipv4-address-list
23684         #
23685         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23686         The PUT operation will entirely replace an existing object.
23687         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23688         #
23689         Other differences between PUT and PATCH are:
23690         #
23691         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23692         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23693         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23694       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23695       consumes:
23696         - application/json
23697         - application/xml
23698       produces:
23699         - application/json
23700         - application/xml
23701       responses:
23702         "default":
23703           description: Response codes found in [response codes](https://wiki.onap.org/).
23704       parameters:
23705         - name: equipment-name
23706           in: path
23707           required: true
23708           type: string
23709           example: __EQUIPMENT-NAME__
23710         - name: interface-name
23711           in: path
23712           description: Name that identifies the physical interface
23713           required: true
23714           type: string
23715           example: __INTERFACE-NAME__
23716         - name: interface-name
23717           in: path
23718           description: Name given to the interface
23719           required: true
23720           type: string
23721           example: __INTERFACE-NAME__
23722         - name: l3-interface-ipv4-address
23723           in: path
23724           description: IP address
23725           required: true
23726           type: string
23727           example: __L3-INTERFACE-IPV4-ADDRESS__
23728         - name: body
23729           in: body
23730           description: l3-interface-ipv4-address-list object that needs to be created or updated.
23731           required: true
23732           schema:
23733             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
23734     delete:
23735       tags:
23736         - Network
23737       summary: delete an existing l3-interface-ipv4-address-list
23738       description: delete an existing l3-interface-ipv4-address-list
23739       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
23740       consumes:
23741         - application/json
23742         - application/xml
23743       produces:
23744         - application/json
23745         - application/xml
23746       responses:
23747         "default":
23748           description: Response codes found in [response codes](https://wiki.onap.org/).
23749       parameters:
23750         - name: equipment-name
23751           in: path
23752           required: true
23753           type: string
23754           example: __EQUIPMENT-NAME__
23755         - name: interface-name
23756           in: path
23757           description: Name that identifies the physical interface
23758           required: true
23759           type: string
23760           example: __INTERFACE-NAME__
23761         - name: interface-name
23762           in: path
23763           description: Name given to the interface
23764           required: true
23765           type: string
23766           example: __INTERFACE-NAME__
23767         - name: l3-interface-ipv4-address
23768           in: path
23769           description: IP address
23770           required: true
23771           type: string
23772           example: __L3-INTERFACE-IPV4-ADDRESS__
23773         - name: resource-version
23774           in: query
23775           description: resource-version for concurrency
23776           required: true
23777           type: string
23778   /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:
23779     put:
23780       tags:
23781         - Network
23782       summary: see node definition for valid relationships
23783       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23784       consumes:
23785         - application/json
23786         - application/xml
23787       produces:
23788         - application/json
23789         - application/xml
23790       responses:
23791         "default":
23792           description: Response codes found in [response codes](https://wiki.onap.org/).
23793       parameters:
23794         - name: equipment-name
23795           in: path
23796           required: true
23797           type: string
23798           example: __EQUIPMENT-NAME__
23799         - name: interface-name
23800           in: path
23801           description: Name that identifies the physical interface
23802           required: true
23803           type: string
23804           example: __INTERFACE-NAME__
23805         - name: interface-name
23806           in: path
23807           description: Name given to the interface
23808           required: true
23809           type: string
23810           example: __INTERFACE-NAME__
23811         - name: l3-interface-ipv6-address
23812           in: path
23813           description: IP address
23814           required: true
23815           type: string
23816           example: __L3-INTERFACE-IPV6-ADDRESS__
23817         - name: body
23818           in: body
23819           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23820           required: true
23821           schema:
23822             $ref: "#/definitions/relationship"
23823     delete:
23824       tags:
23825         - Network
23826       summary: delete an existing relationship
23827       description: delete an existing relationship
23828       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
23829       consumes:
23830         - application/json
23831         - application/xml
23832       produces:
23833         - application/json
23834         - application/xml
23835       responses:
23836         "default":
23837           description: Response codes found in [response codes](https://wiki.onap.org/).
23838       parameters:
23839         - name: equipment-name
23840           in: path
23841           required: true
23842           type: string
23843           example: __EQUIPMENT-NAME__
23844         - name: interface-name
23845           in: path
23846           description: Name that identifies the physical interface
23847           required: true
23848           type: string
23849           example: __INTERFACE-NAME__
23850         - name: interface-name
23851           in: path
23852           description: Name given to the interface
23853           required: true
23854           type: string
23855           example: __INTERFACE-NAME__
23856         - name: l3-interface-ipv6-address
23857           in: path
23858           description: IP address
23859           required: true
23860           type: string
23861           example: __L3-INTERFACE-IPV6-ADDRESS__
23862   /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}:
23863     get:
23864       tags:
23865         - Network
23866       summary: returns l3-interface-ipv6-address-list
23867       description: returns l3-interface-ipv6-address-list
23868       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23869       produces:
23870         - application/json
23871         - application/xml
23872       responses:
23873         "200":
23874           description: successful operation
23875           schema:
23876               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
23877         "default":
23878           description: Response codes found in [response codes](https://wiki.onap.org/).
23879       parameters:
23880         - name: equipment-name
23881           in: path
23882           required: true
23883           type: string
23884           example: __EQUIPMENT-NAME__
23885         - name: interface-name
23886           in: path
23887           description: Name that identifies the physical interface
23888           required: true
23889           type: string
23890           example: __INTERFACE-NAME__
23891         - name: interface-name
23892           in: path
23893           description: Name given to the interface
23894           required: true
23895           type: string
23896           example: __INTERFACE-NAME__
23897         - name: l3-interface-ipv6-address
23898           in: path
23899           description: IP address
23900           required: true
23901           type: string
23902           example: __L3-INTERFACE-IPV6-ADDRESS__
23903         - name: prov-status
23904           in: query
23905           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
23906           required: false
23907           type: string
23908         - name: prov-status
23909           in: query
23910           description: Trigger for operational monitoring of this resource by Service Assurance systems.
23911           required: false
23912           type: string
23913         - name: interface-id
23914           in: query
23915           description: ID of interface
23916           required: false
23917           type: string
23918         - name: macaddr
23919           in: query
23920           description: MAC address for the interface
23921           required: false
23922           type: string
23923         - name: network-name
23924           in: query
23925           description: Name of the network
23926           required: false
23927           type: string
23928         - name: vlan-id-inner
23929           in: query
23930           description: Inner VLAN tag
23931           required: false
23932           type: integer
23933           format: int64
23934         - name: neutron-network-id
23935           in: query
23936           description: Neutron network id of the interface that address belongs to
23937           required: false
23938           type: string
23939         - name: neutron-subnet-id
23940           in: query
23941           description: Neutron id of subnet that address belongs to
23942           required: false
23943           type: string
23944     put:
23945       tags:
23946         - Network
23947       summary: create or update an existing l3-interface-ipv6-address-list
23948       description: |
23949         Create or update an existing l3-interface-ipv6-address-list.
23950         #
23951         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23952       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
23953       consumes:
23954         - application/json
23955         - application/xml
23956       produces:
23957         - application/json
23958         - application/xml
23959       responses:
23960         "default":
23961           description: Response codes found in [response codes](https://wiki.onap.org/).
23962       parameters:
23963         - name: equipment-name
23964           in: path
23965           required: true
23966           type: string
23967           example: __EQUIPMENT-NAME__
23968         - name: interface-name
23969           in: path
23970           description: Name that identifies the physical interface
23971           required: true
23972           type: string
23973           example: __INTERFACE-NAME__
23974         - name: interface-name
23975           in: path
23976           description: Name given to the interface
23977           required: true
23978           type: string
23979           example: __INTERFACE-NAME__
23980         - name: l3-interface-ipv6-address
23981           in: path
23982           description: IP address
23983           required: true
23984           type: string
23985           example: __L3-INTERFACE-IPV6-ADDRESS__
23986         - name: body
23987           in: body
23988           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
23989           required: true
23990           schema:
23991             $ref: "#/definitions/l3-interface-ipv6-address-list"
23992     patch:
23993       tags:
23994         - Network
23995       summary: update an existing l3-interface-ipv6-address-list
23996       description: |
23997         Update an existing l3-interface-ipv6-address-list
23998         #
23999         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24000         The PUT operation will entirely replace an existing object.
24001         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24002         #
24003         Other differences between PUT and PATCH are:
24004         #
24005         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24006         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24007         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24008       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24009       consumes:
24010         - application/json
24011         - application/xml
24012       produces:
24013         - application/json
24014         - application/xml
24015       responses:
24016         "default":
24017           description: Response codes found in [response codes](https://wiki.onap.org/).
24018       parameters:
24019         - name: equipment-name
24020           in: path
24021           required: true
24022           type: string
24023           example: __EQUIPMENT-NAME__
24024         - name: interface-name
24025           in: path
24026           description: Name that identifies the physical interface
24027           required: true
24028           type: string
24029           example: __INTERFACE-NAME__
24030         - name: interface-name
24031           in: path
24032           description: Name given to the interface
24033           required: true
24034           type: string
24035           example: __INTERFACE-NAME__
24036         - name: l3-interface-ipv6-address
24037           in: path
24038           description: IP address
24039           required: true
24040           type: string
24041           example: __L3-INTERFACE-IPV6-ADDRESS__
24042         - name: body
24043           in: body
24044           description: l3-interface-ipv6-address-list object that needs to be created or updated.
24045           required: true
24046           schema:
24047             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
24048     delete:
24049       tags:
24050         - Network
24051       summary: delete an existing l3-interface-ipv6-address-list
24052       description: delete an existing l3-interface-ipv6-address-list
24053       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
24054       consumes:
24055         - application/json
24056         - application/xml
24057       produces:
24058         - application/json
24059         - application/xml
24060       responses:
24061         "default":
24062           description: Response codes found in [response codes](https://wiki.onap.org/).
24063       parameters:
24064         - name: equipment-name
24065           in: path
24066           required: true
24067           type: string
24068           example: __EQUIPMENT-NAME__
24069         - name: interface-name
24070           in: path
24071           description: Name that identifies the physical interface
24072           required: true
24073           type: string
24074           example: __INTERFACE-NAME__
24075         - name: interface-name
24076           in: path
24077           description: Name given to the interface
24078           required: true
24079           type: string
24080           example: __INTERFACE-NAME__
24081         - name: l3-interface-ipv6-address
24082           in: path
24083           description: IP address
24084           required: true
24085           type: string
24086           example: __L3-INTERFACE-IPV6-ADDRESS__
24087         - name: resource-version
24088           in: query
24089           description: resource-version for concurrency
24090           required: true
24091           type: string
24092   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
24093     get:
24094       tags:
24095         - Network
24096       summary: returns l-interface
24097       description: returns l-interface
24098       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24099       produces:
24100         - application/json
24101         - application/xml
24102       responses:
24103         "200":
24104           description: successful operation
24105           schema:
24106               $ref: "#/getDefinitions/l-interface"
24107         "default":
24108           description: Response codes found in [response codes](https://wiki.onap.org/).
24109       parameters:
24110         - name: equipment-name
24111           in: path
24112           required: true
24113           type: string
24114           example: __EQUIPMENT-NAME__
24115         - name: interface-name
24116           in: path
24117           description: Name that identifies the physical interface
24118           required: true
24119           type: string
24120           example: __INTERFACE-NAME__
24121         - name: interface-name
24122           in: path
24123           description: Name given to the interface
24124           required: true
24125           type: string
24126           example: __INTERFACE-NAME__
24127         - name: prov-status
24128           in: query
24129           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24130           required: false
24131           type: string
24132         - name: prov-status
24133           in: query
24134           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24135           required: false
24136           type: string
24137         - name: interface-id
24138           in: query
24139           description: ID of interface
24140           required: false
24141           type: string
24142         - name: macaddr
24143           in: query
24144           description: MAC address for the interface
24145           required: false
24146           type: string
24147         - name: network-name
24148           in: query
24149           description: Name of the network
24150           required: false
24151           type: string
24152     put:
24153       tags:
24154         - Network
24155       summary: create or update an existing l-interface
24156       description: |
24157         Create or update an existing l-interface.
24158         #
24159         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24160       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24161       consumes:
24162         - application/json
24163         - application/xml
24164       produces:
24165         - application/json
24166         - application/xml
24167       responses:
24168         "default":
24169           description: Response codes found in [response codes](https://wiki.onap.org/).
24170       parameters:
24171         - name: equipment-name
24172           in: path
24173           required: true
24174           type: string
24175           example: __EQUIPMENT-NAME__
24176         - name: interface-name
24177           in: path
24178           description: Name that identifies the physical interface
24179           required: true
24180           type: string
24181           example: __INTERFACE-NAME__
24182         - name: interface-name
24183           in: path
24184           description: Name given to the interface
24185           required: true
24186           type: string
24187           example: __INTERFACE-NAME__
24188         - name: body
24189           in: body
24190           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
24191           required: true
24192           schema:
24193             $ref: "#/definitions/l-interface"
24194     patch:
24195       tags:
24196         - Network
24197       summary: update an existing l-interface
24198       description: |
24199         Update an existing l-interface
24200         #
24201         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24202         The PUT operation will entirely replace an existing object.
24203         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24204         #
24205         Other differences between PUT and PATCH are:
24206         #
24207         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24208         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24209         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24210       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24211       consumes:
24212         - application/json
24213         - application/xml
24214       produces:
24215         - application/json
24216         - application/xml
24217       responses:
24218         "default":
24219           description: Response codes found in [response codes](https://wiki.onap.org/).
24220       parameters:
24221         - name: equipment-name
24222           in: path
24223           required: true
24224           type: string
24225           example: __EQUIPMENT-NAME__
24226         - name: interface-name
24227           in: path
24228           description: Name that identifies the physical interface
24229           required: true
24230           type: string
24231           example: __INTERFACE-NAME__
24232         - name: interface-name
24233           in: path
24234           description: Name given to the interface
24235           required: true
24236           type: string
24237           example: __INTERFACE-NAME__
24238         - name: body
24239           in: body
24240           description: l-interface object that needs to be created or updated.
24241           required: true
24242           schema:
24243             $ref: "#/patchDefinitions/l-interface"
24244     delete:
24245       tags:
24246         - Network
24247       summary: delete an existing l-interface
24248       description: delete an existing l-interface
24249       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
24250       consumes:
24251         - application/json
24252         - application/xml
24253       produces:
24254         - application/json
24255         - application/xml
24256       responses:
24257         "default":
24258           description: Response codes found in [response codes](https://wiki.onap.org/).
24259       parameters:
24260         - name: equipment-name
24261           in: path
24262           required: true
24263           type: string
24264           example: __EQUIPMENT-NAME__
24265         - name: interface-name
24266           in: path
24267           description: Name that identifies the physical interface
24268           required: true
24269           type: string
24270           example: __INTERFACE-NAME__
24271         - name: interface-name
24272           in: path
24273           description: Name given to the interface
24274           required: true
24275           type: string
24276           example: __INTERFACE-NAME__
24277         - name: resource-version
24278           in: query
24279           description: resource-version for concurrency
24280           required: true
24281           type: string
24282   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
24283     get:
24284       tags:
24285         - Network
24286       summary: returns l-interfaces
24287       description: returns l-interfaces
24288       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
24289       produces:
24290         - application/json
24291         - application/xml
24292       responses:
24293         "200":
24294           description: successful operation
24295           schema:
24296               $ref: "#/getDefinitions/l-interfaces"
24297         "default":
24298           description: Response codes found in [response codes](https://wiki.onap.org/).
24299       parameters:
24300         - name: equipment-name
24301           in: path
24302           required: true
24303           type: string
24304           example: __EQUIPMENT-NAME__
24305         - name: interface-name
24306           in: path
24307           description: Name that identifies the physical interface
24308           required: true
24309           type: string
24310           example: __INTERFACE-NAME__
24311         - name: prov-status
24312           in: query
24313           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24314           required: false
24315           type: string
24316         - name: prov-status
24317           in: query
24318           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24319           required: false
24320           type: string
24321   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
24322     get:
24323       tags:
24324         - Network
24325       summary: returns p-interface
24326       description: returns p-interface
24327       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
24328       produces:
24329         - application/json
24330         - application/xml
24331       responses:
24332         "200":
24333           description: successful operation
24334           schema:
24335               $ref: "#/getDefinitions/p-interface"
24336         "default":
24337           description: Response codes found in [response codes](https://wiki.onap.org/).
24338       parameters:
24339         - name: equipment-name
24340           in: path
24341           required: true
24342           type: string
24343           example: __EQUIPMENT-NAME__
24344         - name: interface-name
24345           in: path
24346           description: Name that identifies the physical interface
24347           required: true
24348           type: string
24349           example: __INTERFACE-NAME__
24350         - name: prov-status
24351           in: query
24352           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24353           required: false
24354           type: string
24355         - name: prov-status
24356           in: query
24357           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24358           required: false
24359           type: string
24360     put:
24361       tags:
24362         - Network
24363       summary: create or update an existing p-interface
24364       description: |
24365         Create or update an existing p-interface.
24366         #
24367         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24368       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
24369       consumes:
24370         - application/json
24371         - application/xml
24372       produces:
24373         - application/json
24374         - application/xml
24375       responses:
24376         "default":
24377           description: Response codes found in [response codes](https://wiki.onap.org/).
24378       parameters:
24379         - name: equipment-name
24380           in: path
24381           required: true
24382           type: string
24383           example: __EQUIPMENT-NAME__
24384         - name: interface-name
24385           in: path
24386           description: Name that identifies the physical interface
24387           required: true
24388           type: string
24389           example: __INTERFACE-NAME__
24390         - name: body
24391           in: body
24392           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPePInterfacesPInterface.json)
24393           required: true
24394           schema:
24395             $ref: "#/definitions/p-interface"
24396     patch:
24397       tags:
24398         - Network
24399       summary: update an existing p-interface
24400       description: |
24401         Update an existing p-interface
24402         #
24403         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24404         The PUT operation will entirely replace an existing object.
24405         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24406         #
24407         Other differences between PUT and PATCH are:
24408         #
24409         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24410         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24411         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24412       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
24413       consumes:
24414         - application/json
24415         - application/xml
24416       produces:
24417         - application/json
24418         - application/xml
24419       responses:
24420         "default":
24421           description: Response codes found in [response codes](https://wiki.onap.org/).
24422       parameters:
24423         - name: equipment-name
24424           in: path
24425           required: true
24426           type: string
24427           example: __EQUIPMENT-NAME__
24428         - name: interface-name
24429           in: path
24430           description: Name that identifies the physical interface
24431           required: true
24432           type: string
24433           example: __INTERFACE-NAME__
24434         - name: body
24435           in: body
24436           description: p-interface object that needs to be created or updated.
24437           required: true
24438           schema:
24439             $ref: "#/patchDefinitions/p-interface"
24440     delete:
24441       tags:
24442         - Network
24443       summary: delete an existing p-interface
24444       description: delete an existing p-interface
24445       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
24446       consumes:
24447         - application/json
24448         - application/xml
24449       produces:
24450         - application/json
24451         - application/xml
24452       responses:
24453         "default":
24454           description: Response codes found in [response codes](https://wiki.onap.org/).
24455       parameters:
24456         - name: equipment-name
24457           in: path
24458           required: true
24459           type: string
24460           example: __EQUIPMENT-NAME__
24461         - name: interface-name
24462           in: path
24463           description: Name that identifies the physical interface
24464           required: true
24465           type: string
24466           example: __INTERFACE-NAME__
24467         - name: resource-version
24468           in: query
24469           description: resource-version for concurrency
24470           required: true
24471           type: string
24472   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
24473     get:
24474       tags:
24475         - Network
24476       summary: returns p-interfaces
24477       description: returns p-interfaces
24478       operationId: getNetworkVplsPesVplsPePInterfaces
24479       produces:
24480         - application/json
24481         - application/xml
24482       responses:
24483         "200":
24484           description: successful operation
24485           schema:
24486               $ref: "#/getDefinitions/p-interfaces"
24487         "default":
24488           description: Response codes found in [response codes](https://wiki.onap.org/).
24489       parameters:
24490         - name: equipment-name
24491           in: path
24492           required: true
24493           type: string
24494           example: __EQUIPMENT-NAME__
24495         - name: prov-status
24496           in: query
24497           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24498           required: false
24499           type: string
24500   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
24501     put:
24502       tags:
24503         - Network
24504       summary: see node definition for valid relationships
24505       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24506       consumes:
24507         - application/json
24508         - application/xml
24509       produces:
24510         - application/json
24511         - application/xml
24512       responses:
24513         "default":
24514           description: Response codes found in [response codes](https://wiki.onap.org/).
24515       parameters:
24516         - name: equipment-name
24517           in: path
24518           required: true
24519           type: string
24520           example: __EQUIPMENT-NAME__
24521         - name: interface-name
24522           in: path
24523           description: Name that identifies the link aggregate interface
24524           required: true
24525           type: string
24526           example: __INTERFACE-NAME__
24527         - name: body
24528           in: body
24529           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
24530           required: true
24531           schema:
24532             $ref: "#/definitions/relationship"
24533     delete:
24534       tags:
24535         - Network
24536       summary: delete an existing relationship
24537       description: delete an existing relationship
24538       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
24539       consumes:
24540         - application/json
24541         - application/xml
24542       produces:
24543         - application/json
24544         - application/xml
24545       responses:
24546         "default":
24547           description: Response codes found in [response codes](https://wiki.onap.org/).
24548       parameters:
24549         - name: equipment-name
24550           in: path
24551           required: true
24552           type: string
24553           example: __EQUIPMENT-NAME__
24554         - name: interface-name
24555           in: path
24556           description: Name that identifies the link aggregate interface
24557           required: true
24558           type: string
24559           example: __INTERFACE-NAME__
24560   /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:
24561     put:
24562       tags:
24563         - Network
24564       summary: see node definition for valid relationships
24565       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24566       consumes:
24567         - application/json
24568         - application/xml
24569       produces:
24570         - application/json
24571         - application/xml
24572       responses:
24573         "default":
24574           description: Response codes found in [response codes](https://wiki.onap.org/).
24575       parameters:
24576         - name: equipment-name
24577           in: path
24578           required: true
24579           type: string
24580           example: __EQUIPMENT-NAME__
24581         - name: interface-name
24582           in: path
24583           description: Name that identifies the link aggregate interface
24584           required: true
24585           type: string
24586           example: __INTERFACE-NAME__
24587         - name: interface-name
24588           in: path
24589           description: Name given to the interface
24590           required: true
24591           type: string
24592           example: __INTERFACE-NAME__
24593         - name: vlan-interface
24594           in: path
24595           description: String that identifies the interface
24596           required: true
24597           type: string
24598           example: __VLAN-INTERFACE__
24599         - name: body
24600           in: body
24601           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
24602           required: true
24603           schema:
24604             $ref: "#/definitions/relationship"
24605     delete:
24606       tags:
24607         - Network
24608       summary: delete an existing relationship
24609       description: delete an existing relationship
24610       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24611       consumes:
24612         - application/json
24613         - application/xml
24614       produces:
24615         - application/json
24616         - application/xml
24617       responses:
24618         "default":
24619           description: Response codes found in [response codes](https://wiki.onap.org/).
24620       parameters:
24621         - name: equipment-name
24622           in: path
24623           required: true
24624           type: string
24625           example: __EQUIPMENT-NAME__
24626         - name: interface-name
24627           in: path
24628           description: Name that identifies the link aggregate interface
24629           required: true
24630           type: string
24631           example: __INTERFACE-NAME__
24632         - name: interface-name
24633           in: path
24634           description: Name given to the interface
24635           required: true
24636           type: string
24637           example: __INTERFACE-NAME__
24638         - name: vlan-interface
24639           in: path
24640           description: String that identifies the interface
24641           required: true
24642           type: string
24643           example: __VLAN-INTERFACE__
24644   /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:
24645     put:
24646       tags:
24647         - Network
24648       summary: see node definition for valid relationships
24649       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24650       consumes:
24651         - application/json
24652         - application/xml
24653       produces:
24654         - application/json
24655         - application/xml
24656       responses:
24657         "default":
24658           description: Response codes found in [response codes](https://wiki.onap.org/).
24659       parameters:
24660         - name: equipment-name
24661           in: path
24662           required: true
24663           type: string
24664           example: __EQUIPMENT-NAME__
24665         - name: interface-name
24666           in: path
24667           description: Name that identifies the link aggregate interface
24668           required: true
24669           type: string
24670           example: __INTERFACE-NAME__
24671         - name: interface-name
24672           in: path
24673           description: Name given to the interface
24674           required: true
24675           type: string
24676           example: __INTERFACE-NAME__
24677         - name: vlan-interface
24678           in: path
24679           description: String that identifies the interface
24680           required: true
24681           type: string
24682           example: __VLAN-INTERFACE__
24683         - name: l3-interface-ipv4-address
24684           in: path
24685           description: IP address
24686           required: true
24687           type: string
24688           example: __L3-INTERFACE-IPV4-ADDRESS__
24689         - name: body
24690           in: body
24691           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24692           required: true
24693           schema:
24694             $ref: "#/definitions/relationship"
24695     delete:
24696       tags:
24697         - Network
24698       summary: delete an existing relationship
24699       description: delete an existing relationship
24700       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24701       consumes:
24702         - application/json
24703         - application/xml
24704       produces:
24705         - application/json
24706         - application/xml
24707       responses:
24708         "default":
24709           description: Response codes found in [response codes](https://wiki.onap.org/).
24710       parameters:
24711         - name: equipment-name
24712           in: path
24713           required: true
24714           type: string
24715           example: __EQUIPMENT-NAME__
24716         - name: interface-name
24717           in: path
24718           description: Name that identifies the link aggregate interface
24719           required: true
24720           type: string
24721           example: __INTERFACE-NAME__
24722         - name: interface-name
24723           in: path
24724           description: Name given to the interface
24725           required: true
24726           type: string
24727           example: __INTERFACE-NAME__
24728         - name: vlan-interface
24729           in: path
24730           description: String that identifies the interface
24731           required: true
24732           type: string
24733           example: __VLAN-INTERFACE__
24734         - name: l3-interface-ipv4-address
24735           in: path
24736           description: IP address
24737           required: true
24738           type: string
24739           example: __L3-INTERFACE-IPV4-ADDRESS__
24740   /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}:
24741     get:
24742       tags:
24743         - Network
24744       summary: returns l3-interface-ipv4-address-list
24745       description: returns l3-interface-ipv4-address-list
24746       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24747       produces:
24748         - application/json
24749         - application/xml
24750       responses:
24751         "200":
24752           description: successful operation
24753           schema:
24754               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24755         "default":
24756           description: Response codes found in [response codes](https://wiki.onap.org/).
24757       parameters:
24758         - name: equipment-name
24759           in: path
24760           required: true
24761           type: string
24762           example: __EQUIPMENT-NAME__
24763         - name: interface-name
24764           in: path
24765           description: Name that identifies the link aggregate interface
24766           required: true
24767           type: string
24768           example: __INTERFACE-NAME__
24769         - name: interface-name
24770           in: path
24771           description: Name given to the interface
24772           required: true
24773           type: string
24774           example: __INTERFACE-NAME__
24775         - name: vlan-interface
24776           in: path
24777           description: String that identifies the interface
24778           required: true
24779           type: string
24780           example: __VLAN-INTERFACE__
24781         - name: l3-interface-ipv4-address
24782           in: path
24783           description: IP address
24784           required: true
24785           type: string
24786           example: __L3-INTERFACE-IPV4-ADDRESS__
24787         - name: prov-status
24788           in: query
24789           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24790           required: false
24791           type: string
24792         - name: interface-id
24793           in: query
24794           description: ID of interface
24795           required: false
24796           type: string
24797         - name: interface-role
24798           in: query
24799           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
24800           required: false
24801           type: string
24802         - name: interface-id
24803           in: query
24804           description: ID of interface
24805           required: false
24806           type: string
24807         - name: macaddr
24808           in: query
24809           description: MAC address for the interface
24810           required: false
24811           type: string
24812         - name: network-name
24813           in: query
24814           description: Name of the network
24815           required: false
24816           type: string
24817         - name: vlan-id-inner
24818           in: query
24819           description: Inner VLAN tag
24820           required: false
24821           type: integer
24822           format: int64
24823         - name: vpn-id
24824           in: query
24825           description: This indicates the customers VPN ID associated with this vlan
24826           required: false
24827           type: string
24828         - name: vlan-id-inner
24829           in: query
24830           description: Inner VLAN tag
24831           required: false
24832           type: integer
24833           format: int64
24834         - name: neutron-network-id
24835           in: query
24836           description: Neutron network id of the interface that address belongs to
24837           required: false
24838           type: string
24839         - name: neutron-subnet-id
24840           in: query
24841           description: Neutron id of subnet that address belongs to
24842           required: false
24843           type: string
24844     put:
24845       tags:
24846         - Network
24847       summary: create or update an existing l3-interface-ipv4-address-list
24848       description: |
24849         Create or update an existing l3-interface-ipv4-address-list.
24850         #
24851         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24852       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24853       consumes:
24854         - application/json
24855         - application/xml
24856       produces:
24857         - application/json
24858         - application/xml
24859       responses:
24860         "default":
24861           description: Response codes found in [response codes](https://wiki.onap.org/).
24862       parameters:
24863         - name: equipment-name
24864           in: path
24865           required: true
24866           type: string
24867           example: __EQUIPMENT-NAME__
24868         - name: interface-name
24869           in: path
24870           description: Name that identifies the link aggregate interface
24871           required: true
24872           type: string
24873           example: __INTERFACE-NAME__
24874         - name: interface-name
24875           in: path
24876           description: Name given to the interface
24877           required: true
24878           type: string
24879           example: __INTERFACE-NAME__
24880         - name: vlan-interface
24881           in: path
24882           description: String that identifies the interface
24883           required: true
24884           type: string
24885           example: __VLAN-INTERFACE__
24886         - name: l3-interface-ipv4-address
24887           in: path
24888           description: IP address
24889           required: true
24890           type: string
24891           example: __L3-INTERFACE-IPV4-ADDRESS__
24892         - name: body
24893           in: body
24894           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24895           required: true
24896           schema:
24897             $ref: "#/definitions/l3-interface-ipv4-address-list"
24898     patch:
24899       tags:
24900         - Network
24901       summary: update an existing l3-interface-ipv4-address-list
24902       description: |
24903         Update an existing l3-interface-ipv4-address-list
24904         #
24905         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24906         The PUT operation will entirely replace an existing object.
24907         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24908         #
24909         Other differences between PUT and PATCH are:
24910         #
24911         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24912         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24913         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24914       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24915       consumes:
24916         - application/json
24917         - application/xml
24918       produces:
24919         - application/json
24920         - application/xml
24921       responses:
24922         "default":
24923           description: Response codes found in [response codes](https://wiki.onap.org/).
24924       parameters:
24925         - name: equipment-name
24926           in: path
24927           required: true
24928           type: string
24929           example: __EQUIPMENT-NAME__
24930         - name: interface-name
24931           in: path
24932           description: Name that identifies the link aggregate interface
24933           required: true
24934           type: string
24935           example: __INTERFACE-NAME__
24936         - name: interface-name
24937           in: path
24938           description: Name given to the interface
24939           required: true
24940           type: string
24941           example: __INTERFACE-NAME__
24942         - name: vlan-interface
24943           in: path
24944           description: String that identifies the interface
24945           required: true
24946           type: string
24947           example: __VLAN-INTERFACE__
24948         - name: l3-interface-ipv4-address
24949           in: path
24950           description: IP address
24951           required: true
24952           type: string
24953           example: __L3-INTERFACE-IPV4-ADDRESS__
24954         - name: body
24955           in: body
24956           description: l3-interface-ipv4-address-list object that needs to be created or updated.
24957           required: true
24958           schema:
24959             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24960     delete:
24961       tags:
24962         - Network
24963       summary: delete an existing l3-interface-ipv4-address-list
24964       description: delete an existing l3-interface-ipv4-address-list
24965       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24966       consumes:
24967         - application/json
24968         - application/xml
24969       produces:
24970         - application/json
24971         - application/xml
24972       responses:
24973         "default":
24974           description: Response codes found in [response codes](https://wiki.onap.org/).
24975       parameters:
24976         - name: equipment-name
24977           in: path
24978           required: true
24979           type: string
24980           example: __EQUIPMENT-NAME__
24981         - name: interface-name
24982           in: path
24983           description: Name that identifies the link aggregate interface
24984           required: true
24985           type: string
24986           example: __INTERFACE-NAME__
24987         - name: interface-name
24988           in: path
24989           description: Name given to the interface
24990           required: true
24991           type: string
24992           example: __INTERFACE-NAME__
24993         - name: vlan-interface
24994           in: path
24995           description: String that identifies the interface
24996           required: true
24997           type: string
24998           example: __VLAN-INTERFACE__
24999         - name: l3-interface-ipv4-address
25000           in: path
25001           description: IP address
25002           required: true
25003           type: string
25004           example: __L3-INTERFACE-IPV4-ADDRESS__
25005         - name: resource-version
25006           in: query
25007           description: resource-version for concurrency
25008           required: true
25009           type: string
25010   /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:
25011     put:
25012       tags:
25013         - Network
25014       summary: see node definition for valid relationships
25015       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25016       consumes:
25017         - application/json
25018         - application/xml
25019       produces:
25020         - application/json
25021         - application/xml
25022       responses:
25023         "default":
25024           description: Response codes found in [response codes](https://wiki.onap.org/).
25025       parameters:
25026         - name: equipment-name
25027           in: path
25028           required: true
25029           type: string
25030           example: __EQUIPMENT-NAME__
25031         - name: interface-name
25032           in: path
25033           description: Name that identifies the link aggregate interface
25034           required: true
25035           type: string
25036           example: __INTERFACE-NAME__
25037         - name: interface-name
25038           in: path
25039           description: Name given to the interface
25040           required: true
25041           type: string
25042           example: __INTERFACE-NAME__
25043         - name: vlan-interface
25044           in: path
25045           description: String that identifies the interface
25046           required: true
25047           type: string
25048           example: __VLAN-INTERFACE__
25049         - name: l3-interface-ipv6-address
25050           in: path
25051           description: IP address
25052           required: true
25053           type: string
25054           example: __L3-INTERFACE-IPV6-ADDRESS__
25055         - name: body
25056           in: body
25057           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25058           required: true
25059           schema:
25060             $ref: "#/definitions/relationship"
25061     delete:
25062       tags:
25063         - Network
25064       summary: delete an existing relationship
25065       description: delete an existing relationship
25066       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
25067       consumes:
25068         - application/json
25069         - application/xml
25070       produces:
25071         - application/json
25072         - application/xml
25073       responses:
25074         "default":
25075           description: Response codes found in [response codes](https://wiki.onap.org/).
25076       parameters:
25077         - name: equipment-name
25078           in: path
25079           required: true
25080           type: string
25081           example: __EQUIPMENT-NAME__
25082         - name: interface-name
25083           in: path
25084           description: Name that identifies the link aggregate interface
25085           required: true
25086           type: string
25087           example: __INTERFACE-NAME__
25088         - name: interface-name
25089           in: path
25090           description: Name given to the interface
25091           required: true
25092           type: string
25093           example: __INTERFACE-NAME__
25094         - name: vlan-interface
25095           in: path
25096           description: String that identifies the interface
25097           required: true
25098           type: string
25099           example: __VLAN-INTERFACE__
25100         - name: l3-interface-ipv6-address
25101           in: path
25102           description: IP address
25103           required: true
25104           type: string
25105           example: __L3-INTERFACE-IPV6-ADDRESS__
25106   /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}:
25107     get:
25108       tags:
25109         - Network
25110       summary: returns l3-interface-ipv6-address-list
25111       description: returns l3-interface-ipv6-address-list
25112       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25113       produces:
25114         - application/json
25115         - application/xml
25116       responses:
25117         "200":
25118           description: successful operation
25119           schema:
25120               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
25121         "default":
25122           description: Response codes found in [response codes](https://wiki.onap.org/).
25123       parameters:
25124         - name: equipment-name
25125           in: path
25126           required: true
25127           type: string
25128           example: __EQUIPMENT-NAME__
25129         - name: interface-name
25130           in: path
25131           description: Name that identifies the link aggregate interface
25132           required: true
25133           type: string
25134           example: __INTERFACE-NAME__
25135         - name: interface-name
25136           in: path
25137           description: Name given to the interface
25138           required: true
25139           type: string
25140           example: __INTERFACE-NAME__
25141         - name: vlan-interface
25142           in: path
25143           description: String that identifies the interface
25144           required: true
25145           type: string
25146           example: __VLAN-INTERFACE__
25147         - name: l3-interface-ipv6-address
25148           in: path
25149           description: IP address
25150           required: true
25151           type: string
25152           example: __L3-INTERFACE-IPV6-ADDRESS__
25153         - name: prov-status
25154           in: query
25155           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25156           required: false
25157           type: string
25158         - name: interface-id
25159           in: query
25160           description: ID of interface
25161           required: false
25162           type: string
25163         - name: interface-role
25164           in: query
25165           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25166           required: false
25167           type: string
25168         - name: interface-id
25169           in: query
25170           description: ID of interface
25171           required: false
25172           type: string
25173         - name: macaddr
25174           in: query
25175           description: MAC address for the interface
25176           required: false
25177           type: string
25178         - name: network-name
25179           in: query
25180           description: Name of the network
25181           required: false
25182           type: string
25183         - name: vlan-id-inner
25184           in: query
25185           description: Inner VLAN tag
25186           required: false
25187           type: integer
25188           format: int64
25189         - name: vpn-id
25190           in: query
25191           description: This indicates the customers VPN ID associated with this vlan
25192           required: false
25193           type: string
25194         - name: vlan-id-inner
25195           in: query
25196           description: Inner VLAN tag
25197           required: false
25198           type: integer
25199           format: int64
25200         - name: neutron-network-id
25201           in: query
25202           description: Neutron network id of the interface that address belongs to
25203           required: false
25204           type: string
25205         - name: neutron-subnet-id
25206           in: query
25207           description: Neutron id of subnet that address belongs to
25208           required: false
25209           type: string
25210     put:
25211       tags:
25212         - Network
25213       summary: create or update an existing l3-interface-ipv6-address-list
25214       description: |
25215         Create or update an existing l3-interface-ipv6-address-list.
25216         #
25217         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25218       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25219       consumes:
25220         - application/json
25221         - application/xml
25222       produces:
25223         - application/json
25224         - application/xml
25225       responses:
25226         "default":
25227           description: Response codes found in [response codes](https://wiki.onap.org/).
25228       parameters:
25229         - name: equipment-name
25230           in: path
25231           required: true
25232           type: string
25233           example: __EQUIPMENT-NAME__
25234         - name: interface-name
25235           in: path
25236           description: Name that identifies the link aggregate interface
25237           required: true
25238           type: string
25239           example: __INTERFACE-NAME__
25240         - name: interface-name
25241           in: path
25242           description: Name given to the interface
25243           required: true
25244           type: string
25245           example: __INTERFACE-NAME__
25246         - name: vlan-interface
25247           in: path
25248           description: String that identifies the interface
25249           required: true
25250           type: string
25251           example: __VLAN-INTERFACE__
25252         - name: l3-interface-ipv6-address
25253           in: path
25254           description: IP address
25255           required: true
25256           type: string
25257           example: __L3-INTERFACE-IPV6-ADDRESS__
25258         - name: body
25259           in: body
25260           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
25261           required: true
25262           schema:
25263             $ref: "#/definitions/l3-interface-ipv6-address-list"
25264     patch:
25265       tags:
25266         - Network
25267       summary: update an existing l3-interface-ipv6-address-list
25268       description: |
25269         Update an existing l3-interface-ipv6-address-list
25270         #
25271         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25272         The PUT operation will entirely replace an existing object.
25273         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25274         #
25275         Other differences between PUT and PATCH are:
25276         #
25277         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25278         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25279         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25280       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
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: equipment-name
25292           in: path
25293           required: true
25294           type: string
25295           example: __EQUIPMENT-NAME__
25296         - name: interface-name
25297           in: path
25298           description: Name that identifies the link aggregate interface
25299           required: true
25300           type: string
25301           example: __INTERFACE-NAME__
25302         - name: interface-name
25303           in: path
25304           description: Name given to the interface
25305           required: true
25306           type: string
25307           example: __INTERFACE-NAME__
25308         - name: vlan-interface
25309           in: path
25310           description: String that identifies the interface
25311           required: true
25312           type: string
25313           example: __VLAN-INTERFACE__
25314         - name: l3-interface-ipv6-address
25315           in: path
25316           description: IP address
25317           required: true
25318           type: string
25319           example: __L3-INTERFACE-IPV6-ADDRESS__
25320         - name: body
25321           in: body
25322           description: l3-interface-ipv6-address-list object that needs to be created or updated.
25323           required: true
25324           schema:
25325             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25326     delete:
25327       tags:
25328         - Network
25329       summary: delete an existing l3-interface-ipv6-address-list
25330       description: delete an existing l3-interface-ipv6-address-list
25331       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25332       consumes:
25333         - application/json
25334         - application/xml
25335       produces:
25336         - application/json
25337         - application/xml
25338       responses:
25339         "default":
25340           description: Response codes found in [response codes](https://wiki.onap.org/).
25341       parameters:
25342         - name: equipment-name
25343           in: path
25344           required: true
25345           type: string
25346           example: __EQUIPMENT-NAME__
25347         - name: interface-name
25348           in: path
25349           description: Name that identifies the link aggregate interface
25350           required: true
25351           type: string
25352           example: __INTERFACE-NAME__
25353         - name: interface-name
25354           in: path
25355           description: Name given to the interface
25356           required: true
25357           type: string
25358           example: __INTERFACE-NAME__
25359         - name: vlan-interface
25360           in: path
25361           description: String that identifies the interface
25362           required: true
25363           type: string
25364           example: __VLAN-INTERFACE__
25365         - name: l3-interface-ipv6-address
25366           in: path
25367           description: IP address
25368           required: true
25369           type: string
25370           example: __L3-INTERFACE-IPV6-ADDRESS__
25371         - name: resource-version
25372           in: query
25373           description: resource-version for concurrency
25374           required: true
25375           type: string
25376   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25377     get:
25378       tags:
25379         - Network
25380       summary: returns vlan
25381       description: returns vlan
25382       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25383       produces:
25384         - application/json
25385         - application/xml
25386       responses:
25387         "200":
25388           description: successful operation
25389           schema:
25390               $ref: "#/getDefinitions/vlan"
25391         "default":
25392           description: Response codes found in [response codes](https://wiki.onap.org/).
25393       parameters:
25394         - name: equipment-name
25395           in: path
25396           required: true
25397           type: string
25398           example: __EQUIPMENT-NAME__
25399         - name: interface-name
25400           in: path
25401           description: Name that identifies the link aggregate interface
25402           required: true
25403           type: string
25404           example: __INTERFACE-NAME__
25405         - name: interface-name
25406           in: path
25407           description: Name given to the interface
25408           required: true
25409           type: string
25410           example: __INTERFACE-NAME__
25411         - name: vlan-interface
25412           in: path
25413           description: String that identifies the interface
25414           required: true
25415           type: string
25416           example: __VLAN-INTERFACE__
25417         - name: prov-status
25418           in: query
25419           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25420           required: false
25421           type: string
25422         - name: interface-id
25423           in: query
25424           description: ID of interface
25425           required: false
25426           type: string
25427         - name: interface-role
25428           in: query
25429           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25430           required: false
25431           type: string
25432         - name: interface-id
25433           in: query
25434           description: ID of interface
25435           required: false
25436           type: string
25437         - name: macaddr
25438           in: query
25439           description: MAC address for the interface
25440           required: false
25441           type: string
25442         - name: network-name
25443           in: query
25444           description: Name of the network
25445           required: false
25446           type: string
25447         - name: vlan-id-inner
25448           in: query
25449           description: Inner VLAN tag
25450           required: false
25451           type: integer
25452           format: int64
25453         - name: vpn-id
25454           in: query
25455           description: This indicates the customers VPN ID associated with this vlan
25456           required: false
25457           type: string
25458     put:
25459       tags:
25460         - Network
25461       summary: create or update an existing vlan
25462       description: |
25463         Create or update an existing vlan.
25464         #
25465         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25466       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25467       consumes:
25468         - application/json
25469         - application/xml
25470       produces:
25471         - application/json
25472         - application/xml
25473       responses:
25474         "default":
25475           description: Response codes found in [response codes](https://wiki.onap.org/).
25476       parameters:
25477         - name: equipment-name
25478           in: path
25479           required: true
25480           type: string
25481           example: __EQUIPMENT-NAME__
25482         - name: interface-name
25483           in: path
25484           description: Name that identifies the link aggregate interface
25485           required: true
25486           type: string
25487           example: __INTERFACE-NAME__
25488         - name: interface-name
25489           in: path
25490           description: Name given to the interface
25491           required: true
25492           type: string
25493           example: __INTERFACE-NAME__
25494         - name: vlan-interface
25495           in: path
25496           description: String that identifies the interface
25497           required: true
25498           type: string
25499           example: __VLAN-INTERFACE__
25500         - name: body
25501           in: body
25502           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
25503           required: true
25504           schema:
25505             $ref: "#/definitions/vlan"
25506     patch:
25507       tags:
25508         - Network
25509       summary: update an existing vlan
25510       description: |
25511         Update an existing vlan
25512         #
25513         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25514         The PUT operation will entirely replace an existing object.
25515         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25516         #
25517         Other differences between PUT and PATCH are:
25518         #
25519         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25520         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25521         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25522       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25523       consumes:
25524         - application/json
25525         - application/xml
25526       produces:
25527         - application/json
25528         - application/xml
25529       responses:
25530         "default":
25531           description: Response codes found in [response codes](https://wiki.onap.org/).
25532       parameters:
25533         - name: equipment-name
25534           in: path
25535           required: true
25536           type: string
25537           example: __EQUIPMENT-NAME__
25538         - name: interface-name
25539           in: path
25540           description: Name that identifies the link aggregate interface
25541           required: true
25542           type: string
25543           example: __INTERFACE-NAME__
25544         - name: interface-name
25545           in: path
25546           description: Name given to the interface
25547           required: true
25548           type: string
25549           example: __INTERFACE-NAME__
25550         - name: vlan-interface
25551           in: path
25552           description: String that identifies the interface
25553           required: true
25554           type: string
25555           example: __VLAN-INTERFACE__
25556         - name: body
25557           in: body
25558           description: vlan object that needs to be created or updated.
25559           required: true
25560           schema:
25561             $ref: "#/patchDefinitions/vlan"
25562     delete:
25563       tags:
25564         - Network
25565       summary: delete an existing vlan
25566       description: delete an existing vlan
25567       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
25568       consumes:
25569         - application/json
25570         - application/xml
25571       produces:
25572         - application/json
25573         - application/xml
25574       responses:
25575         "default":
25576           description: Response codes found in [response codes](https://wiki.onap.org/).
25577       parameters:
25578         - name: equipment-name
25579           in: path
25580           required: true
25581           type: string
25582           example: __EQUIPMENT-NAME__
25583         - name: interface-name
25584           in: path
25585           description: Name that identifies the link aggregate interface
25586           required: true
25587           type: string
25588           example: __INTERFACE-NAME__
25589         - name: interface-name
25590           in: path
25591           description: Name given to the interface
25592           required: true
25593           type: string
25594           example: __INTERFACE-NAME__
25595         - name: vlan-interface
25596           in: path
25597           description: String that identifies the interface
25598           required: true
25599           type: string
25600           example: __VLAN-INTERFACE__
25601         - name: resource-version
25602           in: query
25603           description: resource-version for concurrency
25604           required: true
25605           type: string
25606   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25607     get:
25608       tags:
25609         - Network
25610       summary: returns vlans
25611       description: returns vlans
25612       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
25613       produces:
25614         - application/json
25615         - application/xml
25616       responses:
25617         "200":
25618           description: successful operation
25619           schema:
25620               $ref: "#/getDefinitions/vlans"
25621         "default":
25622           description: Response codes found in [response codes](https://wiki.onap.org/).
25623       parameters:
25624         - name: equipment-name
25625           in: path
25626           required: true
25627           type: string
25628           example: __EQUIPMENT-NAME__
25629         - name: interface-name
25630           in: path
25631           description: Name that identifies the link aggregate interface
25632           required: true
25633           type: string
25634           example: __INTERFACE-NAME__
25635         - name: interface-name
25636           in: path
25637           description: Name given to the interface
25638           required: true
25639           type: string
25640           example: __INTERFACE-NAME__
25641         - name: prov-status
25642           in: query
25643           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25644           required: false
25645           type: string
25646         - name: interface-id
25647           in: query
25648           description: ID of interface
25649           required: false
25650           type: string
25651         - name: interface-role
25652           in: query
25653           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25654           required: false
25655           type: string
25656         - name: interface-id
25657           in: query
25658           description: ID of interface
25659           required: false
25660           type: string
25661         - name: macaddr
25662           in: query
25663           description: MAC address for the interface
25664           required: false
25665           type: string
25666         - name: network-name
25667           in: query
25668           description: Name of the network
25669           required: false
25670           type: string
25671   /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:
25672     put:
25673       tags:
25674         - Network
25675       summary: see node definition for valid relationships
25676       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25677       consumes:
25678         - application/json
25679         - application/xml
25680       produces:
25681         - application/json
25682         - application/xml
25683       responses:
25684         "default":
25685           description: Response codes found in [response codes](https://wiki.onap.org/).
25686       parameters:
25687         - name: equipment-name
25688           in: path
25689           required: true
25690           type: string
25691           example: __EQUIPMENT-NAME__
25692         - name: interface-name
25693           in: path
25694           description: Name that identifies the link aggregate interface
25695           required: true
25696           type: string
25697           example: __INTERFACE-NAME__
25698         - name: interface-name
25699           in: path
25700           description: Name given to the interface
25701           required: true
25702           type: string
25703           example: __INTERFACE-NAME__
25704         - name: pci-id
25705           in: path
25706           description: PCI ID used to identify the sriov-vf
25707           required: true
25708           type: string
25709           example: __PCI-ID__
25710         - name: body
25711           in: body
25712           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25713           required: true
25714           schema:
25715             $ref: "#/definitions/relationship"
25716     delete:
25717       tags:
25718         - Network
25719       summary: delete an existing relationship
25720       description: delete an existing relationship
25721       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25722       consumes:
25723         - application/json
25724         - application/xml
25725       produces:
25726         - application/json
25727         - application/xml
25728       responses:
25729         "default":
25730           description: Response codes found in [response codes](https://wiki.onap.org/).
25731       parameters:
25732         - name: equipment-name
25733           in: path
25734           required: true
25735           type: string
25736           example: __EQUIPMENT-NAME__
25737         - name: interface-name
25738           in: path
25739           description: Name that identifies the link aggregate interface
25740           required: true
25741           type: string
25742           example: __INTERFACE-NAME__
25743         - name: interface-name
25744           in: path
25745           description: Name given to the interface
25746           required: true
25747           type: string
25748           example: __INTERFACE-NAME__
25749         - name: pci-id
25750           in: path
25751           description: PCI ID used to identify the sriov-vf
25752           required: true
25753           type: string
25754           example: __PCI-ID__
25755   /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}:
25756     get:
25757       tags:
25758         - Network
25759       summary: returns sriov-vf
25760       description: returns sriov-vf
25761       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25762       produces:
25763         - application/json
25764         - application/xml
25765       responses:
25766         "200":
25767           description: successful operation
25768           schema:
25769               $ref: "#/getDefinitions/sriov-vf"
25770         "default":
25771           description: Response codes found in [response codes](https://wiki.onap.org/).
25772       parameters:
25773         - name: equipment-name
25774           in: path
25775           required: true
25776           type: string
25777           example: __EQUIPMENT-NAME__
25778         - name: interface-name
25779           in: path
25780           description: Name that identifies the link aggregate interface
25781           required: true
25782           type: string
25783           example: __INTERFACE-NAME__
25784         - name: interface-name
25785           in: path
25786           description: Name given to the interface
25787           required: true
25788           type: string
25789           example: __INTERFACE-NAME__
25790         - name: pci-id
25791           in: path
25792           description: PCI ID used to identify the sriov-vf
25793           required: true
25794           type: string
25795           example: __PCI-ID__
25796         - name: prov-status
25797           in: query
25798           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25799           required: false
25800           type: string
25801         - name: interface-id
25802           in: query
25803           description: ID of interface
25804           required: false
25805           type: string
25806         - name: interface-role
25807           in: query
25808           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
25809           required: false
25810           type: string
25811         - name: interface-id
25812           in: query
25813           description: ID of interface
25814           required: false
25815           type: string
25816         - name: macaddr
25817           in: query
25818           description: MAC address for the interface
25819           required: false
25820           type: string
25821         - name: network-name
25822           in: query
25823           description: Name of the network
25824           required: false
25825           type: string
25826         - name: vf-vlan-filter
25827           in: query
25828           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25829           required: false
25830           type: string
25831         - name: vf-mac-filter
25832           in: query
25833           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25834           required: false
25835           type: string
25836         - name: vf-vlan-strip
25837           in: query
25838           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25839           required: false
25840           type: boolean
25841         - name: neutron-network-id
25842           in: query
25843           description: Neutron network id of the interface
25844           required: false
25845           type: string
25846     put:
25847       tags:
25848         - Network
25849       summary: create or update an existing sriov-vf
25850       description: |
25851         Create or update an existing sriov-vf.
25852         #
25853         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25854       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25855       consumes:
25856         - application/json
25857         - application/xml
25858       produces:
25859         - application/json
25860         - application/xml
25861       responses:
25862         "default":
25863           description: Response codes found in [response codes](https://wiki.onap.org/).
25864       parameters:
25865         - name: equipment-name
25866           in: path
25867           required: true
25868           type: string
25869           example: __EQUIPMENT-NAME__
25870         - name: interface-name
25871           in: path
25872           description: Name that identifies the link aggregate interface
25873           required: true
25874           type: string
25875           example: __INTERFACE-NAME__
25876         - name: interface-name
25877           in: path
25878           description: Name given to the interface
25879           required: true
25880           type: string
25881           example: __INTERFACE-NAME__
25882         - name: pci-id
25883           in: path
25884           description: PCI ID used to identify the sriov-vf
25885           required: true
25886           type: string
25887           example: __PCI-ID__
25888         - name: body
25889           in: body
25890           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25891           required: true
25892           schema:
25893             $ref: "#/definitions/sriov-vf"
25894     patch:
25895       tags:
25896         - Network
25897       summary: update an existing sriov-vf
25898       description: |
25899         Update an existing sriov-vf
25900         #
25901         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25902         The PUT operation will entirely replace an existing object.
25903         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25904         #
25905         Other differences between PUT and PATCH are:
25906         #
25907         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25908         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25909         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25910       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25911       consumes:
25912         - application/json
25913         - application/xml
25914       produces:
25915         - application/json
25916         - application/xml
25917       responses:
25918         "default":
25919           description: Response codes found in [response codes](https://wiki.onap.org/).
25920       parameters:
25921         - name: equipment-name
25922           in: path
25923           required: true
25924           type: string
25925           example: __EQUIPMENT-NAME__
25926         - name: interface-name
25927           in: path
25928           description: Name that identifies the link aggregate interface
25929           required: true
25930           type: string
25931           example: __INTERFACE-NAME__
25932         - name: interface-name
25933           in: path
25934           description: Name given to the interface
25935           required: true
25936           type: string
25937           example: __INTERFACE-NAME__
25938         - name: pci-id
25939           in: path
25940           description: PCI ID used to identify the sriov-vf
25941           required: true
25942           type: string
25943           example: __PCI-ID__
25944         - name: body
25945           in: body
25946           description: sriov-vf object that needs to be created or updated.
25947           required: true
25948           schema:
25949             $ref: "#/patchDefinitions/sriov-vf"
25950     delete:
25951       tags:
25952         - Network
25953       summary: delete an existing sriov-vf
25954       description: delete an existing sriov-vf
25955       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25956       consumes:
25957         - application/json
25958         - application/xml
25959       produces:
25960         - application/json
25961         - application/xml
25962       responses:
25963         "default":
25964           description: Response codes found in [response codes](https://wiki.onap.org/).
25965       parameters:
25966         - name: equipment-name
25967           in: path
25968           required: true
25969           type: string
25970           example: __EQUIPMENT-NAME__
25971         - name: interface-name
25972           in: path
25973           description: Name that identifies the link aggregate interface
25974           required: true
25975           type: string
25976           example: __INTERFACE-NAME__
25977         - name: interface-name
25978           in: path
25979           description: Name given to the interface
25980           required: true
25981           type: string
25982           example: __INTERFACE-NAME__
25983         - name: pci-id
25984           in: path
25985           description: PCI ID used to identify the sriov-vf
25986           required: true
25987           type: string
25988           example: __PCI-ID__
25989         - name: resource-version
25990           in: query
25991           description: resource-version for concurrency
25992           required: true
25993           type: string
25994   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25995     get:
25996       tags:
25997         - Network
25998       summary: returns sriov-vfs
25999       description: returns sriov-vfs
26000       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
26001       produces:
26002         - application/json
26003         - application/xml
26004       responses:
26005         "200":
26006           description: successful operation
26007           schema:
26008               $ref: "#/getDefinitions/sriov-vfs"
26009         "default":
26010           description: Response codes found in [response codes](https://wiki.onap.org/).
26011       parameters:
26012         - name: equipment-name
26013           in: path
26014           required: true
26015           type: string
26016           example: __EQUIPMENT-NAME__
26017         - name: interface-name
26018           in: path
26019           description: Name that identifies the link aggregate interface
26020           required: true
26021           type: string
26022           example: __INTERFACE-NAME__
26023         - name: interface-name
26024           in: path
26025           description: Name given to the interface
26026           required: true
26027           type: string
26028           example: __INTERFACE-NAME__
26029         - name: prov-status
26030           in: query
26031           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26032           required: false
26033           type: string
26034         - name: interface-id
26035           in: query
26036           description: ID of interface
26037           required: false
26038           type: string
26039         - name: interface-role
26040           in: query
26041           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26042           required: false
26043           type: string
26044         - name: interface-id
26045           in: query
26046           description: ID of interface
26047           required: false
26048           type: string
26049         - name: macaddr
26050           in: query
26051           description: MAC address for the interface
26052           required: false
26053           type: string
26054         - name: network-name
26055           in: query
26056           description: Name of the network
26057           required: false
26058           type: string
26059   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
26060     put:
26061       tags:
26062         - Network
26063       summary: see node definition for valid relationships
26064       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26065       consumes:
26066         - application/json
26067         - application/xml
26068       produces:
26069         - application/json
26070         - application/xml
26071       responses:
26072         "default":
26073           description: Response codes found in [response codes](https://wiki.onap.org/).
26074       parameters:
26075         - name: equipment-name
26076           in: path
26077           required: true
26078           type: string
26079           example: __EQUIPMENT-NAME__
26080         - name: interface-name
26081           in: path
26082           description: Name that identifies the link aggregate interface
26083           required: true
26084           type: string
26085           example: __INTERFACE-NAME__
26086         - name: interface-name
26087           in: path
26088           description: Name given to the interface
26089           required: true
26090           type: string
26091           example: __INTERFACE-NAME__
26092         - name: body
26093           in: body
26094           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26095           required: true
26096           schema:
26097             $ref: "#/definitions/relationship"
26098     delete:
26099       tags:
26100         - Network
26101       summary: delete an existing relationship
26102       description: delete an existing relationship
26103       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
26104       consumes:
26105         - application/json
26106         - application/xml
26107       produces:
26108         - application/json
26109         - application/xml
26110       responses:
26111         "default":
26112           description: Response codes found in [response codes](https://wiki.onap.org/).
26113       parameters:
26114         - name: equipment-name
26115           in: path
26116           required: true
26117           type: string
26118           example: __EQUIPMENT-NAME__
26119         - name: interface-name
26120           in: path
26121           description: Name that identifies the link aggregate interface
26122           required: true
26123           type: string
26124           example: __INTERFACE-NAME__
26125         - name: interface-name
26126           in: path
26127           description: Name given to the interface
26128           required: true
26129           type: string
26130           example: __INTERFACE-NAME__
26131   /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:
26132     put:
26133       tags:
26134         - Network
26135       summary: see node definition for valid relationships
26136       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26137       consumes:
26138         - application/json
26139         - application/xml
26140       produces:
26141         - application/json
26142         - application/xml
26143       responses:
26144         "default":
26145           description: Response codes found in [response codes](https://wiki.onap.org/).
26146       parameters:
26147         - name: equipment-name
26148           in: path
26149           required: true
26150           type: string
26151           example: __EQUIPMENT-NAME__
26152         - name: interface-name
26153           in: path
26154           description: Name that identifies the link aggregate interface
26155           required: true
26156           type: string
26157           example: __INTERFACE-NAME__
26158         - name: interface-name
26159           in: path
26160           description: Name given to the interface
26161           required: true
26162           type: string
26163           example: __INTERFACE-NAME__
26164         - name: l3-interface-ipv4-address
26165           in: path
26166           description: IP address
26167           required: true
26168           type: string
26169           example: __L3-INTERFACE-IPV4-ADDRESS__
26170         - name: body
26171           in: body
26172           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26173           required: true
26174           schema:
26175             $ref: "#/definitions/relationship"
26176     delete:
26177       tags:
26178         - Network
26179       summary: delete an existing relationship
26180       description: delete an existing relationship
26181       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
26182       consumes:
26183         - application/json
26184         - application/xml
26185       produces:
26186         - application/json
26187         - application/xml
26188       responses:
26189         "default":
26190           description: Response codes found in [response codes](https://wiki.onap.org/).
26191       parameters:
26192         - name: equipment-name
26193           in: path
26194           required: true
26195           type: string
26196           example: __EQUIPMENT-NAME__
26197         - name: interface-name
26198           in: path
26199           description: Name that identifies the link aggregate interface
26200           required: true
26201           type: string
26202           example: __INTERFACE-NAME__
26203         - name: interface-name
26204           in: path
26205           description: Name given to the interface
26206           required: true
26207           type: string
26208           example: __INTERFACE-NAME__
26209         - name: l3-interface-ipv4-address
26210           in: path
26211           description: IP address
26212           required: true
26213           type: string
26214           example: __L3-INTERFACE-IPV4-ADDRESS__
26215   /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}:
26216     get:
26217       tags:
26218         - Network
26219       summary: returns l3-interface-ipv4-address-list
26220       description: returns l3-interface-ipv4-address-list
26221       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26222       produces:
26223         - application/json
26224         - application/xml
26225       responses:
26226         "200":
26227           description: successful operation
26228           schema:
26229               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
26230         "default":
26231           description: Response codes found in [response codes](https://wiki.onap.org/).
26232       parameters:
26233         - name: equipment-name
26234           in: path
26235           required: true
26236           type: string
26237           example: __EQUIPMENT-NAME__
26238         - name: interface-name
26239           in: path
26240           description: Name that identifies the link aggregate interface
26241           required: true
26242           type: string
26243           example: __INTERFACE-NAME__
26244         - name: interface-name
26245           in: path
26246           description: Name given to the interface
26247           required: true
26248           type: string
26249           example: __INTERFACE-NAME__
26250         - name: l3-interface-ipv4-address
26251           in: path
26252           description: IP address
26253           required: true
26254           type: string
26255           example: __L3-INTERFACE-IPV4-ADDRESS__
26256         - name: prov-status
26257           in: query
26258           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26259           required: false
26260           type: string
26261         - name: interface-id
26262           in: query
26263           description: ID of interface
26264           required: false
26265           type: string
26266         - name: interface-role
26267           in: query
26268           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26269           required: false
26270           type: string
26271         - name: interface-id
26272           in: query
26273           description: ID of interface
26274           required: false
26275           type: string
26276         - name: macaddr
26277           in: query
26278           description: MAC address for the interface
26279           required: false
26280           type: string
26281         - name: network-name
26282           in: query
26283           description: Name of the network
26284           required: false
26285           type: string
26286         - name: vlan-id-inner
26287           in: query
26288           description: Inner VLAN tag
26289           required: false
26290           type: integer
26291           format: int64
26292         - name: neutron-network-id
26293           in: query
26294           description: Neutron network id of the interface that address belongs to
26295           required: false
26296           type: string
26297         - name: neutron-subnet-id
26298           in: query
26299           description: Neutron id of subnet that address belongs to
26300           required: false
26301           type: string
26302     put:
26303       tags:
26304         - Network
26305       summary: create or update an existing l3-interface-ipv4-address-list
26306       description: |
26307         Create or update an existing l3-interface-ipv4-address-list.
26308         #
26309         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26310       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26311       consumes:
26312         - application/json
26313         - application/xml
26314       produces:
26315         - application/json
26316         - application/xml
26317       responses:
26318         "default":
26319           description: Response codes found in [response codes](https://wiki.onap.org/).
26320       parameters:
26321         - name: equipment-name
26322           in: path
26323           required: true
26324           type: string
26325           example: __EQUIPMENT-NAME__
26326         - name: interface-name
26327           in: path
26328           description: Name that identifies the link aggregate interface
26329           required: true
26330           type: string
26331           example: __INTERFACE-NAME__
26332         - name: interface-name
26333           in: path
26334           description: Name given to the interface
26335           required: true
26336           type: string
26337           example: __INTERFACE-NAME__
26338         - name: l3-interface-ipv4-address
26339           in: path
26340           description: IP address
26341           required: true
26342           type: string
26343           example: __L3-INTERFACE-IPV4-ADDRESS__
26344         - name: body
26345           in: body
26346           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26347           required: true
26348           schema:
26349             $ref: "#/definitions/l3-interface-ipv4-address-list"
26350     patch:
26351       tags:
26352         - Network
26353       summary: update an existing l3-interface-ipv4-address-list
26354       description: |
26355         Update an existing l3-interface-ipv4-address-list
26356         #
26357         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26358         The PUT operation will entirely replace an existing object.
26359         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26360         #
26361         Other differences between PUT and PATCH are:
26362         #
26363         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26364         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26365         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26366       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26367       consumes:
26368         - application/json
26369         - application/xml
26370       produces:
26371         - application/json
26372         - application/xml
26373       responses:
26374         "default":
26375           description: Response codes found in [response codes](https://wiki.onap.org/).
26376       parameters:
26377         - name: equipment-name
26378           in: path
26379           required: true
26380           type: string
26381           example: __EQUIPMENT-NAME__
26382         - name: interface-name
26383           in: path
26384           description: Name that identifies the link aggregate interface
26385           required: true
26386           type: string
26387           example: __INTERFACE-NAME__
26388         - name: interface-name
26389           in: path
26390           description: Name given to the interface
26391           required: true
26392           type: string
26393           example: __INTERFACE-NAME__
26394         - name: l3-interface-ipv4-address
26395           in: path
26396           description: IP address
26397           required: true
26398           type: string
26399           example: __L3-INTERFACE-IPV4-ADDRESS__
26400         - name: body
26401           in: body
26402           description: l3-interface-ipv4-address-list object that needs to be created or updated.
26403           required: true
26404           schema:
26405             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26406     delete:
26407       tags:
26408         - Network
26409       summary: delete an existing l3-interface-ipv4-address-list
26410       description: delete an existing l3-interface-ipv4-address-list
26411       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
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: equipment-name
26423           in: path
26424           required: true
26425           type: string
26426           example: __EQUIPMENT-NAME__
26427         - name: interface-name
26428           in: path
26429           description: Name that identifies the link aggregate interface
26430           required: true
26431           type: string
26432           example: __INTERFACE-NAME__
26433         - name: interface-name
26434           in: path
26435           description: Name given to the interface
26436           required: true
26437           type: string
26438           example: __INTERFACE-NAME__
26439         - name: l3-interface-ipv4-address
26440           in: path
26441           description: IP address
26442           required: true
26443           type: string
26444           example: __L3-INTERFACE-IPV4-ADDRESS__
26445         - name: resource-version
26446           in: query
26447           description: resource-version for concurrency
26448           required: true
26449           type: string
26450   /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:
26451     put:
26452       tags:
26453         - Network
26454       summary: see node definition for valid relationships
26455       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26456       consumes:
26457         - application/json
26458         - application/xml
26459       produces:
26460         - application/json
26461         - application/xml
26462       responses:
26463         "default":
26464           description: Response codes found in [response codes](https://wiki.onap.org/).
26465       parameters:
26466         - name: equipment-name
26467           in: path
26468           required: true
26469           type: string
26470           example: __EQUIPMENT-NAME__
26471         - name: interface-name
26472           in: path
26473           description: Name that identifies the link aggregate interface
26474           required: true
26475           type: string
26476           example: __INTERFACE-NAME__
26477         - name: interface-name
26478           in: path
26479           description: Name given to the interface
26480           required: true
26481           type: string
26482           example: __INTERFACE-NAME__
26483         - name: l3-interface-ipv6-address
26484           in: path
26485           description: IP address
26486           required: true
26487           type: string
26488           example: __L3-INTERFACE-IPV6-ADDRESS__
26489         - name: body
26490           in: body
26491           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26492           required: true
26493           schema:
26494             $ref: "#/definitions/relationship"
26495     delete:
26496       tags:
26497         - Network
26498       summary: delete an existing relationship
26499       description: delete an existing relationship
26500       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26501       consumes:
26502         - application/json
26503         - application/xml
26504       produces:
26505         - application/json
26506         - application/xml
26507       responses:
26508         "default":
26509           description: Response codes found in [response codes](https://wiki.onap.org/).
26510       parameters:
26511         - name: equipment-name
26512           in: path
26513           required: true
26514           type: string
26515           example: __EQUIPMENT-NAME__
26516         - name: interface-name
26517           in: path
26518           description: Name that identifies the link aggregate interface
26519           required: true
26520           type: string
26521           example: __INTERFACE-NAME__
26522         - name: interface-name
26523           in: path
26524           description: Name given to the interface
26525           required: true
26526           type: string
26527           example: __INTERFACE-NAME__
26528         - name: l3-interface-ipv6-address
26529           in: path
26530           description: IP address
26531           required: true
26532           type: string
26533           example: __L3-INTERFACE-IPV6-ADDRESS__
26534   /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}:
26535     get:
26536       tags:
26537         - Network
26538       summary: returns l3-interface-ipv6-address-list
26539       description: returns l3-interface-ipv6-address-list
26540       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26541       produces:
26542         - application/json
26543         - application/xml
26544       responses:
26545         "200":
26546           description: successful operation
26547           schema:
26548               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26549         "default":
26550           description: Response codes found in [response codes](https://wiki.onap.org/).
26551       parameters:
26552         - name: equipment-name
26553           in: path
26554           required: true
26555           type: string
26556           example: __EQUIPMENT-NAME__
26557         - name: interface-name
26558           in: path
26559           description: Name that identifies the link aggregate interface
26560           required: true
26561           type: string
26562           example: __INTERFACE-NAME__
26563         - name: interface-name
26564           in: path
26565           description: Name given to the interface
26566           required: true
26567           type: string
26568           example: __INTERFACE-NAME__
26569         - name: l3-interface-ipv6-address
26570           in: path
26571           description: IP address
26572           required: true
26573           type: string
26574           example: __L3-INTERFACE-IPV6-ADDRESS__
26575         - name: prov-status
26576           in: query
26577           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26578           required: false
26579           type: string
26580         - name: interface-id
26581           in: query
26582           description: ID of interface
26583           required: false
26584           type: string
26585         - name: interface-role
26586           in: query
26587           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26588           required: false
26589           type: string
26590         - name: interface-id
26591           in: query
26592           description: ID of interface
26593           required: false
26594           type: string
26595         - name: macaddr
26596           in: query
26597           description: MAC address for the interface
26598           required: false
26599           type: string
26600         - name: network-name
26601           in: query
26602           description: Name of the network
26603           required: false
26604           type: string
26605         - name: vlan-id-inner
26606           in: query
26607           description: Inner VLAN tag
26608           required: false
26609           type: integer
26610           format: int64
26611         - name: neutron-network-id
26612           in: query
26613           description: Neutron network id of the interface that address belongs to
26614           required: false
26615           type: string
26616         - name: neutron-subnet-id
26617           in: query
26618           description: Neutron id of subnet that address belongs to
26619           required: false
26620           type: string
26621     put:
26622       tags:
26623         - Network
26624       summary: create or update an existing l3-interface-ipv6-address-list
26625       description: |
26626         Create or update an existing l3-interface-ipv6-address-list.
26627         #
26628         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26629       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26630       consumes:
26631         - application/json
26632         - application/xml
26633       produces:
26634         - application/json
26635         - application/xml
26636       responses:
26637         "default":
26638           description: Response codes found in [response codes](https://wiki.onap.org/).
26639       parameters:
26640         - name: equipment-name
26641           in: path
26642           required: true
26643           type: string
26644           example: __EQUIPMENT-NAME__
26645         - name: interface-name
26646           in: path
26647           description: Name that identifies the link aggregate interface
26648           required: true
26649           type: string
26650           example: __INTERFACE-NAME__
26651         - name: interface-name
26652           in: path
26653           description: Name given to the interface
26654           required: true
26655           type: string
26656           example: __INTERFACE-NAME__
26657         - name: l3-interface-ipv6-address
26658           in: path
26659           description: IP address
26660           required: true
26661           type: string
26662           example: __L3-INTERFACE-IPV6-ADDRESS__
26663         - name: body
26664           in: body
26665           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26666           required: true
26667           schema:
26668             $ref: "#/definitions/l3-interface-ipv6-address-list"
26669     patch:
26670       tags:
26671         - Network
26672       summary: update an existing l3-interface-ipv6-address-list
26673       description: |
26674         Update an existing l3-interface-ipv6-address-list
26675         #
26676         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26677         The PUT operation will entirely replace an existing object.
26678         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26679         #
26680         Other differences between PUT and PATCH are:
26681         #
26682         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26683         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26684         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26685       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26686       consumes:
26687         - application/json
26688         - application/xml
26689       produces:
26690         - application/json
26691         - application/xml
26692       responses:
26693         "default":
26694           description: Response codes found in [response codes](https://wiki.onap.org/).
26695       parameters:
26696         - name: equipment-name
26697           in: path
26698           required: true
26699           type: string
26700           example: __EQUIPMENT-NAME__
26701         - name: interface-name
26702           in: path
26703           description: Name that identifies the link aggregate interface
26704           required: true
26705           type: string
26706           example: __INTERFACE-NAME__
26707         - name: interface-name
26708           in: path
26709           description: Name given to the interface
26710           required: true
26711           type: string
26712           example: __INTERFACE-NAME__
26713         - name: l3-interface-ipv6-address
26714           in: path
26715           description: IP address
26716           required: true
26717           type: string
26718           example: __L3-INTERFACE-IPV6-ADDRESS__
26719         - name: body
26720           in: body
26721           description: l3-interface-ipv6-address-list object that needs to be created or updated.
26722           required: true
26723           schema:
26724             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26725     delete:
26726       tags:
26727         - Network
26728       summary: delete an existing l3-interface-ipv6-address-list
26729       description: delete an existing l3-interface-ipv6-address-list
26730       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26731       consumes:
26732         - application/json
26733         - application/xml
26734       produces:
26735         - application/json
26736         - application/xml
26737       responses:
26738         "default":
26739           description: Response codes found in [response codes](https://wiki.onap.org/).
26740       parameters:
26741         - name: equipment-name
26742           in: path
26743           required: true
26744           type: string
26745           example: __EQUIPMENT-NAME__
26746         - name: interface-name
26747           in: path
26748           description: Name that identifies the link aggregate interface
26749           required: true
26750           type: string
26751           example: __INTERFACE-NAME__
26752         - name: interface-name
26753           in: path
26754           description: Name given to the interface
26755           required: true
26756           type: string
26757           example: __INTERFACE-NAME__
26758         - name: l3-interface-ipv6-address
26759           in: path
26760           description: IP address
26761           required: true
26762           type: string
26763           example: __L3-INTERFACE-IPV6-ADDRESS__
26764         - name: resource-version
26765           in: query
26766           description: resource-version for concurrency
26767           required: true
26768           type: string
26769   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26770     get:
26771       tags:
26772         - Network
26773       summary: returns l-interface
26774       description: returns l-interface
26775       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26776       produces:
26777         - application/json
26778         - application/xml
26779       responses:
26780         "200":
26781           description: successful operation
26782           schema:
26783               $ref: "#/getDefinitions/l-interface"
26784         "default":
26785           description: Response codes found in [response codes](https://wiki.onap.org/).
26786       parameters:
26787         - name: equipment-name
26788           in: path
26789           required: true
26790           type: string
26791           example: __EQUIPMENT-NAME__
26792         - name: interface-name
26793           in: path
26794           description: Name that identifies the link aggregate interface
26795           required: true
26796           type: string
26797           example: __INTERFACE-NAME__
26798         - name: interface-name
26799           in: path
26800           description: Name given to the interface
26801           required: true
26802           type: string
26803           example: __INTERFACE-NAME__
26804         - name: prov-status
26805           in: query
26806           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26807           required: false
26808           type: string
26809         - name: interface-id
26810           in: query
26811           description: ID of interface
26812           required: false
26813           type: string
26814         - name: interface-role
26815           in: query
26816           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
26817           required: false
26818           type: string
26819         - name: interface-id
26820           in: query
26821           description: ID of interface
26822           required: false
26823           type: string
26824         - name: macaddr
26825           in: query
26826           description: MAC address for the interface
26827           required: false
26828           type: string
26829         - name: network-name
26830           in: query
26831           description: Name of the network
26832           required: false
26833           type: string
26834     put:
26835       tags:
26836         - Network
26837       summary: create or update an existing l-interface
26838       description: |
26839         Create or update an existing l-interface.
26840         #
26841         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26842       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26843       consumes:
26844         - application/json
26845         - application/xml
26846       produces:
26847         - application/json
26848         - application/xml
26849       responses:
26850         "default":
26851           description: Response codes found in [response codes](https://wiki.onap.org/).
26852       parameters:
26853         - name: equipment-name
26854           in: path
26855           required: true
26856           type: string
26857           example: __EQUIPMENT-NAME__
26858         - name: interface-name
26859           in: path
26860           description: Name that identifies the link aggregate interface
26861           required: true
26862           type: string
26863           example: __INTERFACE-NAME__
26864         - name: interface-name
26865           in: path
26866           description: Name given to the interface
26867           required: true
26868           type: string
26869           example: __INTERFACE-NAME__
26870         - name: body
26871           in: body
26872           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
26873           required: true
26874           schema:
26875             $ref: "#/definitions/l-interface"
26876     patch:
26877       tags:
26878         - Network
26879       summary: update an existing l-interface
26880       description: |
26881         Update an existing l-interface
26882         #
26883         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26884         The PUT operation will entirely replace an existing object.
26885         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26886         #
26887         Other differences between PUT and PATCH are:
26888         #
26889         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26890         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26891         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26892       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26893       consumes:
26894         - application/json
26895         - application/xml
26896       produces:
26897         - application/json
26898         - application/xml
26899       responses:
26900         "default":
26901           description: Response codes found in [response codes](https://wiki.onap.org/).
26902       parameters:
26903         - name: equipment-name
26904           in: path
26905           required: true
26906           type: string
26907           example: __EQUIPMENT-NAME__
26908         - name: interface-name
26909           in: path
26910           description: Name that identifies the link aggregate interface
26911           required: true
26912           type: string
26913           example: __INTERFACE-NAME__
26914         - name: interface-name
26915           in: path
26916           description: Name given to the interface
26917           required: true
26918           type: string
26919           example: __INTERFACE-NAME__
26920         - name: body
26921           in: body
26922           description: l-interface object that needs to be created or updated.
26923           required: true
26924           schema:
26925             $ref: "#/patchDefinitions/l-interface"
26926     delete:
26927       tags:
26928         - Network
26929       summary: delete an existing l-interface
26930       description: delete an existing l-interface
26931       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
26932       consumes:
26933         - application/json
26934         - application/xml
26935       produces:
26936         - application/json
26937         - application/xml
26938       responses:
26939         "default":
26940           description: Response codes found in [response codes](https://wiki.onap.org/).
26941       parameters:
26942         - name: equipment-name
26943           in: path
26944           required: true
26945           type: string
26946           example: __EQUIPMENT-NAME__
26947         - name: interface-name
26948           in: path
26949           description: Name that identifies the link aggregate interface
26950           required: true
26951           type: string
26952           example: __INTERFACE-NAME__
26953         - name: interface-name
26954           in: path
26955           description: Name given to the interface
26956           required: true
26957           type: string
26958           example: __INTERFACE-NAME__
26959         - name: resource-version
26960           in: query
26961           description: resource-version for concurrency
26962           required: true
26963           type: string
26964   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
26965     get:
26966       tags:
26967         - Network
26968       summary: returns l-interfaces
26969       description: returns l-interfaces
26970       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
26971       produces:
26972         - application/json
26973         - application/xml
26974       responses:
26975         "200":
26976           description: successful operation
26977           schema:
26978               $ref: "#/getDefinitions/l-interfaces"
26979         "default":
26980           description: Response codes found in [response codes](https://wiki.onap.org/).
26981       parameters:
26982         - name: equipment-name
26983           in: path
26984           required: true
26985           type: string
26986           example: __EQUIPMENT-NAME__
26987         - name: interface-name
26988           in: path
26989           description: Name that identifies the link aggregate interface
26990           required: true
26991           type: string
26992           example: __INTERFACE-NAME__
26993         - name: prov-status
26994           in: query
26995           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26996           required: false
26997           type: string
26998         - name: interface-id
26999           in: query
27000           description: ID of interface
27001           required: false
27002           type: string
27003         - name: interface-role
27004           in: query
27005           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27006           required: false
27007           type: string
27008   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
27009     get:
27010       tags:
27011         - Network
27012       summary: returns lag-interface
27013       description: returns lag-interface
27014       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
27015       produces:
27016         - application/json
27017         - application/xml
27018       responses:
27019         "200":
27020           description: successful operation
27021           schema:
27022               $ref: "#/getDefinitions/lag-interface"
27023         "default":
27024           description: Response codes found in [response codes](https://wiki.onap.org/).
27025       parameters:
27026         - name: equipment-name
27027           in: path
27028           required: true
27029           type: string
27030           example: __EQUIPMENT-NAME__
27031         - name: interface-name
27032           in: path
27033           description: Name that identifies the link aggregate interface
27034           required: true
27035           type: string
27036           example: __INTERFACE-NAME__
27037         - name: prov-status
27038           in: query
27039           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27040           required: false
27041           type: string
27042         - name: interface-id
27043           in: query
27044           description: ID of interface
27045           required: false
27046           type: string
27047         - name: interface-role
27048           in: query
27049           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27050           required: false
27051           type: string
27052     put:
27053       tags:
27054         - Network
27055       summary: create or update an existing lag-interface
27056       description: |
27057         Create or update an existing lag-interface.
27058         #
27059         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27060       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27061       consumes:
27062         - application/json
27063         - application/xml
27064       produces:
27065         - application/json
27066         - application/xml
27067       responses:
27068         "default":
27069           description: Response codes found in [response codes](https://wiki.onap.org/).
27070       parameters:
27071         - name: equipment-name
27072           in: path
27073           required: true
27074           type: string
27075           example: __EQUIPMENT-NAME__
27076         - name: interface-name
27077           in: path
27078           description: Name that identifies the link aggregate interface
27079           required: true
27080           type: string
27081           example: __INTERFACE-NAME__
27082         - name: body
27083           in: body
27084           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
27085           required: true
27086           schema:
27087             $ref: "#/definitions/lag-interface"
27088     patch:
27089       tags:
27090         - Network
27091       summary: update an existing lag-interface
27092       description: |
27093         Update an existing lag-interface
27094         #
27095         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27096         The PUT operation will entirely replace an existing object.
27097         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27098         #
27099         Other differences between PUT and PATCH are:
27100         #
27101         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27102         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27103         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27104       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
27105       consumes:
27106         - application/json
27107         - application/xml
27108       produces:
27109         - application/json
27110         - application/xml
27111       responses:
27112         "default":
27113           description: Response codes found in [response codes](https://wiki.onap.org/).
27114       parameters:
27115         - name: equipment-name
27116           in: path
27117           required: true
27118           type: string
27119           example: __EQUIPMENT-NAME__
27120         - name: interface-name
27121           in: path
27122           description: Name that identifies the link aggregate interface
27123           required: true
27124           type: string
27125           example: __INTERFACE-NAME__
27126         - name: body
27127           in: body
27128           description: lag-interface object that needs to be created or updated.
27129           required: true
27130           schema:
27131             $ref: "#/patchDefinitions/lag-interface"
27132     delete:
27133       tags:
27134         - Network
27135       summary: delete an existing lag-interface
27136       description: delete an existing lag-interface
27137       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
27138       consumes:
27139         - application/json
27140         - application/xml
27141       produces:
27142         - application/json
27143         - application/xml
27144       responses:
27145         "default":
27146           description: Response codes found in [response codes](https://wiki.onap.org/).
27147       parameters:
27148         - name: equipment-name
27149           in: path
27150           required: true
27151           type: string
27152           example: __EQUIPMENT-NAME__
27153         - name: interface-name
27154           in: path
27155           description: Name that identifies the link aggregate interface
27156           required: true
27157           type: string
27158           example: __INTERFACE-NAME__
27159         - name: resource-version
27160           in: query
27161           description: resource-version for concurrency
27162           required: true
27163           type: string
27164   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
27165     get:
27166       tags:
27167         - Network
27168       summary: returns lag-interfaces
27169       description: returns lag-interfaces
27170       operationId: getNetworkVplsPesVplsPeLagInterfaces
27171       produces:
27172         - application/json
27173         - application/xml
27174       responses:
27175         "200":
27176           description: successful operation
27177           schema:
27178               $ref: "#/getDefinitions/lag-interfaces"
27179         "default":
27180           description: Response codes found in [response codes](https://wiki.onap.org/).
27181       parameters:
27182         - name: equipment-name
27183           in: path
27184           required: true
27185           type: string
27186           example: __EQUIPMENT-NAME__
27187         - name: prov-status
27188           in: query
27189           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27190           required: false
27191           type: string
27192   /network/vpls-pes/vpls-pe/{equipment-name}:
27193     get:
27194       tags:
27195         - Network
27196       summary: returns vpls-pe
27197       description: returns vpls-pe
27198       operationId: getNetworkVplsPesVplsPe
27199       produces:
27200         - application/json
27201         - application/xml
27202       responses:
27203         "200":
27204           description: successful operation
27205           schema:
27206               $ref: "#/getDefinitions/vpls-pe"
27207         "default":
27208           description: Response codes found in [response codes](https://wiki.onap.org/).
27209       parameters:
27210         - name: equipment-name
27211           in: path
27212           required: true
27213           type: string
27214           example: __EQUIPMENT-NAME__
27215         - name: prov-status
27216           in: query
27217           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27218           required: false
27219           type: string
27220     put:
27221       tags:
27222         - Network
27223       summary: create or update an existing vpls-pe
27224       description: |
27225         Create or update an existing vpls-pe.
27226         #
27227         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27228       operationId: createOrUpdateNetworkVplsPesVplsPe
27229       consumes:
27230         - application/json
27231         - application/xml
27232       produces:
27233         - application/json
27234         - application/xml
27235       responses:
27236         "default":
27237           description: Response codes found in [response codes](https://wiki.onap.org/).
27238       parameters:
27239         - name: equipment-name
27240           in: path
27241           required: true
27242           type: string
27243           example: __EQUIPMENT-NAME__
27244         - name: body
27245           in: body
27246           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVplsPesVplsPe.json)
27247           required: true
27248           schema:
27249             $ref: "#/definitions/vpls-pe"
27250     patch:
27251       tags:
27252         - Network
27253       summary: update an existing vpls-pe
27254       description: |
27255         Update an existing vpls-pe
27256         #
27257         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27258         The PUT operation will entirely replace an existing object.
27259         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27260         #
27261         Other differences between PUT and PATCH are:
27262         #
27263         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27264         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27265         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27266       operationId: UpdateNetworkVplsPesVplsPe
27267       consumes:
27268         - application/json
27269         - application/xml
27270       produces:
27271         - application/json
27272         - application/xml
27273       responses:
27274         "default":
27275           description: Response codes found in [response codes](https://wiki.onap.org/).
27276       parameters:
27277         - name: equipment-name
27278           in: path
27279           required: true
27280           type: string
27281           example: __EQUIPMENT-NAME__
27282         - name: body
27283           in: body
27284           description: vpls-pe object that needs to be created or updated.
27285           required: true
27286           schema:
27287             $ref: "#/patchDefinitions/vpls-pe"
27288     delete:
27289       tags:
27290         - Network
27291       summary: delete an existing vpls-pe
27292       description: delete an existing vpls-pe
27293       operationId: deleteNetworkVplsPesVplsPe
27294       consumes:
27295         - application/json
27296         - application/xml
27297       produces:
27298         - application/json
27299         - application/xml
27300       responses:
27301         "default":
27302           description: Response codes found in [response codes](https://wiki.onap.org/).
27303       parameters:
27304         - name: equipment-name
27305           in: path
27306           required: true
27307           type: string
27308           example: __EQUIPMENT-NAME__
27309         - name: resource-version
27310           in: query
27311           description: resource-version for concurrency
27312           required: true
27313           type: string
27314   /network/vpls-pes:
27315     get:
27316       tags:
27317         - Network
27318       summary: returns vpls-pes
27319       description: returns vpls-pes
27320       operationId: getNetworkVplsPes
27321       produces:
27322         - application/json
27323         - application/xml
27324       responses:
27325         "200":
27326           description: successful operation
27327           schema:
27328               $ref: "#/getDefinitions/vpls-pes"
27329         "default":
27330           description: Response codes found in [response codes](https://wiki.onap.org/).
27331   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
27332     put:
27333       tags:
27334         - Network
27335       summary: see node definition for valid relationships
27336       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27337       consumes:
27338         - application/json
27339         - application/xml
27340       produces:
27341         - application/json
27342         - application/xml
27343       responses:
27344         "default":
27345           description: Response codes found in [response codes](https://wiki.onap.org/).
27346       parameters:
27347         - name: multicast-configuration-id
27348           in: path
27349           description: Unique id of multicast configuration.
27350           required: true
27351           type: string
27352           example: __MULTICAST-CONFIGURATION-ID__
27353         - name: body
27354           in: body
27355           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
27356           required: true
27357           schema:
27358             $ref: "#/definitions/relationship"
27359     delete:
27360       tags:
27361         - Network
27362       summary: delete an existing relationship
27363       description: delete an existing relationship
27364       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
27365       consumes:
27366         - application/json
27367         - application/xml
27368       produces:
27369         - application/json
27370         - application/xml
27371       responses:
27372         "default":
27373           description: Response codes found in [response codes](https://wiki.onap.org/).
27374       parameters:
27375         - name: multicast-configuration-id
27376           in: path
27377           description: Unique id of multicast configuration.
27378           required: true
27379           type: string
27380           example: __MULTICAST-CONFIGURATION-ID__
27381   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
27382     get:
27383       tags:
27384         - Network
27385       summary: returns multicast-configuration
27386       description: returns multicast-configuration
27387       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
27388       produces:
27389         - application/json
27390         - application/xml
27391       responses:
27392         "200":
27393           description: successful operation
27394           schema:
27395               $ref: "#/getDefinitions/multicast-configuration"
27396         "default":
27397           description: Response codes found in [response codes](https://wiki.onap.org/).
27398       parameters:
27399         - name: multicast-configuration-id
27400           in: path
27401           description: Unique id of multicast configuration.
27402           required: true
27403           type: string
27404           example: __MULTICAST-CONFIGURATION-ID__
27405     put:
27406       tags:
27407         - Network
27408       summary: create or update an existing multicast-configuration
27409       description: |
27410         Create or update an existing multicast-configuration.
27411         #
27412         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27413       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
27414       consumes:
27415         - application/json
27416         - application/xml
27417       produces:
27418         - application/json
27419         - application/xml
27420       responses:
27421         "default":
27422           description: Response codes found in [response codes](https://wiki.onap.org/).
27423       parameters:
27424         - name: multicast-configuration-id
27425           in: path
27426           description: Unique id of multicast configuration.
27427           required: true
27428           type: string
27429           example: __MULTICAST-CONFIGURATION-ID__
27430         - name: body
27431           in: body
27432           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkMulticastConfigurationsMulticastConfiguration.json)
27433           required: true
27434           schema:
27435             $ref: "#/definitions/multicast-configuration"
27436     patch:
27437       tags:
27438         - Network
27439       summary: update an existing multicast-configuration
27440       description: |
27441         Update an existing multicast-configuration
27442         #
27443         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27444         The PUT operation will entirely replace an existing object.
27445         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27446         #
27447         Other differences between PUT and PATCH are:
27448         #
27449         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27450         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27451         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27452       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
27453       consumes:
27454         - application/json
27455         - application/xml
27456       produces:
27457         - application/json
27458         - application/xml
27459       responses:
27460         "default":
27461           description: Response codes found in [response codes](https://wiki.onap.org/).
27462       parameters:
27463         - name: multicast-configuration-id
27464           in: path
27465           description: Unique id of multicast configuration.
27466           required: true
27467           type: string
27468           example: __MULTICAST-CONFIGURATION-ID__
27469         - name: body
27470           in: body
27471           description: multicast-configuration object that needs to be created or updated.
27472           required: true
27473           schema:
27474             $ref: "#/patchDefinitions/multicast-configuration"
27475     delete:
27476       tags:
27477         - Network
27478       summary: delete an existing multicast-configuration
27479       description: delete an existing multicast-configuration
27480       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
27481       consumes:
27482         - application/json
27483         - application/xml
27484       produces:
27485         - application/json
27486         - application/xml
27487       responses:
27488         "default":
27489           description: Response codes found in [response codes](https://wiki.onap.org/).
27490       parameters:
27491         - name: multicast-configuration-id
27492           in: path
27493           description: Unique id of multicast configuration.
27494           required: true
27495           type: string
27496           example: __MULTICAST-CONFIGURATION-ID__
27497         - name: resource-version
27498           in: query
27499           description: resource-version for concurrency
27500           required: true
27501           type: string
27502   /network/multicast-configurations:
27503     get:
27504       tags:
27505         - Network
27506       summary: returns multicast-configurations
27507       description: returns multicast-configurations
27508       operationId: getNetworkMulticastConfigurations
27509       produces:
27510         - application/json
27511         - application/xml
27512       responses:
27513         "200":
27514           description: successful operation
27515           schema:
27516               $ref: "#/getDefinitions/multicast-configurations"
27517         "default":
27518           description: Response codes found in [response codes](https://wiki.onap.org/).
27519   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
27520     put:
27521       tags:
27522         - Network
27523       summary: see node definition for valid relationships
27524       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27525       consumes:
27526         - application/json
27527         - application/xml
27528       produces:
27529         - application/json
27530         - application/xml
27531       responses:
27532         "default":
27533           description: Response codes found in [response codes](https://wiki.onap.org/).
27534       parameters:
27535         - name: vnf-id
27536           in: path
27537           description: Unique id of VNF.  This is unique across the graph.
27538           required: true
27539           type: string
27540           example: __VNF-ID__
27541         - name: interface-id
27542           in: path
27543           description: Unique ID of the interface
27544           required: true
27545           type: string
27546           example: __INTERFACE-ID__
27547         - name: cvlan-tag
27548           in: path
27549           description: See mis-na-virtualization-platform.yang
27550           required: true
27551           type: integer
27552           format: int64
27553           example: __CVLAN-TAG__
27554         - name: body
27555           in: body
27556           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27557           required: true
27558           schema:
27559             $ref: "#/definitions/relationship"
27560     delete:
27561       tags:
27562         - Network
27563       summary: delete an existing relationship
27564       description: delete an existing relationship
27565       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
27566       consumes:
27567         - application/json
27568         - application/xml
27569       produces:
27570         - application/json
27571         - application/xml
27572       responses:
27573         "default":
27574           description: Response codes found in [response codes](https://wiki.onap.org/).
27575       parameters:
27576         - name: vnf-id
27577           in: path
27578           description: Unique id of VNF.  This is unique across the graph.
27579           required: true
27580           type: string
27581           example: __VNF-ID__
27582         - name: interface-id
27583           in: path
27584           description: Unique ID of the interface
27585           required: true
27586           type: string
27587           example: __INTERFACE-ID__
27588         - name: cvlan-tag
27589           in: path
27590           description: See mis-na-virtualization-platform.yang
27591           required: true
27592           type: integer
27593           format: int64
27594           example: __CVLAN-TAG__
27595   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
27596     get:
27597       tags:
27598         - Network
27599       summary: returns cvlan-tag-entry
27600       description: returns cvlan-tag-entry
27601       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27602       produces:
27603         - application/json
27604         - application/xml
27605       responses:
27606         "200":
27607           description: successful operation
27608           schema:
27609               $ref: "#/getDefinitions/cvlan-tag-entry"
27610         "default":
27611           description: Response codes found in [response codes](https://wiki.onap.org/).
27612       parameters:
27613         - name: vnf-id
27614           in: path
27615           description: Unique id of VNF.  This is unique across the graph.
27616           required: true
27617           type: string
27618           example: __VNF-ID__
27619         - name: interface-id
27620           in: path
27621           description: Unique ID of the interface
27622           required: true
27623           type: string
27624           example: __INTERFACE-ID__
27625         - name: cvlan-tag
27626           in: path
27627           description: See mis-na-virtualization-platform.yang
27628           required: true
27629           type: integer
27630           format: int64
27631           example: __CVLAN-TAG__
27632         - name: vnf-name
27633           in: query
27634           description: Name of VNF.
27635           required: false
27636           type: string
27637         - name: vnf-name2
27638           in: query
27639           description: Alternate name of VNF.
27640           required: false
27641           type: string
27642         - name: vnf-type
27643           in: query
27644           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27645           required: false
27646           type: string
27647         - name: service-id
27648           in: query
27649           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27650           required: false
27651           type: string
27652         - name: regional-resource-zone
27653           in: query
27654           description: Regional way of organizing pservers, source of truth should define values
27655           required: false
27656           type: string
27657         - name: prov-status
27658           in: query
27659           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27660           required: false
27661           type: string
27662         - name: heat-stack-id
27663           in: query
27664           description: Heat stack id corresponding to this instance, managed by MSO
27665           required: false
27666           type: string
27667         - name: vpe-id
27668           in: query
27669           description: Unique ID of VPE connected to this VCE.
27670           required: false
27671           type: string
27672         - name: port-group-id
27673           in: query
27674           description: Unique ID for port group in vmware
27675           required: false
27676           type: string
27677         - name: switch-name
27678           in: query
27679           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27680           required: false
27681           type: string
27682         - name: heat-stack-id
27683           in: query
27684           description: Heat stack id corresponding to this instance, managed by MSO
27685           required: false
27686           type: string
27687     put:
27688       tags:
27689         - Network
27690       summary: create or update an existing cvlan-tag-entry
27691       description: |
27692         Create or update an existing cvlan-tag-entry.
27693         #
27694         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27695       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27696       consumes:
27697         - application/json
27698         - application/xml
27699       produces:
27700         - application/json
27701         - application/xml
27702       responses:
27703         "default":
27704           description: Response codes found in [response codes](https://wiki.onap.org/).
27705       parameters:
27706         - name: vnf-id
27707           in: path
27708           description: Unique id of VNF.  This is unique across the graph.
27709           required: true
27710           type: string
27711           example: __VNF-ID__
27712         - name: interface-id
27713           in: path
27714           description: Unique ID of the interface
27715           required: true
27716           type: string
27717           example: __INTERFACE-ID__
27718         - name: cvlan-tag
27719           in: path
27720           description: See mis-na-virtualization-platform.yang
27721           required: true
27722           type: integer
27723           format: int64
27724           example: __CVLAN-TAG__
27725         - name: body
27726           in: body
27727           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
27728           required: true
27729           schema:
27730             $ref: "#/definitions/cvlan-tag-entry"
27731     patch:
27732       tags:
27733         - Network
27734       summary: update an existing cvlan-tag-entry
27735       description: |
27736         Update an existing cvlan-tag-entry
27737         #
27738         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27739         The PUT operation will entirely replace an existing object.
27740         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27741         #
27742         Other differences between PUT and PATCH are:
27743         #
27744         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27745         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27746         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27747       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27748       consumes:
27749         - application/json
27750         - application/xml
27751       produces:
27752         - application/json
27753         - application/xml
27754       responses:
27755         "default":
27756           description: Response codes found in [response codes](https://wiki.onap.org/).
27757       parameters:
27758         - name: vnf-id
27759           in: path
27760           description: Unique id of VNF.  This is unique across the graph.
27761           required: true
27762           type: string
27763           example: __VNF-ID__
27764         - name: interface-id
27765           in: path
27766           description: Unique ID of the interface
27767           required: true
27768           type: string
27769           example: __INTERFACE-ID__
27770         - name: cvlan-tag
27771           in: path
27772           description: See mis-na-virtualization-platform.yang
27773           required: true
27774           type: integer
27775           format: int64
27776           example: __CVLAN-TAG__
27777         - name: body
27778           in: body
27779           description: cvlan-tag-entry object that needs to be created or updated.
27780           required: true
27781           schema:
27782             $ref: "#/patchDefinitions/cvlan-tag-entry"
27783     delete:
27784       tags:
27785         - Network
27786       summary: delete an existing cvlan-tag-entry
27787       description: delete an existing cvlan-tag-entry
27788       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
27789       consumes:
27790         - application/json
27791         - application/xml
27792       produces:
27793         - application/json
27794         - application/xml
27795       responses:
27796         "default":
27797           description: Response codes found in [response codes](https://wiki.onap.org/).
27798       parameters:
27799         - name: vnf-id
27800           in: path
27801           description: Unique id of VNF.  This is unique across the graph.
27802           required: true
27803           type: string
27804           example: __VNF-ID__
27805         - name: interface-id
27806           in: path
27807           description: Unique ID of the interface
27808           required: true
27809           type: string
27810           example: __INTERFACE-ID__
27811         - name: cvlan-tag
27812           in: path
27813           description: See mis-na-virtualization-platform.yang
27814           required: true
27815           type: integer
27816           format: int64
27817           example: __CVLAN-TAG__
27818         - name: resource-version
27819           in: query
27820           description: resource-version for concurrency
27821           required: true
27822           type: string
27823   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
27824     get:
27825       tags:
27826         - Network
27827       summary: returns cvlan-tags
27828       description: returns cvlan-tags
27829       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
27830       produces:
27831         - application/json
27832         - application/xml
27833       responses:
27834         "200":
27835           description: successful operation
27836           schema:
27837               $ref: "#/getDefinitions/cvlan-tags"
27838         "default":
27839           description: Response codes found in [response codes](https://wiki.onap.org/).
27840       parameters:
27841         - name: vnf-id
27842           in: path
27843           description: Unique id of VNF.  This is unique across the graph.
27844           required: true
27845           type: string
27846           example: __VNF-ID__
27847         - name: interface-id
27848           in: path
27849           description: Unique ID of the interface
27850           required: true
27851           type: string
27852           example: __INTERFACE-ID__
27853         - name: vnf-name
27854           in: query
27855           description: Name of VNF.
27856           required: false
27857           type: string
27858         - name: vnf-name2
27859           in: query
27860           description: Alternate name of VNF.
27861           required: false
27862           type: string
27863         - name: vnf-type
27864           in: query
27865           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
27866           required: false
27867           type: string
27868         - name: service-id
27869           in: query
27870           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
27871           required: false
27872           type: string
27873         - name: regional-resource-zone
27874           in: query
27875           description: Regional way of organizing pservers, source of truth should define values
27876           required: false
27877           type: string
27878         - name: prov-status
27879           in: query
27880           description: Trigger for operational monitoring of this resource by Service Assurance systems.
27881           required: false
27882           type: string
27883         - name: heat-stack-id
27884           in: query
27885           description: Heat stack id corresponding to this instance, managed by MSO
27886           required: false
27887           type: string
27888         - name: vpe-id
27889           in: query
27890           description: Unique ID of VPE connected to this VCE.
27891           required: false
27892           type: string
27893         - name: port-group-id
27894           in: query
27895           description: Unique ID for port group in vmware
27896           required: false
27897           type: string
27898         - name: switch-name
27899           in: query
27900           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
27901           required: false
27902           type: string
27903         - name: heat-stack-id
27904           in: query
27905           description: Heat stack id corresponding to this instance, managed by MSO
27906           required: false
27907           type: string
27908   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
27909     put:
27910       tags:
27911         - Network
27912       summary: see node definition for valid relationships
27913       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27914       consumes:
27915         - application/json
27916         - application/xml
27917       produces:
27918         - application/json
27919         - application/xml
27920       responses:
27921         "default":
27922           description: Response codes found in [response codes](https://wiki.onap.org/).
27923       parameters:
27924         - name: vnf-id
27925           in: path
27926           description: Unique id of VNF.  This is unique across the graph.
27927           required: true
27928           type: string
27929           example: __VNF-ID__
27930         - name: interface-id
27931           in: path
27932           description: Unique ID of the interface
27933           required: true
27934           type: string
27935           example: __INTERFACE-ID__
27936         - name: body
27937           in: body
27938           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
27939           required: true
27940           schema:
27941             $ref: "#/definitions/relationship"
27942     delete:
27943       tags:
27944         - Network
27945       summary: delete an existing relationship
27946       description: delete an existing relationship
27947       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
27948       consumes:
27949         - application/json
27950         - application/xml
27951       produces:
27952         - application/json
27953         - application/xml
27954       responses:
27955         "default":
27956           description: Response codes found in [response codes](https://wiki.onap.org/).
27957       parameters:
27958         - name: vnf-id
27959           in: path
27960           description: Unique id of VNF.  This is unique across the graph.
27961           required: true
27962           type: string
27963           example: __VNF-ID__
27964         - name: interface-id
27965           in: path
27966           description: Unique ID of the interface
27967           required: true
27968           type: string
27969           example: __INTERFACE-ID__
27970   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
27971     get:
27972       tags:
27973         - Network
27974       summary: returns port-group
27975       description: returns port-group
27976       operationId: getNetworkVcesVcePortGroupsPortGroup
27977       produces:
27978         - application/json
27979         - application/xml
27980       responses:
27981         "200":
27982           description: successful operation
27983           schema:
27984               $ref: "#/getDefinitions/port-group"
27985         "default":
27986           description: Response codes found in [response codes](https://wiki.onap.org/).
27987       parameters:
27988         - name: vnf-id
27989           in: path
27990           description: Unique id of VNF.  This is unique across the graph.
27991           required: true
27992           type: string
27993           example: __VNF-ID__
27994         - name: interface-id
27995           in: path
27996           description: Unique ID of the interface
27997           required: true
27998           type: string
27999           example: __INTERFACE-ID__
28000         - name: vnf-name
28001           in: query
28002           description: Name of VNF.
28003           required: false
28004           type: string
28005         - name: vnf-name2
28006           in: query
28007           description: Alternate name of VNF.
28008           required: false
28009           type: string
28010         - name: vnf-type
28011           in: query
28012           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28013           required: false
28014           type: string
28015         - name: service-id
28016           in: query
28017           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28018           required: false
28019           type: string
28020         - name: regional-resource-zone
28021           in: query
28022           description: Regional way of organizing pservers, source of truth should define values
28023           required: false
28024           type: string
28025         - name: prov-status
28026           in: query
28027           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28028           required: false
28029           type: string
28030         - name: heat-stack-id
28031           in: query
28032           description: Heat stack id corresponding to this instance, managed by MSO
28033           required: false
28034           type: string
28035         - name: vpe-id
28036           in: query
28037           description: Unique ID of VPE connected to this VCE.
28038           required: false
28039           type: string
28040         - name: port-group-id
28041           in: query
28042           description: Unique ID for port group in vmware
28043           required: false
28044           type: string
28045         - name: switch-name
28046           in: query
28047           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
28048           required: false
28049           type: string
28050         - name: heat-stack-id
28051           in: query
28052           description: Heat stack id corresponding to this instance, managed by MSO
28053           required: false
28054           type: string
28055     put:
28056       tags:
28057         - Network
28058       summary: create or update an existing port-group
28059       description: |
28060         Create or update an existing port-group.
28061         #
28062         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28063       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
28064       consumes:
28065         - application/json
28066         - application/xml
28067       produces:
28068         - application/json
28069         - application/xml
28070       responses:
28071         "default":
28072           description: Response codes found in [response codes](https://wiki.onap.org/).
28073       parameters:
28074         - name: vnf-id
28075           in: path
28076           description: Unique id of VNF.  This is unique across the graph.
28077           required: true
28078           type: string
28079           example: __VNF-ID__
28080         - name: interface-id
28081           in: path
28082           description: Unique ID of the interface
28083           required: true
28084           type: string
28085           example: __INTERFACE-ID__
28086         - name: body
28087           in: body
28088           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVcePortGroupsPortGroup.json)
28089           required: true
28090           schema:
28091             $ref: "#/definitions/port-group"
28092     patch:
28093       tags:
28094         - Network
28095       summary: update an existing port-group
28096       description: |
28097         Update an existing port-group
28098         #
28099         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28100         The PUT operation will entirely replace an existing object.
28101         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28102         #
28103         Other differences between PUT and PATCH are:
28104         #
28105         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28106         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28107         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28108       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
28109       consumes:
28110         - application/json
28111         - application/xml
28112       produces:
28113         - application/json
28114         - application/xml
28115       responses:
28116         "default":
28117           description: Response codes found in [response codes](https://wiki.onap.org/).
28118       parameters:
28119         - name: vnf-id
28120           in: path
28121           description: Unique id of VNF.  This is unique across the graph.
28122           required: true
28123           type: string
28124           example: __VNF-ID__
28125         - name: interface-id
28126           in: path
28127           description: Unique ID of the interface
28128           required: true
28129           type: string
28130           example: __INTERFACE-ID__
28131         - name: body
28132           in: body
28133           description: port-group object that needs to be created or updated.
28134           required: true
28135           schema:
28136             $ref: "#/patchDefinitions/port-group"
28137     delete:
28138       tags:
28139         - Network
28140       summary: delete an existing port-group
28141       description: delete an existing port-group
28142       operationId: deleteNetworkVcesVcePortGroupsPortGroup
28143       consumes:
28144         - application/json
28145         - application/xml
28146       produces:
28147         - application/json
28148         - application/xml
28149       responses:
28150         "default":
28151           description: Response codes found in [response codes](https://wiki.onap.org/).
28152       parameters:
28153         - name: vnf-id
28154           in: path
28155           description: Unique id of VNF.  This is unique across the graph.
28156           required: true
28157           type: string
28158           example: __VNF-ID__
28159         - name: interface-id
28160           in: path
28161           description: Unique ID of the interface
28162           required: true
28163           type: string
28164           example: __INTERFACE-ID__
28165         - name: resource-version
28166           in: query
28167           description: resource-version for concurrency
28168           required: true
28169           type: string
28170   /network/vces/vce/{vnf-id}/port-groups:
28171     get:
28172       tags:
28173         - Network
28174       summary: returns port-groups
28175       description: returns port-groups
28176       operationId: getNetworkVcesVcePortGroups
28177       produces:
28178         - application/json
28179         - application/xml
28180       responses:
28181         "200":
28182           description: successful operation
28183           schema:
28184               $ref: "#/getDefinitions/port-groups"
28185         "default":
28186           description: Response codes found in [response codes](https://wiki.onap.org/).
28187       parameters:
28188         - name: vnf-id
28189           in: path
28190           description: Unique id of VNF.  This is unique across the graph.
28191           required: true
28192           type: string
28193           example: __VNF-ID__
28194         - name: vnf-name
28195           in: query
28196           description: Name of VNF.
28197           required: false
28198           type: string
28199         - name: vnf-name2
28200           in: query
28201           description: Alternate name of VNF.
28202           required: false
28203           type: string
28204         - name: vnf-type
28205           in: query
28206           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28207           required: false
28208           type: string
28209         - name: service-id
28210           in: query
28211           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28212           required: false
28213           type: string
28214         - name: regional-resource-zone
28215           in: query
28216           description: Regional way of organizing pservers, source of truth should define values
28217           required: false
28218           type: string
28219         - name: prov-status
28220           in: query
28221           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28222           required: false
28223           type: string
28224         - name: heat-stack-id
28225           in: query
28226           description: Heat stack id corresponding to this instance, managed by MSO
28227           required: false
28228           type: string
28229         - name: vpe-id
28230           in: query
28231           description: Unique ID of VPE connected to this VCE.
28232           required: false
28233           type: string
28234   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28235     put:
28236       tags:
28237         - Network
28238       summary: see node definition for valid relationships
28239       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
28240       consumes:
28241         - application/json
28242         - application/xml
28243       produces:
28244         - application/json
28245         - application/xml
28246       responses:
28247         "default":
28248           description: Response codes found in [response codes](https://wiki.onap.org/).
28249       parameters:
28250         - name: vnf-id
28251           in: path
28252           description: Unique id of VNF.  This is unique across the graph.
28253           required: true
28254           type: string
28255           example: __VNF-ID__
28256         - name: group-uuid
28257           in: path
28258           description: Unique ID for the license group the resource belongs to, should be uuid.
28259           required: true
28260           type: string
28261           example: __GROUP-UUID__
28262         - name: resource-uuid
28263           in: path
28264           description: Unique ID of a license resource.
28265           required: true
28266           type: string
28267           example: __RESOURCE-UUID__
28268         - name: body
28269           in: body
28270           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
28271           required: true
28272           schema:
28273             $ref: "#/definitions/relationship"
28274     delete:
28275       tags:
28276         - Network
28277       summary: delete an existing relationship
28278       description: delete an existing relationship
28279       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
28280       consumes:
28281         - application/json
28282         - application/xml
28283       produces:
28284         - application/json
28285         - application/xml
28286       responses:
28287         "default":
28288           description: Response codes found in [response codes](https://wiki.onap.org/).
28289       parameters:
28290         - name: vnf-id
28291           in: path
28292           description: Unique id of VNF.  This is unique across the graph.
28293           required: true
28294           type: string
28295           example: __VNF-ID__
28296         - name: group-uuid
28297           in: path
28298           description: Unique ID for the license group the resource belongs to, should be uuid.
28299           required: true
28300           type: string
28301           example: __GROUP-UUID__
28302         - name: resource-uuid
28303           in: path
28304           description: Unique ID of a license resource.
28305           required: true
28306           type: string
28307           example: __RESOURCE-UUID__
28308   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
28309     get:
28310       tags:
28311         - Network
28312       summary: returns license
28313       description: returns license
28314       operationId: getNetworkVcesVceLicensesLicense
28315       produces:
28316         - application/json
28317         - application/xml
28318       responses:
28319         "200":
28320           description: successful operation
28321           schema:
28322               $ref: "#/getDefinitions/license"
28323         "default":
28324           description: Response codes found in [response codes](https://wiki.onap.org/).
28325       parameters:
28326         - name: vnf-id
28327           in: path
28328           description: Unique id of VNF.  This is unique across the graph.
28329           required: true
28330           type: string
28331           example: __VNF-ID__
28332         - name: group-uuid
28333           in: path
28334           description: Unique ID for the license group the resource belongs to, should be uuid.
28335           required: true
28336           type: string
28337           example: __GROUP-UUID__
28338         - name: resource-uuid
28339           in: path
28340           description: Unique ID of a license resource.
28341           required: true
28342           type: string
28343           example: __RESOURCE-UUID__
28344         - name: vnf-name
28345           in: query
28346           description: Name of VNF.
28347           required: false
28348           type: string
28349         - name: vnf-name2
28350           in: query
28351           description: Alternate name of VNF.
28352           required: false
28353           type: string
28354         - name: vnf-type
28355           in: query
28356           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28357           required: false
28358           type: string
28359         - name: service-id
28360           in: query
28361           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28362           required: false
28363           type: string
28364         - name: regional-resource-zone
28365           in: query
28366           description: Regional way of organizing pservers, source of truth should define values
28367           required: false
28368           type: string
28369         - name: prov-status
28370           in: query
28371           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28372           required: false
28373           type: string
28374         - name: heat-stack-id
28375           in: query
28376           description: Heat stack id corresponding to this instance, managed by MSO
28377           required: false
28378           type: string
28379         - name: vpe-id
28380           in: query
28381           description: Unique ID of VPE connected to this VCE.
28382           required: false
28383           type: string
28384     put:
28385       tags:
28386         - Network
28387       summary: create or update an existing license
28388       description: |
28389         Create or update an existing license.
28390         #
28391         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28392       operationId: createOrUpdateNetworkVcesVceLicensesLicense
28393       consumes:
28394         - application/json
28395         - application/xml
28396       produces:
28397         - application/json
28398         - application/xml
28399       responses:
28400         "default":
28401           description: Response codes found in [response codes](https://wiki.onap.org/).
28402       parameters:
28403         - name: vnf-id
28404           in: path
28405           description: Unique id of VNF.  This is unique across the graph.
28406           required: true
28407           type: string
28408           example: __VNF-ID__
28409         - name: group-uuid
28410           in: path
28411           description: Unique ID for the license group the resource belongs to, should be uuid.
28412           required: true
28413           type: string
28414           example: __GROUP-UUID__
28415         - name: resource-uuid
28416           in: path
28417           description: Unique ID of a license resource.
28418           required: true
28419           type: string
28420           example: __RESOURCE-UUID__
28421         - name: body
28422           in: body
28423           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceLicensesLicense.json)
28424           required: true
28425           schema:
28426             $ref: "#/definitions/license"
28427     patch:
28428       tags:
28429         - Network
28430       summary: update an existing license
28431       description: |
28432         Update an existing license
28433         #
28434         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28435         The PUT operation will entirely replace an existing object.
28436         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28437         #
28438         Other differences between PUT and PATCH are:
28439         #
28440         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28441         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28442         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28443       operationId: UpdateNetworkVcesVceLicensesLicense
28444       consumes:
28445         - application/json
28446         - application/xml
28447       produces:
28448         - application/json
28449         - application/xml
28450       responses:
28451         "default":
28452           description: Response codes found in [response codes](https://wiki.onap.org/).
28453       parameters:
28454         - name: vnf-id
28455           in: path
28456           description: Unique id of VNF.  This is unique across the graph.
28457           required: true
28458           type: string
28459           example: __VNF-ID__
28460         - name: group-uuid
28461           in: path
28462           description: Unique ID for the license group the resource belongs to, should be uuid.
28463           required: true
28464           type: string
28465           example: __GROUP-UUID__
28466         - name: resource-uuid
28467           in: path
28468           description: Unique ID of a license resource.
28469           required: true
28470           type: string
28471           example: __RESOURCE-UUID__
28472         - name: body
28473           in: body
28474           description: license object that needs to be created or updated.
28475           required: true
28476           schema:
28477             $ref: "#/patchDefinitions/license"
28478     delete:
28479       tags:
28480         - Network
28481       summary: delete an existing license
28482       description: delete an existing license
28483       operationId: deleteNetworkVcesVceLicensesLicense
28484       consumes:
28485         - application/json
28486         - application/xml
28487       produces:
28488         - application/json
28489         - application/xml
28490       responses:
28491         "default":
28492           description: Response codes found in [response codes](https://wiki.onap.org/).
28493       parameters:
28494         - name: vnf-id
28495           in: path
28496           description: Unique id of VNF.  This is unique across the graph.
28497           required: true
28498           type: string
28499           example: __VNF-ID__
28500         - name: group-uuid
28501           in: path
28502           description: Unique ID for the license group the resource belongs to, should be uuid.
28503           required: true
28504           type: string
28505           example: __GROUP-UUID__
28506         - name: resource-uuid
28507           in: path
28508           description: Unique ID of a license resource.
28509           required: true
28510           type: string
28511           example: __RESOURCE-UUID__
28512         - name: resource-version
28513           in: query
28514           description: resource-version for concurrency
28515           required: true
28516           type: string
28517   /network/vces/vce/{vnf-id}/licenses:
28518     get:
28519       tags:
28520         - Network
28521       summary: returns licenses
28522       description: returns licenses
28523       operationId: getNetworkVcesVceLicenses
28524       produces:
28525         - application/json
28526         - application/xml
28527       responses:
28528         "200":
28529           description: successful operation
28530           schema:
28531               $ref: "#/getDefinitions/licenses"
28532         "default":
28533           description: Response codes found in [response codes](https://wiki.onap.org/).
28534       parameters:
28535         - name: vnf-id
28536           in: path
28537           description: Unique id of VNF.  This is unique across the graph.
28538           required: true
28539           type: string
28540           example: __VNF-ID__
28541         - name: vnf-name
28542           in: query
28543           description: Name of VNF.
28544           required: false
28545           type: string
28546         - name: vnf-name2
28547           in: query
28548           description: Alternate name of VNF.
28549           required: false
28550           type: string
28551         - name: vnf-type
28552           in: query
28553           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28554           required: false
28555           type: string
28556         - name: service-id
28557           in: query
28558           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28559           required: false
28560           type: string
28561         - name: regional-resource-zone
28562           in: query
28563           description: Regional way of organizing pservers, source of truth should define values
28564           required: false
28565           type: string
28566         - name: prov-status
28567           in: query
28568           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28569           required: false
28570           type: string
28571         - name: heat-stack-id
28572           in: query
28573           description: Heat stack id corresponding to this instance, managed by MSO
28574           required: false
28575           type: string
28576         - name: vpe-id
28577           in: query
28578           description: Unique ID of VPE connected to this VCE.
28579           required: false
28580           type: string
28581   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
28582     put:
28583       tags:
28584         - Network
28585       summary: see node definition for valid relationships
28586       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28587       consumes:
28588         - application/json
28589         - application/xml
28590       produces:
28591         - application/json
28592         - application/xml
28593       responses:
28594         "default":
28595           description: Response codes found in [response codes](https://wiki.onap.org/).
28596       parameters:
28597         - name: vnf-id
28598           in: path
28599           description: Unique id of VNF.  This is unique across the graph.
28600           required: true
28601           type: string
28602           example: __VNF-ID__
28603         - name: group-uuid
28604           in: path
28605           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28606           required: true
28607           type: string
28608           example: __GROUP-UUID__
28609         - name: resource-uuid
28610           in: path
28611           description: Unique ID of an entitlement resource.
28612           required: true
28613           type: string
28614           example: __RESOURCE-UUID__
28615         - name: body
28616           in: body
28617           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
28618           required: true
28619           schema:
28620             $ref: "#/definitions/relationship"
28621     delete:
28622       tags:
28623         - Network
28624       summary: delete an existing relationship
28625       description: delete an existing relationship
28626       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
28627       consumes:
28628         - application/json
28629         - application/xml
28630       produces:
28631         - application/json
28632         - application/xml
28633       responses:
28634         "default":
28635           description: Response codes found in [response codes](https://wiki.onap.org/).
28636       parameters:
28637         - name: vnf-id
28638           in: path
28639           description: Unique id of VNF.  This is unique across the graph.
28640           required: true
28641           type: string
28642           example: __VNF-ID__
28643         - name: group-uuid
28644           in: path
28645           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28646           required: true
28647           type: string
28648           example: __GROUP-UUID__
28649         - name: resource-uuid
28650           in: path
28651           description: Unique ID of an entitlement resource.
28652           required: true
28653           type: string
28654           example: __RESOURCE-UUID__
28655   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
28656     get:
28657       tags:
28658         - Network
28659       summary: returns entitlement
28660       description: returns entitlement
28661       operationId: getNetworkVcesVceEntitlementsEntitlement
28662       produces:
28663         - application/json
28664         - application/xml
28665       responses:
28666         "200":
28667           description: successful operation
28668           schema:
28669               $ref: "#/getDefinitions/entitlement"
28670         "default":
28671           description: Response codes found in [response codes](https://wiki.onap.org/).
28672       parameters:
28673         - name: vnf-id
28674           in: path
28675           description: Unique id of VNF.  This is unique across the graph.
28676           required: true
28677           type: string
28678           example: __VNF-ID__
28679         - name: group-uuid
28680           in: path
28681           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28682           required: true
28683           type: string
28684           example: __GROUP-UUID__
28685         - name: resource-uuid
28686           in: path
28687           description: Unique ID of an entitlement resource.
28688           required: true
28689           type: string
28690           example: __RESOURCE-UUID__
28691         - name: vnf-name
28692           in: query
28693           description: Name of VNF.
28694           required: false
28695           type: string
28696         - name: vnf-name2
28697           in: query
28698           description: Alternate name of VNF.
28699           required: false
28700           type: string
28701         - name: vnf-type
28702           in: query
28703           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28704           required: false
28705           type: string
28706         - name: service-id
28707           in: query
28708           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28709           required: false
28710           type: string
28711         - name: regional-resource-zone
28712           in: query
28713           description: Regional way of organizing pservers, source of truth should define values
28714           required: false
28715           type: string
28716         - name: prov-status
28717           in: query
28718           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28719           required: false
28720           type: string
28721         - name: heat-stack-id
28722           in: query
28723           description: Heat stack id corresponding to this instance, managed by MSO
28724           required: false
28725           type: string
28726         - name: vpe-id
28727           in: query
28728           description: Unique ID of VPE connected to this VCE.
28729           required: false
28730           type: string
28731     put:
28732       tags:
28733         - Network
28734       summary: create or update an existing entitlement
28735       description: |
28736         Create or update an existing entitlement.
28737         #
28738         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28739       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
28740       consumes:
28741         - application/json
28742         - application/xml
28743       produces:
28744         - application/json
28745         - application/xml
28746       responses:
28747         "default":
28748           description: Response codes found in [response codes](https://wiki.onap.org/).
28749       parameters:
28750         - name: vnf-id
28751           in: path
28752           description: Unique id of VNF.  This is unique across the graph.
28753           required: true
28754           type: string
28755           example: __VNF-ID__
28756         - name: group-uuid
28757           in: path
28758           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28759           required: true
28760           type: string
28761           example: __GROUP-UUID__
28762         - name: resource-uuid
28763           in: path
28764           description: Unique ID of an entitlement resource.
28765           required: true
28766           type: string
28767           example: __RESOURCE-UUID__
28768         - name: body
28769           in: body
28770           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVceEntitlementsEntitlement.json)
28771           required: true
28772           schema:
28773             $ref: "#/definitions/entitlement"
28774     patch:
28775       tags:
28776         - Network
28777       summary: update an existing entitlement
28778       description: |
28779         Update an existing entitlement
28780         #
28781         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28782         The PUT operation will entirely replace an existing object.
28783         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28784         #
28785         Other differences between PUT and PATCH are:
28786         #
28787         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28788         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28789         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28790       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
28791       consumes:
28792         - application/json
28793         - application/xml
28794       produces:
28795         - application/json
28796         - application/xml
28797       responses:
28798         "default":
28799           description: Response codes found in [response codes](https://wiki.onap.org/).
28800       parameters:
28801         - name: vnf-id
28802           in: path
28803           description: Unique id of VNF.  This is unique across the graph.
28804           required: true
28805           type: string
28806           example: __VNF-ID__
28807         - name: group-uuid
28808           in: path
28809           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28810           required: true
28811           type: string
28812           example: __GROUP-UUID__
28813         - name: resource-uuid
28814           in: path
28815           description: Unique ID of an entitlement resource.
28816           required: true
28817           type: string
28818           example: __RESOURCE-UUID__
28819         - name: body
28820           in: body
28821           description: entitlement object that needs to be created or updated.
28822           required: true
28823           schema:
28824             $ref: "#/patchDefinitions/entitlement"
28825     delete:
28826       tags:
28827         - Network
28828       summary: delete an existing entitlement
28829       description: delete an existing entitlement
28830       operationId: deleteNetworkVcesVceEntitlementsEntitlement
28831       consumes:
28832         - application/json
28833         - application/xml
28834       produces:
28835         - application/json
28836         - application/xml
28837       responses:
28838         "default":
28839           description: Response codes found in [response codes](https://wiki.onap.org/).
28840       parameters:
28841         - name: vnf-id
28842           in: path
28843           description: Unique id of VNF.  This is unique across the graph.
28844           required: true
28845           type: string
28846           example: __VNF-ID__
28847         - name: group-uuid
28848           in: path
28849           description: Unique ID for the entitlement group the resource comes from, should be uuid.
28850           required: true
28851           type: string
28852           example: __GROUP-UUID__
28853         - name: resource-uuid
28854           in: path
28855           description: Unique ID of an entitlement resource.
28856           required: true
28857           type: string
28858           example: __RESOURCE-UUID__
28859         - name: resource-version
28860           in: query
28861           description: resource-version for concurrency
28862           required: true
28863           type: string
28864   /network/vces/vce/{vnf-id}/entitlements:
28865     get:
28866       tags:
28867         - Network
28868       summary: returns entitlements
28869       description: returns entitlements
28870       operationId: getNetworkVcesVceEntitlements
28871       produces:
28872         - application/json
28873         - application/xml
28874       responses:
28875         "200":
28876           description: successful operation
28877           schema:
28878               $ref: "#/getDefinitions/entitlements"
28879         "default":
28880           description: Response codes found in [response codes](https://wiki.onap.org/).
28881       parameters:
28882         - name: vnf-id
28883           in: path
28884           description: Unique id of VNF.  This is unique across the graph.
28885           required: true
28886           type: string
28887           example: __VNF-ID__
28888         - name: vnf-name
28889           in: query
28890           description: Name of VNF.
28891           required: false
28892           type: string
28893         - name: vnf-name2
28894           in: query
28895           description: Alternate name of VNF.
28896           required: false
28897           type: string
28898         - name: vnf-type
28899           in: query
28900           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
28901           required: false
28902           type: string
28903         - name: service-id
28904           in: query
28905           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
28906           required: false
28907           type: string
28908         - name: regional-resource-zone
28909           in: query
28910           description: Regional way of organizing pservers, source of truth should define values
28911           required: false
28912           type: string
28913         - name: prov-status
28914           in: query
28915           description: Trigger for operational monitoring of this resource by Service Assurance systems.
28916           required: false
28917           type: string
28918         - name: heat-stack-id
28919           in: query
28920           description: Heat stack id corresponding to this instance, managed by MSO
28921           required: false
28922           type: string
28923         - name: vpe-id
28924           in: query
28925           description: Unique ID of VPE connected to this VCE.
28926           required: false
28927           type: string
28928   /network/vces/vce/{vnf-id}/relationship-list/relationship:
28929     put:
28930       tags:
28931         - Network
28932       summary: see node definition for valid relationships
28933       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
28934       consumes:
28935         - application/json
28936         - application/xml
28937       produces:
28938         - application/json
28939         - application/xml
28940       responses:
28941         "default":
28942           description: Response codes found in [response codes](https://wiki.onap.org/).
28943       parameters:
28944         - name: vnf-id
28945           in: path
28946           description: Unique id of VNF.  This is unique across the graph.
28947           required: true
28948           type: string
28949           example: __VNF-ID__
28950         - name: body
28951           in: body
28952           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
28953           required: true
28954           schema:
28955             $ref: "#/definitions/relationship"
28956     delete:
28957       tags:
28958         - Network
28959       summary: delete an existing relationship
28960       description: delete an existing relationship
28961       operationId: deleteNetworkVcesVceRelationshipListRelationship
28962       consumes:
28963         - application/json
28964         - application/xml
28965       produces:
28966         - application/json
28967         - application/xml
28968       responses:
28969         "default":
28970           description: Response codes found in [response codes](https://wiki.onap.org/).
28971       parameters:
28972         - name: vnf-id
28973           in: path
28974           description: Unique id of VNF.  This is unique across the graph.
28975           required: true
28976           type: string
28977           example: __VNF-ID__
28978   /network/vces/vce/{vnf-id}:
28979     get:
28980       tags:
28981         - Network
28982       summary: returns vce
28983       description: returns vce
28984       operationId: getNetworkVcesVce
28985       produces:
28986         - application/json
28987         - application/xml
28988       responses:
28989         "200":
28990           description: successful operation
28991           schema:
28992               $ref: "#/getDefinitions/vce"
28993         "default":
28994           description: Response codes found in [response codes](https://wiki.onap.org/).
28995       parameters:
28996         - name: vnf-id
28997           in: path
28998           description: Unique id of VNF.  This is unique across the graph.
28999           required: true
29000           type: string
29001           example: __VNF-ID__
29002         - name: vnf-name
29003           in: query
29004           description: Name of VNF.
29005           required: false
29006           type: string
29007         - name: vnf-name2
29008           in: query
29009           description: Alternate name of VNF.
29010           required: false
29011           type: string
29012         - name: vnf-type
29013           in: query
29014           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
29015           required: false
29016           type: string
29017         - name: service-id
29018           in: query
29019           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
29020           required: false
29021           type: string
29022         - name: regional-resource-zone
29023           in: query
29024           description: Regional way of organizing pservers, source of truth should define values
29025           required: false
29026           type: string
29027         - name: prov-status
29028           in: query
29029           description: Trigger for operational monitoring of this resource by Service Assurance systems.
29030           required: false
29031           type: string
29032         - name: heat-stack-id
29033           in: query
29034           description: Heat stack id corresponding to this instance, managed by MSO
29035           required: false
29036           type: string
29037         - name: vpe-id
29038           in: query
29039           description: Unique ID of VPE connected to this VCE.
29040           required: false
29041           type: string
29042     put:
29043       tags:
29044         - Network
29045       summary: create or update an existing vce
29046       description: |
29047         Create or update an existing vce.
29048         #
29049         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29050       operationId: createOrUpdateNetworkVcesVce
29051       consumes:
29052         - application/json
29053         - application/xml
29054       produces:
29055         - application/json
29056         - application/xml
29057       responses:
29058         "default":
29059           description: Response codes found in [response codes](https://wiki.onap.org/).
29060       parameters:
29061         - name: vnf-id
29062           in: path
29063           description: Unique id of VNF.  This is unique across the graph.
29064           required: true
29065           type: string
29066           example: __VNF-ID__
29067         - name: body
29068           in: body
29069           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVcesVce.json)
29070           required: true
29071           schema:
29072             $ref: "#/definitions/vce"
29073     patch:
29074       tags:
29075         - Network
29076       summary: update an existing vce
29077       description: |
29078         Update an existing vce
29079         #
29080         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29081         The PUT operation will entirely replace an existing object.
29082         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29083         #
29084         Other differences between PUT and PATCH are:
29085         #
29086         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29087         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29088         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29089       operationId: UpdateNetworkVcesVce
29090       consumes:
29091         - application/json
29092         - application/xml
29093       produces:
29094         - application/json
29095         - application/xml
29096       responses:
29097         "default":
29098           description: Response codes found in [response codes](https://wiki.onap.org/).
29099       parameters:
29100         - name: vnf-id
29101           in: path
29102           description: Unique id of VNF.  This is unique across the graph.
29103           required: true
29104           type: string
29105           example: __VNF-ID__
29106         - name: body
29107           in: body
29108           description: vce object that needs to be created or updated.
29109           required: true
29110           schema:
29111             $ref: "#/patchDefinitions/vce"
29112     delete:
29113       tags:
29114         - Network
29115       summary: delete an existing vce
29116       description: delete an existing vce
29117       operationId: deleteNetworkVcesVce
29118       consumes:
29119         - application/json
29120         - application/xml
29121       produces:
29122         - application/json
29123         - application/xml
29124       responses:
29125         "default":
29126           description: Response codes found in [response codes](https://wiki.onap.org/).
29127       parameters:
29128         - name: vnf-id
29129           in: path
29130           description: Unique id of VNF.  This is unique across the graph.
29131           required: true
29132           type: string
29133           example: __VNF-ID__
29134         - name: resource-version
29135           in: query
29136           description: resource-version for concurrency
29137           required: true
29138           type: string
29139   /network/vces:
29140     get:
29141       tags:
29142         - Network
29143       summary: returns vces
29144       description: returns vces
29145       operationId: getNetworkVces
29146       produces:
29147         - application/json
29148         - application/xml
29149       responses:
29150         "200":
29151           description: successful operation
29152           schema:
29153               $ref: "#/getDefinitions/vces"
29154         "default":
29155           description: Response codes found in [response codes](https://wiki.onap.org/).
29156   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
29157     put:
29158       tags:
29159         - Network
29160       summary: see node definition for valid relationships
29161       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
29162       consumes:
29163         - application/json
29164         - application/xml
29165       produces:
29166         - application/json
29167         - application/xml
29168       responses:
29169         "default":
29170           description: Response codes found in [response codes](https://wiki.onap.org/).
29171       parameters:
29172         - name: vnfc-name
29173           in: path
29174           description: Unique ID of vnfc.
29175           required: true
29176           type: string
29177           example: __VNFC-NAME__
29178         - name: body
29179           in: body
29180           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
29181           required: true
29182           schema:
29183             $ref: "#/definitions/relationship"
29184     delete:
29185       tags:
29186         - Network
29187       summary: delete an existing relationship
29188       description: delete an existing relationship
29189       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
29190       consumes:
29191         - application/json
29192         - application/xml
29193       produces:
29194         - application/json
29195         - application/xml
29196       responses:
29197         "default":
29198           description: Response codes found in [response codes](https://wiki.onap.org/).
29199       parameters:
29200         - name: vnfc-name
29201           in: path
29202           description: Unique ID of vnfc.
29203           required: true
29204           type: string
29205           example: __VNFC-NAME__
29206   /network/vnfcs/vnfc/{vnfc-name}:
29207     get:
29208       tags:
29209         - Network
29210       summary: returns vnfc
29211       description: returns vnfc
29212       operationId: getNetworkVnfcsVnfc
29213       produces:
29214         - application/json
29215         - application/xml
29216       responses:
29217         "200":
29218           description: successful operation
29219           schema:
29220               $ref: "#/getDefinitions/vnfc"
29221         "default":
29222           description: Response codes found in [response codes](https://wiki.onap.org/).
29223       parameters:
29224         - name: vnfc-name
29225           in: path
29226           description: Unique ID of vnfc.
29227           required: true
29228           type: string
29229           example: __VNFC-NAME__
29230         - name: vnfc-function-code
29231           in: query
29232           description: function code
29233           required: false
29234           type: string
29235         - name: vnfc-type
29236           in: query
29237           description: type
29238           required: false
29239           type: string
29240         - name: prov-status
29241           in: query
29242           description: prov status of this vnfc
29243           required: false
29244           type: string
29245         - name: ipaddress-v4-oam-vip
29246           in: query
29247           description: Oam V4 vip address of this vnfc
29248           required: false
29249           type: string
29250         - name: in-maint
29251           in: query
29252           required: false
29253           type: boolean
29254         - name: is-closed-loop-disabled
29255           in: query
29256           required: false
29257           type: boolean
29258         - name: group-notation
29259           in: query
29260           description: Group notation of VNFC
29261           required: false
29262           type: string
29263     put:
29264       tags:
29265         - Network
29266       summary: create or update an existing vnfc
29267       description: |
29268         Create or update an existing vnfc.
29269         #
29270         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29271       operationId: createOrUpdateNetworkVnfcsVnfc
29272       consumes:
29273         - application/json
29274         - application/xml
29275       produces:
29276         - application/json
29277         - application/xml
29278       responses:
29279         "default":
29280           description: Response codes found in [response codes](https://wiki.onap.org/).
29281       parameters:
29282         - name: vnfc-name
29283           in: path
29284           description: Unique ID of vnfc.
29285           required: true
29286           type: string
29287           example: __VNFC-NAME__
29288         - name: body
29289           in: body
29290           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkVnfcsVnfc.json)
29291           required: true
29292           schema:
29293             $ref: "#/definitions/vnfc"
29294     patch:
29295       tags:
29296         - Network
29297       summary: update an existing vnfc
29298       description: |
29299         Update an existing vnfc
29300         #
29301         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29302         The PUT operation will entirely replace an existing object.
29303         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29304         #
29305         Other differences between PUT and PATCH are:
29306         #
29307         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29308         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29309         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29310       operationId: UpdateNetworkVnfcsVnfc
29311       consumes:
29312         - application/json
29313         - application/xml
29314       produces:
29315         - application/json
29316         - application/xml
29317       responses:
29318         "default":
29319           description: Response codes found in [response codes](https://wiki.onap.org/).
29320       parameters:
29321         - name: vnfc-name
29322           in: path
29323           description: Unique ID of vnfc.
29324           required: true
29325           type: string
29326           example: __VNFC-NAME__
29327         - name: body
29328           in: body
29329           description: vnfc object that needs to be created or updated.
29330           required: true
29331           schema:
29332             $ref: "#/patchDefinitions/vnfc"
29333     delete:
29334       tags:
29335         - Network
29336       summary: delete an existing vnfc
29337       description: delete an existing vnfc
29338       operationId: deleteNetworkVnfcsVnfc
29339       consumes:
29340         - application/json
29341         - application/xml
29342       produces:
29343         - application/json
29344         - application/xml
29345       responses:
29346         "default":
29347           description: Response codes found in [response codes](https://wiki.onap.org/).
29348       parameters:
29349         - name: vnfc-name
29350           in: path
29351           description: Unique ID of vnfc.
29352           required: true
29353           type: string
29354           example: __VNFC-NAME__
29355         - name: resource-version
29356           in: query
29357           description: resource-version for concurrency
29358           required: true
29359           type: string
29360   /network/vnfcs:
29361     get:
29362       tags:
29363         - Network
29364       summary: returns vnfcs
29365       description: returns vnfcs
29366       operationId: getNetworkVnfcs
29367       produces:
29368         - application/json
29369         - application/xml
29370       responses:
29371         "200":
29372           description: successful operation
29373           schema:
29374               $ref: "#/getDefinitions/vnfcs"
29375         "default":
29376           description: Response codes found in [response codes](https://wiki.onap.org/).
29377   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
29378     put:
29379       tags:
29380         - Network
29381       summary: see node definition for valid relationships
29382       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29383       consumes:
29384         - application/json
29385         - application/xml
29386       produces:
29387         - application/json
29388         - application/xml
29389       responses:
29390         "default":
29391           description: Response codes found in [response codes](https://wiki.onap.org/).
29392       parameters:
29393         - name: network-id
29394           in: path
29395           description: Network ID, should be uuid. Unique across A&AI.
29396           required: true
29397           type: string
29398           example: __NETWORK-ID__
29399         - name: subnet-id
29400           in: path
29401           description: Subnet ID, should be UUID.
29402           required: true
29403           type: string
29404           example: __SUBNET-ID__
29405         - name: body
29406           in: body
29407           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29408           required: true
29409           schema:
29410             $ref: "#/definitions/relationship"
29411     delete:
29412       tags:
29413         - Network
29414       summary: delete an existing relationship
29415       description: delete an existing relationship
29416       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
29417       consumes:
29418         - application/json
29419         - application/xml
29420       produces:
29421         - application/json
29422         - application/xml
29423       responses:
29424         "default":
29425           description: Response codes found in [response codes](https://wiki.onap.org/).
29426       parameters:
29427         - name: network-id
29428           in: path
29429           description: Network ID, should be uuid. Unique across A&AI.
29430           required: true
29431           type: string
29432           example: __NETWORK-ID__
29433         - name: subnet-id
29434           in: path
29435           description: Subnet ID, should be UUID.
29436           required: true
29437           type: string
29438           example: __SUBNET-ID__
29439   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
29440     get:
29441       tags:
29442         - Network
29443       summary: returns subnet
29444       description: returns subnet
29445       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
29446       produces:
29447         - application/json
29448         - application/xml
29449       responses:
29450         "200":
29451           description: successful operation
29452           schema:
29453               $ref: "#/getDefinitions/subnet"
29454         "default":
29455           description: Response codes found in [response codes](https://wiki.onap.org/).
29456       parameters:
29457         - name: network-id
29458           in: path
29459           description: Network ID, should be uuid. Unique across A&AI.
29460           required: true
29461           type: string
29462           example: __NETWORK-ID__
29463         - name: subnet-id
29464           in: path
29465           description: Subnet ID, should be UUID.
29466           required: true
29467           type: string
29468           example: __SUBNET-ID__
29469         - name: network-name
29470           in: query
29471           description: Name of the network, governed by some naming convention..
29472           required: false
29473           type: string
29474         - name: network-role
29475           in: query
29476           description: Role the network plans - who defines these values?
29477           required: false
29478           type: string
29479         - name: service-id
29480           in: query
29481           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29482           required: false
29483           type: string
29484         - name: heat-stack-id
29485           in: query
29486           description: Heat stack id corresponding to this instance, managed by MSO
29487           required: false
29488           type: string
29489         - name: contrail-network-fqdn
29490           in: query
29491           description: Contrail FQDN for the network
29492           required: false
29493           type: string
29494         - name: model-invariant-id
29495           in: query
29496           description: the ASDC model id for this resource or service model.
29497           required: false
29498           type: string
29499         - name: model-version-id
29500           in: query
29501           description: the ASDC model version for this resource or service model.
29502           required: false
29503           type: string
29504         - name: widget-model-id
29505           in: query
29506           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29507           required: false
29508           type: string
29509         - name: widget-model-version
29510           in: query
29511           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29512           required: false
29513           type: string
29514         - name: subnet-name
29515           in: query
29516           description: Name associated with the subnet.
29517           required: false
29518           type: string
29519     put:
29520       tags:
29521         - Network
29522       summary: create or update an existing subnet
29523       description: |
29524         Create or update an existing subnet.
29525         #
29526         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29527       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29528       consumes:
29529         - application/json
29530         - application/xml
29531       produces:
29532         - application/json
29533         - application/xml
29534       responses:
29535         "default":
29536           description: Response codes found in [response codes](https://wiki.onap.org/).
29537       parameters:
29538         - name: network-id
29539           in: path
29540           description: Network ID, should be uuid. Unique across A&AI.
29541           required: true
29542           type: string
29543           example: __NETWORK-ID__
29544         - name: subnet-id
29545           in: path
29546           description: Subnet ID, should be UUID.
29547           required: true
29548           type: string
29549           example: __SUBNET-ID__
29550         - name: body
29551           in: body
29552           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
29553           required: true
29554           schema:
29555             $ref: "#/definitions/subnet"
29556     patch:
29557       tags:
29558         - Network
29559       summary: update an existing subnet
29560       description: |
29561         Update an existing subnet
29562         #
29563         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29564         The PUT operation will entirely replace an existing object.
29565         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29566         #
29567         Other differences between PUT and PATCH are:
29568         #
29569         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29570         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29571         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29572       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
29573       consumes:
29574         - application/json
29575         - application/xml
29576       produces:
29577         - application/json
29578         - application/xml
29579       responses:
29580         "default":
29581           description: Response codes found in [response codes](https://wiki.onap.org/).
29582       parameters:
29583         - name: network-id
29584           in: path
29585           description: Network ID, should be uuid. Unique across A&AI.
29586           required: true
29587           type: string
29588           example: __NETWORK-ID__
29589         - name: subnet-id
29590           in: path
29591           description: Subnet ID, should be UUID.
29592           required: true
29593           type: string
29594           example: __SUBNET-ID__
29595         - name: body
29596           in: body
29597           description: subnet object that needs to be created or updated.
29598           required: true
29599           schema:
29600             $ref: "#/patchDefinitions/subnet"
29601     delete:
29602       tags:
29603         - Network
29604       summary: delete an existing subnet
29605       description: delete an existing subnet
29606       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
29607       consumes:
29608         - application/json
29609         - application/xml
29610       produces:
29611         - application/json
29612         - application/xml
29613       responses:
29614         "default":
29615           description: Response codes found in [response codes](https://wiki.onap.org/).
29616       parameters:
29617         - name: network-id
29618           in: path
29619           description: Network ID, should be uuid. Unique across A&AI.
29620           required: true
29621           type: string
29622           example: __NETWORK-ID__
29623         - name: subnet-id
29624           in: path
29625           description: Subnet ID, should be UUID.
29626           required: true
29627           type: string
29628           example: __SUBNET-ID__
29629         - name: resource-version
29630           in: query
29631           description: resource-version for concurrency
29632           required: true
29633           type: string
29634   /network/l3-networks/l3-network/{network-id}/subnets:
29635     get:
29636       tags:
29637         - Network
29638       summary: returns subnets
29639       description: returns subnets
29640       operationId: getNetworkL3NetworksL3NetworkSubnets
29641       produces:
29642         - application/json
29643         - application/xml
29644       responses:
29645         "200":
29646           description: successful operation
29647           schema:
29648               $ref: "#/getDefinitions/subnets"
29649         "default":
29650           description: Response codes found in [response codes](https://wiki.onap.org/).
29651       parameters:
29652         - name: network-id
29653           in: path
29654           description: Network ID, should be uuid. Unique across A&AI.
29655           required: true
29656           type: string
29657           example: __NETWORK-ID__
29658         - name: network-name
29659           in: query
29660           description: Name of the network, governed by some naming convention..
29661           required: false
29662           type: string
29663         - name: network-role
29664           in: query
29665           description: Role the network plans - who defines these values?
29666           required: false
29667           type: string
29668         - name: service-id
29669           in: query
29670           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29671           required: false
29672           type: string
29673         - name: heat-stack-id
29674           in: query
29675           description: Heat stack id corresponding to this instance, managed by MSO
29676           required: false
29677           type: string
29678         - name: contrail-network-fqdn
29679           in: query
29680           description: Contrail FQDN for the network
29681           required: false
29682           type: string
29683         - name: model-invariant-id
29684           in: query
29685           description: the ASDC model id for this resource or service model.
29686           required: false
29687           type: string
29688         - name: model-version-id
29689           in: query
29690           description: the ASDC model version for this resource or service model.
29691           required: false
29692           type: string
29693         - name: widget-model-id
29694           in: query
29695           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29696           required: false
29697           type: string
29698         - name: widget-model-version
29699           in: query
29700           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29701           required: false
29702           type: string
29703   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
29704     put:
29705       tags:
29706         - Network
29707       summary: see node definition for valid relationships
29708       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29709       consumes:
29710         - application/json
29711         - application/xml
29712       produces:
29713         - application/json
29714         - application/xml
29715       responses:
29716         "default":
29717           description: Response codes found in [response codes](https://wiki.onap.org/).
29718       parameters:
29719         - name: network-id
29720           in: path
29721           description: Network ID, should be uuid. Unique across A&AI.
29722           required: true
29723           type: string
29724           example: __NETWORK-ID__
29725         - name: vlan-id-inner
29726           in: path
29727           description: id.
29728           required: true
29729           type: integer
29730           format: int64
29731           example: __VLAN-ID-INNER__
29732         - name: body
29733           in: body
29734           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29735           required: true
29736           schema:
29737             $ref: "#/definitions/relationship"
29738     delete:
29739       tags:
29740         - Network
29741       summary: delete an existing relationship
29742       description: delete an existing relationship
29743       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
29744       consumes:
29745         - application/json
29746         - application/xml
29747       produces:
29748         - application/json
29749         - application/xml
29750       responses:
29751         "default":
29752           description: Response codes found in [response codes](https://wiki.onap.org/).
29753       parameters:
29754         - name: network-id
29755           in: path
29756           description: Network ID, should be uuid. Unique across A&AI.
29757           required: true
29758           type: string
29759           example: __NETWORK-ID__
29760         - name: vlan-id-inner
29761           in: path
29762           description: id.
29763           required: true
29764           type: integer
29765           format: int64
29766           example: __VLAN-ID-INNER__
29767   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
29768     get:
29769       tags:
29770         - Network
29771       summary: returns ctag-assignment
29772       description: returns ctag-assignment
29773       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29774       produces:
29775         - application/json
29776         - application/xml
29777       responses:
29778         "200":
29779           description: successful operation
29780           schema:
29781               $ref: "#/getDefinitions/ctag-assignment"
29782         "default":
29783           description: Response codes found in [response codes](https://wiki.onap.org/).
29784       parameters:
29785         - name: network-id
29786           in: path
29787           description: Network ID, should be uuid. Unique across A&AI.
29788           required: true
29789           type: string
29790           example: __NETWORK-ID__
29791         - name: vlan-id-inner
29792           in: path
29793           description: id.
29794           required: true
29795           type: integer
29796           format: int64
29797           example: __VLAN-ID-INNER__
29798         - name: network-name
29799           in: query
29800           description: Name of the network, governed by some naming convention..
29801           required: false
29802           type: string
29803         - name: network-role
29804           in: query
29805           description: Role the network plans - who defines these values?
29806           required: false
29807           type: string
29808         - name: service-id
29809           in: query
29810           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29811           required: false
29812           type: string
29813         - name: heat-stack-id
29814           in: query
29815           description: Heat stack id corresponding to this instance, managed by MSO
29816           required: false
29817           type: string
29818         - name: contrail-network-fqdn
29819           in: query
29820           description: Contrail FQDN for the network
29821           required: false
29822           type: string
29823         - name: model-invariant-id
29824           in: query
29825           description: the ASDC model id for this resource or service model.
29826           required: false
29827           type: string
29828         - name: model-version-id
29829           in: query
29830           description: the ASDC model version for this resource or service model.
29831           required: false
29832           type: string
29833         - name: widget-model-id
29834           in: query
29835           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
29836           required: false
29837           type: string
29838         - name: widget-model-version
29839           in: query
29840           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
29841           required: false
29842           type: string
29843     put:
29844       tags:
29845         - Network
29846       summary: create or update an existing ctag-assignment
29847       description: |
29848         Create or update an existing ctag-assignment.
29849         #
29850         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29851       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29852       consumes:
29853         - application/json
29854         - application/xml
29855       produces:
29856         - application/json
29857         - application/xml
29858       responses:
29859         "default":
29860           description: Response codes found in [response codes](https://wiki.onap.org/).
29861       parameters:
29862         - name: network-id
29863           in: path
29864           description: Network ID, should be uuid. Unique across A&AI.
29865           required: true
29866           type: string
29867           example: __NETWORK-ID__
29868         - name: vlan-id-inner
29869           in: path
29870           description: id.
29871           required: true
29872           type: integer
29873           format: int64
29874           example: __VLAN-ID-INNER__
29875         - name: body
29876           in: body
29877           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
29878           required: true
29879           schema:
29880             $ref: "#/definitions/ctag-assignment"
29881     patch:
29882       tags:
29883         - Network
29884       summary: update an existing ctag-assignment
29885       description: |
29886         Update an existing ctag-assignment
29887         #
29888         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29889         The PUT operation will entirely replace an existing object.
29890         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29891         #
29892         Other differences between PUT and PATCH are:
29893         #
29894         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29895         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29896         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29897       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29898       consumes:
29899         - application/json
29900         - application/xml
29901       produces:
29902         - application/json
29903         - application/xml
29904       responses:
29905         "default":
29906           description: Response codes found in [response codes](https://wiki.onap.org/).
29907       parameters:
29908         - name: network-id
29909           in: path
29910           description: Network ID, should be uuid. Unique across A&AI.
29911           required: true
29912           type: string
29913           example: __NETWORK-ID__
29914         - name: vlan-id-inner
29915           in: path
29916           description: id.
29917           required: true
29918           type: integer
29919           format: int64
29920           example: __VLAN-ID-INNER__
29921         - name: body
29922           in: body
29923           description: ctag-assignment object that needs to be created or updated.
29924           required: true
29925           schema:
29926             $ref: "#/patchDefinitions/ctag-assignment"
29927     delete:
29928       tags:
29929         - Network
29930       summary: delete an existing ctag-assignment
29931       description: delete an existing ctag-assignment
29932       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
29933       consumes:
29934         - application/json
29935         - application/xml
29936       produces:
29937         - application/json
29938         - application/xml
29939       responses:
29940         "default":
29941           description: Response codes found in [response codes](https://wiki.onap.org/).
29942       parameters:
29943         - name: network-id
29944           in: path
29945           description: Network ID, should be uuid. Unique across A&AI.
29946           required: true
29947           type: string
29948           example: __NETWORK-ID__
29949         - name: vlan-id-inner
29950           in: path
29951           description: id.
29952           required: true
29953           type: integer
29954           format: int64
29955           example: __VLAN-ID-INNER__
29956         - name: resource-version
29957           in: query
29958           description: resource-version for concurrency
29959           required: true
29960           type: string
29961   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
29962     get:
29963       tags:
29964         - Network
29965       summary: returns ctag-assignments
29966       description: returns ctag-assignments
29967       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
29968       produces:
29969         - application/json
29970         - application/xml
29971       responses:
29972         "200":
29973           description: successful operation
29974           schema:
29975               $ref: "#/getDefinitions/ctag-assignments"
29976         "default":
29977           description: Response codes found in [response codes](https://wiki.onap.org/).
29978       parameters:
29979         - name: network-id
29980           in: path
29981           description: Network ID, should be uuid. Unique across A&AI.
29982           required: true
29983           type: string
29984           example: __NETWORK-ID__
29985         - name: network-name
29986           in: query
29987           description: Name of the network, governed by some naming convention..
29988           required: false
29989           type: string
29990         - name: network-role
29991           in: query
29992           description: Role the network plans - who defines these values?
29993           required: false
29994           type: string
29995         - name: service-id
29996           in: query
29997           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
29998           required: false
29999           type: string
30000         - name: heat-stack-id
30001           in: query
30002           description: Heat stack id corresponding to this instance, managed by MSO
30003           required: false
30004           type: string
30005         - name: contrail-network-fqdn
30006           in: query
30007           description: Contrail FQDN for the network
30008           required: false
30009           type: string
30010         - name: model-invariant-id
30011           in: query
30012           description: the ASDC model id for this resource or service model.
30013           required: false
30014           type: string
30015         - name: model-version-id
30016           in: query
30017           description: the ASDC model version for this resource or service model.
30018           required: false
30019           type: string
30020         - name: widget-model-id
30021           in: query
30022           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30023           required: false
30024           type: string
30025         - name: widget-model-version
30026           in: query
30027           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30028           required: false
30029           type: string
30030   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
30031     put:
30032       tags:
30033         - Network
30034       summary: see node definition for valid relationships
30035       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30036       consumes:
30037         - application/json
30038         - application/xml
30039       produces:
30040         - application/json
30041         - application/xml
30042       responses:
30043         "default":
30044           description: Response codes found in [response codes](https://wiki.onap.org/).
30045       parameters:
30046         - name: network-id
30047           in: path
30048           description: Network ID, should be uuid. Unique across A&AI.
30049           required: true
30050           type: string
30051           example: __NETWORK-ID__
30052         - name: segmentation-id
30053           in: path
30054           description: Route Table Reference id, UUID assigned to this instance.
30055           required: true
30056           type: string
30057           example: __SEGMENTATION-ID__
30058         - name: body
30059           in: body
30060           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30061           required: true
30062           schema:
30063             $ref: "#/definitions/relationship"
30064     delete:
30065       tags:
30066         - Network
30067       summary: delete an existing relationship
30068       description: delete an existing relationship
30069       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
30070       consumes:
30071         - application/json
30072         - application/xml
30073       produces:
30074         - application/json
30075         - application/xml
30076       responses:
30077         "default":
30078           description: Response codes found in [response codes](https://wiki.onap.org/).
30079       parameters:
30080         - name: network-id
30081           in: path
30082           description: Network ID, should be uuid. Unique across A&AI.
30083           required: true
30084           type: string
30085           example: __NETWORK-ID__
30086         - name: segmentation-id
30087           in: path
30088           description: Route Table Reference id, UUID assigned to this instance.
30089           required: true
30090           type: string
30091           example: __SEGMENTATION-ID__
30092   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
30093     get:
30094       tags:
30095         - Network
30096       summary: returns segmentation-assignment
30097       description: returns segmentation-assignment
30098       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30099       produces:
30100         - application/json
30101         - application/xml
30102       responses:
30103         "200":
30104           description: successful operation
30105           schema:
30106               $ref: "#/getDefinitions/segmentation-assignment"
30107         "default":
30108           description: Response codes found in [response codes](https://wiki.onap.org/).
30109       parameters:
30110         - name: network-id
30111           in: path
30112           description: Network ID, should be uuid. Unique across A&AI.
30113           required: true
30114           type: string
30115           example: __NETWORK-ID__
30116         - name: segmentation-id
30117           in: path
30118           description: Route Table Reference id, UUID assigned to this instance.
30119           required: true
30120           type: string
30121           example: __SEGMENTATION-ID__
30122         - name: network-name
30123           in: query
30124           description: Name of the network, governed by some naming convention..
30125           required: false
30126           type: string
30127         - name: network-role
30128           in: query
30129           description: Role the network plans - who defines these values?
30130           required: false
30131           type: string
30132         - name: service-id
30133           in: query
30134           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
30135           required: false
30136           type: string
30137         - name: heat-stack-id
30138           in: query
30139           description: Heat stack id corresponding to this instance, managed by MSO
30140           required: false
30141           type: string
30142         - name: contrail-network-fqdn
30143           in: query
30144           description: Contrail FQDN for the network
30145           required: false
30146           type: string
30147         - name: model-invariant-id
30148           in: query
30149           description: the ASDC model id for this resource or service model.
30150           required: false
30151           type: string
30152         - name: model-version-id
30153           in: query
30154           description: the ASDC model version for this resource or service model.
30155           required: false
30156           type: string
30157         - name: widget-model-id
30158           in: query
30159           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30160           required: false
30161           type: string
30162         - name: widget-model-version
30163           in: query
30164           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30165           required: false
30166           type: string
30167     put:
30168       tags:
30169         - Network
30170       summary: create or update an existing segmentation-assignment
30171       description: |
30172         Create or update an existing segmentation-assignment.
30173         #
30174         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30175       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30176       consumes:
30177         - application/json
30178         - application/xml
30179       produces:
30180         - application/json
30181         - application/xml
30182       responses:
30183         "default":
30184           description: Response codes found in [response codes](https://wiki.onap.org/).
30185       parameters:
30186         - name: network-id
30187           in: path
30188           description: Network ID, should be uuid. Unique across A&AI.
30189           required: true
30190           type: string
30191           example: __NETWORK-ID__
30192         - name: segmentation-id
30193           in: path
30194           description: Route Table Reference id, UUID assigned to this instance.
30195           required: true
30196           type: string
30197           example: __SEGMENTATION-ID__
30198         - name: body
30199           in: body
30200           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
30201           required: true
30202           schema:
30203             $ref: "#/definitions/segmentation-assignment"
30204     patch:
30205       tags:
30206         - Network
30207       summary: update an existing segmentation-assignment
30208       description: |
30209         Update an existing segmentation-assignment
30210         #
30211         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30212         The PUT operation will entirely replace an existing object.
30213         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30214         #
30215         Other differences between PUT and PATCH are:
30216         #
30217         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30218         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30219         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30220       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30221       consumes:
30222         - application/json
30223         - application/xml
30224       produces:
30225         - application/json
30226         - application/xml
30227       responses:
30228         "default":
30229           description: Response codes found in [response codes](https://wiki.onap.org/).
30230       parameters:
30231         - name: network-id
30232           in: path
30233           description: Network ID, should be uuid. Unique across A&AI.
30234           required: true
30235           type: string
30236           example: __NETWORK-ID__
30237         - name: segmentation-id
30238           in: path
30239           description: Route Table Reference id, UUID assigned to this instance.
30240           required: true
30241           type: string
30242           example: __SEGMENTATION-ID__
30243         - name: body
30244           in: body
30245           description: segmentation-assignment object that needs to be created or updated.
30246           required: true
30247           schema:
30248             $ref: "#/patchDefinitions/segmentation-assignment"
30249     delete:
30250       tags:
30251         - Network
30252       summary: delete an existing segmentation-assignment
30253       description: delete an existing segmentation-assignment
30254       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
30255       consumes:
30256         - application/json
30257         - application/xml
30258       produces:
30259         - application/json
30260         - application/xml
30261       responses:
30262         "default":
30263           description: Response codes found in [response codes](https://wiki.onap.org/).
30264       parameters:
30265         - name: network-id
30266           in: path
30267           description: Network ID, should be uuid. Unique across A&AI.
30268           required: true
30269           type: string
30270           example: __NETWORK-ID__
30271         - name: segmentation-id
30272           in: path
30273           description: Route Table Reference id, UUID assigned to this instance.
30274           required: true
30275           type: string
30276           example: __SEGMENTATION-ID__
30277         - name: resource-version
30278           in: query
30279           description: resource-version for concurrency
30280           required: true
30281           type: string
30282   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
30283     get:
30284       tags:
30285         - Network
30286       summary: returns segmentation-assignments
30287       description: returns segmentation-assignments
30288       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
30289       produces:
30290         - application/json
30291         - application/xml
30292       responses:
30293         "200":
30294           description: successful operation
30295           schema:
30296               $ref: "#/getDefinitions/segmentation-assignments"
30297         "default":
30298           description: Response codes found in [response codes](https://wiki.onap.org/).
30299       parameters:
30300         - name: network-id
30301           in: path
30302           description: Network ID, should be uuid. Unique across A&AI.
30303           required: true
30304           type: string
30305           example: __NETWORK-ID__
30306         - name: network-name
30307           in: query
30308           description: Name of the network, governed by some naming convention..
30309           required: false
30310           type: string
30311         - name: network-role
30312           in: query
30313           description: Role the network plans - who defines these values?
30314           required: false
30315           type: string
30316         - name: service-id
30317           in: query
30318           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
30319           required: false
30320           type: string
30321         - name: heat-stack-id
30322           in: query
30323           description: Heat stack id corresponding to this instance, managed by MSO
30324           required: false
30325           type: string
30326         - name: contrail-network-fqdn
30327           in: query
30328           description: Contrail FQDN for the network
30329           required: false
30330           type: string
30331         - name: model-invariant-id
30332           in: query
30333           description: the ASDC model id for this resource or service model.
30334           required: false
30335           type: string
30336         - name: model-version-id
30337           in: query
30338           description: the ASDC model version for this resource or service model.
30339           required: false
30340           type: string
30341         - name: widget-model-id
30342           in: query
30343           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30344           required: false
30345           type: string
30346         - name: widget-model-version
30347           in: query
30348           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30349           required: false
30350           type: string
30351   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
30352     put:
30353       tags:
30354         - Network
30355       summary: see node definition for valid relationships
30356       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
30357       consumes:
30358         - application/json
30359         - application/xml
30360       produces:
30361         - application/json
30362         - application/xml
30363       responses:
30364         "default":
30365           description: Response codes found in [response codes](https://wiki.onap.org/).
30366       parameters:
30367         - name: network-id
30368           in: path
30369           description: Network ID, should be uuid. Unique across A&AI.
30370           required: true
30371           type: string
30372           example: __NETWORK-ID__
30373         - name: body
30374           in: body
30375           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
30376           required: true
30377           schema:
30378             $ref: "#/definitions/relationship"
30379     delete:
30380       tags:
30381         - Network
30382       summary: delete an existing relationship
30383       description: delete an existing relationship
30384       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
30385       consumes:
30386         - application/json
30387         - application/xml
30388       produces:
30389         - application/json
30390         - application/xml
30391       responses:
30392         "default":
30393           description: Response codes found in [response codes](https://wiki.onap.org/).
30394       parameters:
30395         - name: network-id
30396           in: path
30397           description: Network ID, should be uuid. Unique across A&AI.
30398           required: true
30399           type: string
30400           example: __NETWORK-ID__
30401   /network/l3-networks/l3-network/{network-id}:
30402     get:
30403       tags:
30404         - Network
30405       summary: returns l3-network
30406       description: returns l3-network
30407       operationId: getNetworkL3NetworksL3Network
30408       produces:
30409         - application/json
30410         - application/xml
30411       responses:
30412         "200":
30413           description: successful operation
30414           schema:
30415               $ref: "#/getDefinitions/l3-network"
30416         "default":
30417           description: Response codes found in [response codes](https://wiki.onap.org/).
30418       parameters:
30419         - name: network-id
30420           in: path
30421           description: Network ID, should be uuid. Unique across A&AI.
30422           required: true
30423           type: string
30424           example: __NETWORK-ID__
30425         - name: network-name
30426           in: query
30427           description: Name of the network, governed by some naming convention..
30428           required: false
30429           type: string
30430         - name: network-role
30431           in: query
30432           description: Role the network plans - who defines these values?
30433           required: false
30434           type: string
30435         - name: service-id
30436           in: query
30437           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
30438           required: false
30439           type: string
30440         - name: heat-stack-id
30441           in: query
30442           description: Heat stack id corresponding to this instance, managed by MSO
30443           required: false
30444           type: string
30445         - name: contrail-network-fqdn
30446           in: query
30447           description: Contrail FQDN for the network
30448           required: false
30449           type: string
30450         - name: model-invariant-id
30451           in: query
30452           description: the ASDC model id for this resource or service model.
30453           required: false
30454           type: string
30455         - name: model-version-id
30456           in: query
30457           description: the ASDC model version for this resource or service model.
30458           required: false
30459           type: string
30460         - name: widget-model-id
30461           in: query
30462           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
30463           required: false
30464           type: string
30465         - name: widget-model-version
30466           in: query
30467           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
30468           required: false
30469           type: string
30470     put:
30471       tags:
30472         - Network
30473       summary: create or update an existing l3-network
30474       description: |
30475         Create or update an existing l3-network.
30476         #
30477         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30478       operationId: createOrUpdateNetworkL3NetworksL3Network
30479       consumes:
30480         - application/json
30481         - application/xml
30482       produces:
30483         - application/json
30484         - application/xml
30485       responses:
30486         "default":
30487           description: Response codes found in [response codes](https://wiki.onap.org/).
30488       parameters:
30489         - name: network-id
30490           in: path
30491           description: Network ID, should be uuid. Unique across A&AI.
30492           required: true
30493           type: string
30494           example: __NETWORK-ID__
30495         - name: body
30496           in: body
30497           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkL3NetworksL3Network.json)
30498           required: true
30499           schema:
30500             $ref: "#/definitions/l3-network"
30501     patch:
30502       tags:
30503         - Network
30504       summary: update an existing l3-network
30505       description: |
30506         Update an existing l3-network
30507         #
30508         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30509         The PUT operation will entirely replace an existing object.
30510         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30511         #
30512         Other differences between PUT and PATCH are:
30513         #
30514         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30515         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30516         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30517       operationId: UpdateNetworkL3NetworksL3Network
30518       consumes:
30519         - application/json
30520         - application/xml
30521       produces:
30522         - application/json
30523         - application/xml
30524       responses:
30525         "default":
30526           description: Response codes found in [response codes](https://wiki.onap.org/).
30527       parameters:
30528         - name: network-id
30529           in: path
30530           description: Network ID, should be uuid. Unique across A&AI.
30531           required: true
30532           type: string
30533           example: __NETWORK-ID__
30534         - name: body
30535           in: body
30536           description: l3-network object that needs to be created or updated.
30537           required: true
30538           schema:
30539             $ref: "#/patchDefinitions/l3-network"
30540     delete:
30541       tags:
30542         - Network
30543       summary: delete an existing l3-network
30544       description: delete an existing l3-network
30545       operationId: deleteNetworkL3NetworksL3Network
30546       consumes:
30547         - application/json
30548         - application/xml
30549       produces:
30550         - application/json
30551         - application/xml
30552       responses:
30553         "default":
30554           description: Response codes found in [response codes](https://wiki.onap.org/).
30555       parameters:
30556         - name: network-id
30557           in: path
30558           description: Network ID, should be uuid. Unique across A&AI.
30559           required: true
30560           type: string
30561           example: __NETWORK-ID__
30562         - name: resource-version
30563           in: query
30564           description: resource-version for concurrency
30565           required: true
30566           type: string
30567   /network/l3-networks:
30568     get:
30569       tags:
30570         - Network
30571       summary: returns l3-networks
30572       description: returns l3-networks
30573       operationId: getNetworkL3Networks
30574       produces:
30575         - application/json
30576         - application/xml
30577       responses:
30578         "200":
30579           description: successful operation
30580           schema:
30581               $ref: "#/getDefinitions/l3-networks"
30582         "default":
30583           description: Response codes found in [response codes](https://wiki.onap.org/).
30584   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
30585     put:
30586       tags:
30587         - Network
30588       summary: see node definition for valid relationships
30589       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30590       consumes:
30591         - application/json
30592         - application/xml
30593       produces:
30594         - application/json
30595         - application/xml
30596       responses:
30597         "default":
30598           description: Response codes found in [response codes](https://wiki.onap.org/).
30599       parameters:
30600         - name: network-policy-id
30601           in: path
30602           description: UUID representing unique key to this instance
30603           required: true
30604           type: string
30605           example: __NETWORK-POLICY-ID__
30606         - name: body
30607           in: body
30608           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
30609           required: true
30610           schema:
30611             $ref: "#/definitions/relationship"
30612     delete:
30613       tags:
30614         - Network
30615       summary: delete an existing relationship
30616       description: delete an existing relationship
30617       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
30618       consumes:
30619         - application/json
30620         - application/xml
30621       produces:
30622         - application/json
30623         - application/xml
30624       responses:
30625         "default":
30626           description: Response codes found in [response codes](https://wiki.onap.org/).
30627       parameters:
30628         - name: network-policy-id
30629           in: path
30630           description: UUID representing unique key to this instance
30631           required: true
30632           type: string
30633           example: __NETWORK-POLICY-ID__
30634   /network/network-policies/network-policy/{network-policy-id}:
30635     get:
30636       tags:
30637         - Network
30638       summary: returns network-policy
30639       description: returns network-policy
30640       operationId: getNetworkNetworkPoliciesNetworkPolicy
30641       produces:
30642         - application/json
30643         - application/xml
30644       responses:
30645         "200":
30646           description: successful operation
30647           schema:
30648               $ref: "#/getDefinitions/network-policy"
30649         "default":
30650           description: Response codes found in [response codes](https://wiki.onap.org/).
30651       parameters:
30652         - name: network-policy-id
30653           in: path
30654           description: UUID representing unique key to this instance
30655           required: true
30656           type: string
30657           example: __NETWORK-POLICY-ID__
30658         - name: network-policy-fqdn
30659           in: query
30660           description: Contrail FQDN for the policy
30661           required: false
30662           type: string
30663     put:
30664       tags:
30665         - Network
30666       summary: create or update an existing network-policy
30667       description: |
30668         Create or update an existing network-policy.
30669         #
30670         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30671       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
30672       consumes:
30673         - application/json
30674         - application/xml
30675       produces:
30676         - application/json
30677         - application/xml
30678       responses:
30679         "default":
30680           description: Response codes found in [response codes](https://wiki.onap.org/).
30681       parameters:
30682         - name: network-policy-id
30683           in: path
30684           description: UUID representing unique key to this instance
30685           required: true
30686           type: string
30687           example: __NETWORK-POLICY-ID__
30688         - name: body
30689           in: body
30690           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNetworkPoliciesNetworkPolicy.json)
30691           required: true
30692           schema:
30693             $ref: "#/definitions/network-policy"
30694     patch:
30695       tags:
30696         - Network
30697       summary: update an existing network-policy
30698       description: |
30699         Update an existing network-policy
30700         #
30701         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30702         The PUT operation will entirely replace an existing object.
30703         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30704         #
30705         Other differences between PUT and PATCH are:
30706         #
30707         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30708         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30709         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30710       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
30711       consumes:
30712         - application/json
30713         - application/xml
30714       produces:
30715         - application/json
30716         - application/xml
30717       responses:
30718         "default":
30719           description: Response codes found in [response codes](https://wiki.onap.org/).
30720       parameters:
30721         - name: network-policy-id
30722           in: path
30723           description: UUID representing unique key to this instance
30724           required: true
30725           type: string
30726           example: __NETWORK-POLICY-ID__
30727         - name: body
30728           in: body
30729           description: network-policy object that needs to be created or updated.
30730           required: true
30731           schema:
30732             $ref: "#/patchDefinitions/network-policy"
30733     delete:
30734       tags:
30735         - Network
30736       summary: delete an existing network-policy
30737       description: delete an existing network-policy
30738       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
30739       consumes:
30740         - application/json
30741         - application/xml
30742       produces:
30743         - application/json
30744         - application/xml
30745       responses:
30746         "default":
30747           description: Response codes found in [response codes](https://wiki.onap.org/).
30748       parameters:
30749         - name: network-policy-id
30750           in: path
30751           description: UUID representing unique key to this instance
30752           required: true
30753           type: string
30754           example: __NETWORK-POLICY-ID__
30755         - name: resource-version
30756           in: query
30757           description: resource-version for concurrency
30758           required: true
30759           type: string
30760   /network/network-policies:
30761     get:
30762       tags:
30763         - Network
30764       summary: returns network-policies
30765       description: returns network-policies
30766       operationId: getNetworkNetworkPolicies
30767       produces:
30768         - application/json
30769         - application/xml
30770       responses:
30771         "200":
30772           description: successful operation
30773           schema:
30774               $ref: "#/getDefinitions/network-policies"
30775         "default":
30776           description: Response codes found in [response codes](https://wiki.onap.org/).
30777   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
30778     put:
30779       tags:
30780         - Network
30781       summary: see node definition for valid relationships
30782       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
30783       consumes:
30784         - application/json
30785         - application/xml
30786       produces:
30787         - application/json
30788         - application/xml
30789       responses:
30790         "default":
30791           description: Response codes found in [response codes](https://wiki.onap.org/).
30792       parameters:
30793         - name: vnf-id
30794           in: path
30795           description: Unique id of VNF.  This is unique across the graph.
30796           required: true
30797           type: string
30798           example: __VNF-ID__
30799         - name: body
30800           in: body
30801           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
30802           required: true
30803           schema:
30804             $ref: "#/definitions/relationship"
30805     delete:
30806       tags:
30807         - Network
30808       summary: delete an existing relationship
30809       description: delete an existing relationship
30810       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
30811       consumes:
30812         - application/json
30813         - application/xml
30814       produces:
30815         - application/json
30816         - application/xml
30817       responses:
30818         "default":
30819           description: Response codes found in [response codes](https://wiki.onap.org/).
30820       parameters:
30821         - name: vnf-id
30822           in: path
30823           description: Unique id of VNF.  This is unique across the graph.
30824           required: true
30825           type: string
30826           example: __VNF-ID__
30827   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
30828     put:
30829       tags:
30830         - Network
30831       summary: see node definition for valid relationships
30832       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30833       consumes:
30834         - application/json
30835         - application/xml
30836       produces:
30837         - application/json
30838         - application/xml
30839       responses:
30840         "default":
30841           description: Response codes found in [response codes](https://wiki.onap.org/).
30842       parameters:
30843         - name: vnf-id
30844           in: path
30845           description: Unique id of VNF.  This is unique across the graph.
30846           required: true
30847           type: string
30848           example: __VNF-ID__
30849         - name: interface-name
30850           in: path
30851           description: Name given to the interface
30852           required: true
30853           type: string
30854           example: __INTERFACE-NAME__
30855         - name: vlan-interface
30856           in: path
30857           description: String that identifies the interface
30858           required: true
30859           type: string
30860           example: __VLAN-INTERFACE__
30861         - name: body
30862           in: body
30863           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
30864           required: true
30865           schema:
30866             $ref: "#/definitions/relationship"
30867     delete:
30868       tags:
30869         - Network
30870       summary: delete an existing relationship
30871       description: delete an existing relationship
30872       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
30873       consumes:
30874         - application/json
30875         - application/xml
30876       produces:
30877         - application/json
30878         - application/xml
30879       responses:
30880         "default":
30881           description: Response codes found in [response codes](https://wiki.onap.org/).
30882       parameters:
30883         - name: vnf-id
30884           in: path
30885           description: Unique id of VNF.  This is unique across the graph.
30886           required: true
30887           type: string
30888           example: __VNF-ID__
30889         - name: interface-name
30890           in: path
30891           description: Name given to the interface
30892           required: true
30893           type: string
30894           example: __INTERFACE-NAME__
30895         - name: vlan-interface
30896           in: path
30897           description: String that identifies the interface
30898           required: true
30899           type: string
30900           example: __VLAN-INTERFACE__
30901   /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:
30902     put:
30903       tags:
30904         - Network
30905       summary: see node definition for valid relationships
30906       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30907       consumes:
30908         - application/json
30909         - application/xml
30910       produces:
30911         - application/json
30912         - application/xml
30913       responses:
30914         "default":
30915           description: Response codes found in [response codes](https://wiki.onap.org/).
30916       parameters:
30917         - name: vnf-id
30918           in: path
30919           description: Unique id of VNF.  This is unique across the graph.
30920           required: true
30921           type: string
30922           example: __VNF-ID__
30923         - name: interface-name
30924           in: path
30925           description: Name given to the interface
30926           required: true
30927           type: string
30928           example: __INTERFACE-NAME__
30929         - name: vlan-interface
30930           in: path
30931           description: String that identifies the interface
30932           required: true
30933           type: string
30934           example: __VLAN-INTERFACE__
30935         - name: l3-interface-ipv4-address
30936           in: path
30937           description: IP address
30938           required: true
30939           type: string
30940           example: __L3-INTERFACE-IPV4-ADDRESS__
30941         - name: body
30942           in: body
30943           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
30944           required: true
30945           schema:
30946             $ref: "#/definitions/relationship"
30947     delete:
30948       tags:
30949         - Network
30950       summary: delete an existing relationship
30951       description: delete an existing relationship
30952       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
30953       consumes:
30954         - application/json
30955         - application/xml
30956       produces:
30957         - application/json
30958         - application/xml
30959       responses:
30960         "default":
30961           description: Response codes found in [response codes](https://wiki.onap.org/).
30962       parameters:
30963         - name: vnf-id
30964           in: path
30965           description: Unique id of VNF.  This is unique across the graph.
30966           required: true
30967           type: string
30968           example: __VNF-ID__
30969         - name: interface-name
30970           in: path
30971           description: Name given to the interface
30972           required: true
30973           type: string
30974           example: __INTERFACE-NAME__
30975         - name: vlan-interface
30976           in: path
30977           description: String that identifies the interface
30978           required: true
30979           type: string
30980           example: __VLAN-INTERFACE__
30981         - name: l3-interface-ipv4-address
30982           in: path
30983           description: IP address
30984           required: true
30985           type: string
30986           example: __L3-INTERFACE-IPV4-ADDRESS__
30987   /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}:
30988     get:
30989       tags:
30990         - Network
30991       summary: returns l3-interface-ipv4-address-list
30992       description: returns l3-interface-ipv4-address-list
30993       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
30994       produces:
30995         - application/json
30996         - application/xml
30997       responses:
30998         "200":
30999           description: successful operation
31000           schema:
31001               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31002         "default":
31003           description: Response codes found in [response codes](https://wiki.onap.org/).
31004       parameters:
31005         - name: vnf-id
31006           in: path
31007           description: Unique id of VNF.  This is unique across the graph.
31008           required: true
31009           type: string
31010           example: __VNF-ID__
31011         - name: interface-name
31012           in: path
31013           description: Name given to the interface
31014           required: true
31015           type: string
31016           example: __INTERFACE-NAME__
31017         - name: vlan-interface
31018           in: path
31019           description: String that identifies the interface
31020           required: true
31021           type: string
31022           example: __VLAN-INTERFACE__
31023         - name: l3-interface-ipv4-address
31024           in: path
31025           description: IP address
31026           required: true
31027           type: string
31028           example: __L3-INTERFACE-IPV4-ADDRESS__
31029         - name: vnf-name
31030           in: query
31031           description: Name of VNF.
31032           required: false
31033           type: string
31034         - name: vnf-name2
31035           in: query
31036           description: Alternate name of VNF.
31037           required: false
31038           type: string
31039         - name: vnf-type
31040           in: query
31041           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31042           required: false
31043           type: string
31044         - name: service-id
31045           in: query
31046           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31047           required: false
31048           type: string
31049         - name: regional-resource-zone
31050           in: query
31051           description: Regional way of organizing pservers, source of truth should define values
31052           required: false
31053           type: string
31054         - name: prov-status
31055           in: query
31056           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31057           required: false
31058           type: string
31059         - name: heat-stack-id
31060           in: query
31061           description: Heat stack id corresponding to this instance, managed by MSO
31062           required: false
31063           type: string
31064         - name: in-maint
31065           in: query
31066           required: false
31067           type: boolean
31068         - name: is-closed-loop-disabled
31069           in: query
31070           required: false
31071           type: boolean
31072         - name: model-invariant-id
31073           in: query
31074           description: the ASDC model id for this resource or service model.
31075           required: false
31076           type: string
31077         - name: model-version-id
31078           in: query
31079           description: the ASDC model version for this resource or service model.
31080           required: false
31081           type: string
31082         - name: widget-model-id
31083           in: query
31084           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31085           required: false
31086           type: string
31087         - name: widget-model-version
31088           in: query
31089           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31090           required: false
31091           type: string
31092         - name: nf-type
31093           in: query
31094           description: Generic description of the type of NF
31095           required: false
31096           type: string
31097         - name: nf-function
31098           in: query
31099           description: English description of Network function that the specific VNF deployment is providing
31100           required: false
31101           type: string
31102         - name: nf-role
31103           in: query
31104           description: role in the network that this model will be providing
31105           required: false
31106           type: string
31107         - name: nf-naming-code
31108           in: query
31109           description: string assigned to this model used for naming purposes
31110           required: false
31111           type: string
31112         - name: interface-id
31113           in: query
31114           description: ID of interface
31115           required: false
31116           type: string
31117         - name: macaddr
31118           in: query
31119           description: MAC address for the interface
31120           required: false
31121           type: string
31122         - name: network-name
31123           in: query
31124           description: Name of the network
31125           required: false
31126           type: string
31127         - name: vlan-id-inner
31128           in: query
31129           description: Inner VLAN tag
31130           required: false
31131           type: integer
31132           format: int64
31133         - name: vpn-id
31134           in: query
31135           description: This indicates the customers VPN ID associated with this vlan
31136           required: false
31137           type: string
31138         - name: vlan-id-inner
31139           in: query
31140           description: Inner VLAN tag
31141           required: false
31142           type: integer
31143           format: int64
31144         - name: neutron-network-id
31145           in: query
31146           description: Neutron network id of the interface that address belongs to
31147           required: false
31148           type: string
31149         - name: neutron-subnet-id
31150           in: query
31151           description: Neutron id of subnet that address belongs to
31152           required: false
31153           type: string
31154     put:
31155       tags:
31156         - Network
31157       summary: create or update an existing l3-interface-ipv4-address-list
31158       description: |
31159         Create or update an existing l3-interface-ipv4-address-list.
31160         #
31161         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31162       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31163       consumes:
31164         - application/json
31165         - application/xml
31166       produces:
31167         - application/json
31168         - application/xml
31169       responses:
31170         "default":
31171           description: Response codes found in [response codes](https://wiki.onap.org/).
31172       parameters:
31173         - name: vnf-id
31174           in: path
31175           description: Unique id of VNF.  This is unique across the graph.
31176           required: true
31177           type: string
31178           example: __VNF-ID__
31179         - name: interface-name
31180           in: path
31181           description: Name given to the interface
31182           required: true
31183           type: string
31184           example: __INTERFACE-NAME__
31185         - name: vlan-interface
31186           in: path
31187           description: String that identifies the interface
31188           required: true
31189           type: string
31190           example: __VLAN-INTERFACE__
31191         - name: l3-interface-ipv4-address
31192           in: path
31193           description: IP address
31194           required: true
31195           type: string
31196           example: __L3-INTERFACE-IPV4-ADDRESS__
31197         - name: body
31198           in: body
31199           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
31200           required: true
31201           schema:
31202             $ref: "#/definitions/l3-interface-ipv4-address-list"
31203     patch:
31204       tags:
31205         - Network
31206       summary: update an existing l3-interface-ipv4-address-list
31207       description: |
31208         Update an existing l3-interface-ipv4-address-list
31209         #
31210         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31211         The PUT operation will entirely replace an existing object.
31212         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31213         #
31214         Other differences between PUT and PATCH are:
31215         #
31216         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31217         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31218         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31219       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31220       consumes:
31221         - application/json
31222         - application/xml
31223       produces:
31224         - application/json
31225         - application/xml
31226       responses:
31227         "default":
31228           description: Response codes found in [response codes](https://wiki.onap.org/).
31229       parameters:
31230         - name: vnf-id
31231           in: path
31232           description: Unique id of VNF.  This is unique across the graph.
31233           required: true
31234           type: string
31235           example: __VNF-ID__
31236         - name: interface-name
31237           in: path
31238           description: Name given to the interface
31239           required: true
31240           type: string
31241           example: __INTERFACE-NAME__
31242         - name: vlan-interface
31243           in: path
31244           description: String that identifies the interface
31245           required: true
31246           type: string
31247           example: __VLAN-INTERFACE__
31248         - name: l3-interface-ipv4-address
31249           in: path
31250           description: IP address
31251           required: true
31252           type: string
31253           example: __L3-INTERFACE-IPV4-ADDRESS__
31254         - name: body
31255           in: body
31256           description: l3-interface-ipv4-address-list object that needs to be created or updated.
31257           required: true
31258           schema:
31259             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31260     delete:
31261       tags:
31262         - Network
31263       summary: delete an existing l3-interface-ipv4-address-list
31264       description: delete an existing l3-interface-ipv4-address-list
31265       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
31266       consumes:
31267         - application/json
31268         - application/xml
31269       produces:
31270         - application/json
31271         - application/xml
31272       responses:
31273         "default":
31274           description: Response codes found in [response codes](https://wiki.onap.org/).
31275       parameters:
31276         - name: vnf-id
31277           in: path
31278           description: Unique id of VNF.  This is unique across the graph.
31279           required: true
31280           type: string
31281           example: __VNF-ID__
31282         - name: interface-name
31283           in: path
31284           description: Name given to the interface
31285           required: true
31286           type: string
31287           example: __INTERFACE-NAME__
31288         - name: vlan-interface
31289           in: path
31290           description: String that identifies the interface
31291           required: true
31292           type: string
31293           example: __VLAN-INTERFACE__
31294         - name: l3-interface-ipv4-address
31295           in: path
31296           description: IP address
31297           required: true
31298           type: string
31299           example: __L3-INTERFACE-IPV4-ADDRESS__
31300         - name: resource-version
31301           in: query
31302           description: resource-version for concurrency
31303           required: true
31304           type: string
31305   /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:
31306     put:
31307       tags:
31308         - Network
31309       summary: see node definition for valid relationships
31310       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31311       consumes:
31312         - application/json
31313         - application/xml
31314       produces:
31315         - application/json
31316         - application/xml
31317       responses:
31318         "default":
31319           description: Response codes found in [response codes](https://wiki.onap.org/).
31320       parameters:
31321         - name: vnf-id
31322           in: path
31323           description: Unique id of VNF.  This is unique across the graph.
31324           required: true
31325           type: string
31326           example: __VNF-ID__
31327         - name: interface-name
31328           in: path
31329           description: Name given to the interface
31330           required: true
31331           type: string
31332           example: __INTERFACE-NAME__
31333         - name: vlan-interface
31334           in: path
31335           description: String that identifies the interface
31336           required: true
31337           type: string
31338           example: __VLAN-INTERFACE__
31339         - name: l3-interface-ipv6-address
31340           in: path
31341           description: IP address
31342           required: true
31343           type: string
31344           example: __L3-INTERFACE-IPV6-ADDRESS__
31345         - name: body
31346           in: body
31347           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31348           required: true
31349           schema:
31350             $ref: "#/definitions/relationship"
31351     delete:
31352       tags:
31353         - Network
31354       summary: delete an existing relationship
31355       description: delete an existing relationship
31356       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
31357       consumes:
31358         - application/json
31359         - application/xml
31360       produces:
31361         - application/json
31362         - application/xml
31363       responses:
31364         "default":
31365           description: Response codes found in [response codes](https://wiki.onap.org/).
31366       parameters:
31367         - name: vnf-id
31368           in: path
31369           description: Unique id of VNF.  This is unique across the graph.
31370           required: true
31371           type: string
31372           example: __VNF-ID__
31373         - name: interface-name
31374           in: path
31375           description: Name given to the interface
31376           required: true
31377           type: string
31378           example: __INTERFACE-NAME__
31379         - name: vlan-interface
31380           in: path
31381           description: String that identifies the interface
31382           required: true
31383           type: string
31384           example: __VLAN-INTERFACE__
31385         - name: l3-interface-ipv6-address
31386           in: path
31387           description: IP address
31388           required: true
31389           type: string
31390           example: __L3-INTERFACE-IPV6-ADDRESS__
31391   /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}:
31392     get:
31393       tags:
31394         - Network
31395       summary: returns l3-interface-ipv6-address-list
31396       description: returns l3-interface-ipv6-address-list
31397       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31398       produces:
31399         - application/json
31400         - application/xml
31401       responses:
31402         "200":
31403           description: successful operation
31404           schema:
31405               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31406         "default":
31407           description: Response codes found in [response codes](https://wiki.onap.org/).
31408       parameters:
31409         - name: vnf-id
31410           in: path
31411           description: Unique id of VNF.  This is unique across the graph.
31412           required: true
31413           type: string
31414           example: __VNF-ID__
31415         - name: interface-name
31416           in: path
31417           description: Name given to the interface
31418           required: true
31419           type: string
31420           example: __INTERFACE-NAME__
31421         - name: vlan-interface
31422           in: path
31423           description: String that identifies the interface
31424           required: true
31425           type: string
31426           example: __VLAN-INTERFACE__
31427         - name: l3-interface-ipv6-address
31428           in: path
31429           description: IP address
31430           required: true
31431           type: string
31432           example: __L3-INTERFACE-IPV6-ADDRESS__
31433         - name: vnf-name
31434           in: query
31435           description: Name of VNF.
31436           required: false
31437           type: string
31438         - name: vnf-name2
31439           in: query
31440           description: Alternate name of VNF.
31441           required: false
31442           type: string
31443         - name: vnf-type
31444           in: query
31445           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31446           required: false
31447           type: string
31448         - name: service-id
31449           in: query
31450           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31451           required: false
31452           type: string
31453         - name: regional-resource-zone
31454           in: query
31455           description: Regional way of organizing pservers, source of truth should define values
31456           required: false
31457           type: string
31458         - name: prov-status
31459           in: query
31460           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31461           required: false
31462           type: string
31463         - name: heat-stack-id
31464           in: query
31465           description: Heat stack id corresponding to this instance, managed by MSO
31466           required: false
31467           type: string
31468         - name: in-maint
31469           in: query
31470           required: false
31471           type: boolean
31472         - name: is-closed-loop-disabled
31473           in: query
31474           required: false
31475           type: boolean
31476         - name: model-invariant-id
31477           in: query
31478           description: the ASDC model id for this resource or service model.
31479           required: false
31480           type: string
31481         - name: model-version-id
31482           in: query
31483           description: the ASDC model version for this resource or service model.
31484           required: false
31485           type: string
31486         - name: widget-model-id
31487           in: query
31488           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31489           required: false
31490           type: string
31491         - name: widget-model-version
31492           in: query
31493           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31494           required: false
31495           type: string
31496         - name: nf-type
31497           in: query
31498           description: Generic description of the type of NF
31499           required: false
31500           type: string
31501         - name: nf-function
31502           in: query
31503           description: English description of Network function that the specific VNF deployment is providing
31504           required: false
31505           type: string
31506         - name: nf-role
31507           in: query
31508           description: role in the network that this model will be providing
31509           required: false
31510           type: string
31511         - name: nf-naming-code
31512           in: query
31513           description: string assigned to this model used for naming purposes
31514           required: false
31515           type: string
31516         - name: interface-id
31517           in: query
31518           description: ID of interface
31519           required: false
31520           type: string
31521         - name: macaddr
31522           in: query
31523           description: MAC address for the interface
31524           required: false
31525           type: string
31526         - name: network-name
31527           in: query
31528           description: Name of the network
31529           required: false
31530           type: string
31531         - name: vlan-id-inner
31532           in: query
31533           description: Inner VLAN tag
31534           required: false
31535           type: integer
31536           format: int64
31537         - name: vpn-id
31538           in: query
31539           description: This indicates the customers VPN ID associated with this vlan
31540           required: false
31541           type: string
31542         - name: vlan-id-inner
31543           in: query
31544           description: Inner VLAN tag
31545           required: false
31546           type: integer
31547           format: int64
31548         - name: neutron-network-id
31549           in: query
31550           description: Neutron network id of the interface that address belongs to
31551           required: false
31552           type: string
31553         - name: neutron-subnet-id
31554           in: query
31555           description: Neutron id of subnet that address belongs to
31556           required: false
31557           type: string
31558     put:
31559       tags:
31560         - Network
31561       summary: create or update an existing l3-interface-ipv6-address-list
31562       description: |
31563         Create or update an existing l3-interface-ipv6-address-list.
31564         #
31565         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31566       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31567       consumes:
31568         - application/json
31569         - application/xml
31570       produces:
31571         - application/json
31572         - application/xml
31573       responses:
31574         "default":
31575           description: Response codes found in [response codes](https://wiki.onap.org/).
31576       parameters:
31577         - name: vnf-id
31578           in: path
31579           description: Unique id of VNF.  This is unique across the graph.
31580           required: true
31581           type: string
31582           example: __VNF-ID__
31583         - name: interface-name
31584           in: path
31585           description: Name given to the interface
31586           required: true
31587           type: string
31588           example: __INTERFACE-NAME__
31589         - name: vlan-interface
31590           in: path
31591           description: String that identifies the interface
31592           required: true
31593           type: string
31594           example: __VLAN-INTERFACE__
31595         - name: l3-interface-ipv6-address
31596           in: path
31597           description: IP address
31598           required: true
31599           type: string
31600           example: __L3-INTERFACE-IPV6-ADDRESS__
31601         - name: body
31602           in: body
31603           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
31604           required: true
31605           schema:
31606             $ref: "#/definitions/l3-interface-ipv6-address-list"
31607     patch:
31608       tags:
31609         - Network
31610       summary: update an existing l3-interface-ipv6-address-list
31611       description: |
31612         Update an existing l3-interface-ipv6-address-list
31613         #
31614         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31615         The PUT operation will entirely replace an existing object.
31616         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31617         #
31618         Other differences between PUT and PATCH are:
31619         #
31620         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31621         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31622         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31623       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31624       consumes:
31625         - application/json
31626         - application/xml
31627       produces:
31628         - application/json
31629         - application/xml
31630       responses:
31631         "default":
31632           description: Response codes found in [response codes](https://wiki.onap.org/).
31633       parameters:
31634         - name: vnf-id
31635           in: path
31636           description: Unique id of VNF.  This is unique across the graph.
31637           required: true
31638           type: string
31639           example: __VNF-ID__
31640         - name: interface-name
31641           in: path
31642           description: Name given to the interface
31643           required: true
31644           type: string
31645           example: __INTERFACE-NAME__
31646         - name: vlan-interface
31647           in: path
31648           description: String that identifies the interface
31649           required: true
31650           type: string
31651           example: __VLAN-INTERFACE__
31652         - name: l3-interface-ipv6-address
31653           in: path
31654           description: IP address
31655           required: true
31656           type: string
31657           example: __L3-INTERFACE-IPV6-ADDRESS__
31658         - name: body
31659           in: body
31660           description: l3-interface-ipv6-address-list object that needs to be created or updated.
31661           required: true
31662           schema:
31663             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
31664     delete:
31665       tags:
31666         - Network
31667       summary: delete an existing l3-interface-ipv6-address-list
31668       description: delete an existing l3-interface-ipv6-address-list
31669       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
31670       consumes:
31671         - application/json
31672         - application/xml
31673       produces:
31674         - application/json
31675         - application/xml
31676       responses:
31677         "default":
31678           description: Response codes found in [response codes](https://wiki.onap.org/).
31679       parameters:
31680         - name: vnf-id
31681           in: path
31682           description: Unique id of VNF.  This is unique across the graph.
31683           required: true
31684           type: string
31685           example: __VNF-ID__
31686         - name: interface-name
31687           in: path
31688           description: Name given to the interface
31689           required: true
31690           type: string
31691           example: __INTERFACE-NAME__
31692         - name: vlan-interface
31693           in: path
31694           description: String that identifies the interface
31695           required: true
31696           type: string
31697           example: __VLAN-INTERFACE__
31698         - name: l3-interface-ipv6-address
31699           in: path
31700           description: IP address
31701           required: true
31702           type: string
31703           example: __L3-INTERFACE-IPV6-ADDRESS__
31704         - name: resource-version
31705           in: query
31706           description: resource-version for concurrency
31707           required: true
31708           type: string
31709   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
31710     get:
31711       tags:
31712         - Network
31713       summary: returns vlan
31714       description: returns vlan
31715       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31716       produces:
31717         - application/json
31718         - application/xml
31719       responses:
31720         "200":
31721           description: successful operation
31722           schema:
31723               $ref: "#/getDefinitions/vlan"
31724         "default":
31725           description: Response codes found in [response codes](https://wiki.onap.org/).
31726       parameters:
31727         - name: vnf-id
31728           in: path
31729           description: Unique id of VNF.  This is unique across the graph.
31730           required: true
31731           type: string
31732           example: __VNF-ID__
31733         - name: interface-name
31734           in: path
31735           description: Name given to the interface
31736           required: true
31737           type: string
31738           example: __INTERFACE-NAME__
31739         - name: vlan-interface
31740           in: path
31741           description: String that identifies the interface
31742           required: true
31743           type: string
31744           example: __VLAN-INTERFACE__
31745         - name: vnf-name
31746           in: query
31747           description: Name of VNF.
31748           required: false
31749           type: string
31750         - name: vnf-name2
31751           in: query
31752           description: Alternate name of VNF.
31753           required: false
31754           type: string
31755         - name: vnf-type
31756           in: query
31757           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
31758           required: false
31759           type: string
31760         - name: service-id
31761           in: query
31762           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
31763           required: false
31764           type: string
31765         - name: regional-resource-zone
31766           in: query
31767           description: Regional way of organizing pservers, source of truth should define values
31768           required: false
31769           type: string
31770         - name: prov-status
31771           in: query
31772           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31773           required: false
31774           type: string
31775         - name: heat-stack-id
31776           in: query
31777           description: Heat stack id corresponding to this instance, managed by MSO
31778           required: false
31779           type: string
31780         - name: in-maint
31781           in: query
31782           required: false
31783           type: boolean
31784         - name: is-closed-loop-disabled
31785           in: query
31786           required: false
31787           type: boolean
31788         - name: model-invariant-id
31789           in: query
31790           description: the ASDC model id for this resource or service model.
31791           required: false
31792           type: string
31793         - name: model-version-id
31794           in: query
31795           description: the ASDC model version for this resource or service model.
31796           required: false
31797           type: string
31798         - name: widget-model-id
31799           in: query
31800           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
31801           required: false
31802           type: string
31803         - name: widget-model-version
31804           in: query
31805           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
31806           required: false
31807           type: string
31808         - name: nf-type
31809           in: query
31810           description: Generic description of the type of NF
31811           required: false
31812           type: string
31813         - name: nf-function
31814           in: query
31815           description: English description of Network function that the specific VNF deployment is providing
31816           required: false
31817           type: string
31818         - name: nf-role
31819           in: query
31820           description: role in the network that this model will be providing
31821           required: false
31822           type: string
31823         - name: nf-naming-code
31824           in: query
31825           description: string assigned to this model used for naming purposes
31826           required: false
31827           type: string
31828         - name: interface-id
31829           in: query
31830           description: ID of interface
31831           required: false
31832           type: string
31833         - name: macaddr
31834           in: query
31835           description: MAC address for the interface
31836           required: false
31837           type: string
31838         - name: network-name
31839           in: query
31840           description: Name of the network
31841           required: false
31842           type: string
31843         - name: vlan-id-inner
31844           in: query
31845           description: Inner VLAN tag
31846           required: false
31847           type: integer
31848           format: int64
31849         - name: vpn-id
31850           in: query
31851           description: This indicates the customers VPN ID associated with this vlan
31852           required: false
31853           type: string
31854     put:
31855       tags:
31856         - Network
31857       summary: create or update an existing vlan
31858       description: |
31859         Create or update an existing vlan.
31860         #
31861         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31862       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31863       consumes:
31864         - application/json
31865         - application/xml
31866       produces:
31867         - application/json
31868         - application/xml
31869       responses:
31870         "default":
31871           description: Response codes found in [response codes](https://wiki.onap.org/).
31872       parameters:
31873         - name: vnf-id
31874           in: path
31875           description: Unique id of VNF.  This is unique across the graph.
31876           required: true
31877           type: string
31878           example: __VNF-ID__
31879         - name: interface-name
31880           in: path
31881           description: Name given to the interface
31882           required: true
31883           type: string
31884           example: __INTERFACE-NAME__
31885         - name: vlan-interface
31886           in: path
31887           description: String that identifies the interface
31888           required: true
31889           type: string
31890           example: __VLAN-INTERFACE__
31891         - name: body
31892           in: body
31893           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
31894           required: true
31895           schema:
31896             $ref: "#/definitions/vlan"
31897     patch:
31898       tags:
31899         - Network
31900       summary: update an existing vlan
31901       description: |
31902         Update an existing vlan
31903         #
31904         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31905         The PUT operation will entirely replace an existing object.
31906         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31907         #
31908         Other differences between PUT and PATCH are:
31909         #
31910         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31911         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31912         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31913       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31914       consumes:
31915         - application/json
31916         - application/xml
31917       produces:
31918         - application/json
31919         - application/xml
31920       responses:
31921         "default":
31922           description: Response codes found in [response codes](https://wiki.onap.org/).
31923       parameters:
31924         - name: vnf-id
31925           in: path
31926           description: Unique id of VNF.  This is unique across the graph.
31927           required: true
31928           type: string
31929           example: __VNF-ID__
31930         - name: interface-name
31931           in: path
31932           description: Name given to the interface
31933           required: true
31934           type: string
31935           example: __INTERFACE-NAME__
31936         - name: vlan-interface
31937           in: path
31938           description: String that identifies the interface
31939           required: true
31940           type: string
31941           example: __VLAN-INTERFACE__
31942         - name: body
31943           in: body
31944           description: vlan object that needs to be created or updated.
31945           required: true
31946           schema:
31947             $ref: "#/patchDefinitions/vlan"
31948     delete:
31949       tags:
31950         - Network
31951       summary: delete an existing vlan
31952       description: delete an existing vlan
31953       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
31954       consumes:
31955         - application/json
31956         - application/xml
31957       produces:
31958         - application/json
31959         - application/xml
31960       responses:
31961         "default":
31962           description: Response codes found in [response codes](https://wiki.onap.org/).
31963       parameters:
31964         - name: vnf-id
31965           in: path
31966           description: Unique id of VNF.  This is unique across the graph.
31967           required: true
31968           type: string
31969           example: __VNF-ID__
31970         - name: interface-name
31971           in: path
31972           description: Name given to the interface
31973           required: true
31974           type: string
31975           example: __INTERFACE-NAME__
31976         - name: vlan-interface
31977           in: path
31978           description: String that identifies the interface
31979           required: true
31980           type: string
31981           example: __VLAN-INTERFACE__
31982         - name: resource-version
31983           in: query
31984           description: resource-version for concurrency
31985           required: true
31986           type: string
31987   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
31988     get:
31989       tags:
31990         - Network
31991       summary: returns vlans
31992       description: returns vlans
31993       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
31994       produces:
31995         - application/json
31996         - application/xml
31997       responses:
31998         "200":
31999           description: successful operation
32000           schema:
32001               $ref: "#/getDefinitions/vlans"
32002         "default":
32003           description: Response codes found in [response codes](https://wiki.onap.org/).
32004       parameters:
32005         - name: vnf-id
32006           in: path
32007           description: Unique id of VNF.  This is unique across the graph.
32008           required: true
32009           type: string
32010           example: __VNF-ID__
32011         - name: interface-name
32012           in: path
32013           description: Name given to the interface
32014           required: true
32015           type: string
32016           example: __INTERFACE-NAME__
32017         - name: vnf-name
32018           in: query
32019           description: Name of VNF.
32020           required: false
32021           type: string
32022         - name: vnf-name2
32023           in: query
32024           description: Alternate name of VNF.
32025           required: false
32026           type: string
32027         - name: vnf-type
32028           in: query
32029           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32030           required: false
32031           type: string
32032         - name: service-id
32033           in: query
32034           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32035           required: false
32036           type: string
32037         - name: regional-resource-zone
32038           in: query
32039           description: Regional way of organizing pservers, source of truth should define values
32040           required: false
32041           type: string
32042         - name: prov-status
32043           in: query
32044           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32045           required: false
32046           type: string
32047         - name: heat-stack-id
32048           in: query
32049           description: Heat stack id corresponding to this instance, managed by MSO
32050           required: false
32051           type: string
32052         - name: in-maint
32053           in: query
32054           required: false
32055           type: boolean
32056         - name: is-closed-loop-disabled
32057           in: query
32058           required: false
32059           type: boolean
32060         - name: model-invariant-id
32061           in: query
32062           description: the ASDC model id for this resource or service model.
32063           required: false
32064           type: string
32065         - name: model-version-id
32066           in: query
32067           description: the ASDC model version for this resource or service model.
32068           required: false
32069           type: string
32070         - name: widget-model-id
32071           in: query
32072           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32073           required: false
32074           type: string
32075         - name: widget-model-version
32076           in: query
32077           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32078           required: false
32079           type: string
32080         - name: nf-type
32081           in: query
32082           description: Generic description of the type of NF
32083           required: false
32084           type: string
32085         - name: nf-function
32086           in: query
32087           description: English description of Network function that the specific VNF deployment is providing
32088           required: false
32089           type: string
32090         - name: nf-role
32091           in: query
32092           description: role in the network that this model will be providing
32093           required: false
32094           type: string
32095         - name: nf-naming-code
32096           in: query
32097           description: string assigned to this model used for naming purposes
32098           required: false
32099           type: string
32100         - name: interface-id
32101           in: query
32102           description: ID of interface
32103           required: false
32104           type: string
32105         - name: macaddr
32106           in: query
32107           description: MAC address for the interface
32108           required: false
32109           type: string
32110         - name: network-name
32111           in: query
32112           description: Name of the network
32113           required: false
32114           type: string
32115   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
32116     put:
32117       tags:
32118         - Network
32119       summary: see node definition for valid relationships
32120       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32121       consumes:
32122         - application/json
32123         - application/xml
32124       produces:
32125         - application/json
32126         - application/xml
32127       responses:
32128         "default":
32129           description: Response codes found in [response codes](https://wiki.onap.org/).
32130       parameters:
32131         - name: vnf-id
32132           in: path
32133           description: Unique id of VNF.  This is unique across the graph.
32134           required: true
32135           type: string
32136           example: __VNF-ID__
32137         - name: interface-name
32138           in: path
32139           description: Name given to the interface
32140           required: true
32141           type: string
32142           example: __INTERFACE-NAME__
32143         - name: pci-id
32144           in: path
32145           description: PCI ID used to identify the sriov-vf
32146           required: true
32147           type: string
32148           example: __PCI-ID__
32149         - name: body
32150           in: body
32151           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32152           required: true
32153           schema:
32154             $ref: "#/definitions/relationship"
32155     delete:
32156       tags:
32157         - Network
32158       summary: delete an existing relationship
32159       description: delete an existing relationship
32160       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
32161       consumes:
32162         - application/json
32163         - application/xml
32164       produces:
32165         - application/json
32166         - application/xml
32167       responses:
32168         "default":
32169           description: Response codes found in [response codes](https://wiki.onap.org/).
32170       parameters:
32171         - name: vnf-id
32172           in: path
32173           description: Unique id of VNF.  This is unique across the graph.
32174           required: true
32175           type: string
32176           example: __VNF-ID__
32177         - name: interface-name
32178           in: path
32179           description: Name given to the interface
32180           required: true
32181           type: string
32182           example: __INTERFACE-NAME__
32183         - name: pci-id
32184           in: path
32185           description: PCI ID used to identify the sriov-vf
32186           required: true
32187           type: string
32188           example: __PCI-ID__
32189   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
32190     get:
32191       tags:
32192         - Network
32193       summary: returns sriov-vf
32194       description: returns sriov-vf
32195       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32196       produces:
32197         - application/json
32198         - application/xml
32199       responses:
32200         "200":
32201           description: successful operation
32202           schema:
32203               $ref: "#/getDefinitions/sriov-vf"
32204         "default":
32205           description: Response codes found in [response codes](https://wiki.onap.org/).
32206       parameters:
32207         - name: vnf-id
32208           in: path
32209           description: Unique id of VNF.  This is unique across the graph.
32210           required: true
32211           type: string
32212           example: __VNF-ID__
32213         - name: interface-name
32214           in: path
32215           description: Name given to the interface
32216           required: true
32217           type: string
32218           example: __INTERFACE-NAME__
32219         - name: pci-id
32220           in: path
32221           description: PCI ID used to identify the sriov-vf
32222           required: true
32223           type: string
32224           example: __PCI-ID__
32225         - name: vnf-name
32226           in: query
32227           description: Name of VNF.
32228           required: false
32229           type: string
32230         - name: vnf-name2
32231           in: query
32232           description: Alternate name of VNF.
32233           required: false
32234           type: string
32235         - name: vnf-type
32236           in: query
32237           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32238           required: false
32239           type: string
32240         - name: service-id
32241           in: query
32242           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32243           required: false
32244           type: string
32245         - name: regional-resource-zone
32246           in: query
32247           description: Regional way of organizing pservers, source of truth should define values
32248           required: false
32249           type: string
32250         - name: prov-status
32251           in: query
32252           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32253           required: false
32254           type: string
32255         - name: heat-stack-id
32256           in: query
32257           description: Heat stack id corresponding to this instance, managed by MSO
32258           required: false
32259           type: string
32260         - name: in-maint
32261           in: query
32262           required: false
32263           type: boolean
32264         - name: is-closed-loop-disabled
32265           in: query
32266           required: false
32267           type: boolean
32268         - name: model-invariant-id
32269           in: query
32270           description: the ASDC model id for this resource or service model.
32271           required: false
32272           type: string
32273         - name: model-version-id
32274           in: query
32275           description: the ASDC model version for this resource or service model.
32276           required: false
32277           type: string
32278         - name: widget-model-id
32279           in: query
32280           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32281           required: false
32282           type: string
32283         - name: widget-model-version
32284           in: query
32285           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32286           required: false
32287           type: string
32288         - name: nf-type
32289           in: query
32290           description: Generic description of the type of NF
32291           required: false
32292           type: string
32293         - name: nf-function
32294           in: query
32295           description: English description of Network function that the specific VNF deployment is providing
32296           required: false
32297           type: string
32298         - name: nf-role
32299           in: query
32300           description: role in the network that this model will be providing
32301           required: false
32302           type: string
32303         - name: nf-naming-code
32304           in: query
32305           description: string assigned to this model used for naming purposes
32306           required: false
32307           type: string
32308         - name: interface-id
32309           in: query
32310           description: ID of interface
32311           required: false
32312           type: string
32313         - name: macaddr
32314           in: query
32315           description: MAC address for the interface
32316           required: false
32317           type: string
32318         - name: network-name
32319           in: query
32320           description: Name of the network
32321           required: false
32322           type: string
32323         - name: vf-vlan-filter
32324           in: query
32325           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
32326           required: false
32327           type: string
32328         - name: vf-mac-filter
32329           in: query
32330           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
32331           required: false
32332           type: string
32333         - name: vf-vlan-strip
32334           in: query
32335           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
32336           required: false
32337           type: boolean
32338         - name: neutron-network-id
32339           in: query
32340           description: Neutron network id of the interface
32341           required: false
32342           type: string
32343     put:
32344       tags:
32345         - Network
32346       summary: create or update an existing sriov-vf
32347       description: |
32348         Create or update an existing sriov-vf.
32349         #
32350         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32351       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32352       consumes:
32353         - application/json
32354         - application/xml
32355       produces:
32356         - application/json
32357         - application/xml
32358       responses:
32359         "default":
32360           description: Response codes found in [response codes](https://wiki.onap.org/).
32361       parameters:
32362         - name: vnf-id
32363           in: path
32364           description: Unique id of VNF.  This is unique across the graph.
32365           required: true
32366           type: string
32367           example: __VNF-ID__
32368         - name: interface-name
32369           in: path
32370           description: Name given to the interface
32371           required: true
32372           type: string
32373           example: __INTERFACE-NAME__
32374         - name: pci-id
32375           in: path
32376           description: PCI ID used to identify the sriov-vf
32377           required: true
32378           type: string
32379           example: __PCI-ID__
32380         - name: body
32381           in: body
32382           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
32383           required: true
32384           schema:
32385             $ref: "#/definitions/sriov-vf"
32386     patch:
32387       tags:
32388         - Network
32389       summary: update an existing sriov-vf
32390       description: |
32391         Update an existing sriov-vf
32392         #
32393         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32394         The PUT operation will entirely replace an existing object.
32395         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32396         #
32397         Other differences between PUT and PATCH are:
32398         #
32399         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32400         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32401         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32402       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32403       consumes:
32404         - application/json
32405         - application/xml
32406       produces:
32407         - application/json
32408         - application/xml
32409       responses:
32410         "default":
32411           description: Response codes found in [response codes](https://wiki.onap.org/).
32412       parameters:
32413         - name: vnf-id
32414           in: path
32415           description: Unique id of VNF.  This is unique across the graph.
32416           required: true
32417           type: string
32418           example: __VNF-ID__
32419         - name: interface-name
32420           in: path
32421           description: Name given to the interface
32422           required: true
32423           type: string
32424           example: __INTERFACE-NAME__
32425         - name: pci-id
32426           in: path
32427           description: PCI ID used to identify the sriov-vf
32428           required: true
32429           type: string
32430           example: __PCI-ID__
32431         - name: body
32432           in: body
32433           description: sriov-vf object that needs to be created or updated.
32434           required: true
32435           schema:
32436             $ref: "#/patchDefinitions/sriov-vf"
32437     delete:
32438       tags:
32439         - Network
32440       summary: delete an existing sriov-vf
32441       description: delete an existing sriov-vf
32442       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
32443       consumes:
32444         - application/json
32445         - application/xml
32446       produces:
32447         - application/json
32448         - application/xml
32449       responses:
32450         "default":
32451           description: Response codes found in [response codes](https://wiki.onap.org/).
32452       parameters:
32453         - name: vnf-id
32454           in: path
32455           description: Unique id of VNF.  This is unique across the graph.
32456           required: true
32457           type: string
32458           example: __VNF-ID__
32459         - name: interface-name
32460           in: path
32461           description: Name given to the interface
32462           required: true
32463           type: string
32464           example: __INTERFACE-NAME__
32465         - name: pci-id
32466           in: path
32467           description: PCI ID used to identify the sriov-vf
32468           required: true
32469           type: string
32470           example: __PCI-ID__
32471         - name: resource-version
32472           in: query
32473           description: resource-version for concurrency
32474           required: true
32475           type: string
32476   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
32477     get:
32478       tags:
32479         - Network
32480       summary: returns sriov-vfs
32481       description: returns sriov-vfs
32482       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
32483       produces:
32484         - application/json
32485         - application/xml
32486       responses:
32487         "200":
32488           description: successful operation
32489           schema:
32490               $ref: "#/getDefinitions/sriov-vfs"
32491         "default":
32492           description: Response codes found in [response codes](https://wiki.onap.org/).
32493       parameters:
32494         - name: vnf-id
32495           in: path
32496           description: Unique id of VNF.  This is unique across the graph.
32497           required: true
32498           type: string
32499           example: __VNF-ID__
32500         - name: interface-name
32501           in: path
32502           description: Name given to the interface
32503           required: true
32504           type: string
32505           example: __INTERFACE-NAME__
32506         - name: vnf-name
32507           in: query
32508           description: Name of VNF.
32509           required: false
32510           type: string
32511         - name: vnf-name2
32512           in: query
32513           description: Alternate name of VNF.
32514           required: false
32515           type: string
32516         - name: vnf-type
32517           in: query
32518           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32519           required: false
32520           type: string
32521         - name: service-id
32522           in: query
32523           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32524           required: false
32525           type: string
32526         - name: regional-resource-zone
32527           in: query
32528           description: Regional way of organizing pservers, source of truth should define values
32529           required: false
32530           type: string
32531         - name: prov-status
32532           in: query
32533           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32534           required: false
32535           type: string
32536         - name: heat-stack-id
32537           in: query
32538           description: Heat stack id corresponding to this instance, managed by MSO
32539           required: false
32540           type: string
32541         - name: in-maint
32542           in: query
32543           required: false
32544           type: boolean
32545         - name: is-closed-loop-disabled
32546           in: query
32547           required: false
32548           type: boolean
32549         - name: model-invariant-id
32550           in: query
32551           description: the ASDC model id for this resource or service model.
32552           required: false
32553           type: string
32554         - name: model-version-id
32555           in: query
32556           description: the ASDC model version for this resource or service model.
32557           required: false
32558           type: string
32559         - name: widget-model-id
32560           in: query
32561           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32562           required: false
32563           type: string
32564         - name: widget-model-version
32565           in: query
32566           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32567           required: false
32568           type: string
32569         - name: nf-type
32570           in: query
32571           description: Generic description of the type of NF
32572           required: false
32573           type: string
32574         - name: nf-function
32575           in: query
32576           description: English description of Network function that the specific VNF deployment is providing
32577           required: false
32578           type: string
32579         - name: nf-role
32580           in: query
32581           description: role in the network that this model will be providing
32582           required: false
32583           type: string
32584         - name: nf-naming-code
32585           in: query
32586           description: string assigned to this model used for naming purposes
32587           required: false
32588           type: string
32589         - name: interface-id
32590           in: query
32591           description: ID of interface
32592           required: false
32593           type: string
32594         - name: macaddr
32595           in: query
32596           description: MAC address for the interface
32597           required: false
32598           type: string
32599         - name: network-name
32600           in: query
32601           description: Name of the network
32602           required: false
32603           type: string
32604   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
32605     put:
32606       tags:
32607         - Network
32608       summary: see node definition for valid relationships
32609       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32610       consumes:
32611         - application/json
32612         - application/xml
32613       produces:
32614         - application/json
32615         - application/xml
32616       responses:
32617         "default":
32618           description: Response codes found in [response codes](https://wiki.onap.org/).
32619       parameters:
32620         - name: vnf-id
32621           in: path
32622           description: Unique id of VNF.  This is unique across the graph.
32623           required: true
32624           type: string
32625           example: __VNF-ID__
32626         - name: interface-name
32627           in: path
32628           description: Name given to the interface
32629           required: true
32630           type: string
32631           example: __INTERFACE-NAME__
32632         - name: body
32633           in: body
32634           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
32635           required: true
32636           schema:
32637             $ref: "#/definitions/relationship"
32638     delete:
32639       tags:
32640         - Network
32641       summary: delete an existing relationship
32642       description: delete an existing relationship
32643       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
32644       consumes:
32645         - application/json
32646         - application/xml
32647       produces:
32648         - application/json
32649         - application/xml
32650       responses:
32651         "default":
32652           description: Response codes found in [response codes](https://wiki.onap.org/).
32653       parameters:
32654         - name: vnf-id
32655           in: path
32656           description: Unique id of VNF.  This is unique across the graph.
32657           required: true
32658           type: string
32659           example: __VNF-ID__
32660         - name: interface-name
32661           in: path
32662           description: Name given to the interface
32663           required: true
32664           type: string
32665           example: __INTERFACE-NAME__
32666   /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:
32667     put:
32668       tags:
32669         - Network
32670       summary: see node definition for valid relationships
32671       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32672       consumes:
32673         - application/json
32674         - application/xml
32675       produces:
32676         - application/json
32677         - application/xml
32678       responses:
32679         "default":
32680           description: Response codes found in [response codes](https://wiki.onap.org/).
32681       parameters:
32682         - name: vnf-id
32683           in: path
32684           description: Unique id of VNF.  This is unique across the graph.
32685           required: true
32686           type: string
32687           example: __VNF-ID__
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         - name: l3-interface-ipv4-address
32695           in: path
32696           description: IP address
32697           required: true
32698           type: string
32699           example: __L3-INTERFACE-IPV4-ADDRESS__
32700         - name: body
32701           in: body
32702           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32703           required: true
32704           schema:
32705             $ref: "#/definitions/relationship"
32706     delete:
32707       tags:
32708         - Network
32709       summary: delete an existing relationship
32710       description: delete an existing relationship
32711       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
32712       consumes:
32713         - application/json
32714         - application/xml
32715       produces:
32716         - application/json
32717         - application/xml
32718       responses:
32719         "default":
32720           description: Response codes found in [response codes](https://wiki.onap.org/).
32721       parameters:
32722         - name: vnf-id
32723           in: path
32724           description: Unique id of VNF.  This is unique across the graph.
32725           required: true
32726           type: string
32727           example: __VNF-ID__
32728         - name: interface-name
32729           in: path
32730           description: Name given to the interface
32731           required: true
32732           type: string
32733           example: __INTERFACE-NAME__
32734         - name: l3-interface-ipv4-address
32735           in: path
32736           description: IP address
32737           required: true
32738           type: string
32739           example: __L3-INTERFACE-IPV4-ADDRESS__
32740   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
32741     get:
32742       tags:
32743         - Network
32744       summary: returns l3-interface-ipv4-address-list
32745       description: returns l3-interface-ipv4-address-list
32746       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32747       produces:
32748         - application/json
32749         - application/xml
32750       responses:
32751         "200":
32752           description: successful operation
32753           schema:
32754               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
32755         "default":
32756           description: Response codes found in [response codes](https://wiki.onap.org/).
32757       parameters:
32758         - name: vnf-id
32759           in: path
32760           description: Unique id of VNF.  This is unique across the graph.
32761           required: true
32762           type: string
32763           example: __VNF-ID__
32764         - name: interface-name
32765           in: path
32766           description: Name given to the interface
32767           required: true
32768           type: string
32769           example: __INTERFACE-NAME__
32770         - name: l3-interface-ipv4-address
32771           in: path
32772           description: IP address
32773           required: true
32774           type: string
32775           example: __L3-INTERFACE-IPV4-ADDRESS__
32776         - name: vnf-name
32777           in: query
32778           description: Name of VNF.
32779           required: false
32780           type: string
32781         - name: vnf-name2
32782           in: query
32783           description: Alternate name of VNF.
32784           required: false
32785           type: string
32786         - name: vnf-type
32787           in: query
32788           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
32789           required: false
32790           type: string
32791         - name: service-id
32792           in: query
32793           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
32794           required: false
32795           type: string
32796         - name: regional-resource-zone
32797           in: query
32798           description: Regional way of organizing pservers, source of truth should define values
32799           required: false
32800           type: string
32801         - name: prov-status
32802           in: query
32803           description: Trigger for operational monitoring of this resource by Service Assurance systems.
32804           required: false
32805           type: string
32806         - name: heat-stack-id
32807           in: query
32808           description: Heat stack id corresponding to this instance, managed by MSO
32809           required: false
32810           type: string
32811         - name: in-maint
32812           in: query
32813           required: false
32814           type: boolean
32815         - name: is-closed-loop-disabled
32816           in: query
32817           required: false
32818           type: boolean
32819         - name: model-invariant-id
32820           in: query
32821           description: the ASDC model id for this resource or service model.
32822           required: false
32823           type: string
32824         - name: model-version-id
32825           in: query
32826           description: the ASDC model version for this resource or service model.
32827           required: false
32828           type: string
32829         - name: widget-model-id
32830           in: query
32831           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32832           required: false
32833           type: string
32834         - name: widget-model-version
32835           in: query
32836           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32837           required: false
32838           type: string
32839         - name: nf-type
32840           in: query
32841           description: Generic description of the type of NF
32842           required: false
32843           type: string
32844         - name: nf-function
32845           in: query
32846           description: English description of Network function that the specific VNF deployment is providing
32847           required: false
32848           type: string
32849         - name: nf-role
32850           in: query
32851           description: role in the network that this model will be providing
32852           required: false
32853           type: string
32854         - name: nf-naming-code
32855           in: query
32856           description: string assigned to this model used for naming purposes
32857           required: false
32858           type: string
32859         - name: interface-id
32860           in: query
32861           description: ID of interface
32862           required: false
32863           type: string
32864         - name: macaddr
32865           in: query
32866           description: MAC address for the interface
32867           required: false
32868           type: string
32869         - name: network-name
32870           in: query
32871           description: Name of the network
32872           required: false
32873           type: string
32874         - name: vlan-id-inner
32875           in: query
32876           description: Inner VLAN tag
32877           required: false
32878           type: integer
32879           format: int64
32880         - name: neutron-network-id
32881           in: query
32882           description: Neutron network id of the interface that address belongs to
32883           required: false
32884           type: string
32885         - name: neutron-subnet-id
32886           in: query
32887           description: Neutron id of subnet that address belongs to
32888           required: false
32889           type: string
32890     put:
32891       tags:
32892         - Network
32893       summary: create or update an existing l3-interface-ipv4-address-list
32894       description: |
32895         Create or update an existing l3-interface-ipv4-address-list.
32896         #
32897         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32898       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32899       consumes:
32900         - application/json
32901         - application/xml
32902       produces:
32903         - application/json
32904         - application/xml
32905       responses:
32906         "default":
32907           description: Response codes found in [response codes](https://wiki.onap.org/).
32908       parameters:
32909         - name: vnf-id
32910           in: path
32911           description: Unique id of VNF.  This is unique across the graph.
32912           required: true
32913           type: string
32914           example: __VNF-ID__
32915         - name: interface-name
32916           in: path
32917           description: Name given to the interface
32918           required: true
32919           type: string
32920           example: __INTERFACE-NAME__
32921         - name: l3-interface-ipv4-address
32922           in: path
32923           description: IP address
32924           required: true
32925           type: string
32926           example: __L3-INTERFACE-IPV4-ADDRESS__
32927         - name: body
32928           in: body
32929           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
32930           required: true
32931           schema:
32932             $ref: "#/definitions/l3-interface-ipv4-address-list"
32933     patch:
32934       tags:
32935         - Network
32936       summary: update an existing l3-interface-ipv4-address-list
32937       description: |
32938         Update an existing l3-interface-ipv4-address-list
32939         #
32940         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32941         The PUT operation will entirely replace an existing object.
32942         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32943         #
32944         Other differences between PUT and PATCH are:
32945         #
32946         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32947         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32948         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32949       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32950       consumes:
32951         - application/json
32952         - application/xml
32953       produces:
32954         - application/json
32955         - application/xml
32956       responses:
32957         "default":
32958           description: Response codes found in [response codes](https://wiki.onap.org/).
32959       parameters:
32960         - name: vnf-id
32961           in: path
32962           description: Unique id of VNF.  This is unique across the graph.
32963           required: true
32964           type: string
32965           example: __VNF-ID__
32966         - name: interface-name
32967           in: path
32968           description: Name given to the interface
32969           required: true
32970           type: string
32971           example: __INTERFACE-NAME__
32972         - name: l3-interface-ipv4-address
32973           in: path
32974           description: IP address
32975           required: true
32976           type: string
32977           example: __L3-INTERFACE-IPV4-ADDRESS__
32978         - name: body
32979           in: body
32980           description: l3-interface-ipv4-address-list object that needs to be created or updated.
32981           required: true
32982           schema:
32983             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
32984     delete:
32985       tags:
32986         - Network
32987       summary: delete an existing l3-interface-ipv4-address-list
32988       description: delete an existing l3-interface-ipv4-address-list
32989       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
32990       consumes:
32991         - application/json
32992         - application/xml
32993       produces:
32994         - application/json
32995         - application/xml
32996       responses:
32997         "default":
32998           description: Response codes found in [response codes](https://wiki.onap.org/).
32999       parameters:
33000         - name: vnf-id
33001           in: path
33002           description: Unique id of VNF.  This is unique across the graph.
33003           required: true
33004           type: string
33005           example: __VNF-ID__
33006         - name: interface-name
33007           in: path
33008           description: Name given to the interface
33009           required: true
33010           type: string
33011           example: __INTERFACE-NAME__
33012         - name: l3-interface-ipv4-address
33013           in: path
33014           description: IP address
33015           required: true
33016           type: string
33017           example: __L3-INTERFACE-IPV4-ADDRESS__
33018         - name: resource-version
33019           in: query
33020           description: resource-version for concurrency
33021           required: true
33022           type: string
33023   /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:
33024     put:
33025       tags:
33026         - Network
33027       summary: see node definition for valid relationships
33028       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33029       consumes:
33030         - application/json
33031         - application/xml
33032       produces:
33033         - application/json
33034         - application/xml
33035       responses:
33036         "default":
33037           description: Response codes found in [response codes](https://wiki.onap.org/).
33038       parameters:
33039         - name: vnf-id
33040           in: path
33041           description: Unique id of VNF.  This is unique across the graph.
33042           required: true
33043           type: string
33044           example: __VNF-ID__
33045         - name: interface-name
33046           in: path
33047           description: Name given to the interface
33048           required: true
33049           type: string
33050           example: __INTERFACE-NAME__
33051         - name: l3-interface-ipv6-address
33052           in: path
33053           description: IP address
33054           required: true
33055           type: string
33056           example: __L3-INTERFACE-IPV6-ADDRESS__
33057         - name: body
33058           in: body
33059           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33060           required: true
33061           schema:
33062             $ref: "#/definitions/relationship"
33063     delete:
33064       tags:
33065         - Network
33066       summary: delete an existing relationship
33067       description: delete an existing relationship
33068       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
33069       consumes:
33070         - application/json
33071         - application/xml
33072       produces:
33073         - application/json
33074         - application/xml
33075       responses:
33076         "default":
33077           description: Response codes found in [response codes](https://wiki.onap.org/).
33078       parameters:
33079         - name: vnf-id
33080           in: path
33081           description: Unique id of VNF.  This is unique across the graph.
33082           required: true
33083           type: string
33084           example: __VNF-ID__
33085         - name: interface-name
33086           in: path
33087           description: Name given to the interface
33088           required: true
33089           type: string
33090           example: __INTERFACE-NAME__
33091         - name: l3-interface-ipv6-address
33092           in: path
33093           description: IP address
33094           required: true
33095           type: string
33096           example: __L3-INTERFACE-IPV6-ADDRESS__
33097   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
33098     get:
33099       tags:
33100         - Network
33101       summary: returns l3-interface-ipv6-address-list
33102       description: returns l3-interface-ipv6-address-list
33103       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33104       produces:
33105         - application/json
33106         - application/xml
33107       responses:
33108         "200":
33109           description: successful operation
33110           schema:
33111               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
33112         "default":
33113           description: Response codes found in [response codes](https://wiki.onap.org/).
33114       parameters:
33115         - name: vnf-id
33116           in: path
33117           description: Unique id of VNF.  This is unique across the graph.
33118           required: true
33119           type: string
33120           example: __VNF-ID__
33121         - name: interface-name
33122           in: path
33123           description: Name given to the interface
33124           required: true
33125           type: string
33126           example: __INTERFACE-NAME__
33127         - name: l3-interface-ipv6-address
33128           in: path
33129           description: IP address
33130           required: true
33131           type: string
33132           example: __L3-INTERFACE-IPV6-ADDRESS__
33133         - name: vnf-name
33134           in: query
33135           description: Name of VNF.
33136           required: false
33137           type: string
33138         - name: vnf-name2
33139           in: query
33140           description: Alternate name of VNF.
33141           required: false
33142           type: string
33143         - name: vnf-type
33144           in: query
33145           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33146           required: false
33147           type: string
33148         - name: service-id
33149           in: query
33150           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
33151           required: false
33152           type: string
33153         - name: regional-resource-zone
33154           in: query
33155           description: Regional way of organizing pservers, source of truth should define values
33156           required: false
33157           type: string
33158         - name: prov-status
33159           in: query
33160           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33161           required: false
33162           type: string
33163         - name: heat-stack-id
33164           in: query
33165           description: Heat stack id corresponding to this instance, managed by MSO
33166           required: false
33167           type: string
33168         - name: in-maint
33169           in: query
33170           required: false
33171           type: boolean
33172         - name: is-closed-loop-disabled
33173           in: query
33174           required: false
33175           type: boolean
33176         - name: model-invariant-id
33177           in: query
33178           description: the ASDC model id for this resource or service model.
33179           required: false
33180           type: string
33181         - name: model-version-id
33182           in: query
33183           description: the ASDC model version for this resource or service model.
33184           required: false
33185           type: string
33186         - name: widget-model-id
33187           in: query
33188           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33189           required: false
33190           type: string
33191         - name: widget-model-version
33192           in: query
33193           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33194           required: false
33195           type: string
33196         - name: nf-type
33197           in: query
33198           description: Generic description of the type of NF
33199           required: false
33200           type: string
33201         - name: nf-function
33202           in: query
33203           description: English description of Network function that the specific VNF deployment is providing
33204           required: false
33205           type: string
33206         - name: nf-role
33207           in: query
33208           description: role in the network that this model will be providing
33209           required: false
33210           type: string
33211         - name: nf-naming-code
33212           in: query
33213           description: string assigned to this model used for naming purposes
33214           required: false
33215           type: string
33216         - name: interface-id
33217           in: query
33218           description: ID of interface
33219           required: false
33220           type: string
33221         - name: macaddr
33222           in: query
33223           description: MAC address for the interface
33224           required: false
33225           type: string
33226         - name: network-name
33227           in: query
33228           description: Name of the network
33229           required: false
33230           type: string
33231         - name: vlan-id-inner
33232           in: query
33233           description: Inner VLAN tag
33234           required: false
33235           type: integer
33236           format: int64
33237         - name: neutron-network-id
33238           in: query
33239           description: Neutron network id of the interface that address belongs to
33240           required: false
33241           type: string
33242         - name: neutron-subnet-id
33243           in: query
33244           description: Neutron id of subnet that address belongs to
33245           required: false
33246           type: string
33247     put:
33248       tags:
33249         - Network
33250       summary: create or update an existing l3-interface-ipv6-address-list
33251       description: |
33252         Create or update an existing l3-interface-ipv6-address-list.
33253         #
33254         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33255       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33256       consumes:
33257         - application/json
33258         - application/xml
33259       produces:
33260         - application/json
33261         - application/xml
33262       responses:
33263         "default":
33264           description: Response codes found in [response codes](https://wiki.onap.org/).
33265       parameters:
33266         - name: vnf-id
33267           in: path
33268           description: Unique id of VNF.  This is unique across the graph.
33269           required: true
33270           type: string
33271           example: __VNF-ID__
33272         - name: interface-name
33273           in: path
33274           description: Name given to the interface
33275           required: true
33276           type: string
33277           example: __INTERFACE-NAME__
33278         - name: l3-interface-ipv6-address
33279           in: path
33280           description: IP address
33281           required: true
33282           type: string
33283           example: __L3-INTERFACE-IPV6-ADDRESS__
33284         - name: body
33285           in: body
33286           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
33287           required: true
33288           schema:
33289             $ref: "#/definitions/l3-interface-ipv6-address-list"
33290     patch:
33291       tags:
33292         - Network
33293       summary: update an existing l3-interface-ipv6-address-list
33294       description: |
33295         Update an existing l3-interface-ipv6-address-list
33296         #
33297         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33298         The PUT operation will entirely replace an existing object.
33299         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33300         #
33301         Other differences between PUT and PATCH are:
33302         #
33303         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33304         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33305         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33306       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33307       consumes:
33308         - application/json
33309         - application/xml
33310       produces:
33311         - application/json
33312         - application/xml
33313       responses:
33314         "default":
33315           description: Response codes found in [response codes](https://wiki.onap.org/).
33316       parameters:
33317         - name: vnf-id
33318           in: path
33319           description: Unique id of VNF.  This is unique across the graph.
33320           required: true
33321           type: string
33322           example: __VNF-ID__
33323         - name: interface-name
33324           in: path
33325           description: Name given to the interface
33326           required: true
33327           type: string
33328           example: __INTERFACE-NAME__
33329         - name: l3-interface-ipv6-address
33330           in: path
33331           description: IP address
33332           required: true
33333           type: string
33334           example: __L3-INTERFACE-IPV6-ADDRESS__
33335         - name: body
33336           in: body
33337           description: l3-interface-ipv6-address-list object that needs to be created or updated.
33338           required: true
33339           schema:
33340             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
33341     delete:
33342       tags:
33343         - Network
33344       summary: delete an existing l3-interface-ipv6-address-list
33345       description: delete an existing l3-interface-ipv6-address-list
33346       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
33347       consumes:
33348         - application/json
33349         - application/xml
33350       produces:
33351         - application/json
33352         - application/xml
33353       responses:
33354         "default":
33355           description: Response codes found in [response codes](https://wiki.onap.org/).
33356       parameters:
33357         - name: vnf-id
33358           in: path
33359           description: Unique id of VNF.  This is unique across the graph.
33360           required: true
33361           type: string
33362           example: __VNF-ID__
33363         - name: interface-name
33364           in: path
33365           description: Name given to the interface
33366           required: true
33367           type: string
33368           example: __INTERFACE-NAME__
33369         - name: l3-interface-ipv6-address
33370           in: path
33371           description: IP address
33372           required: true
33373           type: string
33374           example: __L3-INTERFACE-IPV6-ADDRESS__
33375         - name: resource-version
33376           in: query
33377           description: resource-version for concurrency
33378           required: true
33379           type: string
33380   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
33381     get:
33382       tags:
33383         - Network
33384       summary: returns l-interface
33385       description: returns l-interface
33386       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
33387       produces:
33388         - application/json
33389         - application/xml
33390       responses:
33391         "200":
33392           description: successful operation
33393           schema:
33394               $ref: "#/getDefinitions/l-interface"
33395         "default":
33396           description: Response codes found in [response codes](https://wiki.onap.org/).
33397       parameters:
33398         - name: vnf-id
33399           in: path
33400           description: Unique id of VNF.  This is unique across the graph.
33401           required: true
33402           type: string
33403           example: __VNF-ID__
33404         - name: interface-name
33405           in: path
33406           description: Name given to the interface
33407           required: true
33408           type: string
33409           example: __INTERFACE-NAME__
33410         - name: vnf-name
33411           in: query
33412           description: Name of VNF.
33413           required: false
33414           type: string
33415         - name: vnf-name2
33416           in: query
33417           description: Alternate name of VNF.
33418           required: false
33419           type: string
33420         - name: vnf-type
33421           in: query
33422           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33423           required: false
33424           type: string
33425         - name: service-id
33426           in: query
33427           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
33428           required: false
33429           type: string
33430         - name: regional-resource-zone
33431           in: query
33432           description: Regional way of organizing pservers, source of truth should define values
33433           required: false
33434           type: string
33435         - name: prov-status
33436           in: query
33437           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33438           required: false
33439           type: string
33440         - name: heat-stack-id
33441           in: query
33442           description: Heat stack id corresponding to this instance, managed by MSO
33443           required: false
33444           type: string
33445         - name: in-maint
33446           in: query
33447           required: false
33448           type: boolean
33449         - name: is-closed-loop-disabled
33450           in: query
33451           required: false
33452           type: boolean
33453         - name: model-invariant-id
33454           in: query
33455           description: the ASDC model id for this resource or service model.
33456           required: false
33457           type: string
33458         - name: model-version-id
33459           in: query
33460           description: the ASDC model version for this resource or service model.
33461           required: false
33462           type: string
33463         - name: widget-model-id
33464           in: query
33465           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33466           required: false
33467           type: string
33468         - name: widget-model-version
33469           in: query
33470           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33471           required: false
33472           type: string
33473         - name: nf-type
33474           in: query
33475           description: Generic description of the type of NF
33476           required: false
33477           type: string
33478         - name: nf-function
33479           in: query
33480           description: English description of Network function that the specific VNF deployment is providing
33481           required: false
33482           type: string
33483         - name: nf-role
33484           in: query
33485           description: role in the network that this model will be providing
33486           required: false
33487           type: string
33488         - name: nf-naming-code
33489           in: query
33490           description: string assigned to this model used for naming purposes
33491           required: false
33492           type: string
33493         - name: interface-id
33494           in: query
33495           description: ID of interface
33496           required: false
33497           type: string
33498         - name: macaddr
33499           in: query
33500           description: MAC address for the interface
33501           required: false
33502           type: string
33503         - name: network-name
33504           in: query
33505           description: Name of the network
33506           required: false
33507           type: string
33508     put:
33509       tags:
33510         - Network
33511       summary: create or update an existing l-interface
33512       description: |
33513         Create or update an existing l-interface.
33514         #
33515         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33516       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33517       consumes:
33518         - application/json
33519         - application/xml
33520       produces:
33521         - application/json
33522         - application/xml
33523       responses:
33524         "default":
33525           description: Response codes found in [response codes](https://wiki.onap.org/).
33526       parameters:
33527         - name: vnf-id
33528           in: path
33529           description: Unique id of VNF.  This is unique across the graph.
33530           required: true
33531           type: string
33532           example: __VNF-ID__
33533         - name: interface-name
33534           in: path
33535           description: Name given to the interface
33536           required: true
33537           type: string
33538           example: __INTERFACE-NAME__
33539         - name: body
33540           in: body
33541           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
33542           required: true
33543           schema:
33544             $ref: "#/definitions/l-interface"
33545     patch:
33546       tags:
33547         - Network
33548       summary: update an existing l-interface
33549       description: |
33550         Update an existing l-interface
33551         #
33552         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33553         The PUT operation will entirely replace an existing object.
33554         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33555         #
33556         Other differences between PUT and PATCH are:
33557         #
33558         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33559         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33560         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33561       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
33562       consumes:
33563         - application/json
33564         - application/xml
33565       produces:
33566         - application/json
33567         - application/xml
33568       responses:
33569         "default":
33570           description: Response codes found in [response codes](https://wiki.onap.org/).
33571       parameters:
33572         - name: vnf-id
33573           in: path
33574           description: Unique id of VNF.  This is unique across the graph.
33575           required: true
33576           type: string
33577           example: __VNF-ID__
33578         - name: interface-name
33579           in: path
33580           description: Name given to the interface
33581           required: true
33582           type: string
33583           example: __INTERFACE-NAME__
33584         - name: body
33585           in: body
33586           description: l-interface object that needs to be created or updated.
33587           required: true
33588           schema:
33589             $ref: "#/patchDefinitions/l-interface"
33590     delete:
33591       tags:
33592         - Network
33593       summary: delete an existing l-interface
33594       description: delete an existing l-interface
33595       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
33596       consumes:
33597         - application/json
33598         - application/xml
33599       produces:
33600         - application/json
33601         - application/xml
33602       responses:
33603         "default":
33604           description: Response codes found in [response codes](https://wiki.onap.org/).
33605       parameters:
33606         - name: vnf-id
33607           in: path
33608           description: Unique id of VNF.  This is unique across the graph.
33609           required: true
33610           type: string
33611           example: __VNF-ID__
33612         - name: interface-name
33613           in: path
33614           description: Name given to the interface
33615           required: true
33616           type: string
33617           example: __INTERFACE-NAME__
33618         - name: resource-version
33619           in: query
33620           description: resource-version for concurrency
33621           required: true
33622           type: string
33623   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
33624     get:
33625       tags:
33626         - Network
33627       summary: returns l-interfaces
33628       description: returns l-interfaces
33629       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
33630       produces:
33631         - application/json
33632         - application/xml
33633       responses:
33634         "200":
33635           description: successful operation
33636           schema:
33637               $ref: "#/getDefinitions/l-interfaces"
33638         "default":
33639           description: Response codes found in [response codes](https://wiki.onap.org/).
33640       parameters:
33641         - name: vnf-id
33642           in: path
33643           description: Unique id of VNF.  This is unique across the graph.
33644           required: true
33645           type: string
33646           example: __VNF-ID__
33647         - name: vnf-name
33648           in: query
33649           description: Name of VNF.
33650           required: false
33651           type: string
33652         - name: vnf-name2
33653           in: query
33654           description: Alternate name of VNF.
33655           required: false
33656           type: string
33657         - name: vnf-type
33658           in: query
33659           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
33660           required: false
33661           type: string
33662         - name: service-id
33663           in: query
33664           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
33665           required: false
33666           type: string
33667         - name: regional-resource-zone
33668           in: query
33669           description: Regional way of organizing pservers, source of truth should define values
33670           required: false
33671           type: string
33672         - name: prov-status
33673           in: query
33674           description: Trigger for operational monitoring of this resource by Service Assurance systems.
33675           required: false
33676           type: string
33677         - name: heat-stack-id
33678           in: query
33679           description: Heat stack id corresponding to this instance, managed by MSO
33680           required: false
33681           type: string
33682         - name: in-maint
33683           in: query
33684           required: false
33685           type: boolean
33686         - name: is-closed-loop-disabled
33687           in: query
33688           required: false
33689           type: boolean
33690         - name: model-invariant-id
33691           in: query
33692           description: the ASDC model id for this resource or service model.
33693           required: false
33694           type: string
33695         - name: model-version-id
33696           in: query
33697           description: the ASDC model version for this resource or service model.
33698           required: false
33699           type: string
33700         - name: widget-model-id
33701           in: query
33702           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33703           required: false
33704           type: string
33705         - name: widget-model-version
33706           in: query
33707           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33708           required: false
33709           type: string
33710         - name: nf-type
33711           in: query
33712           description: Generic description of the type of NF
33713           required: false
33714           type: string
33715         - name: nf-function
33716           in: query
33717           description: English description of Network function that the specific VNF deployment is providing
33718           required: false
33719           type: string
33720         - name: nf-role
33721           in: query
33722           description: role in the network that this model will be providing
33723           required: false
33724           type: string
33725         - name: nf-naming-code
33726           in: query
33727           description: string assigned to this model used for naming purposes
33728           required: false
33729           type: string
33730   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
33731     put:
33732       tags:
33733         - Network
33734       summary: see node definition for valid relationships
33735       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33736       consumes:
33737         - application/json
33738         - application/xml
33739       produces:
33740         - application/json
33741         - application/xml
33742       responses:
33743         "default":
33744           description: Response codes found in [response codes](https://wiki.onap.org/).
33745       parameters:
33746         - name: vnf-id
33747           in: path
33748           description: Unique id of VNF.  This is unique across the graph.
33749           required: true
33750           type: string
33751           example: __VNF-ID__
33752         - name: interface-name
33753           in: path
33754           description: Name that identifies the link aggregate interface
33755           required: true
33756           type: string
33757           example: __INTERFACE-NAME__
33758         - name: body
33759           in: body
33760           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
33761           required: true
33762           schema:
33763             $ref: "#/definitions/relationship"
33764     delete:
33765       tags:
33766         - Network
33767       summary: delete an existing relationship
33768       description: delete an existing relationship
33769       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
33770       consumes:
33771         - application/json
33772         - application/xml
33773       produces:
33774         - application/json
33775         - application/xml
33776       responses:
33777         "default":
33778           description: Response codes found in [response codes](https://wiki.onap.org/).
33779       parameters:
33780         - name: vnf-id
33781           in: path
33782           description: Unique id of VNF.  This is unique across the graph.
33783           required: true
33784           type: string
33785           example: __VNF-ID__
33786         - name: interface-name
33787           in: path
33788           description: Name that identifies the link aggregate interface
33789           required: true
33790           type: string
33791           example: __INTERFACE-NAME__
33792   /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:
33793     put:
33794       tags:
33795         - Network
33796       summary: see node definition for valid relationships
33797       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33798       consumes:
33799         - application/json
33800         - application/xml
33801       produces:
33802         - application/json
33803         - application/xml
33804       responses:
33805         "default":
33806           description: Response codes found in [response codes](https://wiki.onap.org/).
33807       parameters:
33808         - name: vnf-id
33809           in: path
33810           description: Unique id of VNF.  This is unique across the graph.
33811           required: true
33812           type: string
33813           example: __VNF-ID__
33814         - name: interface-name
33815           in: path
33816           description: Name that identifies the link aggregate interface
33817           required: true
33818           type: string
33819           example: __INTERFACE-NAME__
33820         - name: interface-name
33821           in: path
33822           description: Name given to the interface
33823           required: true
33824           type: string
33825           example: __INTERFACE-NAME__
33826         - name: vlan-interface
33827           in: path
33828           description: String that identifies the interface
33829           required: true
33830           type: string
33831           example: __VLAN-INTERFACE__
33832         - name: body
33833           in: body
33834           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
33835           required: true
33836           schema:
33837             $ref: "#/definitions/relationship"
33838     delete:
33839       tags:
33840         - Network
33841       summary: delete an existing relationship
33842       description: delete an existing relationship
33843       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
33844       consumes:
33845         - application/json
33846         - application/xml
33847       produces:
33848         - application/json
33849         - application/xml
33850       responses:
33851         "default":
33852           description: Response codes found in [response codes](https://wiki.onap.org/).
33853       parameters:
33854         - name: vnf-id
33855           in: path
33856           description: Unique id of VNF.  This is unique across the graph.
33857           required: true
33858           type: string
33859           example: __VNF-ID__
33860         - name: interface-name
33861           in: path
33862           description: Name that identifies the link aggregate interface
33863           required: true
33864           type: string
33865           example: __INTERFACE-NAME__
33866         - name: interface-name
33867           in: path
33868           description: Name given to the interface
33869           required: true
33870           type: string
33871           example: __INTERFACE-NAME__
33872         - name: vlan-interface
33873           in: path
33874           description: String that identifies the interface
33875           required: true
33876           type: string
33877           example: __VLAN-INTERFACE__
33878   /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:
33879     put:
33880       tags:
33881         - Network
33882       summary: see node definition for valid relationships
33883       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33884       consumes:
33885         - application/json
33886         - application/xml
33887       produces:
33888         - application/json
33889         - application/xml
33890       responses:
33891         "default":
33892           description: Response codes found in [response codes](https://wiki.onap.org/).
33893       parameters:
33894         - name: vnf-id
33895           in: path
33896           description: Unique id of VNF.  This is unique across the graph.
33897           required: true
33898           type: string
33899           example: __VNF-ID__
33900         - name: interface-name
33901           in: path
33902           description: Name that identifies the link aggregate interface
33903           required: true
33904           type: string
33905           example: __INTERFACE-NAME__
33906         - name: interface-name
33907           in: path
33908           description: Name given to the interface
33909           required: true
33910           type: string
33911           example: __INTERFACE-NAME__
33912         - name: vlan-interface
33913           in: path
33914           description: String that identifies the interface
33915           required: true
33916           type: string
33917           example: __VLAN-INTERFACE__
33918         - name: l3-interface-ipv4-address
33919           in: path
33920           description: IP address
33921           required: true
33922           type: string
33923           example: __L3-INTERFACE-IPV4-ADDRESS__
33924         - name: body
33925           in: body
33926           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
33927           required: true
33928           schema:
33929             $ref: "#/definitions/relationship"
33930     delete:
33931       tags:
33932         - Network
33933       summary: delete an existing relationship
33934       description: delete an existing relationship
33935       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
33936       consumes:
33937         - application/json
33938         - application/xml
33939       produces:
33940         - application/json
33941         - application/xml
33942       responses:
33943         "default":
33944           description: Response codes found in [response codes](https://wiki.onap.org/).
33945       parameters:
33946         - name: vnf-id
33947           in: path
33948           description: Unique id of VNF.  This is unique across the graph.
33949           required: true
33950           type: string
33951           example: __VNF-ID__
33952         - name: interface-name
33953           in: path
33954           description: Name that identifies the link aggregate interface
33955           required: true
33956           type: string
33957           example: __INTERFACE-NAME__
33958         - name: interface-name
33959           in: path
33960           description: Name given to the interface
33961           required: true
33962           type: string
33963           example: __INTERFACE-NAME__
33964         - name: vlan-interface
33965           in: path
33966           description: String that identifies the interface
33967           required: true
33968           type: string
33969           example: __VLAN-INTERFACE__
33970         - name: l3-interface-ipv4-address
33971           in: path
33972           description: IP address
33973           required: true
33974           type: string
33975           example: __L3-INTERFACE-IPV4-ADDRESS__
33976   /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}:
33977     get:
33978       tags:
33979         - Network
33980       summary: returns l3-interface-ipv4-address-list
33981       description: returns l3-interface-ipv4-address-list
33982       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
33983       produces:
33984         - application/json
33985         - application/xml
33986       responses:
33987         "200":
33988           description: successful operation
33989           schema:
33990               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
33991         "default":
33992           description: Response codes found in [response codes](https://wiki.onap.org/).
33993       parameters:
33994         - name: vnf-id
33995           in: path
33996           description: Unique id of VNF.  This is unique across the graph.
33997           required: true
33998           type: string
33999           example: __VNF-ID__
34000         - name: interface-name
34001           in: path
34002           description: Name that identifies the link aggregate interface
34003           required: true
34004           type: string
34005           example: __INTERFACE-NAME__
34006         - name: interface-name
34007           in: path
34008           description: Name given to the interface
34009           required: true
34010           type: string
34011           example: __INTERFACE-NAME__
34012         - name: vlan-interface
34013           in: path
34014           description: String that identifies the interface
34015           required: true
34016           type: string
34017           example: __VLAN-INTERFACE__
34018         - name: l3-interface-ipv4-address
34019           in: path
34020           description: IP address
34021           required: true
34022           type: string
34023           example: __L3-INTERFACE-IPV4-ADDRESS__
34024         - name: vnf-name
34025           in: query
34026           description: Name of VNF.
34027           required: false
34028           type: string
34029         - name: vnf-name2
34030           in: query
34031           description: Alternate name of VNF.
34032           required: false
34033           type: string
34034         - name: vnf-type
34035           in: query
34036           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34037           required: false
34038           type: string
34039         - name: service-id
34040           in: query
34041           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34042           required: false
34043           type: string
34044         - name: regional-resource-zone
34045           in: query
34046           description: Regional way of organizing pservers, source of truth should define values
34047           required: false
34048           type: string
34049         - name: prov-status
34050           in: query
34051           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34052           required: false
34053           type: string
34054         - name: heat-stack-id
34055           in: query
34056           description: Heat stack id corresponding to this instance, managed by MSO
34057           required: false
34058           type: string
34059         - name: in-maint
34060           in: query
34061           required: false
34062           type: boolean
34063         - name: is-closed-loop-disabled
34064           in: query
34065           required: false
34066           type: boolean
34067         - name: model-invariant-id
34068           in: query
34069           description: the ASDC model id for this resource or service model.
34070           required: false
34071           type: string
34072         - name: model-version-id
34073           in: query
34074           description: the ASDC model version for this resource or service model.
34075           required: false
34076           type: string
34077         - name: widget-model-id
34078           in: query
34079           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34080           required: false
34081           type: string
34082         - name: widget-model-version
34083           in: query
34084           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34085           required: false
34086           type: string
34087         - name: nf-type
34088           in: query
34089           description: Generic description of the type of NF
34090           required: false
34091           type: string
34092         - name: nf-function
34093           in: query
34094           description: English description of Network function that the specific VNF deployment is providing
34095           required: false
34096           type: string
34097         - name: nf-role
34098           in: query
34099           description: role in the network that this model will be providing
34100           required: false
34101           type: string
34102         - name: nf-naming-code
34103           in: query
34104           description: string assigned to this model used for naming purposes
34105           required: false
34106           type: string
34107         - name: interface-id
34108           in: query
34109           description: ID of interface
34110           required: false
34111           type: string
34112         - name: interface-role
34113           in: query
34114           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34115           required: false
34116           type: string
34117         - name: interface-id
34118           in: query
34119           description: ID of interface
34120           required: false
34121           type: string
34122         - name: macaddr
34123           in: query
34124           description: MAC address for the interface
34125           required: false
34126           type: string
34127         - name: network-name
34128           in: query
34129           description: Name of the network
34130           required: false
34131           type: string
34132         - name: vlan-id-inner
34133           in: query
34134           description: Inner VLAN tag
34135           required: false
34136           type: integer
34137           format: int64
34138         - name: vpn-id
34139           in: query
34140           description: This indicates the customers VPN ID associated with this vlan
34141           required: false
34142           type: string
34143         - name: vlan-id-inner
34144           in: query
34145           description: Inner VLAN tag
34146           required: false
34147           type: integer
34148           format: int64
34149         - name: neutron-network-id
34150           in: query
34151           description: Neutron network id of the interface that address belongs to
34152           required: false
34153           type: string
34154         - name: neutron-subnet-id
34155           in: query
34156           description: Neutron id of subnet that address belongs to
34157           required: false
34158           type: string
34159     put:
34160       tags:
34161         - Network
34162       summary: create or update an existing l3-interface-ipv4-address-list
34163       description: |
34164         Create or update an existing l3-interface-ipv4-address-list.
34165         #
34166         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34167       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34168       consumes:
34169         - application/json
34170         - application/xml
34171       produces:
34172         - application/json
34173         - application/xml
34174       responses:
34175         "default":
34176           description: Response codes found in [response codes](https://wiki.onap.org/).
34177       parameters:
34178         - name: vnf-id
34179           in: path
34180           description: Unique id of VNF.  This is unique across the graph.
34181           required: true
34182           type: string
34183           example: __VNF-ID__
34184         - name: interface-name
34185           in: path
34186           description: Name that identifies the link aggregate interface
34187           required: true
34188           type: string
34189           example: __INTERFACE-NAME__
34190         - name: interface-name
34191           in: path
34192           description: Name given to the interface
34193           required: true
34194           type: string
34195           example: __INTERFACE-NAME__
34196         - name: vlan-interface
34197           in: path
34198           description: String that identifies the interface
34199           required: true
34200           type: string
34201           example: __VLAN-INTERFACE__
34202         - name: l3-interface-ipv4-address
34203           in: path
34204           description: IP address
34205           required: true
34206           type: string
34207           example: __L3-INTERFACE-IPV4-ADDRESS__
34208         - name: body
34209           in: body
34210           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34211           required: true
34212           schema:
34213             $ref: "#/definitions/l3-interface-ipv4-address-list"
34214     patch:
34215       tags:
34216         - Network
34217       summary: update an existing l3-interface-ipv4-address-list
34218       description: |
34219         Update an existing l3-interface-ipv4-address-list
34220         #
34221         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34222         The PUT operation will entirely replace an existing object.
34223         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34224         #
34225         Other differences between PUT and PATCH are:
34226         #
34227         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34228         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34229         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34230       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34231       consumes:
34232         - application/json
34233         - application/xml
34234       produces:
34235         - application/json
34236         - application/xml
34237       responses:
34238         "default":
34239           description: Response codes found in [response codes](https://wiki.onap.org/).
34240       parameters:
34241         - name: vnf-id
34242           in: path
34243           description: Unique id of VNF.  This is unique across the graph.
34244           required: true
34245           type: string
34246           example: __VNF-ID__
34247         - name: interface-name
34248           in: path
34249           description: Name that identifies the link aggregate interface
34250           required: true
34251           type: string
34252           example: __INTERFACE-NAME__
34253         - name: interface-name
34254           in: path
34255           description: Name given to the interface
34256           required: true
34257           type: string
34258           example: __INTERFACE-NAME__
34259         - name: vlan-interface
34260           in: path
34261           description: String that identifies the interface
34262           required: true
34263           type: string
34264           example: __VLAN-INTERFACE__
34265         - name: l3-interface-ipv4-address
34266           in: path
34267           description: IP address
34268           required: true
34269           type: string
34270           example: __L3-INTERFACE-IPV4-ADDRESS__
34271         - name: body
34272           in: body
34273           description: l3-interface-ipv4-address-list object that needs to be created or updated.
34274           required: true
34275           schema:
34276             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34277     delete:
34278       tags:
34279         - Network
34280       summary: delete an existing l3-interface-ipv4-address-list
34281       description: delete an existing l3-interface-ipv4-address-list
34282       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34283       consumes:
34284         - application/json
34285         - application/xml
34286       produces:
34287         - application/json
34288         - application/xml
34289       responses:
34290         "default":
34291           description: Response codes found in [response codes](https://wiki.onap.org/).
34292       parameters:
34293         - name: vnf-id
34294           in: path
34295           description: Unique id of VNF.  This is unique across the graph.
34296           required: true
34297           type: string
34298           example: __VNF-ID__
34299         - name: interface-name
34300           in: path
34301           description: Name that identifies the link aggregate interface
34302           required: true
34303           type: string
34304           example: __INTERFACE-NAME__
34305         - name: interface-name
34306           in: path
34307           description: Name given to the interface
34308           required: true
34309           type: string
34310           example: __INTERFACE-NAME__
34311         - name: vlan-interface
34312           in: path
34313           description: String that identifies the interface
34314           required: true
34315           type: string
34316           example: __VLAN-INTERFACE__
34317         - name: l3-interface-ipv4-address
34318           in: path
34319           description: IP address
34320           required: true
34321           type: string
34322           example: __L3-INTERFACE-IPV4-ADDRESS__
34323         - name: resource-version
34324           in: query
34325           description: resource-version for concurrency
34326           required: true
34327           type: string
34328   /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:
34329     put:
34330       tags:
34331         - Network
34332       summary: see node definition for valid relationships
34333       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34334       consumes:
34335         - application/json
34336         - application/xml
34337       produces:
34338         - application/json
34339         - application/xml
34340       responses:
34341         "default":
34342           description: Response codes found in [response codes](https://wiki.onap.org/).
34343       parameters:
34344         - name: vnf-id
34345           in: path
34346           description: Unique id of VNF.  This is unique across the graph.
34347           required: true
34348           type: string
34349           example: __VNF-ID__
34350         - name: interface-name
34351           in: path
34352           description: Name that identifies the link aggregate interface
34353           required: true
34354           type: string
34355           example: __INTERFACE-NAME__
34356         - name: interface-name
34357           in: path
34358           description: Name given to the interface
34359           required: true
34360           type: string
34361           example: __INTERFACE-NAME__
34362         - name: vlan-interface
34363           in: path
34364           description: String that identifies the interface
34365           required: true
34366           type: string
34367           example: __VLAN-INTERFACE__
34368         - name: l3-interface-ipv6-address
34369           in: path
34370           description: IP address
34371           required: true
34372           type: string
34373           example: __L3-INTERFACE-IPV6-ADDRESS__
34374         - name: body
34375           in: body
34376           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34377           required: true
34378           schema:
34379             $ref: "#/definitions/relationship"
34380     delete:
34381       tags:
34382         - Network
34383       summary: delete an existing relationship
34384       description: delete an existing relationship
34385       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34386       consumes:
34387         - application/json
34388         - application/xml
34389       produces:
34390         - application/json
34391         - application/xml
34392       responses:
34393         "default":
34394           description: Response codes found in [response codes](https://wiki.onap.org/).
34395       parameters:
34396         - name: vnf-id
34397           in: path
34398           description: Unique id of VNF.  This is unique across the graph.
34399           required: true
34400           type: string
34401           example: __VNF-ID__
34402         - name: interface-name
34403           in: path
34404           description: Name that identifies the link aggregate interface
34405           required: true
34406           type: string
34407           example: __INTERFACE-NAME__
34408         - name: interface-name
34409           in: path
34410           description: Name given to the interface
34411           required: true
34412           type: string
34413           example: __INTERFACE-NAME__
34414         - name: vlan-interface
34415           in: path
34416           description: String that identifies the interface
34417           required: true
34418           type: string
34419           example: __VLAN-INTERFACE__
34420         - name: l3-interface-ipv6-address
34421           in: path
34422           description: IP address
34423           required: true
34424           type: string
34425           example: __L3-INTERFACE-IPV6-ADDRESS__
34426   /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}:
34427     get:
34428       tags:
34429         - Network
34430       summary: returns l3-interface-ipv6-address-list
34431       description: returns l3-interface-ipv6-address-list
34432       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34433       produces:
34434         - application/json
34435         - application/xml
34436       responses:
34437         "200":
34438           description: successful operation
34439           schema:
34440               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34441         "default":
34442           description: Response codes found in [response codes](https://wiki.onap.org/).
34443       parameters:
34444         - name: vnf-id
34445           in: path
34446           description: Unique id of VNF.  This is unique across the graph.
34447           required: true
34448           type: string
34449           example: __VNF-ID__
34450         - name: interface-name
34451           in: path
34452           description: Name that identifies the link aggregate interface
34453           required: true
34454           type: string
34455           example: __INTERFACE-NAME__
34456         - name: interface-name
34457           in: path
34458           description: Name given to the interface
34459           required: true
34460           type: string
34461           example: __INTERFACE-NAME__
34462         - name: vlan-interface
34463           in: path
34464           description: String that identifies the interface
34465           required: true
34466           type: string
34467           example: __VLAN-INTERFACE__
34468         - name: l3-interface-ipv6-address
34469           in: path
34470           description: IP address
34471           required: true
34472           type: string
34473           example: __L3-INTERFACE-IPV6-ADDRESS__
34474         - name: vnf-name
34475           in: query
34476           description: Name of VNF.
34477           required: false
34478           type: string
34479         - name: vnf-name2
34480           in: query
34481           description: Alternate name of VNF.
34482           required: false
34483           type: string
34484         - name: vnf-type
34485           in: query
34486           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34487           required: false
34488           type: string
34489         - name: service-id
34490           in: query
34491           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34492           required: false
34493           type: string
34494         - name: regional-resource-zone
34495           in: query
34496           description: Regional way of organizing pservers, source of truth should define values
34497           required: false
34498           type: string
34499         - name: prov-status
34500           in: query
34501           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34502           required: false
34503           type: string
34504         - name: heat-stack-id
34505           in: query
34506           description: Heat stack id corresponding to this instance, managed by MSO
34507           required: false
34508           type: string
34509         - name: in-maint
34510           in: query
34511           required: false
34512           type: boolean
34513         - name: is-closed-loop-disabled
34514           in: query
34515           required: false
34516           type: boolean
34517         - name: model-invariant-id
34518           in: query
34519           description: the ASDC model id for this resource or service model.
34520           required: false
34521           type: string
34522         - name: model-version-id
34523           in: query
34524           description: the ASDC model version for this resource or service model.
34525           required: false
34526           type: string
34527         - name: widget-model-id
34528           in: query
34529           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34530           required: false
34531           type: string
34532         - name: widget-model-version
34533           in: query
34534           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34535           required: false
34536           type: string
34537         - name: nf-type
34538           in: query
34539           description: Generic description of the type of NF
34540           required: false
34541           type: string
34542         - name: nf-function
34543           in: query
34544           description: English description of Network function that the specific VNF deployment is providing
34545           required: false
34546           type: string
34547         - name: nf-role
34548           in: query
34549           description: role in the network that this model will be providing
34550           required: false
34551           type: string
34552         - name: nf-naming-code
34553           in: query
34554           description: string assigned to this model used for naming purposes
34555           required: false
34556           type: string
34557         - name: interface-id
34558           in: query
34559           description: ID of interface
34560           required: false
34561           type: string
34562         - name: interface-role
34563           in: query
34564           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34565           required: false
34566           type: string
34567         - name: interface-id
34568           in: query
34569           description: ID of interface
34570           required: false
34571           type: string
34572         - name: macaddr
34573           in: query
34574           description: MAC address for the interface
34575           required: false
34576           type: string
34577         - name: network-name
34578           in: query
34579           description: Name of the network
34580           required: false
34581           type: string
34582         - name: vlan-id-inner
34583           in: query
34584           description: Inner VLAN tag
34585           required: false
34586           type: integer
34587           format: int64
34588         - name: vpn-id
34589           in: query
34590           description: This indicates the customers VPN ID associated with this vlan
34591           required: false
34592           type: string
34593         - name: vlan-id-inner
34594           in: query
34595           description: Inner VLAN tag
34596           required: false
34597           type: integer
34598           format: int64
34599         - name: neutron-network-id
34600           in: query
34601           description: Neutron network id of the interface that address belongs to
34602           required: false
34603           type: string
34604         - name: neutron-subnet-id
34605           in: query
34606           description: Neutron id of subnet that address belongs to
34607           required: false
34608           type: string
34609     put:
34610       tags:
34611         - Network
34612       summary: create or update an existing l3-interface-ipv6-address-list
34613       description: |
34614         Create or update an existing l3-interface-ipv6-address-list.
34615         #
34616         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34617       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34618       consumes:
34619         - application/json
34620         - application/xml
34621       produces:
34622         - application/json
34623         - application/xml
34624       responses:
34625         "default":
34626           description: Response codes found in [response codes](https://wiki.onap.org/).
34627       parameters:
34628         - name: vnf-id
34629           in: path
34630           description: Unique id of VNF.  This is unique across the graph.
34631           required: true
34632           type: string
34633           example: __VNF-ID__
34634         - name: interface-name
34635           in: path
34636           description: Name that identifies the link aggregate interface
34637           required: true
34638           type: string
34639           example: __INTERFACE-NAME__
34640         - name: interface-name
34641           in: path
34642           description: Name given to the interface
34643           required: true
34644           type: string
34645           example: __INTERFACE-NAME__
34646         - name: vlan-interface
34647           in: path
34648           description: String that identifies the interface
34649           required: true
34650           type: string
34651           example: __VLAN-INTERFACE__
34652         - name: l3-interface-ipv6-address
34653           in: path
34654           description: IP address
34655           required: true
34656           type: string
34657           example: __L3-INTERFACE-IPV6-ADDRESS__
34658         - name: body
34659           in: body
34660           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34661           required: true
34662           schema:
34663             $ref: "#/definitions/l3-interface-ipv6-address-list"
34664     patch:
34665       tags:
34666         - Network
34667       summary: update an existing l3-interface-ipv6-address-list
34668       description: |
34669         Update an existing l3-interface-ipv6-address-list
34670         #
34671         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34672         The PUT operation will entirely replace an existing object.
34673         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34674         #
34675         Other differences between PUT and PATCH are:
34676         #
34677         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34678         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34679         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34680       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34681       consumes:
34682         - application/json
34683         - application/xml
34684       produces:
34685         - application/json
34686         - application/xml
34687       responses:
34688         "default":
34689           description: Response codes found in [response codes](https://wiki.onap.org/).
34690       parameters:
34691         - name: vnf-id
34692           in: path
34693           description: Unique id of VNF.  This is unique across the graph.
34694           required: true
34695           type: string
34696           example: __VNF-ID__
34697         - name: interface-name
34698           in: path
34699           description: Name that identifies the link aggregate interface
34700           required: true
34701           type: string
34702           example: __INTERFACE-NAME__
34703         - name: interface-name
34704           in: path
34705           description: Name given to the interface
34706           required: true
34707           type: string
34708           example: __INTERFACE-NAME__
34709         - name: vlan-interface
34710           in: path
34711           description: String that identifies the interface
34712           required: true
34713           type: string
34714           example: __VLAN-INTERFACE__
34715         - name: l3-interface-ipv6-address
34716           in: path
34717           description: IP address
34718           required: true
34719           type: string
34720           example: __L3-INTERFACE-IPV6-ADDRESS__
34721         - name: body
34722           in: body
34723           description: l3-interface-ipv6-address-list object that needs to be created or updated.
34724           required: true
34725           schema:
34726             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34727     delete:
34728       tags:
34729         - Network
34730       summary: delete an existing l3-interface-ipv6-address-list
34731       description: delete an existing l3-interface-ipv6-address-list
34732       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34733       consumes:
34734         - application/json
34735         - application/xml
34736       produces:
34737         - application/json
34738         - application/xml
34739       responses:
34740         "default":
34741           description: Response codes found in [response codes](https://wiki.onap.org/).
34742       parameters:
34743         - name: vnf-id
34744           in: path
34745           description: Unique id of VNF.  This is unique across the graph.
34746           required: true
34747           type: string
34748           example: __VNF-ID__
34749         - name: interface-name
34750           in: path
34751           description: Name that identifies the link aggregate interface
34752           required: true
34753           type: string
34754           example: __INTERFACE-NAME__
34755         - name: interface-name
34756           in: path
34757           description: Name given to the interface
34758           required: true
34759           type: string
34760           example: __INTERFACE-NAME__
34761         - name: vlan-interface
34762           in: path
34763           description: String that identifies the interface
34764           required: true
34765           type: string
34766           example: __VLAN-INTERFACE__
34767         - name: l3-interface-ipv6-address
34768           in: path
34769           description: IP address
34770           required: true
34771           type: string
34772           example: __L3-INTERFACE-IPV6-ADDRESS__
34773         - name: resource-version
34774           in: query
34775           description: resource-version for concurrency
34776           required: true
34777           type: string
34778   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34779     get:
34780       tags:
34781         - Network
34782       summary: returns vlan
34783       description: returns vlan
34784       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34785       produces:
34786         - application/json
34787         - application/xml
34788       responses:
34789         "200":
34790           description: successful operation
34791           schema:
34792               $ref: "#/getDefinitions/vlan"
34793         "default":
34794           description: Response codes found in [response codes](https://wiki.onap.org/).
34795       parameters:
34796         - name: vnf-id
34797           in: path
34798           description: Unique id of VNF.  This is unique across the graph.
34799           required: true
34800           type: string
34801           example: __VNF-ID__
34802         - name: interface-name
34803           in: path
34804           description: Name that identifies the link aggregate interface
34805           required: true
34806           type: string
34807           example: __INTERFACE-NAME__
34808         - name: interface-name
34809           in: path
34810           description: Name given to the interface
34811           required: true
34812           type: string
34813           example: __INTERFACE-NAME__
34814         - name: vlan-interface
34815           in: path
34816           description: String that identifies the interface
34817           required: true
34818           type: string
34819           example: __VLAN-INTERFACE__
34820         - name: vnf-name
34821           in: query
34822           description: Name of VNF.
34823           required: false
34824           type: string
34825         - name: vnf-name2
34826           in: query
34827           description: Alternate name of VNF.
34828           required: false
34829           type: string
34830         - name: vnf-type
34831           in: query
34832           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
34833           required: false
34834           type: string
34835         - name: service-id
34836           in: query
34837           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34838           required: false
34839           type: string
34840         - name: regional-resource-zone
34841           in: query
34842           description: Regional way of organizing pservers, source of truth should define values
34843           required: false
34844           type: string
34845         - name: prov-status
34846           in: query
34847           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34848           required: false
34849           type: string
34850         - name: heat-stack-id
34851           in: query
34852           description: Heat stack id corresponding to this instance, managed by MSO
34853           required: false
34854           type: string
34855         - name: in-maint
34856           in: query
34857           required: false
34858           type: boolean
34859         - name: is-closed-loop-disabled
34860           in: query
34861           required: false
34862           type: boolean
34863         - name: model-invariant-id
34864           in: query
34865           description: the ASDC model id for this resource or service model.
34866           required: false
34867           type: string
34868         - name: model-version-id
34869           in: query
34870           description: the ASDC model version for this resource or service model.
34871           required: false
34872           type: string
34873         - name: widget-model-id
34874           in: query
34875           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34876           required: false
34877           type: string
34878         - name: widget-model-version
34879           in: query
34880           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34881           required: false
34882           type: string
34883         - name: nf-type
34884           in: query
34885           description: Generic description of the type of NF
34886           required: false
34887           type: string
34888         - name: nf-function
34889           in: query
34890           description: English description of Network function that the specific VNF deployment is providing
34891           required: false
34892           type: string
34893         - name: nf-role
34894           in: query
34895           description: role in the network that this model will be providing
34896           required: false
34897           type: string
34898         - name: nf-naming-code
34899           in: query
34900           description: string assigned to this model used for naming purposes
34901           required: false
34902           type: string
34903         - name: interface-id
34904           in: query
34905           description: ID of interface
34906           required: false
34907           type: string
34908         - name: interface-role
34909           in: query
34910           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
34911           required: false
34912           type: string
34913         - name: interface-id
34914           in: query
34915           description: ID of interface
34916           required: false
34917           type: string
34918         - name: macaddr
34919           in: query
34920           description: MAC address for the interface
34921           required: false
34922           type: string
34923         - name: network-name
34924           in: query
34925           description: Name of the network
34926           required: false
34927           type: string
34928         - name: vlan-id-inner
34929           in: query
34930           description: Inner VLAN tag
34931           required: false
34932           type: integer
34933           format: int64
34934         - name: vpn-id
34935           in: query
34936           description: This indicates the customers VPN ID associated with this vlan
34937           required: false
34938           type: string
34939     put:
34940       tags:
34941         - Network
34942       summary: create or update an existing vlan
34943       description: |
34944         Create or update an existing vlan.
34945         #
34946         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34947       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
34948       consumes:
34949         - application/json
34950         - application/xml
34951       produces:
34952         - application/json
34953         - application/xml
34954       responses:
34955         "default":
34956           description: Response codes found in [response codes](https://wiki.onap.org/).
34957       parameters:
34958         - name: vnf-id
34959           in: path
34960           description: Unique id of VNF.  This is unique across the graph.
34961           required: true
34962           type: string
34963           example: __VNF-ID__
34964         - name: interface-name
34965           in: path
34966           description: Name that identifies the link aggregate interface
34967           required: true
34968           type: string
34969           example: __INTERFACE-NAME__
34970         - name: interface-name
34971           in: path
34972           description: Name given to the interface
34973           required: true
34974           type: string
34975           example: __INTERFACE-NAME__
34976         - name: vlan-interface
34977           in: path
34978           description: String that identifies the interface
34979           required: true
34980           type: string
34981           example: __VLAN-INTERFACE__
34982         - name: body
34983           in: body
34984           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
34985           required: true
34986           schema:
34987             $ref: "#/definitions/vlan"
34988     patch:
34989       tags:
34990         - Network
34991       summary: update an existing vlan
34992       description: |
34993         Update an existing vlan
34994         #
34995         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34996         The PUT operation will entirely replace an existing object.
34997         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34998         #
34999         Other differences between PUT and PATCH are:
35000         #
35001         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35002         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35003         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35004       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35005       consumes:
35006         - application/json
35007         - application/xml
35008       produces:
35009         - application/json
35010         - application/xml
35011       responses:
35012         "default":
35013           description: Response codes found in [response codes](https://wiki.onap.org/).
35014       parameters:
35015         - name: vnf-id
35016           in: path
35017           description: Unique id of VNF.  This is unique across the graph.
35018           required: true
35019           type: string
35020           example: __VNF-ID__
35021         - name: interface-name
35022           in: path
35023           description: Name that identifies the link aggregate interface
35024           required: true
35025           type: string
35026           example: __INTERFACE-NAME__
35027         - name: interface-name
35028           in: path
35029           description: Name given to the interface
35030           required: true
35031           type: string
35032           example: __INTERFACE-NAME__
35033         - name: vlan-interface
35034           in: path
35035           description: String that identifies the interface
35036           required: true
35037           type: string
35038           example: __VLAN-INTERFACE__
35039         - name: body
35040           in: body
35041           description: vlan object that needs to be created or updated.
35042           required: true
35043           schema:
35044             $ref: "#/patchDefinitions/vlan"
35045     delete:
35046       tags:
35047         - Network
35048       summary: delete an existing vlan
35049       description: delete an existing vlan
35050       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
35051       consumes:
35052         - application/json
35053         - application/xml
35054       produces:
35055         - application/json
35056         - application/xml
35057       responses:
35058         "default":
35059           description: Response codes found in [response codes](https://wiki.onap.org/).
35060       parameters:
35061         - name: vnf-id
35062           in: path
35063           description: Unique id of VNF.  This is unique across the graph.
35064           required: true
35065           type: string
35066           example: __VNF-ID__
35067         - name: interface-name
35068           in: path
35069           description: Name that identifies the link aggregate interface
35070           required: true
35071           type: string
35072           example: __INTERFACE-NAME__
35073         - name: interface-name
35074           in: path
35075           description: Name given to the interface
35076           required: true
35077           type: string
35078           example: __INTERFACE-NAME__
35079         - name: vlan-interface
35080           in: path
35081           description: String that identifies the interface
35082           required: true
35083           type: string
35084           example: __VLAN-INTERFACE__
35085         - name: resource-version
35086           in: query
35087           description: resource-version for concurrency
35088           required: true
35089           type: string
35090   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
35091     get:
35092       tags:
35093         - Network
35094       summary: returns vlans
35095       description: returns vlans
35096       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
35097       produces:
35098         - application/json
35099         - application/xml
35100       responses:
35101         "200":
35102           description: successful operation
35103           schema:
35104               $ref: "#/getDefinitions/vlans"
35105         "default":
35106           description: Response codes found in [response codes](https://wiki.onap.org/).
35107       parameters:
35108         - name: vnf-id
35109           in: path
35110           description: Unique id of VNF.  This is unique across the graph.
35111           required: true
35112           type: string
35113           example: __VNF-ID__
35114         - name: interface-name
35115           in: path
35116           description: Name that identifies the link aggregate interface
35117           required: true
35118           type: string
35119           example: __INTERFACE-NAME__
35120         - name: interface-name
35121           in: path
35122           description: Name given to the interface
35123           required: true
35124           type: string
35125           example: __INTERFACE-NAME__
35126         - name: vnf-name
35127           in: query
35128           description: Name of VNF.
35129           required: false
35130           type: string
35131         - name: vnf-name2
35132           in: query
35133           description: Alternate name of VNF.
35134           required: false
35135           type: string
35136         - name: vnf-type
35137           in: query
35138           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35139           required: false
35140           type: string
35141         - name: service-id
35142           in: query
35143           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35144           required: false
35145           type: string
35146         - name: regional-resource-zone
35147           in: query
35148           description: Regional way of organizing pservers, source of truth should define values
35149           required: false
35150           type: string
35151         - name: prov-status
35152           in: query
35153           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35154           required: false
35155           type: string
35156         - name: heat-stack-id
35157           in: query
35158           description: Heat stack id corresponding to this instance, managed by MSO
35159           required: false
35160           type: string
35161         - name: in-maint
35162           in: query
35163           required: false
35164           type: boolean
35165         - name: is-closed-loop-disabled
35166           in: query
35167           required: false
35168           type: boolean
35169         - name: model-invariant-id
35170           in: query
35171           description: the ASDC model id for this resource or service model.
35172           required: false
35173           type: string
35174         - name: model-version-id
35175           in: query
35176           description: the ASDC model version for this resource or service model.
35177           required: false
35178           type: string
35179         - name: widget-model-id
35180           in: query
35181           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35182           required: false
35183           type: string
35184         - name: widget-model-version
35185           in: query
35186           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35187           required: false
35188           type: string
35189         - name: nf-type
35190           in: query
35191           description: Generic description of the type of NF
35192           required: false
35193           type: string
35194         - name: nf-function
35195           in: query
35196           description: English description of Network function that the specific VNF deployment is providing
35197           required: false
35198           type: string
35199         - name: nf-role
35200           in: query
35201           description: role in the network that this model will be providing
35202           required: false
35203           type: string
35204         - name: nf-naming-code
35205           in: query
35206           description: string assigned to this model used for naming purposes
35207           required: false
35208           type: string
35209         - name: interface-id
35210           in: query
35211           description: ID of interface
35212           required: false
35213           type: string
35214         - name: interface-role
35215           in: query
35216           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35217           required: false
35218           type: string
35219         - name: interface-id
35220           in: query
35221           description: ID of interface
35222           required: false
35223           type: string
35224         - name: macaddr
35225           in: query
35226           description: MAC address for the interface
35227           required: false
35228           type: string
35229         - name: network-name
35230           in: query
35231           description: Name of the network
35232           required: false
35233           type: string
35234   /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:
35235     put:
35236       tags:
35237         - Network
35238       summary: see node definition for valid relationships
35239       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35240       consumes:
35241         - application/json
35242         - application/xml
35243       produces:
35244         - application/json
35245         - application/xml
35246       responses:
35247         "default":
35248           description: Response codes found in [response codes](https://wiki.onap.org/).
35249       parameters:
35250         - name: vnf-id
35251           in: path
35252           description: Unique id of VNF.  This is unique across the graph.
35253           required: true
35254           type: string
35255           example: __VNF-ID__
35256         - name: interface-name
35257           in: path
35258           description: Name that identifies the link aggregate interface
35259           required: true
35260           type: string
35261           example: __INTERFACE-NAME__
35262         - name: interface-name
35263           in: path
35264           description: Name given to the interface
35265           required: true
35266           type: string
35267           example: __INTERFACE-NAME__
35268         - name: pci-id
35269           in: path
35270           description: PCI ID used to identify the sriov-vf
35271           required: true
35272           type: string
35273           example: __PCI-ID__
35274         - name: body
35275           in: body
35276           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35277           required: true
35278           schema:
35279             $ref: "#/definitions/relationship"
35280     delete:
35281       tags:
35282         - Network
35283       summary: delete an existing relationship
35284       description: delete an existing relationship
35285       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35286       consumes:
35287         - application/json
35288         - application/xml
35289       produces:
35290         - application/json
35291         - application/xml
35292       responses:
35293         "default":
35294           description: Response codes found in [response codes](https://wiki.onap.org/).
35295       parameters:
35296         - name: vnf-id
35297           in: path
35298           description: Unique id of VNF.  This is unique across the graph.
35299           required: true
35300           type: string
35301           example: __VNF-ID__
35302         - name: interface-name
35303           in: path
35304           description: Name that identifies the link aggregate interface
35305           required: true
35306           type: string
35307           example: __INTERFACE-NAME__
35308         - name: interface-name
35309           in: path
35310           description: Name given to the interface
35311           required: true
35312           type: string
35313           example: __INTERFACE-NAME__
35314         - name: pci-id
35315           in: path
35316           description: PCI ID used to identify the sriov-vf
35317           required: true
35318           type: string
35319           example: __PCI-ID__
35320   /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}:
35321     get:
35322       tags:
35323         - Network
35324       summary: returns sriov-vf
35325       description: returns sriov-vf
35326       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35327       produces:
35328         - application/json
35329         - application/xml
35330       responses:
35331         "200":
35332           description: successful operation
35333           schema:
35334               $ref: "#/getDefinitions/sriov-vf"
35335         "default":
35336           description: Response codes found in [response codes](https://wiki.onap.org/).
35337       parameters:
35338         - name: vnf-id
35339           in: path
35340           description: Unique id of VNF.  This is unique across the graph.
35341           required: true
35342           type: string
35343           example: __VNF-ID__
35344         - name: interface-name
35345           in: path
35346           description: Name that identifies the link aggregate interface
35347           required: true
35348           type: string
35349           example: __INTERFACE-NAME__
35350         - name: interface-name
35351           in: path
35352           description: Name given to the interface
35353           required: true
35354           type: string
35355           example: __INTERFACE-NAME__
35356         - name: pci-id
35357           in: path
35358           description: PCI ID used to identify the sriov-vf
35359           required: true
35360           type: string
35361           example: __PCI-ID__
35362         - name: vnf-name
35363           in: query
35364           description: Name of VNF.
35365           required: false
35366           type: string
35367         - name: vnf-name2
35368           in: query
35369           description: Alternate name of VNF.
35370           required: false
35371           type: string
35372         - name: vnf-type
35373           in: query
35374           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35375           required: false
35376           type: string
35377         - name: service-id
35378           in: query
35379           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35380           required: false
35381           type: string
35382         - name: regional-resource-zone
35383           in: query
35384           description: Regional way of organizing pservers, source of truth should define values
35385           required: false
35386           type: string
35387         - name: prov-status
35388           in: query
35389           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35390           required: false
35391           type: string
35392         - name: heat-stack-id
35393           in: query
35394           description: Heat stack id corresponding to this instance, managed by MSO
35395           required: false
35396           type: string
35397         - name: in-maint
35398           in: query
35399           required: false
35400           type: boolean
35401         - name: is-closed-loop-disabled
35402           in: query
35403           required: false
35404           type: boolean
35405         - name: model-invariant-id
35406           in: query
35407           description: the ASDC model id for this resource or service model.
35408           required: false
35409           type: string
35410         - name: model-version-id
35411           in: query
35412           description: the ASDC model version for this resource or service model.
35413           required: false
35414           type: string
35415         - name: widget-model-id
35416           in: query
35417           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35418           required: false
35419           type: string
35420         - name: widget-model-version
35421           in: query
35422           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35423           required: false
35424           type: string
35425         - name: nf-type
35426           in: query
35427           description: Generic description of the type of NF
35428           required: false
35429           type: string
35430         - name: nf-function
35431           in: query
35432           description: English description of Network function that the specific VNF deployment is providing
35433           required: false
35434           type: string
35435         - name: nf-role
35436           in: query
35437           description: role in the network that this model will be providing
35438           required: false
35439           type: string
35440         - name: nf-naming-code
35441           in: query
35442           description: string assigned to this model used for naming purposes
35443           required: false
35444           type: string
35445         - name: interface-id
35446           in: query
35447           description: ID of interface
35448           required: false
35449           type: string
35450         - name: interface-role
35451           in: query
35452           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35453           required: false
35454           type: string
35455         - name: interface-id
35456           in: query
35457           description: ID of interface
35458           required: false
35459           type: string
35460         - name: macaddr
35461           in: query
35462           description: MAC address for the interface
35463           required: false
35464           type: string
35465         - name: network-name
35466           in: query
35467           description: Name of the network
35468           required: false
35469           type: string
35470         - name: vf-vlan-filter
35471           in: query
35472           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
35473           required: false
35474           type: string
35475         - name: vf-mac-filter
35476           in: query
35477           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
35478           required: false
35479           type: string
35480         - name: vf-vlan-strip
35481           in: query
35482           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
35483           required: false
35484           type: boolean
35485         - name: neutron-network-id
35486           in: query
35487           description: Neutron network id of the interface
35488           required: false
35489           type: string
35490     put:
35491       tags:
35492         - Network
35493       summary: create or update an existing sriov-vf
35494       description: |
35495         Create or update an existing sriov-vf.
35496         #
35497         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35498       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35499       consumes:
35500         - application/json
35501         - application/xml
35502       produces:
35503         - application/json
35504         - application/xml
35505       responses:
35506         "default":
35507           description: Response codes found in [response codes](https://wiki.onap.org/).
35508       parameters:
35509         - name: vnf-id
35510           in: path
35511           description: Unique id of VNF.  This is unique across the graph.
35512           required: true
35513           type: string
35514           example: __VNF-ID__
35515         - name: interface-name
35516           in: path
35517           description: Name that identifies the link aggregate interface
35518           required: true
35519           type: string
35520           example: __INTERFACE-NAME__
35521         - name: interface-name
35522           in: path
35523           description: Name given to the interface
35524           required: true
35525           type: string
35526           example: __INTERFACE-NAME__
35527         - name: pci-id
35528           in: path
35529           description: PCI ID used to identify the sriov-vf
35530           required: true
35531           type: string
35532           example: __PCI-ID__
35533         - name: body
35534           in: body
35535           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
35536           required: true
35537           schema:
35538             $ref: "#/definitions/sriov-vf"
35539     patch:
35540       tags:
35541         - Network
35542       summary: update an existing sriov-vf
35543       description: |
35544         Update an existing sriov-vf
35545         #
35546         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35547         The PUT operation will entirely replace an existing object.
35548         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35549         #
35550         Other differences between PUT and PATCH are:
35551         #
35552         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35553         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35554         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35555       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35556       consumes:
35557         - application/json
35558         - application/xml
35559       produces:
35560         - application/json
35561         - application/xml
35562       responses:
35563         "default":
35564           description: Response codes found in [response codes](https://wiki.onap.org/).
35565       parameters:
35566         - name: vnf-id
35567           in: path
35568           description: Unique id of VNF.  This is unique across the graph.
35569           required: true
35570           type: string
35571           example: __VNF-ID__
35572         - name: interface-name
35573           in: path
35574           description: Name that identifies the link aggregate interface
35575           required: true
35576           type: string
35577           example: __INTERFACE-NAME__
35578         - name: interface-name
35579           in: path
35580           description: Name given to the interface
35581           required: true
35582           type: string
35583           example: __INTERFACE-NAME__
35584         - name: pci-id
35585           in: path
35586           description: PCI ID used to identify the sriov-vf
35587           required: true
35588           type: string
35589           example: __PCI-ID__
35590         - name: body
35591           in: body
35592           description: sriov-vf object that needs to be created or updated.
35593           required: true
35594           schema:
35595             $ref: "#/patchDefinitions/sriov-vf"
35596     delete:
35597       tags:
35598         - Network
35599       summary: delete an existing sriov-vf
35600       description: delete an existing sriov-vf
35601       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
35602       consumes:
35603         - application/json
35604         - application/xml
35605       produces:
35606         - application/json
35607         - application/xml
35608       responses:
35609         "default":
35610           description: Response codes found in [response codes](https://wiki.onap.org/).
35611       parameters:
35612         - name: vnf-id
35613           in: path
35614           description: Unique id of VNF.  This is unique across the graph.
35615           required: true
35616           type: string
35617           example: __VNF-ID__
35618         - name: interface-name
35619           in: path
35620           description: Name that identifies the link aggregate interface
35621           required: true
35622           type: string
35623           example: __INTERFACE-NAME__
35624         - name: interface-name
35625           in: path
35626           description: Name given to the interface
35627           required: true
35628           type: string
35629           example: __INTERFACE-NAME__
35630         - name: pci-id
35631           in: path
35632           description: PCI ID used to identify the sriov-vf
35633           required: true
35634           type: string
35635           example: __PCI-ID__
35636         - name: resource-version
35637           in: query
35638           description: resource-version for concurrency
35639           required: true
35640           type: string
35641   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35642     get:
35643       tags:
35644         - Network
35645       summary: returns sriov-vfs
35646       description: returns sriov-vfs
35647       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
35648       produces:
35649         - application/json
35650         - application/xml
35651       responses:
35652         "200":
35653           description: successful operation
35654           schema:
35655               $ref: "#/getDefinitions/sriov-vfs"
35656         "default":
35657           description: Response codes found in [response codes](https://wiki.onap.org/).
35658       parameters:
35659         - name: vnf-id
35660           in: path
35661           description: Unique id of VNF.  This is unique across the graph.
35662           required: true
35663           type: string
35664           example: __VNF-ID__
35665         - name: interface-name
35666           in: path
35667           description: Name that identifies the link aggregate interface
35668           required: true
35669           type: string
35670           example: __INTERFACE-NAME__
35671         - name: interface-name
35672           in: path
35673           description: Name given to the interface
35674           required: true
35675           type: string
35676           example: __INTERFACE-NAME__
35677         - name: vnf-name
35678           in: query
35679           description: Name of VNF.
35680           required: false
35681           type: string
35682         - name: vnf-name2
35683           in: query
35684           description: Alternate name of VNF.
35685           required: false
35686           type: string
35687         - name: vnf-type
35688           in: query
35689           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
35690           required: false
35691           type: string
35692         - name: service-id
35693           in: query
35694           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35695           required: false
35696           type: string
35697         - name: regional-resource-zone
35698           in: query
35699           description: Regional way of organizing pservers, source of truth should define values
35700           required: false
35701           type: string
35702         - name: prov-status
35703           in: query
35704           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35705           required: false
35706           type: string
35707         - name: heat-stack-id
35708           in: query
35709           description: Heat stack id corresponding to this instance, managed by MSO
35710           required: false
35711           type: string
35712         - name: in-maint
35713           in: query
35714           required: false
35715           type: boolean
35716         - name: is-closed-loop-disabled
35717           in: query
35718           required: false
35719           type: boolean
35720         - name: model-invariant-id
35721           in: query
35722           description: the ASDC model id for this resource or service model.
35723           required: false
35724           type: string
35725         - name: model-version-id
35726           in: query
35727           description: the ASDC model version for this resource or service model.
35728           required: false
35729           type: string
35730         - name: widget-model-id
35731           in: query
35732           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35733           required: false
35734           type: string
35735         - name: widget-model-version
35736           in: query
35737           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35738           required: false
35739           type: string
35740         - name: nf-type
35741           in: query
35742           description: Generic description of the type of NF
35743           required: false
35744           type: string
35745         - name: nf-function
35746           in: query
35747           description: English description of Network function that the specific VNF deployment is providing
35748           required: false
35749           type: string
35750         - name: nf-role
35751           in: query
35752           description: role in the network that this model will be providing
35753           required: false
35754           type: string
35755         - name: nf-naming-code
35756           in: query
35757           description: string assigned to this model used for naming purposes
35758           required: false
35759           type: string
35760         - name: interface-id
35761           in: query
35762           description: ID of interface
35763           required: false
35764           type: string
35765         - name: interface-role
35766           in: query
35767           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
35768           required: false
35769           type: string
35770         - name: interface-id
35771           in: query
35772           description: ID of interface
35773           required: false
35774           type: string
35775         - name: macaddr
35776           in: query
35777           description: MAC address for the interface
35778           required: false
35779           type: string
35780         - name: network-name
35781           in: query
35782           description: Name of the network
35783           required: false
35784           type: string
35785   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35786     put:
35787       tags:
35788         - Network
35789       summary: see node definition for valid relationships
35790       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35791       consumes:
35792         - application/json
35793         - application/xml
35794       produces:
35795         - application/json
35796         - application/xml
35797       responses:
35798         "default":
35799           description: Response codes found in [response codes](https://wiki.onap.org/).
35800       parameters:
35801         - name: vnf-id
35802           in: path
35803           description: Unique id of VNF.  This is unique across the graph.
35804           required: true
35805           type: string
35806           example: __VNF-ID__
35807         - name: interface-name
35808           in: path
35809           description: Name that identifies the link aggregate interface
35810           required: true
35811           type: string
35812           example: __INTERFACE-NAME__
35813         - name: interface-name
35814           in: path
35815           description: Name given to the interface
35816           required: true
35817           type: string
35818           example: __INTERFACE-NAME__
35819         - name: body
35820           in: body
35821           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
35822           required: true
35823           schema:
35824             $ref: "#/definitions/relationship"
35825     delete:
35826       tags:
35827         - Network
35828       summary: delete an existing relationship
35829       description: delete an existing relationship
35830       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
35831       consumes:
35832         - application/json
35833         - application/xml
35834       produces:
35835         - application/json
35836         - application/xml
35837       responses:
35838         "default":
35839           description: Response codes found in [response codes](https://wiki.onap.org/).
35840       parameters:
35841         - name: vnf-id
35842           in: path
35843           description: Unique id of VNF.  This is unique across the graph.
35844           required: true
35845           type: string
35846           example: __VNF-ID__
35847         - name: interface-name
35848           in: path
35849           description: Name that identifies the link aggregate interface
35850           required: true
35851           type: string
35852           example: __INTERFACE-NAME__
35853         - name: interface-name
35854           in: path
35855           description: Name given to the interface
35856           required: true
35857           type: string
35858           example: __INTERFACE-NAME__
35859   /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:
35860     put:
35861       tags:
35862         - Network
35863       summary: see node definition for valid relationships
35864       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35865       consumes:
35866         - application/json
35867         - application/xml
35868       produces:
35869         - application/json
35870         - application/xml
35871       responses:
35872         "default":
35873           description: Response codes found in [response codes](https://wiki.onap.org/).
35874       parameters:
35875         - name: vnf-id
35876           in: path
35877           description: Unique id of VNF.  This is unique across the graph.
35878           required: true
35879           type: string
35880           example: __VNF-ID__
35881         - name: interface-name
35882           in: path
35883           description: Name that identifies the link aggregate interface
35884           required: true
35885           type: string
35886           example: __INTERFACE-NAME__
35887         - name: interface-name
35888           in: path
35889           description: Name given to the interface
35890           required: true
35891           type: string
35892           example: __INTERFACE-NAME__
35893         - name: l3-interface-ipv4-address
35894           in: path
35895           description: IP address
35896           required: true
35897           type: string
35898           example: __L3-INTERFACE-IPV4-ADDRESS__
35899         - name: body
35900           in: body
35901           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35902           required: true
35903           schema:
35904             $ref: "#/definitions/relationship"
35905     delete:
35906       tags:
35907         - Network
35908       summary: delete an existing relationship
35909       description: delete an existing relationship
35910       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35911       consumes:
35912         - application/json
35913         - application/xml
35914       produces:
35915         - application/json
35916         - application/xml
35917       responses:
35918         "default":
35919           description: Response codes found in [response codes](https://wiki.onap.org/).
35920       parameters:
35921         - name: vnf-id
35922           in: path
35923           description: Unique id of VNF.  This is unique across the graph.
35924           required: true
35925           type: string
35926           example: __VNF-ID__
35927         - name: interface-name
35928           in: path
35929           description: Name that identifies the link aggregate interface
35930           required: true
35931           type: string
35932           example: __INTERFACE-NAME__
35933         - name: interface-name
35934           in: path
35935           description: Name given to the interface
35936           required: true
35937           type: string
35938           example: __INTERFACE-NAME__
35939         - name: l3-interface-ipv4-address
35940           in: path
35941           description: IP address
35942           required: true
35943           type: string
35944           example: __L3-INTERFACE-IPV4-ADDRESS__
35945   /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}:
35946     get:
35947       tags:
35948         - Network
35949       summary: returns l3-interface-ipv4-address-list
35950       description: returns l3-interface-ipv4-address-list
35951       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
35952       produces:
35953         - application/json
35954         - application/xml
35955       responses:
35956         "200":
35957           description: successful operation
35958           schema:
35959               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
35960         "default":
35961           description: Response codes found in [response codes](https://wiki.onap.org/).
35962       parameters:
35963         - name: vnf-id
35964           in: path
35965           description: Unique id of VNF.  This is unique across the graph.
35966           required: true
35967           type: string
35968           example: __VNF-ID__
35969         - name: interface-name
35970           in: path
35971           description: Name that identifies the link aggregate interface
35972           required: true
35973           type: string
35974           example: __INTERFACE-NAME__
35975         - name: interface-name
35976           in: path
35977           description: Name given to the interface
35978           required: true
35979           type: string
35980           example: __INTERFACE-NAME__
35981         - name: l3-interface-ipv4-address
35982           in: path
35983           description: IP address
35984           required: true
35985           type: string
35986           example: __L3-INTERFACE-IPV4-ADDRESS__
35987         - name: vnf-name
35988           in: query
35989           description: Name of VNF.
35990           required: false
35991           type: string
35992         - name: vnf-name2
35993           in: query
35994           description: Alternate name of VNF.
35995           required: false
35996           type: string
35997         - name: vnf-type
35998           in: query
35999           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36000           required: false
36001           type: string
36002         - name: service-id
36003           in: query
36004           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36005           required: false
36006           type: string
36007         - name: regional-resource-zone
36008           in: query
36009           description: Regional way of organizing pservers, source of truth should define values
36010           required: false
36011           type: string
36012         - name: prov-status
36013           in: query
36014           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36015           required: false
36016           type: string
36017         - name: heat-stack-id
36018           in: query
36019           description: Heat stack id corresponding to this instance, managed by MSO
36020           required: false
36021           type: string
36022         - name: in-maint
36023           in: query
36024           required: false
36025           type: boolean
36026         - name: is-closed-loop-disabled
36027           in: query
36028           required: false
36029           type: boolean
36030         - name: model-invariant-id
36031           in: query
36032           description: the ASDC model id for this resource or service model.
36033           required: false
36034           type: string
36035         - name: model-version-id
36036           in: query
36037           description: the ASDC model version for this resource or service model.
36038           required: false
36039           type: string
36040         - name: widget-model-id
36041           in: query
36042           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36043           required: false
36044           type: string
36045         - name: widget-model-version
36046           in: query
36047           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36048           required: false
36049           type: string
36050         - name: nf-type
36051           in: query
36052           description: Generic description of the type of NF
36053           required: false
36054           type: string
36055         - name: nf-function
36056           in: query
36057           description: English description of Network function that the specific VNF deployment is providing
36058           required: false
36059           type: string
36060         - name: nf-role
36061           in: query
36062           description: role in the network that this model will be providing
36063           required: false
36064           type: string
36065         - name: nf-naming-code
36066           in: query
36067           description: string assigned to this model used for naming purposes
36068           required: false
36069           type: string
36070         - name: interface-id
36071           in: query
36072           description: ID of interface
36073           required: false
36074           type: string
36075         - name: interface-role
36076           in: query
36077           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36078           required: false
36079           type: string
36080         - name: interface-id
36081           in: query
36082           description: ID of interface
36083           required: false
36084           type: string
36085         - name: macaddr
36086           in: query
36087           description: MAC address for the interface
36088           required: false
36089           type: string
36090         - name: network-name
36091           in: query
36092           description: Name of the network
36093           required: false
36094           type: string
36095         - name: vlan-id-inner
36096           in: query
36097           description: Inner VLAN tag
36098           required: false
36099           type: integer
36100           format: int64
36101         - name: neutron-network-id
36102           in: query
36103           description: Neutron network id of the interface that address belongs to
36104           required: false
36105           type: string
36106         - name: neutron-subnet-id
36107           in: query
36108           description: Neutron id of subnet that address belongs to
36109           required: false
36110           type: string
36111     put:
36112       tags:
36113         - Network
36114       summary: create or update an existing l3-interface-ipv4-address-list
36115       description: |
36116         Create or update an existing l3-interface-ipv4-address-list.
36117         #
36118         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36119       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36120       consumes:
36121         - application/json
36122         - application/xml
36123       produces:
36124         - application/json
36125         - application/xml
36126       responses:
36127         "default":
36128           description: Response codes found in [response codes](https://wiki.onap.org/).
36129       parameters:
36130         - name: vnf-id
36131           in: path
36132           description: Unique id of VNF.  This is unique across the graph.
36133           required: true
36134           type: string
36135           example: __VNF-ID__
36136         - name: interface-name
36137           in: path
36138           description: Name that identifies the link aggregate interface
36139           required: true
36140           type: string
36141           example: __INTERFACE-NAME__
36142         - name: interface-name
36143           in: path
36144           description: Name given to the interface
36145           required: true
36146           type: string
36147           example: __INTERFACE-NAME__
36148         - name: l3-interface-ipv4-address
36149           in: path
36150           description: IP address
36151           required: true
36152           type: string
36153           example: __L3-INTERFACE-IPV4-ADDRESS__
36154         - name: body
36155           in: body
36156           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36157           required: true
36158           schema:
36159             $ref: "#/definitions/l3-interface-ipv4-address-list"
36160     patch:
36161       tags:
36162         - Network
36163       summary: update an existing l3-interface-ipv4-address-list
36164       description: |
36165         Update an existing l3-interface-ipv4-address-list
36166         #
36167         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36168         The PUT operation will entirely replace an existing object.
36169         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36170         #
36171         Other differences between PUT and PATCH are:
36172         #
36173         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36174         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36175         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36176       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36177       consumes:
36178         - application/json
36179         - application/xml
36180       produces:
36181         - application/json
36182         - application/xml
36183       responses:
36184         "default":
36185           description: Response codes found in [response codes](https://wiki.onap.org/).
36186       parameters:
36187         - name: vnf-id
36188           in: path
36189           description: Unique id of VNF.  This is unique across the graph.
36190           required: true
36191           type: string
36192           example: __VNF-ID__
36193         - name: interface-name
36194           in: path
36195           description: Name that identifies the link aggregate interface
36196           required: true
36197           type: string
36198           example: __INTERFACE-NAME__
36199         - name: interface-name
36200           in: path
36201           description: Name given to the interface
36202           required: true
36203           type: string
36204           example: __INTERFACE-NAME__
36205         - name: l3-interface-ipv4-address
36206           in: path
36207           description: IP address
36208           required: true
36209           type: string
36210           example: __L3-INTERFACE-IPV4-ADDRESS__
36211         - name: body
36212           in: body
36213           description: l3-interface-ipv4-address-list object that needs to be created or updated.
36214           required: true
36215           schema:
36216             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36217     delete:
36218       tags:
36219         - Network
36220       summary: delete an existing l3-interface-ipv4-address-list
36221       description: delete an existing l3-interface-ipv4-address-list
36222       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
36223       consumes:
36224         - application/json
36225         - application/xml
36226       produces:
36227         - application/json
36228         - application/xml
36229       responses:
36230         "default":
36231           description: Response codes found in [response codes](https://wiki.onap.org/).
36232       parameters:
36233         - name: vnf-id
36234           in: path
36235           description: Unique id of VNF.  This is unique across the graph.
36236           required: true
36237           type: string
36238           example: __VNF-ID__
36239         - name: interface-name
36240           in: path
36241           description: Name that identifies the link aggregate interface
36242           required: true
36243           type: string
36244           example: __INTERFACE-NAME__
36245         - name: interface-name
36246           in: path
36247           description: Name given to the interface
36248           required: true
36249           type: string
36250           example: __INTERFACE-NAME__
36251         - name: l3-interface-ipv4-address
36252           in: path
36253           description: IP address
36254           required: true
36255           type: string
36256           example: __L3-INTERFACE-IPV4-ADDRESS__
36257         - name: resource-version
36258           in: query
36259           description: resource-version for concurrency
36260           required: true
36261           type: string
36262   /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:
36263     put:
36264       tags:
36265         - Network
36266       summary: see node definition for valid relationships
36267       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36268       consumes:
36269         - application/json
36270         - application/xml
36271       produces:
36272         - application/json
36273         - application/xml
36274       responses:
36275         "default":
36276           description: Response codes found in [response codes](https://wiki.onap.org/).
36277       parameters:
36278         - name: vnf-id
36279           in: path
36280           description: Unique id of VNF.  This is unique across the graph.
36281           required: true
36282           type: string
36283           example: __VNF-ID__
36284         - name: interface-name
36285           in: path
36286           description: Name that identifies the link aggregate interface
36287           required: true
36288           type: string
36289           example: __INTERFACE-NAME__
36290         - name: interface-name
36291           in: path
36292           description: Name given to the interface
36293           required: true
36294           type: string
36295           example: __INTERFACE-NAME__
36296         - name: l3-interface-ipv6-address
36297           in: path
36298           description: IP address
36299           required: true
36300           type: string
36301           example: __L3-INTERFACE-IPV6-ADDRESS__
36302         - name: body
36303           in: body
36304           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36305           required: true
36306           schema:
36307             $ref: "#/definitions/relationship"
36308     delete:
36309       tags:
36310         - Network
36311       summary: delete an existing relationship
36312       description: delete an existing relationship
36313       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36314       consumes:
36315         - application/json
36316         - application/xml
36317       produces:
36318         - application/json
36319         - application/xml
36320       responses:
36321         "default":
36322           description: Response codes found in [response codes](https://wiki.onap.org/).
36323       parameters:
36324         - name: vnf-id
36325           in: path
36326           description: Unique id of VNF.  This is unique across the graph.
36327           required: true
36328           type: string
36329           example: __VNF-ID__
36330         - name: interface-name
36331           in: path
36332           description: Name that identifies the link aggregate interface
36333           required: true
36334           type: string
36335           example: __INTERFACE-NAME__
36336         - name: interface-name
36337           in: path
36338           description: Name given to the interface
36339           required: true
36340           type: string
36341           example: __INTERFACE-NAME__
36342         - name: l3-interface-ipv6-address
36343           in: path
36344           description: IP address
36345           required: true
36346           type: string
36347           example: __L3-INTERFACE-IPV6-ADDRESS__
36348   /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}:
36349     get:
36350       tags:
36351         - Network
36352       summary: returns l3-interface-ipv6-address-list
36353       description: returns l3-interface-ipv6-address-list
36354       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36355       produces:
36356         - application/json
36357         - application/xml
36358       responses:
36359         "200":
36360           description: successful operation
36361           schema:
36362               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36363         "default":
36364           description: Response codes found in [response codes](https://wiki.onap.org/).
36365       parameters:
36366         - name: vnf-id
36367           in: path
36368           description: Unique id of VNF.  This is unique across the graph.
36369           required: true
36370           type: string
36371           example: __VNF-ID__
36372         - name: interface-name
36373           in: path
36374           description: Name that identifies the link aggregate interface
36375           required: true
36376           type: string
36377           example: __INTERFACE-NAME__
36378         - name: interface-name
36379           in: path
36380           description: Name given to the interface
36381           required: true
36382           type: string
36383           example: __INTERFACE-NAME__
36384         - name: l3-interface-ipv6-address
36385           in: path
36386           description: IP address
36387           required: true
36388           type: string
36389           example: __L3-INTERFACE-IPV6-ADDRESS__
36390         - name: vnf-name
36391           in: query
36392           description: Name of VNF.
36393           required: false
36394           type: string
36395         - name: vnf-name2
36396           in: query
36397           description: Alternate name of VNF.
36398           required: false
36399           type: string
36400         - name: vnf-type
36401           in: query
36402           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36403           required: false
36404           type: string
36405         - name: service-id
36406           in: query
36407           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36408           required: false
36409           type: string
36410         - name: regional-resource-zone
36411           in: query
36412           description: Regional way of organizing pservers, source of truth should define values
36413           required: false
36414           type: string
36415         - name: prov-status
36416           in: query
36417           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36418           required: false
36419           type: string
36420         - name: heat-stack-id
36421           in: query
36422           description: Heat stack id corresponding to this instance, managed by MSO
36423           required: false
36424           type: string
36425         - name: in-maint
36426           in: query
36427           required: false
36428           type: boolean
36429         - name: is-closed-loop-disabled
36430           in: query
36431           required: false
36432           type: boolean
36433         - name: model-invariant-id
36434           in: query
36435           description: the ASDC model id for this resource or service model.
36436           required: false
36437           type: string
36438         - name: model-version-id
36439           in: query
36440           description: the ASDC model version for this resource or service model.
36441           required: false
36442           type: string
36443         - name: widget-model-id
36444           in: query
36445           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36446           required: false
36447           type: string
36448         - name: widget-model-version
36449           in: query
36450           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36451           required: false
36452           type: string
36453         - name: nf-type
36454           in: query
36455           description: Generic description of the type of NF
36456           required: false
36457           type: string
36458         - name: nf-function
36459           in: query
36460           description: English description of Network function that the specific VNF deployment is providing
36461           required: false
36462           type: string
36463         - name: nf-role
36464           in: query
36465           description: role in the network that this model will be providing
36466           required: false
36467           type: string
36468         - name: nf-naming-code
36469           in: query
36470           description: string assigned to this model used for naming purposes
36471           required: false
36472           type: string
36473         - name: interface-id
36474           in: query
36475           description: ID of interface
36476           required: false
36477           type: string
36478         - name: interface-role
36479           in: query
36480           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36481           required: false
36482           type: string
36483         - name: interface-id
36484           in: query
36485           description: ID of interface
36486           required: false
36487           type: string
36488         - name: macaddr
36489           in: query
36490           description: MAC address for the interface
36491           required: false
36492           type: string
36493         - name: network-name
36494           in: query
36495           description: Name of the network
36496           required: false
36497           type: string
36498         - name: vlan-id-inner
36499           in: query
36500           description: Inner VLAN tag
36501           required: false
36502           type: integer
36503           format: int64
36504         - name: neutron-network-id
36505           in: query
36506           description: Neutron network id of the interface that address belongs to
36507           required: false
36508           type: string
36509         - name: neutron-subnet-id
36510           in: query
36511           description: Neutron id of subnet that address belongs to
36512           required: false
36513           type: string
36514     put:
36515       tags:
36516         - Network
36517       summary: create or update an existing l3-interface-ipv6-address-list
36518       description: |
36519         Create or update an existing l3-interface-ipv6-address-list.
36520         #
36521         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36522       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36523       consumes:
36524         - application/json
36525         - application/xml
36526       produces:
36527         - application/json
36528         - application/xml
36529       responses:
36530         "default":
36531           description: Response codes found in [response codes](https://wiki.onap.org/).
36532       parameters:
36533         - name: vnf-id
36534           in: path
36535           description: Unique id of VNF.  This is unique across the graph.
36536           required: true
36537           type: string
36538           example: __VNF-ID__
36539         - name: interface-name
36540           in: path
36541           description: Name that identifies the link aggregate interface
36542           required: true
36543           type: string
36544           example: __INTERFACE-NAME__
36545         - name: interface-name
36546           in: path
36547           description: Name given to the interface
36548           required: true
36549           type: string
36550           example: __INTERFACE-NAME__
36551         - name: l3-interface-ipv6-address
36552           in: path
36553           description: IP address
36554           required: true
36555           type: string
36556           example: __L3-INTERFACE-IPV6-ADDRESS__
36557         - name: body
36558           in: body
36559           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36560           required: true
36561           schema:
36562             $ref: "#/definitions/l3-interface-ipv6-address-list"
36563     patch:
36564       tags:
36565         - Network
36566       summary: update an existing l3-interface-ipv6-address-list
36567       description: |
36568         Update an existing l3-interface-ipv6-address-list
36569         #
36570         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36571         The PUT operation will entirely replace an existing object.
36572         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36573         #
36574         Other differences between PUT and PATCH are:
36575         #
36576         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36577         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36578         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36579       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36580       consumes:
36581         - application/json
36582         - application/xml
36583       produces:
36584         - application/json
36585         - application/xml
36586       responses:
36587         "default":
36588           description: Response codes found in [response codes](https://wiki.onap.org/).
36589       parameters:
36590         - name: vnf-id
36591           in: path
36592           description: Unique id of VNF.  This is unique across the graph.
36593           required: true
36594           type: string
36595           example: __VNF-ID__
36596         - name: interface-name
36597           in: path
36598           description: Name that identifies the link aggregate interface
36599           required: true
36600           type: string
36601           example: __INTERFACE-NAME__
36602         - name: interface-name
36603           in: path
36604           description: Name given to the interface
36605           required: true
36606           type: string
36607           example: __INTERFACE-NAME__
36608         - name: l3-interface-ipv6-address
36609           in: path
36610           description: IP address
36611           required: true
36612           type: string
36613           example: __L3-INTERFACE-IPV6-ADDRESS__
36614         - name: body
36615           in: body
36616           description: l3-interface-ipv6-address-list object that needs to be created or updated.
36617           required: true
36618           schema:
36619             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36620     delete:
36621       tags:
36622         - Network
36623       summary: delete an existing l3-interface-ipv6-address-list
36624       description: delete an existing l3-interface-ipv6-address-list
36625       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
36626       consumes:
36627         - application/json
36628         - application/xml
36629       produces:
36630         - application/json
36631         - application/xml
36632       responses:
36633         "default":
36634           description: Response codes found in [response codes](https://wiki.onap.org/).
36635       parameters:
36636         - name: vnf-id
36637           in: path
36638           description: Unique id of VNF.  This is unique across the graph.
36639           required: true
36640           type: string
36641           example: __VNF-ID__
36642         - name: interface-name
36643           in: path
36644           description: Name that identifies the link aggregate interface
36645           required: true
36646           type: string
36647           example: __INTERFACE-NAME__
36648         - name: interface-name
36649           in: path
36650           description: Name given to the interface
36651           required: true
36652           type: string
36653           example: __INTERFACE-NAME__
36654         - name: l3-interface-ipv6-address
36655           in: path
36656           description: IP address
36657           required: true
36658           type: string
36659           example: __L3-INTERFACE-IPV6-ADDRESS__
36660         - name: resource-version
36661           in: query
36662           description: resource-version for concurrency
36663           required: true
36664           type: string
36665   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
36666     get:
36667       tags:
36668         - Network
36669       summary: returns l-interface
36670       description: returns l-interface
36671       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36672       produces:
36673         - application/json
36674         - application/xml
36675       responses:
36676         "200":
36677           description: successful operation
36678           schema:
36679               $ref: "#/getDefinitions/l-interface"
36680         "default":
36681           description: Response codes found in [response codes](https://wiki.onap.org/).
36682       parameters:
36683         - name: vnf-id
36684           in: path
36685           description: Unique id of VNF.  This is unique across the graph.
36686           required: true
36687           type: string
36688           example: __VNF-ID__
36689         - name: interface-name
36690           in: path
36691           description: Name that identifies the link aggregate interface
36692           required: true
36693           type: string
36694           example: __INTERFACE-NAME__
36695         - name: interface-name
36696           in: path
36697           description: Name given to the interface
36698           required: true
36699           type: string
36700           example: __INTERFACE-NAME__
36701         - name: vnf-name
36702           in: query
36703           description: Name of VNF.
36704           required: false
36705           type: string
36706         - name: vnf-name2
36707           in: query
36708           description: Alternate name of VNF.
36709           required: false
36710           type: string
36711         - name: vnf-type
36712           in: query
36713           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36714           required: false
36715           type: string
36716         - name: service-id
36717           in: query
36718           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36719           required: false
36720           type: string
36721         - name: regional-resource-zone
36722           in: query
36723           description: Regional way of organizing pservers, source of truth should define values
36724           required: false
36725           type: string
36726         - name: prov-status
36727           in: query
36728           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36729           required: false
36730           type: string
36731         - name: heat-stack-id
36732           in: query
36733           description: Heat stack id corresponding to this instance, managed by MSO
36734           required: false
36735           type: string
36736         - name: in-maint
36737           in: query
36738           required: false
36739           type: boolean
36740         - name: is-closed-loop-disabled
36741           in: query
36742           required: false
36743           type: boolean
36744         - name: model-invariant-id
36745           in: query
36746           description: the ASDC model id for this resource or service model.
36747           required: false
36748           type: string
36749         - name: model-version-id
36750           in: query
36751           description: the ASDC model version for this resource or service model.
36752           required: false
36753           type: string
36754         - name: widget-model-id
36755           in: query
36756           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36757           required: false
36758           type: string
36759         - name: widget-model-version
36760           in: query
36761           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36762           required: false
36763           type: string
36764         - name: nf-type
36765           in: query
36766           description: Generic description of the type of NF
36767           required: false
36768           type: string
36769         - name: nf-function
36770           in: query
36771           description: English description of Network function that the specific VNF deployment is providing
36772           required: false
36773           type: string
36774         - name: nf-role
36775           in: query
36776           description: role in the network that this model will be providing
36777           required: false
36778           type: string
36779         - name: nf-naming-code
36780           in: query
36781           description: string assigned to this model used for naming purposes
36782           required: false
36783           type: string
36784         - name: interface-id
36785           in: query
36786           description: ID of interface
36787           required: false
36788           type: string
36789         - name: interface-role
36790           in: query
36791           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
36792           required: false
36793           type: string
36794         - name: interface-id
36795           in: query
36796           description: ID of interface
36797           required: false
36798           type: string
36799         - name: macaddr
36800           in: query
36801           description: MAC address for the interface
36802           required: false
36803           type: string
36804         - name: network-name
36805           in: query
36806           description: Name of the network
36807           required: false
36808           type: string
36809     put:
36810       tags:
36811         - Network
36812       summary: create or update an existing l-interface
36813       description: |
36814         Create or update an existing l-interface.
36815         #
36816         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36817       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36818       consumes:
36819         - application/json
36820         - application/xml
36821       produces:
36822         - application/json
36823         - application/xml
36824       responses:
36825         "default":
36826           description: Response codes found in [response codes](https://wiki.onap.org/).
36827       parameters:
36828         - name: vnf-id
36829           in: path
36830           description: Unique id of VNF.  This is unique across the graph.
36831           required: true
36832           type: string
36833           example: __VNF-ID__
36834         - name: interface-name
36835           in: path
36836           description: Name that identifies the link aggregate interface
36837           required: true
36838           type: string
36839           example: __INTERFACE-NAME__
36840         - name: interface-name
36841           in: path
36842           description: Name given to the interface
36843           required: true
36844           type: string
36845           example: __INTERFACE-NAME__
36846         - name: body
36847           in: body
36848           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
36849           required: true
36850           schema:
36851             $ref: "#/definitions/l-interface"
36852     patch:
36853       tags:
36854         - Network
36855       summary: update an existing l-interface
36856       description: |
36857         Update an existing l-interface
36858         #
36859         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36860         The PUT operation will entirely replace an existing object.
36861         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36862         #
36863         Other differences between PUT and PATCH are:
36864         #
36865         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36866         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36867         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36868       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36869       consumes:
36870         - application/json
36871         - application/xml
36872       produces:
36873         - application/json
36874         - application/xml
36875       responses:
36876         "default":
36877           description: Response codes found in [response codes](https://wiki.onap.org/).
36878       parameters:
36879         - name: vnf-id
36880           in: path
36881           description: Unique id of VNF.  This is unique across the graph.
36882           required: true
36883           type: string
36884           example: __VNF-ID__
36885         - name: interface-name
36886           in: path
36887           description: Name that identifies the link aggregate interface
36888           required: true
36889           type: string
36890           example: __INTERFACE-NAME__
36891         - name: interface-name
36892           in: path
36893           description: Name given to the interface
36894           required: true
36895           type: string
36896           example: __INTERFACE-NAME__
36897         - name: body
36898           in: body
36899           description: l-interface object that needs to be created or updated.
36900           required: true
36901           schema:
36902             $ref: "#/patchDefinitions/l-interface"
36903     delete:
36904       tags:
36905         - Network
36906       summary: delete an existing l-interface
36907       description: delete an existing l-interface
36908       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
36909       consumes:
36910         - application/json
36911         - application/xml
36912       produces:
36913         - application/json
36914         - application/xml
36915       responses:
36916         "default":
36917           description: Response codes found in [response codes](https://wiki.onap.org/).
36918       parameters:
36919         - name: vnf-id
36920           in: path
36921           description: Unique id of VNF.  This is unique across the graph.
36922           required: true
36923           type: string
36924           example: __VNF-ID__
36925         - name: interface-name
36926           in: path
36927           description: Name that identifies the link aggregate interface
36928           required: true
36929           type: string
36930           example: __INTERFACE-NAME__
36931         - name: interface-name
36932           in: path
36933           description: Name given to the interface
36934           required: true
36935           type: string
36936           example: __INTERFACE-NAME__
36937         - name: resource-version
36938           in: query
36939           description: resource-version for concurrency
36940           required: true
36941           type: string
36942   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
36943     get:
36944       tags:
36945         - Network
36946       summary: returns l-interfaces
36947       description: returns l-interfaces
36948       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
36949       produces:
36950         - application/json
36951         - application/xml
36952       responses:
36953         "200":
36954           description: successful operation
36955           schema:
36956               $ref: "#/getDefinitions/l-interfaces"
36957         "default":
36958           description: Response codes found in [response codes](https://wiki.onap.org/).
36959       parameters:
36960         - name: vnf-id
36961           in: path
36962           description: Unique id of VNF.  This is unique across the graph.
36963           required: true
36964           type: string
36965           example: __VNF-ID__
36966         - name: interface-name
36967           in: path
36968           description: Name that identifies the link aggregate interface
36969           required: true
36970           type: string
36971           example: __INTERFACE-NAME__
36972         - name: vnf-name
36973           in: query
36974           description: Name of VNF.
36975           required: false
36976           type: string
36977         - name: vnf-name2
36978           in: query
36979           description: Alternate name of VNF.
36980           required: false
36981           type: string
36982         - name: vnf-type
36983           in: query
36984           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
36985           required: false
36986           type: string
36987         - name: service-id
36988           in: query
36989           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36990           required: false
36991           type: string
36992         - name: regional-resource-zone
36993           in: query
36994           description: Regional way of organizing pservers, source of truth should define values
36995           required: false
36996           type: string
36997         - name: prov-status
36998           in: query
36999           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37000           required: false
37001           type: string
37002         - name: heat-stack-id
37003           in: query
37004           description: Heat stack id corresponding to this instance, managed by MSO
37005           required: false
37006           type: string
37007         - name: in-maint
37008           in: query
37009           required: false
37010           type: boolean
37011         - name: is-closed-loop-disabled
37012           in: query
37013           required: false
37014           type: boolean
37015         - name: model-invariant-id
37016           in: query
37017           description: the ASDC model id for this resource or service model.
37018           required: false
37019           type: string
37020         - name: model-version-id
37021           in: query
37022           description: the ASDC model version for this resource or service model.
37023           required: false
37024           type: string
37025         - name: widget-model-id
37026           in: query
37027           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37028           required: false
37029           type: string
37030         - name: widget-model-version
37031           in: query
37032           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37033           required: false
37034           type: string
37035         - name: nf-type
37036           in: query
37037           description: Generic description of the type of NF
37038           required: false
37039           type: string
37040         - name: nf-function
37041           in: query
37042           description: English description of Network function that the specific VNF deployment is providing
37043           required: false
37044           type: string
37045         - name: nf-role
37046           in: query
37047           description: role in the network that this model will be providing
37048           required: false
37049           type: string
37050         - name: nf-naming-code
37051           in: query
37052           description: string assigned to this model used for naming purposes
37053           required: false
37054           type: string
37055         - name: interface-id
37056           in: query
37057           description: ID of interface
37058           required: false
37059           type: string
37060         - name: interface-role
37061           in: query
37062           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37063           required: false
37064           type: string
37065   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
37066     get:
37067       tags:
37068         - Network
37069       summary: returns lag-interface
37070       description: returns lag-interface
37071       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37072       produces:
37073         - application/json
37074         - application/xml
37075       responses:
37076         "200":
37077           description: successful operation
37078           schema:
37079               $ref: "#/getDefinitions/lag-interface"
37080         "default":
37081           description: Response codes found in [response codes](https://wiki.onap.org/).
37082       parameters:
37083         - name: vnf-id
37084           in: path
37085           description: Unique id of VNF.  This is unique across the graph.
37086           required: true
37087           type: string
37088           example: __VNF-ID__
37089         - name: interface-name
37090           in: path
37091           description: Name that identifies the link aggregate interface
37092           required: true
37093           type: string
37094           example: __INTERFACE-NAME__
37095         - name: vnf-name
37096           in: query
37097           description: Name of VNF.
37098           required: false
37099           type: string
37100         - name: vnf-name2
37101           in: query
37102           description: Alternate name of VNF.
37103           required: false
37104           type: string
37105         - name: vnf-type
37106           in: query
37107           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37108           required: false
37109           type: string
37110         - name: service-id
37111           in: query
37112           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37113           required: false
37114           type: string
37115         - name: regional-resource-zone
37116           in: query
37117           description: Regional way of organizing pservers, source of truth should define values
37118           required: false
37119           type: string
37120         - name: prov-status
37121           in: query
37122           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37123           required: false
37124           type: string
37125         - name: heat-stack-id
37126           in: query
37127           description: Heat stack id corresponding to this instance, managed by MSO
37128           required: false
37129           type: string
37130         - name: in-maint
37131           in: query
37132           required: false
37133           type: boolean
37134         - name: is-closed-loop-disabled
37135           in: query
37136           required: false
37137           type: boolean
37138         - name: model-invariant-id
37139           in: query
37140           description: the ASDC model id for this resource or service model.
37141           required: false
37142           type: string
37143         - name: model-version-id
37144           in: query
37145           description: the ASDC model version for this resource or service model.
37146           required: false
37147           type: string
37148         - name: widget-model-id
37149           in: query
37150           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37151           required: false
37152           type: string
37153         - name: widget-model-version
37154           in: query
37155           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37156           required: false
37157           type: string
37158         - name: nf-type
37159           in: query
37160           description: Generic description of the type of NF
37161           required: false
37162           type: string
37163         - name: nf-function
37164           in: query
37165           description: English description of Network function that the specific VNF deployment is providing
37166           required: false
37167           type: string
37168         - name: nf-role
37169           in: query
37170           description: role in the network that this model will be providing
37171           required: false
37172           type: string
37173         - name: nf-naming-code
37174           in: query
37175           description: string assigned to this model used for naming purposes
37176           required: false
37177           type: string
37178         - name: interface-id
37179           in: query
37180           description: ID of interface
37181           required: false
37182           type: string
37183         - name: interface-role
37184           in: query
37185           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37186           required: false
37187           type: string
37188     put:
37189       tags:
37190         - Network
37191       summary: create or update an existing lag-interface
37192       description: |
37193         Create or update an existing lag-interface.
37194         #
37195         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37196       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37197       consumes:
37198         - application/json
37199         - application/xml
37200       produces:
37201         - application/json
37202         - application/xml
37203       responses:
37204         "default":
37205           description: Response codes found in [response codes](https://wiki.onap.org/).
37206       parameters:
37207         - name: vnf-id
37208           in: path
37209           description: Unique id of VNF.  This is unique across the graph.
37210           required: true
37211           type: string
37212           example: __VNF-ID__
37213         - name: interface-name
37214           in: path
37215           description: Name that identifies the link aggregate interface
37216           required: true
37217           type: string
37218           example: __INTERFACE-NAME__
37219         - name: body
37220           in: body
37221           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
37222           required: true
37223           schema:
37224             $ref: "#/definitions/lag-interface"
37225     patch:
37226       tags:
37227         - Network
37228       summary: update an existing lag-interface
37229       description: |
37230         Update an existing lag-interface
37231         #
37232         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37233         The PUT operation will entirely replace an existing object.
37234         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37235         #
37236         Other differences between PUT and PATCH are:
37237         #
37238         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37239         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37240         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37241       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37242       consumes:
37243         - application/json
37244         - application/xml
37245       produces:
37246         - application/json
37247         - application/xml
37248       responses:
37249         "default":
37250           description: Response codes found in [response codes](https://wiki.onap.org/).
37251       parameters:
37252         - name: vnf-id
37253           in: path
37254           description: Unique id of VNF.  This is unique across the graph.
37255           required: true
37256           type: string
37257           example: __VNF-ID__
37258         - name: interface-name
37259           in: path
37260           description: Name that identifies the link aggregate interface
37261           required: true
37262           type: string
37263           example: __INTERFACE-NAME__
37264         - name: body
37265           in: body
37266           description: lag-interface object that needs to be created or updated.
37267           required: true
37268           schema:
37269             $ref: "#/patchDefinitions/lag-interface"
37270     delete:
37271       tags:
37272         - Network
37273       summary: delete an existing lag-interface
37274       description: delete an existing lag-interface
37275       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
37276       consumes:
37277         - application/json
37278         - application/xml
37279       produces:
37280         - application/json
37281         - application/xml
37282       responses:
37283         "default":
37284           description: Response codes found in [response codes](https://wiki.onap.org/).
37285       parameters:
37286         - name: vnf-id
37287           in: path
37288           description: Unique id of VNF.  This is unique across the graph.
37289           required: true
37290           type: string
37291           example: __VNF-ID__
37292         - name: interface-name
37293           in: path
37294           description: Name that identifies the link aggregate interface
37295           required: true
37296           type: string
37297           example: __INTERFACE-NAME__
37298         - name: resource-version
37299           in: query
37300           description: resource-version for concurrency
37301           required: true
37302           type: string
37303   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
37304     get:
37305       tags:
37306         - Network
37307       summary: returns lag-interfaces
37308       description: returns lag-interfaces
37309       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
37310       produces:
37311         - application/json
37312         - application/xml
37313       responses:
37314         "200":
37315           description: successful operation
37316           schema:
37317               $ref: "#/getDefinitions/lag-interfaces"
37318         "default":
37319           description: Response codes found in [response codes](https://wiki.onap.org/).
37320       parameters:
37321         - name: vnf-id
37322           in: path
37323           description: Unique id of VNF.  This is unique across the graph.
37324           required: true
37325           type: string
37326           example: __VNF-ID__
37327         - name: vnf-name
37328           in: query
37329           description: Name of VNF.
37330           required: false
37331           type: string
37332         - name: vnf-name2
37333           in: query
37334           description: Alternate name of VNF.
37335           required: false
37336           type: string
37337         - name: vnf-type
37338           in: query
37339           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37340           required: false
37341           type: string
37342         - name: service-id
37343           in: query
37344           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37345           required: false
37346           type: string
37347         - name: regional-resource-zone
37348           in: query
37349           description: Regional way of organizing pservers, source of truth should define values
37350           required: false
37351           type: string
37352         - name: prov-status
37353           in: query
37354           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37355           required: false
37356           type: string
37357         - name: heat-stack-id
37358           in: query
37359           description: Heat stack id corresponding to this instance, managed by MSO
37360           required: false
37361           type: string
37362         - name: in-maint
37363           in: query
37364           required: false
37365           type: boolean
37366         - name: is-closed-loop-disabled
37367           in: query
37368           required: false
37369           type: boolean
37370         - name: model-invariant-id
37371           in: query
37372           description: the ASDC model id for this resource or service model.
37373           required: false
37374           type: string
37375         - name: model-version-id
37376           in: query
37377           description: the ASDC model version for this resource or service model.
37378           required: false
37379           type: string
37380         - name: widget-model-id
37381           in: query
37382           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37383           required: false
37384           type: string
37385         - name: widget-model-version
37386           in: query
37387           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37388           required: false
37389           type: string
37390         - name: nf-type
37391           in: query
37392           description: Generic description of the type of NF
37393           required: false
37394           type: string
37395         - name: nf-function
37396           in: query
37397           description: English description of Network function that the specific VNF deployment is providing
37398           required: false
37399           type: string
37400         - name: nf-role
37401           in: query
37402           description: role in the network that this model will be providing
37403           required: false
37404           type: string
37405         - name: nf-naming-code
37406           in: query
37407           description: string assigned to this model used for naming purposes
37408           required: false
37409           type: string
37410   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
37411     put:
37412       tags:
37413         - Network
37414       summary: see node definition for valid relationships
37415       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
37416       consumes:
37417         - application/json
37418         - application/xml
37419       produces:
37420         - application/json
37421         - application/xml
37422       responses:
37423         "default":
37424           description: Response codes found in [response codes](https://wiki.onap.org/).
37425       parameters:
37426         - name: vnf-id
37427           in: path
37428           description: Unique id of VNF.  This is unique across the graph.
37429           required: true
37430           type: string
37431           example: __VNF-ID__
37432         - name: vf-module-id
37433           in: path
37434           description: Unique ID of vf-module.
37435           required: true
37436           type: string
37437           example: __VF-MODULE-ID__
37438         - name: body
37439           in: body
37440           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
37441           required: true
37442           schema:
37443             $ref: "#/definitions/relationship"
37444     delete:
37445       tags:
37446         - Network
37447       summary: delete an existing relationship
37448       description: delete an existing relationship
37449       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
37450       consumes:
37451         - application/json
37452         - application/xml
37453       produces:
37454         - application/json
37455         - application/xml
37456       responses:
37457         "default":
37458           description: Response codes found in [response codes](https://wiki.onap.org/).
37459       parameters:
37460         - name: vnf-id
37461           in: path
37462           description: Unique id of VNF.  This is unique across the graph.
37463           required: true
37464           type: string
37465           example: __VNF-ID__
37466         - name: vf-module-id
37467           in: path
37468           description: Unique ID of vf-module.
37469           required: true
37470           type: string
37471           example: __VF-MODULE-ID__
37472   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
37473     get:
37474       tags:
37475         - Network
37476       summary: returns vf-module
37477       description: returns vf-module
37478       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
37479       produces:
37480         - application/json
37481         - application/xml
37482       responses:
37483         "200":
37484           description: successful operation
37485           schema:
37486               $ref: "#/getDefinitions/vf-module"
37487         "default":
37488           description: Response codes found in [response codes](https://wiki.onap.org/).
37489       parameters:
37490         - name: vnf-id
37491           in: path
37492           description: Unique id of VNF.  This is unique across the graph.
37493           required: true
37494           type: string
37495           example: __VNF-ID__
37496         - name: vf-module-id
37497           in: path
37498           description: Unique ID of vf-module.
37499           required: true
37500           type: string
37501           example: __VF-MODULE-ID__
37502         - name: vnf-name
37503           in: query
37504           description: Name of VNF.
37505           required: false
37506           type: string
37507         - name: vnf-name2
37508           in: query
37509           description: Alternate name of VNF.
37510           required: false
37511           type: string
37512         - name: vnf-type
37513           in: query
37514           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37515           required: false
37516           type: string
37517         - name: service-id
37518           in: query
37519           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37520           required: false
37521           type: string
37522         - name: regional-resource-zone
37523           in: query
37524           description: Regional way of organizing pservers, source of truth should define values
37525           required: false
37526           type: string
37527         - name: prov-status
37528           in: query
37529           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37530           required: false
37531           type: string
37532         - name: heat-stack-id
37533           in: query
37534           description: Heat stack id corresponding to this instance, managed by MSO
37535           required: false
37536           type: string
37537         - name: in-maint
37538           in: query
37539           required: false
37540           type: boolean
37541         - name: is-closed-loop-disabled
37542           in: query
37543           required: false
37544           type: boolean
37545         - name: model-invariant-id
37546           in: query
37547           description: the ASDC model id for this resource or service model.
37548           required: false
37549           type: string
37550         - name: model-version-id
37551           in: query
37552           description: the ASDC model version for this resource or service model.
37553           required: false
37554           type: string
37555         - name: widget-model-id
37556           in: query
37557           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37558           required: false
37559           type: string
37560         - name: widget-model-version
37561           in: query
37562           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37563           required: false
37564           type: string
37565         - name: nf-type
37566           in: query
37567           description: Generic description of the type of NF
37568           required: false
37569           type: string
37570         - name: nf-function
37571           in: query
37572           description: English description of Network function that the specific VNF deployment is providing
37573           required: false
37574           type: string
37575         - name: nf-role
37576           in: query
37577           description: role in the network that this model will be providing
37578           required: false
37579           type: string
37580         - name: nf-naming-code
37581           in: query
37582           description: string assigned to this model used for naming purposes
37583           required: false
37584           type: string
37585         - name: vf-module-name
37586           in: query
37587           description: Name of vf-module
37588           required: false
37589           type: string
37590         - name: heat-stack-id
37591           in: query
37592           description: Heat stack id corresponding to this instance.
37593           required: false
37594           type: string
37595         - name: model-invariant-id
37596           in: query
37597           description: the ASDC model id for this resource or service model.
37598           required: false
37599           type: string
37600         - name: model-version-id
37601           in: query
37602           description: the ASDC model version for this resource or service model.
37603           required: false
37604           type: string
37605         - name: widget-model-id
37606           in: query
37607           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37608           required: false
37609           type: string
37610         - name: widget-model-version
37611           in: query
37612           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37613           required: false
37614           type: string
37615         - name: contrail-service-instance-fqdn
37616           in: query
37617           description: the Contrail unique ID for a service-instance
37618           required: false
37619           type: string
37620     put:
37621       tags:
37622         - Network
37623       summary: create or update an existing vf-module
37624       description: |
37625         Create or update an existing vf-module.
37626         #
37627         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37628       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
37629       consumes:
37630         - application/json
37631         - application/xml
37632       produces:
37633         - application/json
37634         - application/xml
37635       responses:
37636         "default":
37637           description: Response codes found in [response codes](https://wiki.onap.org/).
37638       parameters:
37639         - name: vnf-id
37640           in: path
37641           description: Unique id of VNF.  This is unique across the graph.
37642           required: true
37643           type: string
37644           example: __VNF-ID__
37645         - name: vf-module-id
37646           in: path
37647           description: Unique ID of vf-module.
37648           required: true
37649           type: string
37650           example: __VF-MODULE-ID__
37651         - name: body
37652           in: body
37653           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
37654           required: true
37655           schema:
37656             $ref: "#/definitions/vf-module"
37657     patch:
37658       tags:
37659         - Network
37660       summary: update an existing vf-module
37661       description: |
37662         Update an existing vf-module
37663         #
37664         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37665         The PUT operation will entirely replace an existing object.
37666         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37667         #
37668         Other differences between PUT and PATCH are:
37669         #
37670         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37671         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37672         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37673       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
37674       consumes:
37675         - application/json
37676         - application/xml
37677       produces:
37678         - application/json
37679         - application/xml
37680       responses:
37681         "default":
37682           description: Response codes found in [response codes](https://wiki.onap.org/).
37683       parameters:
37684         - name: vnf-id
37685           in: path
37686           description: Unique id of VNF.  This is unique across the graph.
37687           required: true
37688           type: string
37689           example: __VNF-ID__
37690         - name: vf-module-id
37691           in: path
37692           description: Unique ID of vf-module.
37693           required: true
37694           type: string
37695           example: __VF-MODULE-ID__
37696         - name: body
37697           in: body
37698           description: vf-module object that needs to be created or updated.
37699           required: true
37700           schema:
37701             $ref: "#/patchDefinitions/vf-module"
37702     delete:
37703       tags:
37704         - Network
37705       summary: delete an existing vf-module
37706       description: delete an existing vf-module
37707       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
37708       consumes:
37709         - application/json
37710         - application/xml
37711       produces:
37712         - application/json
37713         - application/xml
37714       responses:
37715         "default":
37716           description: Response codes found in [response codes](https://wiki.onap.org/).
37717       parameters:
37718         - name: vnf-id
37719           in: path
37720           description: Unique id of VNF.  This is unique across the graph.
37721           required: true
37722           type: string
37723           example: __VNF-ID__
37724         - name: vf-module-id
37725           in: path
37726           description: Unique ID of vf-module.
37727           required: true
37728           type: string
37729           example: __VF-MODULE-ID__
37730         - name: resource-version
37731           in: query
37732           description: resource-version for concurrency
37733           required: true
37734           type: string
37735   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
37736     get:
37737       tags:
37738         - Network
37739       summary: returns vf-modules
37740       description: returns vf-modules
37741       operationId: getNetworkGenericVnfsGenericVnfVfModules
37742       produces:
37743         - application/json
37744         - application/xml
37745       responses:
37746         "200":
37747           description: successful operation
37748           schema:
37749               $ref: "#/getDefinitions/vf-modules"
37750         "default":
37751           description: Response codes found in [response codes](https://wiki.onap.org/).
37752       parameters:
37753         - name: vnf-id
37754           in: path
37755           description: Unique id of VNF.  This is unique across the graph.
37756           required: true
37757           type: string
37758           example: __VNF-ID__
37759         - name: vnf-name
37760           in: query
37761           description: Name of VNF.
37762           required: false
37763           type: string
37764         - name: vnf-name2
37765           in: query
37766           description: Alternate name of VNF.
37767           required: false
37768           type: string
37769         - name: vnf-type
37770           in: query
37771           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37772           required: false
37773           type: string
37774         - name: service-id
37775           in: query
37776           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37777           required: false
37778           type: string
37779         - name: regional-resource-zone
37780           in: query
37781           description: Regional way of organizing pservers, source of truth should define values
37782           required: false
37783           type: string
37784         - name: prov-status
37785           in: query
37786           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37787           required: false
37788           type: string
37789         - name: heat-stack-id
37790           in: query
37791           description: Heat stack id corresponding to this instance, managed by MSO
37792           required: false
37793           type: string
37794         - name: in-maint
37795           in: query
37796           required: false
37797           type: boolean
37798         - name: is-closed-loop-disabled
37799           in: query
37800           required: false
37801           type: boolean
37802         - name: model-invariant-id
37803           in: query
37804           description: the ASDC model id for this resource or service model.
37805           required: false
37806           type: string
37807         - name: model-version-id
37808           in: query
37809           description: the ASDC model version for this resource or service model.
37810           required: false
37811           type: string
37812         - name: widget-model-id
37813           in: query
37814           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37815           required: false
37816           type: string
37817         - name: widget-model-version
37818           in: query
37819           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37820           required: false
37821           type: string
37822         - name: nf-type
37823           in: query
37824           description: Generic description of the type of NF
37825           required: false
37826           type: string
37827         - name: nf-function
37828           in: query
37829           description: English description of Network function that the specific VNF deployment is providing
37830           required: false
37831           type: string
37832         - name: nf-role
37833           in: query
37834           description: role in the network that this model will be providing
37835           required: false
37836           type: string
37837         - name: nf-naming-code
37838           in: query
37839           description: string assigned to this model used for naming purposes
37840           required: false
37841           type: string
37842   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
37843     put:
37844       tags:
37845         - Network
37846       summary: see node definition for valid relationships
37847       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37848       consumes:
37849         - application/json
37850         - application/xml
37851       produces:
37852         - application/json
37853         - application/xml
37854       responses:
37855         "default":
37856           description: Response codes found in [response codes](https://wiki.onap.org/).
37857       parameters:
37858         - name: vnf-id
37859           in: path
37860           description: Unique id of VNF.  This is unique across the graph.
37861           required: true
37862           type: string
37863           example: __VNF-ID__
37864         - name: group-uuid
37865           in: path
37866           description: Unique ID for the license group the resource belongs to, should be uuid.
37867           required: true
37868           type: string
37869           example: __GROUP-UUID__
37870         - name: resource-uuid
37871           in: path
37872           description: Unique ID of a license resource.
37873           required: true
37874           type: string
37875           example: __RESOURCE-UUID__
37876         - name: body
37877           in: body
37878           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
37879           required: true
37880           schema:
37881             $ref: "#/definitions/relationship"
37882     delete:
37883       tags:
37884         - Network
37885       summary: delete an existing relationship
37886       description: delete an existing relationship
37887       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
37888       consumes:
37889         - application/json
37890         - application/xml
37891       produces:
37892         - application/json
37893         - application/xml
37894       responses:
37895         "default":
37896           description: Response codes found in [response codes](https://wiki.onap.org/).
37897       parameters:
37898         - name: vnf-id
37899           in: path
37900           description: Unique id of VNF.  This is unique across the graph.
37901           required: true
37902           type: string
37903           example: __VNF-ID__
37904         - name: group-uuid
37905           in: path
37906           description: Unique ID for the license group the resource belongs to, should be uuid.
37907           required: true
37908           type: string
37909           example: __GROUP-UUID__
37910         - name: resource-uuid
37911           in: path
37912           description: Unique ID of a license resource.
37913           required: true
37914           type: string
37915           example: __RESOURCE-UUID__
37916   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
37917     get:
37918       tags:
37919         - Network
37920       summary: returns license
37921       description: returns license
37922       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
37923       produces:
37924         - application/json
37925         - application/xml
37926       responses:
37927         "200":
37928           description: successful operation
37929           schema:
37930               $ref: "#/getDefinitions/license"
37931         "default":
37932           description: Response codes found in [response codes](https://wiki.onap.org/).
37933       parameters:
37934         - name: vnf-id
37935           in: path
37936           description: Unique id of VNF.  This is unique across the graph.
37937           required: true
37938           type: string
37939           example: __VNF-ID__
37940         - name: group-uuid
37941           in: path
37942           description: Unique ID for the license group the resource belongs to, should be uuid.
37943           required: true
37944           type: string
37945           example: __GROUP-UUID__
37946         - name: resource-uuid
37947           in: path
37948           description: Unique ID of a license resource.
37949           required: true
37950           type: string
37951           example: __RESOURCE-UUID__
37952         - name: vnf-name
37953           in: query
37954           description: Name of VNF.
37955           required: false
37956           type: string
37957         - name: vnf-name2
37958           in: query
37959           description: Alternate name of VNF.
37960           required: false
37961           type: string
37962         - name: vnf-type
37963           in: query
37964           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
37965           required: false
37966           type: string
37967         - name: service-id
37968           in: query
37969           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37970           required: false
37971           type: string
37972         - name: regional-resource-zone
37973           in: query
37974           description: Regional way of organizing pservers, source of truth should define values
37975           required: false
37976           type: string
37977         - name: prov-status
37978           in: query
37979           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37980           required: false
37981           type: string
37982         - name: heat-stack-id
37983           in: query
37984           description: Heat stack id corresponding to this instance, managed by MSO
37985           required: false
37986           type: string
37987         - name: in-maint
37988           in: query
37989           required: false
37990           type: boolean
37991         - name: is-closed-loop-disabled
37992           in: query
37993           required: false
37994           type: boolean
37995         - name: model-invariant-id
37996           in: query
37997           description: the ASDC model id for this resource or service model.
37998           required: false
37999           type: string
38000         - name: model-version-id
38001           in: query
38002           description: the ASDC model version for this resource or service model.
38003           required: false
38004           type: string
38005         - name: widget-model-id
38006           in: query
38007           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38008           required: false
38009           type: string
38010         - name: widget-model-version
38011           in: query
38012           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38013           required: false
38014           type: string
38015         - name: nf-type
38016           in: query
38017           description: Generic description of the type of NF
38018           required: false
38019           type: string
38020         - name: nf-function
38021           in: query
38022           description: English description of Network function that the specific VNF deployment is providing
38023           required: false
38024           type: string
38025         - name: nf-role
38026           in: query
38027           description: role in the network that this model will be providing
38028           required: false
38029           type: string
38030         - name: nf-naming-code
38031           in: query
38032           description: string assigned to this model used for naming purposes
38033           required: false
38034           type: string
38035     put:
38036       tags:
38037         - Network
38038       summary: create or update an existing license
38039       description: |
38040         Create or update an existing license.
38041         #
38042         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38043       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
38044       consumes:
38045         - application/json
38046         - application/xml
38047       produces:
38048         - application/json
38049         - application/xml
38050       responses:
38051         "default":
38052           description: Response codes found in [response codes](https://wiki.onap.org/).
38053       parameters:
38054         - name: vnf-id
38055           in: path
38056           description: Unique id of VNF.  This is unique across the graph.
38057           required: true
38058           type: string
38059           example: __VNF-ID__
38060         - name: group-uuid
38061           in: path
38062           description: Unique ID for the license group the resource belongs to, should be uuid.
38063           required: true
38064           type: string
38065           example: __GROUP-UUID__
38066         - name: resource-uuid
38067           in: path
38068           description: Unique ID of a license resource.
38069           required: true
38070           type: string
38071           example: __RESOURCE-UUID__
38072         - name: body
38073           in: body
38074           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfLicensesLicense.json)
38075           required: true
38076           schema:
38077             $ref: "#/definitions/license"
38078     patch:
38079       tags:
38080         - Network
38081       summary: update an existing license
38082       description: |
38083         Update an existing license
38084         #
38085         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38086         The PUT operation will entirely replace an existing object.
38087         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38088         #
38089         Other differences between PUT and PATCH are:
38090         #
38091         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38092         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38093         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38094       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
38095       consumes:
38096         - application/json
38097         - application/xml
38098       produces:
38099         - application/json
38100         - application/xml
38101       responses:
38102         "default":
38103           description: Response codes found in [response codes](https://wiki.onap.org/).
38104       parameters:
38105         - name: vnf-id
38106           in: path
38107           description: Unique id of VNF.  This is unique across the graph.
38108           required: true
38109           type: string
38110           example: __VNF-ID__
38111         - name: group-uuid
38112           in: path
38113           description: Unique ID for the license group the resource belongs to, should be uuid.
38114           required: true
38115           type: string
38116           example: __GROUP-UUID__
38117         - name: resource-uuid
38118           in: path
38119           description: Unique ID of a license resource.
38120           required: true
38121           type: string
38122           example: __RESOURCE-UUID__
38123         - name: body
38124           in: body
38125           description: license object that needs to be created or updated.
38126           required: true
38127           schema:
38128             $ref: "#/patchDefinitions/license"
38129     delete:
38130       tags:
38131         - Network
38132       summary: delete an existing license
38133       description: delete an existing license
38134       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
38135       consumes:
38136         - application/json
38137         - application/xml
38138       produces:
38139         - application/json
38140         - application/xml
38141       responses:
38142         "default":
38143           description: Response codes found in [response codes](https://wiki.onap.org/).
38144       parameters:
38145         - name: vnf-id
38146           in: path
38147           description: Unique id of VNF.  This is unique across the graph.
38148           required: true
38149           type: string
38150           example: __VNF-ID__
38151         - name: group-uuid
38152           in: path
38153           description: Unique ID for the license group the resource belongs to, should be uuid.
38154           required: true
38155           type: string
38156           example: __GROUP-UUID__
38157         - name: resource-uuid
38158           in: path
38159           description: Unique ID of a license resource.
38160           required: true
38161           type: string
38162           example: __RESOURCE-UUID__
38163         - name: resource-version
38164           in: query
38165           description: resource-version for concurrency
38166           required: true
38167           type: string
38168   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
38169     get:
38170       tags:
38171         - Network
38172       summary: returns licenses
38173       description: returns licenses
38174       operationId: getNetworkGenericVnfsGenericVnfLicenses
38175       produces:
38176         - application/json
38177         - application/xml
38178       responses:
38179         "200":
38180           description: successful operation
38181           schema:
38182               $ref: "#/getDefinitions/licenses"
38183         "default":
38184           description: Response codes found in [response codes](https://wiki.onap.org/).
38185       parameters:
38186         - name: vnf-id
38187           in: path
38188           description: Unique id of VNF.  This is unique across the graph.
38189           required: true
38190           type: string
38191           example: __VNF-ID__
38192         - name: vnf-name
38193           in: query
38194           description: Name of VNF.
38195           required: false
38196           type: string
38197         - name: vnf-name2
38198           in: query
38199           description: Alternate name of VNF.
38200           required: false
38201           type: string
38202         - name: vnf-type
38203           in: query
38204           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38205           required: false
38206           type: string
38207         - name: service-id
38208           in: query
38209           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38210           required: false
38211           type: string
38212         - name: regional-resource-zone
38213           in: query
38214           description: Regional way of organizing pservers, source of truth should define values
38215           required: false
38216           type: string
38217         - name: prov-status
38218           in: query
38219           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38220           required: false
38221           type: string
38222         - name: heat-stack-id
38223           in: query
38224           description: Heat stack id corresponding to this instance, managed by MSO
38225           required: false
38226           type: string
38227         - name: in-maint
38228           in: query
38229           required: false
38230           type: boolean
38231         - name: is-closed-loop-disabled
38232           in: query
38233           required: false
38234           type: boolean
38235         - name: model-invariant-id
38236           in: query
38237           description: the ASDC model id for this resource or service model.
38238           required: false
38239           type: string
38240         - name: model-version-id
38241           in: query
38242           description: the ASDC model version for this resource or service model.
38243           required: false
38244           type: string
38245         - name: widget-model-id
38246           in: query
38247           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38248           required: false
38249           type: string
38250         - name: widget-model-version
38251           in: query
38252           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38253           required: false
38254           type: string
38255         - name: nf-type
38256           in: query
38257           description: Generic description of the type of NF
38258           required: false
38259           type: string
38260         - name: nf-function
38261           in: query
38262           description: English description of Network function that the specific VNF deployment is providing
38263           required: false
38264           type: string
38265         - name: nf-role
38266           in: query
38267           description: role in the network that this model will be providing
38268           required: false
38269           type: string
38270         - name: nf-naming-code
38271           in: query
38272           description: string assigned to this model used for naming purposes
38273           required: false
38274           type: string
38275   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
38276     put:
38277       tags:
38278         - Network
38279       summary: see node definition for valid relationships
38280       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
38281       consumes:
38282         - application/json
38283         - application/xml
38284       produces:
38285         - application/json
38286         - application/xml
38287       responses:
38288         "default":
38289           description: Response codes found in [response codes](https://wiki.onap.org/).
38290       parameters:
38291         - name: vnf-id
38292           in: path
38293           description: Unique id of VNF.  This is unique across the graph.
38294           required: true
38295           type: string
38296           example: __VNF-ID__
38297         - name: group-uuid
38298           in: path
38299           description: Unique ID for the entitlement group the resource comes from, should be uuid.
38300           required: true
38301           type: string
38302           example: __GROUP-UUID__
38303         - name: resource-uuid
38304           in: path
38305           description: Unique ID of an entitlement resource.
38306           required: true
38307           type: string
38308           example: __RESOURCE-UUID__
38309         - name: body
38310           in: body
38311           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
38312           required: true
38313           schema:
38314             $ref: "#/definitions/relationship"
38315     delete:
38316       tags:
38317         - Network
38318       summary: delete an existing relationship
38319       description: delete an existing relationship
38320       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
38321       consumes:
38322         - application/json
38323         - application/xml
38324       produces:
38325         - application/json
38326         - application/xml
38327       responses:
38328         "default":
38329           description: Response codes found in [response codes](https://wiki.onap.org/).
38330       parameters:
38331         - name: vnf-id
38332           in: path
38333           description: Unique id of VNF.  This is unique across the graph.
38334           required: true
38335           type: string
38336           example: __VNF-ID__
38337         - name: group-uuid
38338           in: path
38339           description: Unique ID for the entitlement group the resource comes from, should be uuid.
38340           required: true
38341           type: string
38342           example: __GROUP-UUID__
38343         - name: resource-uuid
38344           in: path
38345           description: Unique ID of an entitlement resource.
38346           required: true
38347           type: string
38348           example: __RESOURCE-UUID__
38349   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
38350     get:
38351       tags:
38352         - Network
38353       summary: returns entitlement
38354       description: returns entitlement
38355       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38356       produces:
38357         - application/json
38358         - application/xml
38359       responses:
38360         "200":
38361           description: successful operation
38362           schema:
38363               $ref: "#/getDefinitions/entitlement"
38364         "default":
38365           description: Response codes found in [response codes](https://wiki.onap.org/).
38366       parameters:
38367         - name: vnf-id
38368           in: path
38369           description: Unique id of VNF.  This is unique across the graph.
38370           required: true
38371           type: string
38372           example: __VNF-ID__
38373         - name: group-uuid
38374           in: path
38375           description: Unique ID for the entitlement group the resource comes from, should be uuid.
38376           required: true
38377           type: string
38378           example: __GROUP-UUID__
38379         - name: resource-uuid
38380           in: path
38381           description: Unique ID of an entitlement resource.
38382           required: true
38383           type: string
38384           example: __RESOURCE-UUID__
38385         - name: vnf-name
38386           in: query
38387           description: Name of VNF.
38388           required: false
38389           type: string
38390         - name: vnf-name2
38391           in: query
38392           description: Alternate name of VNF.
38393           required: false
38394           type: string
38395         - name: vnf-type
38396           in: query
38397           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38398           required: false
38399           type: string
38400         - name: service-id
38401           in: query
38402           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38403           required: false
38404           type: string
38405         - name: regional-resource-zone
38406           in: query
38407           description: Regional way of organizing pservers, source of truth should define values
38408           required: false
38409           type: string
38410         - name: prov-status
38411           in: query
38412           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38413           required: false
38414           type: string
38415         - name: heat-stack-id
38416           in: query
38417           description: Heat stack id corresponding to this instance, managed by MSO
38418           required: false
38419           type: string
38420         - name: in-maint
38421           in: query
38422           required: false
38423           type: boolean
38424         - name: is-closed-loop-disabled
38425           in: query
38426           required: false
38427           type: boolean
38428         - name: model-invariant-id
38429           in: query
38430           description: the ASDC model id for this resource or service model.
38431           required: false
38432           type: string
38433         - name: model-version-id
38434           in: query
38435           description: the ASDC model version for this resource or service model.
38436           required: false
38437           type: string
38438         - name: widget-model-id
38439           in: query
38440           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38441           required: false
38442           type: string
38443         - name: widget-model-version
38444           in: query
38445           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38446           required: false
38447           type: string
38448         - name: nf-type
38449           in: query
38450           description: Generic description of the type of NF
38451           required: false
38452           type: string
38453         - name: nf-function
38454           in: query
38455           description: English description of Network function that the specific VNF deployment is providing
38456           required: false
38457           type: string
38458         - name: nf-role
38459           in: query
38460           description: role in the network that this model will be providing
38461           required: false
38462           type: string
38463         - name: nf-naming-code
38464           in: query
38465           description: string assigned to this model used for naming purposes
38466           required: false
38467           type: string
38468     put:
38469       tags:
38470         - Network
38471       summary: create or update an existing entitlement
38472       description: |
38473         Create or update an existing entitlement.
38474         #
38475         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38476       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38477       consumes:
38478         - application/json
38479         - application/xml
38480       produces:
38481         - application/json
38482         - application/xml
38483       responses:
38484         "default":
38485           description: Response codes found in [response codes](https://wiki.onap.org/).
38486       parameters:
38487         - name: vnf-id
38488           in: path
38489           description: Unique id of VNF.  This is unique across the graph.
38490           required: true
38491           type: string
38492           example: __VNF-ID__
38493         - name: group-uuid
38494           in: path
38495           description: Unique ID for the entitlement group the resource comes from, should be uuid.
38496           required: true
38497           type: string
38498           example: __GROUP-UUID__
38499         - name: resource-uuid
38500           in: path
38501           description: Unique ID of an entitlement resource.
38502           required: true
38503           type: string
38504           example: __RESOURCE-UUID__
38505         - name: body
38506           in: body
38507           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
38508           required: true
38509           schema:
38510             $ref: "#/definitions/entitlement"
38511     patch:
38512       tags:
38513         - Network
38514       summary: update an existing entitlement
38515       description: |
38516         Update an existing entitlement
38517         #
38518         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38519         The PUT operation will entirely replace an existing object.
38520         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38521         #
38522         Other differences between PUT and PATCH are:
38523         #
38524         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38525         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38526         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38527       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38528       consumes:
38529         - application/json
38530         - application/xml
38531       produces:
38532         - application/json
38533         - application/xml
38534       responses:
38535         "default":
38536           description: Response codes found in [response codes](https://wiki.onap.org/).
38537       parameters:
38538         - name: vnf-id
38539           in: path
38540           description: Unique id of VNF.  This is unique across the graph.
38541           required: true
38542           type: string
38543           example: __VNF-ID__
38544         - name: group-uuid
38545           in: path
38546           description: Unique ID for the entitlement group the resource comes from, should be uuid.
38547           required: true
38548           type: string
38549           example: __GROUP-UUID__
38550         - name: resource-uuid
38551           in: path
38552           description: Unique ID of an entitlement resource.
38553           required: true
38554           type: string
38555           example: __RESOURCE-UUID__
38556         - name: body
38557           in: body
38558           description: entitlement object that needs to be created or updated.
38559           required: true
38560           schema:
38561             $ref: "#/patchDefinitions/entitlement"
38562     delete:
38563       tags:
38564         - Network
38565       summary: delete an existing entitlement
38566       description: delete an existing entitlement
38567       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
38568       consumes:
38569         - application/json
38570         - application/xml
38571       produces:
38572         - application/json
38573         - application/xml
38574       responses:
38575         "default":
38576           description: Response codes found in [response codes](https://wiki.onap.org/).
38577       parameters:
38578         - name: vnf-id
38579           in: path
38580           description: Unique id of VNF.  This is unique across the graph.
38581           required: true
38582           type: string
38583           example: __VNF-ID__
38584         - name: group-uuid
38585           in: path
38586           description: Unique ID for the entitlement group the resource comes from, should be uuid.
38587           required: true
38588           type: string
38589           example: __GROUP-UUID__
38590         - name: resource-uuid
38591           in: path
38592           description: Unique ID of an entitlement resource.
38593           required: true
38594           type: string
38595           example: __RESOURCE-UUID__
38596         - name: resource-version
38597           in: query
38598           description: resource-version for concurrency
38599           required: true
38600           type: string
38601   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
38602     get:
38603       tags:
38604         - Network
38605       summary: returns entitlements
38606       description: returns entitlements
38607       operationId: getNetworkGenericVnfsGenericVnfEntitlements
38608       produces:
38609         - application/json
38610         - application/xml
38611       responses:
38612         "200":
38613           description: successful operation
38614           schema:
38615               $ref: "#/getDefinitions/entitlements"
38616         "default":
38617           description: Response codes found in [response codes](https://wiki.onap.org/).
38618       parameters:
38619         - name: vnf-id
38620           in: path
38621           description: Unique id of VNF.  This is unique across the graph.
38622           required: true
38623           type: string
38624           example: __VNF-ID__
38625         - name: vnf-name
38626           in: query
38627           description: Name of VNF.
38628           required: false
38629           type: string
38630         - name: vnf-name2
38631           in: query
38632           description: Alternate name of VNF.
38633           required: false
38634           type: string
38635         - name: vnf-type
38636           in: query
38637           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38638           required: false
38639           type: string
38640         - name: service-id
38641           in: query
38642           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38643           required: false
38644           type: string
38645         - name: regional-resource-zone
38646           in: query
38647           description: Regional way of organizing pservers, source of truth should define values
38648           required: false
38649           type: string
38650         - name: prov-status
38651           in: query
38652           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38653           required: false
38654           type: string
38655         - name: heat-stack-id
38656           in: query
38657           description: Heat stack id corresponding to this instance, managed by MSO
38658           required: false
38659           type: string
38660         - name: in-maint
38661           in: query
38662           required: false
38663           type: boolean
38664         - name: is-closed-loop-disabled
38665           in: query
38666           required: false
38667           type: boolean
38668         - name: model-invariant-id
38669           in: query
38670           description: the ASDC model id for this resource or service model.
38671           required: false
38672           type: string
38673         - name: model-version-id
38674           in: query
38675           description: the ASDC model version for this resource or service model.
38676           required: false
38677           type: string
38678         - name: widget-model-id
38679           in: query
38680           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38681           required: false
38682           type: string
38683         - name: widget-model-version
38684           in: query
38685           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38686           required: false
38687           type: string
38688         - name: nf-type
38689           in: query
38690           description: Generic description of the type of NF
38691           required: false
38692           type: string
38693         - name: nf-function
38694           in: query
38695           description: English description of Network function that the specific VNF deployment is providing
38696           required: false
38697           type: string
38698         - name: nf-role
38699           in: query
38700           description: role in the network that this model will be providing
38701           required: false
38702           type: string
38703         - name: nf-naming-code
38704           in: query
38705           description: string assigned to this model used for naming purposes
38706           required: false
38707           type: string
38708   /network/generic-vnfs/generic-vnf/{vnf-id}:
38709     get:
38710       tags:
38711         - Network
38712       summary: returns generic-vnf
38713       description: returns generic-vnf
38714       operationId: getNetworkGenericVnfsGenericVnf
38715       produces:
38716         - application/json
38717         - application/xml
38718       responses:
38719         "200":
38720           description: successful operation
38721           schema:
38722               $ref: "#/getDefinitions/generic-vnf"
38723         "default":
38724           description: Response codes found in [response codes](https://wiki.onap.org/).
38725       parameters:
38726         - name: vnf-id
38727           in: path
38728           description: Unique id of VNF.  This is unique across the graph.
38729           required: true
38730           type: string
38731           example: __VNF-ID__
38732         - name: vnf-name
38733           in: query
38734           description: Name of VNF.
38735           required: false
38736           type: string
38737         - name: vnf-name2
38738           in: query
38739           description: Alternate name of VNF.
38740           required: false
38741           type: string
38742         - name: vnf-type
38743           in: query
38744           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
38745           required: false
38746           type: string
38747         - name: service-id
38748           in: query
38749           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38750           required: false
38751           type: string
38752         - name: regional-resource-zone
38753           in: query
38754           description: Regional way of organizing pservers, source of truth should define values
38755           required: false
38756           type: string
38757         - name: prov-status
38758           in: query
38759           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38760           required: false
38761           type: string
38762         - name: heat-stack-id
38763           in: query
38764           description: Heat stack id corresponding to this instance, managed by MSO
38765           required: false
38766           type: string
38767         - name: in-maint
38768           in: query
38769           required: false
38770           type: boolean
38771         - name: is-closed-loop-disabled
38772           in: query
38773           required: false
38774           type: boolean
38775         - name: model-invariant-id
38776           in: query
38777           description: the ASDC model id for this resource or service model.
38778           required: false
38779           type: string
38780         - name: model-version-id
38781           in: query
38782           description: the ASDC model version for this resource or service model.
38783           required: false
38784           type: string
38785         - name: widget-model-id
38786           in: query
38787           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38788           required: false
38789           type: string
38790         - name: widget-model-version
38791           in: query
38792           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38793           required: false
38794           type: string
38795         - name: nf-type
38796           in: query
38797           description: Generic description of the type of NF
38798           required: false
38799           type: string
38800         - name: nf-function
38801           in: query
38802           description: English description of Network function that the specific VNF deployment is providing
38803           required: false
38804           type: string
38805         - name: nf-role
38806           in: query
38807           description: role in the network that this model will be providing
38808           required: false
38809           type: string
38810         - name: nf-naming-code
38811           in: query
38812           description: string assigned to this model used for naming purposes
38813           required: false
38814           type: string
38815     put:
38816       tags:
38817         - Network
38818       summary: create or update an existing generic-vnf
38819       description: |
38820         Create or update an existing generic-vnf.
38821         #
38822         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38823       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
38824       consumes:
38825         - application/json
38826         - application/xml
38827       produces:
38828         - application/json
38829         - application/xml
38830       responses:
38831         "default":
38832           description: Response codes found in [response codes](https://wiki.onap.org/).
38833       parameters:
38834         - name: vnf-id
38835           in: path
38836           description: Unique id of VNF.  This is unique across the graph.
38837           required: true
38838           type: string
38839           example: __VNF-ID__
38840         - name: body
38841           in: body
38842           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkGenericVnfsGenericVnf.json)
38843           required: true
38844           schema:
38845             $ref: "#/definitions/generic-vnf"
38846     patch:
38847       tags:
38848         - Network
38849       summary: update an existing generic-vnf
38850       description: |
38851         Update an existing generic-vnf
38852         #
38853         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38854         The PUT operation will entirely replace an existing object.
38855         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38856         #
38857         Other differences between PUT and PATCH are:
38858         #
38859         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38860         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38861         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38862       operationId: UpdateNetworkGenericVnfsGenericVnf
38863       consumes:
38864         - application/json
38865         - application/xml
38866       produces:
38867         - application/json
38868         - application/xml
38869       responses:
38870         "default":
38871           description: Response codes found in [response codes](https://wiki.onap.org/).
38872       parameters:
38873         - name: vnf-id
38874           in: path
38875           description: Unique id of VNF.  This is unique across the graph.
38876           required: true
38877           type: string
38878           example: __VNF-ID__
38879         - name: body
38880           in: body
38881           description: generic-vnf object that needs to be created or updated.
38882           required: true
38883           schema:
38884             $ref: "#/patchDefinitions/generic-vnf"
38885     delete:
38886       tags:
38887         - Network
38888       summary: delete an existing generic-vnf
38889       description: delete an existing generic-vnf
38890       operationId: deleteNetworkGenericVnfsGenericVnf
38891       consumes:
38892         - application/json
38893         - application/xml
38894       produces:
38895         - application/json
38896         - application/xml
38897       responses:
38898         "default":
38899           description: Response codes found in [response codes](https://wiki.onap.org/).
38900       parameters:
38901         - name: vnf-id
38902           in: path
38903           description: Unique id of VNF.  This is unique across the graph.
38904           required: true
38905           type: string
38906           example: __VNF-ID__
38907         - name: resource-version
38908           in: query
38909           description: resource-version for concurrency
38910           required: true
38911           type: string
38912   /network/generic-vnfs:
38913     get:
38914       tags:
38915         - Network
38916       summary: returns generic-vnfs
38917       description: returns generic-vnfs
38918       operationId: getNetworkGenericVnfs
38919       produces:
38920         - application/json
38921         - application/xml
38922       responses:
38923         "200":
38924           description: successful operation
38925           schema:
38926               $ref: "#/getDefinitions/generic-vnfs"
38927         "default":
38928           description: Response codes found in [response codes](https://wiki.onap.org/).
38929   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
38930     put:
38931       tags:
38932         - Network
38933       summary: see node definition for valid relationships
38934       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
38935       consumes:
38936         - application/json
38937         - application/xml
38938       produces:
38939         - application/json
38940         - application/xml
38941       responses:
38942         "default":
38943           description: Response codes found in [response codes](https://wiki.onap.org/).
38944       parameters:
38945         - name: link-name
38946           in: path
38947           description: Alphabetical concatenation of lag-interface names
38948           required: true
38949           type: string
38950           example: __LINK-NAME__
38951         - name: body
38952           in: body
38953           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
38954           required: true
38955           schema:
38956             $ref: "#/definitions/relationship"
38957     delete:
38958       tags:
38959         - Network
38960       summary: delete an existing relationship
38961       description: delete an existing relationship
38962       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
38963       consumes:
38964         - application/json
38965         - application/xml
38966       produces:
38967         - application/json
38968         - application/xml
38969       responses:
38970         "default":
38971           description: Response codes found in [response codes](https://wiki.onap.org/).
38972       parameters:
38973         - name: link-name
38974           in: path
38975           description: Alphabetical concatenation of lag-interface names
38976           required: true
38977           type: string
38978           example: __LINK-NAME__
38979   /network/lag-links/lag-link/{link-name}:
38980     get:
38981       tags:
38982         - Network
38983       summary: returns lag-link
38984       description: returns lag-link
38985       operationId: getNetworkLagLinksLagLink
38986       produces:
38987         - application/json
38988         - application/xml
38989       responses:
38990         "200":
38991           description: successful operation
38992           schema:
38993               $ref: "#/getDefinitions/lag-link"
38994         "default":
38995           description: Response codes found in [response codes](https://wiki.onap.org/).
38996       parameters:
38997         - name: link-name
38998           in: path
38999           description: Alphabetical concatenation of lag-interface names
39000           required: true
39001           type: string
39002           example: __LINK-NAME__
39003     put:
39004       tags:
39005         - Network
39006       summary: create or update an existing lag-link
39007       description: |
39008         Create or update an existing lag-link.
39009         #
39010         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39011       operationId: createOrUpdateNetworkLagLinksLagLink
39012       consumes:
39013         - application/json
39014         - application/xml
39015       produces:
39016         - application/json
39017         - application/xml
39018       responses:
39019         "default":
39020           description: Response codes found in [response codes](https://wiki.onap.org/).
39021       parameters:
39022         - name: link-name
39023           in: path
39024           description: Alphabetical concatenation of lag-interface names
39025           required: true
39026           type: string
39027           example: __LINK-NAME__
39028         - name: body
39029           in: body
39030           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkLagLinksLagLink.json)
39031           required: true
39032           schema:
39033             $ref: "#/definitions/lag-link"
39034     patch:
39035       tags:
39036         - Network
39037       summary: update an existing lag-link
39038       description: |
39039         Update an existing lag-link
39040         #
39041         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39042         The PUT operation will entirely replace an existing object.
39043         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39044         #
39045         Other differences between PUT and PATCH are:
39046         #
39047         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39048         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39049         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39050       operationId: UpdateNetworkLagLinksLagLink
39051       consumes:
39052         - application/json
39053         - application/xml
39054       produces:
39055         - application/json
39056         - application/xml
39057       responses:
39058         "default":
39059           description: Response codes found in [response codes](https://wiki.onap.org/).
39060       parameters:
39061         - name: link-name
39062           in: path
39063           description: Alphabetical concatenation of lag-interface names
39064           required: true
39065           type: string
39066           example: __LINK-NAME__
39067         - name: body
39068           in: body
39069           description: lag-link object that needs to be created or updated.
39070           required: true
39071           schema:
39072             $ref: "#/patchDefinitions/lag-link"
39073     delete:
39074       tags:
39075         - Network
39076       summary: delete an existing lag-link
39077       description: delete an existing lag-link
39078       operationId: deleteNetworkLagLinksLagLink
39079       consumes:
39080         - application/json
39081         - application/xml
39082       produces:
39083         - application/json
39084         - application/xml
39085       responses:
39086         "default":
39087           description: Response codes found in [response codes](https://wiki.onap.org/).
39088       parameters:
39089         - name: link-name
39090           in: path
39091           description: Alphabetical concatenation of lag-interface names
39092           required: true
39093           type: string
39094           example: __LINK-NAME__
39095         - name: resource-version
39096           in: query
39097           description: resource-version for concurrency
39098           required: true
39099           type: string
39100   /network/lag-links:
39101     get:
39102       tags:
39103         - Network
39104       summary: returns lag-links
39105       description: returns lag-links
39106       operationId: getNetworkLagLinks
39107       produces:
39108         - application/json
39109         - application/xml
39110       responses:
39111         "200":
39112           description: successful operation
39113           schema:
39114               $ref: "#/getDefinitions/lag-links"
39115         "default":
39116           description: Response codes found in [response codes](https://wiki.onap.org/).
39117   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
39118     put:
39119       tags:
39120         - Network
39121       summary: see node definition for valid relationships
39122       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
39123       consumes:
39124         - application/json
39125         - application/xml
39126       produces:
39127         - application/json
39128         - application/xml
39129       responses:
39130         "default":
39131           description: Response codes found in [response codes](https://wiki.onap.org/).
39132       parameters:
39133         - name: vnf-id2
39134           in: path
39135           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39136           required: true
39137           type: string
39138           example: __VNF-ID2__
39139         - name: body
39140           in: body
39141           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
39142           required: true
39143           schema:
39144             $ref: "#/definitions/relationship"
39145     delete:
39146       tags:
39147         - Network
39148       summary: delete an existing relationship
39149       description: delete an existing relationship
39150       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
39151       consumes:
39152         - application/json
39153         - application/xml
39154       produces:
39155         - application/json
39156         - application/xml
39157       responses:
39158         "default":
39159           description: Response codes found in [response codes](https://wiki.onap.org/).
39160       parameters:
39161         - name: vnf-id2
39162           in: path
39163           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39164           required: true
39165           type: string
39166           example: __VNF-ID2__
39167   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
39168     put:
39169       tags:
39170         - Network
39171       summary: see node definition for valid relationships
39172       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39173       consumes:
39174         - application/json
39175         - application/xml
39176       produces:
39177         - application/json
39178         - application/xml
39179       responses:
39180         "default":
39181           description: Response codes found in [response codes](https://wiki.onap.org/).
39182       parameters:
39183         - name: vnf-id2
39184           in: path
39185           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39186           required: true
39187           type: string
39188           example: __VNF-ID2__
39189         - name: interface-name
39190           in: path
39191           description: Name given to the interface
39192           required: true
39193           type: string
39194           example: __INTERFACE-NAME__
39195         - name: vlan-interface
39196           in: path
39197           description: String that identifies the interface
39198           required: true
39199           type: string
39200           example: __VLAN-INTERFACE__
39201         - name: body
39202           in: body
39203           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
39204           required: true
39205           schema:
39206             $ref: "#/definitions/relationship"
39207     delete:
39208       tags:
39209         - Network
39210       summary: delete an existing relationship
39211       description: delete an existing relationship
39212       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
39213       consumes:
39214         - application/json
39215         - application/xml
39216       produces:
39217         - application/json
39218         - application/xml
39219       responses:
39220         "default":
39221           description: Response codes found in [response codes](https://wiki.onap.org/).
39222       parameters:
39223         - name: vnf-id2
39224           in: path
39225           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39226           required: true
39227           type: string
39228           example: __VNF-ID2__
39229         - name: interface-name
39230           in: path
39231           description: Name given to the interface
39232           required: true
39233           type: string
39234           example: __INTERFACE-NAME__
39235         - name: vlan-interface
39236           in: path
39237           description: String that identifies the interface
39238           required: true
39239           type: string
39240           example: __VLAN-INTERFACE__
39241   /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:
39242     put:
39243       tags:
39244         - Network
39245       summary: see node definition for valid relationships
39246       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39247       consumes:
39248         - application/json
39249         - application/xml
39250       produces:
39251         - application/json
39252         - application/xml
39253       responses:
39254         "default":
39255           description: Response codes found in [response codes](https://wiki.onap.org/).
39256       parameters:
39257         - name: vnf-id2
39258           in: path
39259           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39260           required: true
39261           type: string
39262           example: __VNF-ID2__
39263         - name: interface-name
39264           in: path
39265           description: Name given to the interface
39266           required: true
39267           type: string
39268           example: __INTERFACE-NAME__
39269         - name: vlan-interface
39270           in: path
39271           description: String that identifies the interface
39272           required: true
39273           type: string
39274           example: __VLAN-INTERFACE__
39275         - name: l3-interface-ipv4-address
39276           in: path
39277           description: IP address
39278           required: true
39279           type: string
39280           example: __L3-INTERFACE-IPV4-ADDRESS__
39281         - name: body
39282           in: body
39283           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39284           required: true
39285           schema:
39286             $ref: "#/definitions/relationship"
39287     delete:
39288       tags:
39289         - Network
39290       summary: delete an existing relationship
39291       description: delete an existing relationship
39292       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
39293       consumes:
39294         - application/json
39295         - application/xml
39296       produces:
39297         - application/json
39298         - application/xml
39299       responses:
39300         "default":
39301           description: Response codes found in [response codes](https://wiki.onap.org/).
39302       parameters:
39303         - name: vnf-id2
39304           in: path
39305           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39306           required: true
39307           type: string
39308           example: __VNF-ID2__
39309         - name: interface-name
39310           in: path
39311           description: Name given to the interface
39312           required: true
39313           type: string
39314           example: __INTERFACE-NAME__
39315         - name: vlan-interface
39316           in: path
39317           description: String that identifies the interface
39318           required: true
39319           type: string
39320           example: __VLAN-INTERFACE__
39321         - name: l3-interface-ipv4-address
39322           in: path
39323           description: IP address
39324           required: true
39325           type: string
39326           example: __L3-INTERFACE-IPV4-ADDRESS__
39327   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
39328     get:
39329       tags:
39330         - Network
39331       summary: returns l3-interface-ipv4-address-list
39332       description: returns l3-interface-ipv4-address-list
39333       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39334       produces:
39335         - application/json
39336         - application/xml
39337       responses:
39338         "200":
39339           description: successful operation
39340           schema:
39341               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39342         "default":
39343           description: Response codes found in [response codes](https://wiki.onap.org/).
39344       parameters:
39345         - name: vnf-id2
39346           in: path
39347           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39348           required: true
39349           type: string
39350           example: __VNF-ID2__
39351         - name: interface-name
39352           in: path
39353           description: Name given to the interface
39354           required: true
39355           type: string
39356           example: __INTERFACE-NAME__
39357         - name: vlan-interface
39358           in: path
39359           description: String that identifies the interface
39360           required: true
39361           type: string
39362           example: __VLAN-INTERFACE__
39363         - name: l3-interface-ipv4-address
39364           in: path
39365           description: IP address
39366           required: true
39367           type: string
39368           example: __L3-INTERFACE-IPV4-ADDRESS__
39369         - name: vnf-name
39370           in: query
39371           description: Name of VNF.
39372           required: false
39373           type: string
39374         - name: vnf-name2
39375           in: query
39376           description: Alternate name of VNF.
39377           required: false
39378           type: string
39379         - name: vnf-type
39380           in: query
39381           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39382           required: false
39383           type: string
39384         - name: prov-status
39385           in: query
39386           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39387           required: false
39388           type: string
39389         - name: heat-stack-id
39390           in: query
39391           description: Heat stack id corresponding to this instance, managed by MSO
39392           required: false
39393           type: string
39394         - name: interface-id
39395           in: query
39396           description: ID of interface
39397           required: false
39398           type: string
39399         - name: macaddr
39400           in: query
39401           description: MAC address for the interface
39402           required: false
39403           type: string
39404         - name: network-name
39405           in: query
39406           description: Name of the network
39407           required: false
39408           type: string
39409         - name: vlan-id-inner
39410           in: query
39411           description: Inner VLAN tag
39412           required: false
39413           type: integer
39414           format: int64
39415         - name: vpn-id
39416           in: query
39417           description: This indicates the customers VPN ID associated with this vlan
39418           required: false
39419           type: string
39420         - name: vlan-id-inner
39421           in: query
39422           description: Inner VLAN tag
39423           required: false
39424           type: integer
39425           format: int64
39426         - name: neutron-network-id
39427           in: query
39428           description: Neutron network id of the interface that address belongs to
39429           required: false
39430           type: string
39431         - name: neutron-subnet-id
39432           in: query
39433           description: Neutron id of subnet that address belongs to
39434           required: false
39435           type: string
39436     put:
39437       tags:
39438         - Network
39439       summary: create or update an existing l3-interface-ipv4-address-list
39440       description: |
39441         Create or update an existing l3-interface-ipv4-address-list.
39442         #
39443         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39444       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39445       consumes:
39446         - application/json
39447         - application/xml
39448       produces:
39449         - application/json
39450         - application/xml
39451       responses:
39452         "default":
39453           description: Response codes found in [response codes](https://wiki.onap.org/).
39454       parameters:
39455         - name: vnf-id2
39456           in: path
39457           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39458           required: true
39459           type: string
39460           example: __VNF-ID2__
39461         - name: interface-name
39462           in: path
39463           description: Name given to the interface
39464           required: true
39465           type: string
39466           example: __INTERFACE-NAME__
39467         - name: vlan-interface
39468           in: path
39469           description: String that identifies the interface
39470           required: true
39471           type: string
39472           example: __VLAN-INTERFACE__
39473         - name: l3-interface-ipv4-address
39474           in: path
39475           description: IP address
39476           required: true
39477           type: string
39478           example: __L3-INTERFACE-IPV4-ADDRESS__
39479         - name: body
39480           in: body
39481           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
39482           required: true
39483           schema:
39484             $ref: "#/definitions/l3-interface-ipv4-address-list"
39485     patch:
39486       tags:
39487         - Network
39488       summary: update an existing l3-interface-ipv4-address-list
39489       description: |
39490         Update an existing l3-interface-ipv4-address-list
39491         #
39492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39493         The PUT operation will entirely replace an existing object.
39494         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39495         #
39496         Other differences between PUT and PATCH are:
39497         #
39498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39501       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39502       consumes:
39503         - application/json
39504         - application/xml
39505       produces:
39506         - application/json
39507         - application/xml
39508       responses:
39509         "default":
39510           description: Response codes found in [response codes](https://wiki.onap.org/).
39511       parameters:
39512         - name: vnf-id2
39513           in: path
39514           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39515           required: true
39516           type: string
39517           example: __VNF-ID2__
39518         - name: interface-name
39519           in: path
39520           description: Name given to the interface
39521           required: true
39522           type: string
39523           example: __INTERFACE-NAME__
39524         - name: vlan-interface
39525           in: path
39526           description: String that identifies the interface
39527           required: true
39528           type: string
39529           example: __VLAN-INTERFACE__
39530         - name: l3-interface-ipv4-address
39531           in: path
39532           description: IP address
39533           required: true
39534           type: string
39535           example: __L3-INTERFACE-IPV4-ADDRESS__
39536         - name: body
39537           in: body
39538           description: l3-interface-ipv4-address-list object that needs to be created or updated.
39539           required: true
39540           schema:
39541             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39542     delete:
39543       tags:
39544         - Network
39545       summary: delete an existing l3-interface-ipv4-address-list
39546       description: delete an existing l3-interface-ipv4-address-list
39547       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
39548       consumes:
39549         - application/json
39550         - application/xml
39551       produces:
39552         - application/json
39553         - application/xml
39554       responses:
39555         "default":
39556           description: Response codes found in [response codes](https://wiki.onap.org/).
39557       parameters:
39558         - name: vnf-id2
39559           in: path
39560           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39561           required: true
39562           type: string
39563           example: __VNF-ID2__
39564         - name: interface-name
39565           in: path
39566           description: Name given to the interface
39567           required: true
39568           type: string
39569           example: __INTERFACE-NAME__
39570         - name: vlan-interface
39571           in: path
39572           description: String that identifies the interface
39573           required: true
39574           type: string
39575           example: __VLAN-INTERFACE__
39576         - name: l3-interface-ipv4-address
39577           in: path
39578           description: IP address
39579           required: true
39580           type: string
39581           example: __L3-INTERFACE-IPV4-ADDRESS__
39582         - name: resource-version
39583           in: query
39584           description: resource-version for concurrency
39585           required: true
39586           type: string
39587   /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:
39588     put:
39589       tags:
39590         - Network
39591       summary: see node definition for valid relationships
39592       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39593       consumes:
39594         - application/json
39595         - application/xml
39596       produces:
39597         - application/json
39598         - application/xml
39599       responses:
39600         "default":
39601           description: Response codes found in [response codes](https://wiki.onap.org/).
39602       parameters:
39603         - name: vnf-id2
39604           in: path
39605           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39606           required: true
39607           type: string
39608           example: __VNF-ID2__
39609         - name: interface-name
39610           in: path
39611           description: Name given to the interface
39612           required: true
39613           type: string
39614           example: __INTERFACE-NAME__
39615         - name: vlan-interface
39616           in: path
39617           description: String that identifies the interface
39618           required: true
39619           type: string
39620           example: __VLAN-INTERFACE__
39621         - name: l3-interface-ipv6-address
39622           in: path
39623           description: IP address
39624           required: true
39625           type: string
39626           example: __L3-INTERFACE-IPV6-ADDRESS__
39627         - name: body
39628           in: body
39629           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39630           required: true
39631           schema:
39632             $ref: "#/definitions/relationship"
39633     delete:
39634       tags:
39635         - Network
39636       summary: delete an existing relationship
39637       description: delete an existing relationship
39638       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
39639       consumes:
39640         - application/json
39641         - application/xml
39642       produces:
39643         - application/json
39644         - application/xml
39645       responses:
39646         "default":
39647           description: Response codes found in [response codes](https://wiki.onap.org/).
39648       parameters:
39649         - name: vnf-id2
39650           in: path
39651           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39652           required: true
39653           type: string
39654           example: __VNF-ID2__
39655         - name: interface-name
39656           in: path
39657           description: Name given to the interface
39658           required: true
39659           type: string
39660           example: __INTERFACE-NAME__
39661         - name: vlan-interface
39662           in: path
39663           description: String that identifies the interface
39664           required: true
39665           type: string
39666           example: __VLAN-INTERFACE__
39667         - name: l3-interface-ipv6-address
39668           in: path
39669           description: IP address
39670           required: true
39671           type: string
39672           example: __L3-INTERFACE-IPV6-ADDRESS__
39673   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
39674     get:
39675       tags:
39676         - Network
39677       summary: returns l3-interface-ipv6-address-list
39678       description: returns l3-interface-ipv6-address-list
39679       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39680       produces:
39681         - application/json
39682         - application/xml
39683       responses:
39684         "200":
39685           description: successful operation
39686           schema:
39687               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39688         "default":
39689           description: Response codes found in [response codes](https://wiki.onap.org/).
39690       parameters:
39691         - name: vnf-id2
39692           in: path
39693           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39694           required: true
39695           type: string
39696           example: __VNF-ID2__
39697         - name: interface-name
39698           in: path
39699           description: Name given to the interface
39700           required: true
39701           type: string
39702           example: __INTERFACE-NAME__
39703         - name: vlan-interface
39704           in: path
39705           description: String that identifies the interface
39706           required: true
39707           type: string
39708           example: __VLAN-INTERFACE__
39709         - name: l3-interface-ipv6-address
39710           in: path
39711           description: IP address
39712           required: true
39713           type: string
39714           example: __L3-INTERFACE-IPV6-ADDRESS__
39715         - name: vnf-name
39716           in: query
39717           description: Name of VNF.
39718           required: false
39719           type: string
39720         - name: vnf-name2
39721           in: query
39722           description: Alternate name of VNF.
39723           required: false
39724           type: string
39725         - name: vnf-type
39726           in: query
39727           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39728           required: false
39729           type: string
39730         - name: prov-status
39731           in: query
39732           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39733           required: false
39734           type: string
39735         - name: heat-stack-id
39736           in: query
39737           description: Heat stack id corresponding to this instance, managed by MSO
39738           required: false
39739           type: string
39740         - name: interface-id
39741           in: query
39742           description: ID of interface
39743           required: false
39744           type: string
39745         - name: macaddr
39746           in: query
39747           description: MAC address for the interface
39748           required: false
39749           type: string
39750         - name: network-name
39751           in: query
39752           description: Name of the network
39753           required: false
39754           type: string
39755         - name: vlan-id-inner
39756           in: query
39757           description: Inner VLAN tag
39758           required: false
39759           type: integer
39760           format: int64
39761         - name: vpn-id
39762           in: query
39763           description: This indicates the customers VPN ID associated with this vlan
39764           required: false
39765           type: string
39766         - name: vlan-id-inner
39767           in: query
39768           description: Inner VLAN tag
39769           required: false
39770           type: integer
39771           format: int64
39772         - name: neutron-network-id
39773           in: query
39774           description: Neutron network id of the interface that address belongs to
39775           required: false
39776           type: string
39777         - name: neutron-subnet-id
39778           in: query
39779           description: Neutron id of subnet that address belongs to
39780           required: false
39781           type: string
39782     put:
39783       tags:
39784         - Network
39785       summary: create or update an existing l3-interface-ipv6-address-list
39786       description: |
39787         Create or update an existing l3-interface-ipv6-address-list.
39788         #
39789         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39790       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39791       consumes:
39792         - application/json
39793         - application/xml
39794       produces:
39795         - application/json
39796         - application/xml
39797       responses:
39798         "default":
39799           description: Response codes found in [response codes](https://wiki.onap.org/).
39800       parameters:
39801         - name: vnf-id2
39802           in: path
39803           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39804           required: true
39805           type: string
39806           example: __VNF-ID2__
39807         - name: interface-name
39808           in: path
39809           description: Name given to the interface
39810           required: true
39811           type: string
39812           example: __INTERFACE-NAME__
39813         - name: vlan-interface
39814           in: path
39815           description: String that identifies the interface
39816           required: true
39817           type: string
39818           example: __VLAN-INTERFACE__
39819         - name: l3-interface-ipv6-address
39820           in: path
39821           description: IP address
39822           required: true
39823           type: string
39824           example: __L3-INTERFACE-IPV6-ADDRESS__
39825         - name: body
39826           in: body
39827           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
39828           required: true
39829           schema:
39830             $ref: "#/definitions/l3-interface-ipv6-address-list"
39831     patch:
39832       tags:
39833         - Network
39834       summary: update an existing l3-interface-ipv6-address-list
39835       description: |
39836         Update an existing l3-interface-ipv6-address-list
39837         #
39838         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39839         The PUT operation will entirely replace an existing object.
39840         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39841         #
39842         Other differences between PUT and PATCH are:
39843         #
39844         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39845         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39846         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39847       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39848       consumes:
39849         - application/json
39850         - application/xml
39851       produces:
39852         - application/json
39853         - application/xml
39854       responses:
39855         "default":
39856           description: Response codes found in [response codes](https://wiki.onap.org/).
39857       parameters:
39858         - name: vnf-id2
39859           in: path
39860           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39861           required: true
39862           type: string
39863           example: __VNF-ID2__
39864         - name: interface-name
39865           in: path
39866           description: Name given to the interface
39867           required: true
39868           type: string
39869           example: __INTERFACE-NAME__
39870         - name: vlan-interface
39871           in: path
39872           description: String that identifies the interface
39873           required: true
39874           type: string
39875           example: __VLAN-INTERFACE__
39876         - name: l3-interface-ipv6-address
39877           in: path
39878           description: IP address
39879           required: true
39880           type: string
39881           example: __L3-INTERFACE-IPV6-ADDRESS__
39882         - name: body
39883           in: body
39884           description: l3-interface-ipv6-address-list object that needs to be created or updated.
39885           required: true
39886           schema:
39887             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39888     delete:
39889       tags:
39890         - Network
39891       summary: delete an existing l3-interface-ipv6-address-list
39892       description: delete an existing l3-interface-ipv6-address-list
39893       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
39894       consumes:
39895         - application/json
39896         - application/xml
39897       produces:
39898         - application/json
39899         - application/xml
39900       responses:
39901         "default":
39902           description: Response codes found in [response codes](https://wiki.onap.org/).
39903       parameters:
39904         - name: vnf-id2
39905           in: path
39906           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39907           required: true
39908           type: string
39909           example: __VNF-ID2__
39910         - name: interface-name
39911           in: path
39912           description: Name given to the interface
39913           required: true
39914           type: string
39915           example: __INTERFACE-NAME__
39916         - name: vlan-interface
39917           in: path
39918           description: String that identifies the interface
39919           required: true
39920           type: string
39921           example: __VLAN-INTERFACE__
39922         - name: l3-interface-ipv6-address
39923           in: path
39924           description: IP address
39925           required: true
39926           type: string
39927           example: __L3-INTERFACE-IPV6-ADDRESS__
39928         - name: resource-version
39929           in: query
39930           description: resource-version for concurrency
39931           required: true
39932           type: string
39933   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
39934     get:
39935       tags:
39936         - Network
39937       summary: returns vlan
39938       description: returns vlan
39939       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
39940       produces:
39941         - application/json
39942         - application/xml
39943       responses:
39944         "200":
39945           description: successful operation
39946           schema:
39947               $ref: "#/getDefinitions/vlan"
39948         "default":
39949           description: Response codes found in [response codes](https://wiki.onap.org/).
39950       parameters:
39951         - name: vnf-id2
39952           in: path
39953           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
39954           required: true
39955           type: string
39956           example: __VNF-ID2__
39957         - name: interface-name
39958           in: path
39959           description: Name given to the interface
39960           required: true
39961           type: string
39962           example: __INTERFACE-NAME__
39963         - name: vlan-interface
39964           in: path
39965           description: String that identifies the interface
39966           required: true
39967           type: string
39968           example: __VLAN-INTERFACE__
39969         - name: vnf-name
39970           in: query
39971           description: Name of VNF.
39972           required: false
39973           type: string
39974         - name: vnf-name2
39975           in: query
39976           description: Alternate name of VNF.
39977           required: false
39978           type: string
39979         - name: vnf-type
39980           in: query
39981           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
39982           required: false
39983           type: string
39984         - name: prov-status
39985           in: query
39986           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
39987           required: false
39988           type: string
39989         - name: heat-stack-id
39990           in: query
39991           description: Heat stack id corresponding to this instance, managed by MSO
39992           required: false
39993           type: string
39994         - name: interface-id
39995           in: query
39996           description: ID of interface
39997           required: false
39998           type: string
39999         - name: macaddr
40000           in: query
40001           description: MAC address for the interface
40002           required: false
40003           type: string
40004         - name: network-name
40005           in: query
40006           description: Name of the network
40007           required: false
40008           type: string
40009         - name: vlan-id-inner
40010           in: query
40011           description: Inner VLAN tag
40012           required: false
40013           type: integer
40014           format: int64
40015         - name: vpn-id
40016           in: query
40017           description: This indicates the customers VPN ID associated with this vlan
40018           required: false
40019           type: string
40020     put:
40021       tags:
40022         - Network
40023       summary: create or update an existing vlan
40024       description: |
40025         Create or update an existing vlan.
40026         #
40027         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40028       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
40029       consumes:
40030         - application/json
40031         - application/xml
40032       produces:
40033         - application/json
40034         - application/xml
40035       responses:
40036         "default":
40037           description: Response codes found in [response codes](https://wiki.onap.org/).
40038       parameters:
40039         - name: vnf-id2
40040           in: path
40041           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40042           required: true
40043           type: string
40044           example: __VNF-ID2__
40045         - name: interface-name
40046           in: path
40047           description: Name given to the interface
40048           required: true
40049           type: string
40050           example: __INTERFACE-NAME__
40051         - name: vlan-interface
40052           in: path
40053           description: String that identifies the interface
40054           required: true
40055           type: string
40056           example: __VLAN-INTERFACE__
40057         - name: body
40058           in: body
40059           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
40060           required: true
40061           schema:
40062             $ref: "#/definitions/vlan"
40063     patch:
40064       tags:
40065         - Network
40066       summary: update an existing vlan
40067       description: |
40068         Update an existing vlan
40069         #
40070         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40071         The PUT operation will entirely replace an existing object.
40072         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40073         #
40074         Other differences between PUT and PATCH are:
40075         #
40076         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40077         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40078         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40079       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
40080       consumes:
40081         - application/json
40082         - application/xml
40083       produces:
40084         - application/json
40085         - application/xml
40086       responses:
40087         "default":
40088           description: Response codes found in [response codes](https://wiki.onap.org/).
40089       parameters:
40090         - name: vnf-id2
40091           in: path
40092           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40093           required: true
40094           type: string
40095           example: __VNF-ID2__
40096         - name: interface-name
40097           in: path
40098           description: Name given to the interface
40099           required: true
40100           type: string
40101           example: __INTERFACE-NAME__
40102         - name: vlan-interface
40103           in: path
40104           description: String that identifies the interface
40105           required: true
40106           type: string
40107           example: __VLAN-INTERFACE__
40108         - name: body
40109           in: body
40110           description: vlan object that needs to be created or updated.
40111           required: true
40112           schema:
40113             $ref: "#/patchDefinitions/vlan"
40114     delete:
40115       tags:
40116         - Network
40117       summary: delete an existing vlan
40118       description: delete an existing vlan
40119       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
40120       consumes:
40121         - application/json
40122         - application/xml
40123       produces:
40124         - application/json
40125         - application/xml
40126       responses:
40127         "default":
40128           description: Response codes found in [response codes](https://wiki.onap.org/).
40129       parameters:
40130         - name: vnf-id2
40131           in: path
40132           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40133           required: true
40134           type: string
40135           example: __VNF-ID2__
40136         - name: interface-name
40137           in: path
40138           description: Name given to the interface
40139           required: true
40140           type: string
40141           example: __INTERFACE-NAME__
40142         - name: vlan-interface
40143           in: path
40144           description: String that identifies the interface
40145           required: true
40146           type: string
40147           example: __VLAN-INTERFACE__
40148         - name: resource-version
40149           in: query
40150           description: resource-version for concurrency
40151           required: true
40152           type: string
40153   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
40154     get:
40155       tags:
40156         - Network
40157       summary: returns vlans
40158       description: returns vlans
40159       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
40160       produces:
40161         - application/json
40162         - application/xml
40163       responses:
40164         "200":
40165           description: successful operation
40166           schema:
40167               $ref: "#/getDefinitions/vlans"
40168         "default":
40169           description: Response codes found in [response codes](https://wiki.onap.org/).
40170       parameters:
40171         - name: vnf-id2
40172           in: path
40173           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40174           required: true
40175           type: string
40176           example: __VNF-ID2__
40177         - name: interface-name
40178           in: path
40179           description: Name given to the interface
40180           required: true
40181           type: string
40182           example: __INTERFACE-NAME__
40183         - name: vnf-name
40184           in: query
40185           description: Name of VNF.
40186           required: false
40187           type: string
40188         - name: vnf-name2
40189           in: query
40190           description: Alternate name of VNF.
40191           required: false
40192           type: string
40193         - name: vnf-type
40194           in: query
40195           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40196           required: false
40197           type: string
40198         - name: prov-status
40199           in: query
40200           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40201           required: false
40202           type: string
40203         - name: heat-stack-id
40204           in: query
40205           description: Heat stack id corresponding to this instance, managed by MSO
40206           required: false
40207           type: string
40208         - name: interface-id
40209           in: query
40210           description: ID of interface
40211           required: false
40212           type: string
40213         - name: macaddr
40214           in: query
40215           description: MAC address for the interface
40216           required: false
40217           type: string
40218         - name: network-name
40219           in: query
40220           description: Name of the network
40221           required: false
40222           type: string
40223   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
40224     put:
40225       tags:
40226         - Network
40227       summary: see node definition for valid relationships
40228       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40229       consumes:
40230         - application/json
40231         - application/xml
40232       produces:
40233         - application/json
40234         - application/xml
40235       responses:
40236         "default":
40237           description: Response codes found in [response codes](https://wiki.onap.org/).
40238       parameters:
40239         - name: vnf-id2
40240           in: path
40241           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40242           required: true
40243           type: string
40244           example: __VNF-ID2__
40245         - name: interface-name
40246           in: path
40247           description: Name given to the interface
40248           required: true
40249           type: string
40250           example: __INTERFACE-NAME__
40251         - name: pci-id
40252           in: path
40253           description: PCI ID used to identify the sriov-vf
40254           required: true
40255           type: string
40256           example: __PCI-ID__
40257         - name: body
40258           in: body
40259           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
40260           required: true
40261           schema:
40262             $ref: "#/definitions/relationship"
40263     delete:
40264       tags:
40265         - Network
40266       summary: delete an existing relationship
40267       description: delete an existing relationship
40268       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
40269       consumes:
40270         - application/json
40271         - application/xml
40272       produces:
40273         - application/json
40274         - application/xml
40275       responses:
40276         "default":
40277           description: Response codes found in [response codes](https://wiki.onap.org/).
40278       parameters:
40279         - name: vnf-id2
40280           in: path
40281           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40282           required: true
40283           type: string
40284           example: __VNF-ID2__
40285         - name: interface-name
40286           in: path
40287           description: Name given to the interface
40288           required: true
40289           type: string
40290           example: __INTERFACE-NAME__
40291         - name: pci-id
40292           in: path
40293           description: PCI ID used to identify the sriov-vf
40294           required: true
40295           type: string
40296           example: __PCI-ID__
40297   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
40298     get:
40299       tags:
40300         - Network
40301       summary: returns sriov-vf
40302       description: returns sriov-vf
40303       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40304       produces:
40305         - application/json
40306         - application/xml
40307       responses:
40308         "200":
40309           description: successful operation
40310           schema:
40311               $ref: "#/getDefinitions/sriov-vf"
40312         "default":
40313           description: Response codes found in [response codes](https://wiki.onap.org/).
40314       parameters:
40315         - name: vnf-id2
40316           in: path
40317           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40318           required: true
40319           type: string
40320           example: __VNF-ID2__
40321         - name: interface-name
40322           in: path
40323           description: Name given to the interface
40324           required: true
40325           type: string
40326           example: __INTERFACE-NAME__
40327         - name: pci-id
40328           in: path
40329           description: PCI ID used to identify the sriov-vf
40330           required: true
40331           type: string
40332           example: __PCI-ID__
40333         - name: vnf-name
40334           in: query
40335           description: Name of VNF.
40336           required: false
40337           type: string
40338         - name: vnf-name2
40339           in: query
40340           description: Alternate name of VNF.
40341           required: false
40342           type: string
40343         - name: vnf-type
40344           in: query
40345           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40346           required: false
40347           type: string
40348         - name: prov-status
40349           in: query
40350           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40351           required: false
40352           type: string
40353         - name: heat-stack-id
40354           in: query
40355           description: Heat stack id corresponding to this instance, managed by MSO
40356           required: false
40357           type: string
40358         - name: interface-id
40359           in: query
40360           description: ID of interface
40361           required: false
40362           type: string
40363         - name: macaddr
40364           in: query
40365           description: MAC address for the interface
40366           required: false
40367           type: string
40368         - name: network-name
40369           in: query
40370           description: Name of the network
40371           required: false
40372           type: string
40373         - name: vf-vlan-filter
40374           in: query
40375           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
40376           required: false
40377           type: string
40378         - name: vf-mac-filter
40379           in: query
40380           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
40381           required: false
40382           type: string
40383         - name: vf-vlan-strip
40384           in: query
40385           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
40386           required: false
40387           type: boolean
40388         - name: neutron-network-id
40389           in: query
40390           description: Neutron network id of the interface
40391           required: false
40392           type: string
40393     put:
40394       tags:
40395         - Network
40396       summary: create or update an existing sriov-vf
40397       description: |
40398         Create or update an existing sriov-vf.
40399         #
40400         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40401       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40402       consumes:
40403         - application/json
40404         - application/xml
40405       produces:
40406         - application/json
40407         - application/xml
40408       responses:
40409         "default":
40410           description: Response codes found in [response codes](https://wiki.onap.org/).
40411       parameters:
40412         - name: vnf-id2
40413           in: path
40414           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40415           required: true
40416           type: string
40417           example: __VNF-ID2__
40418         - name: interface-name
40419           in: path
40420           description: Name given to the interface
40421           required: true
40422           type: string
40423           example: __INTERFACE-NAME__
40424         - name: pci-id
40425           in: path
40426           description: PCI ID used to identify the sriov-vf
40427           required: true
40428           type: string
40429           example: __PCI-ID__
40430         - name: body
40431           in: body
40432           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
40433           required: true
40434           schema:
40435             $ref: "#/definitions/sriov-vf"
40436     patch:
40437       tags:
40438         - Network
40439       summary: update an existing sriov-vf
40440       description: |
40441         Update an existing sriov-vf
40442         #
40443         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40444         The PUT operation will entirely replace an existing object.
40445         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40446         #
40447         Other differences between PUT and PATCH are:
40448         #
40449         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40450         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40451         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40452       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40453       consumes:
40454         - application/json
40455         - application/xml
40456       produces:
40457         - application/json
40458         - application/xml
40459       responses:
40460         "default":
40461           description: Response codes found in [response codes](https://wiki.onap.org/).
40462       parameters:
40463         - name: vnf-id2
40464           in: path
40465           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40466           required: true
40467           type: string
40468           example: __VNF-ID2__
40469         - name: interface-name
40470           in: path
40471           description: Name given to the interface
40472           required: true
40473           type: string
40474           example: __INTERFACE-NAME__
40475         - name: pci-id
40476           in: path
40477           description: PCI ID used to identify the sriov-vf
40478           required: true
40479           type: string
40480           example: __PCI-ID__
40481         - name: body
40482           in: body
40483           description: sriov-vf object that needs to be created or updated.
40484           required: true
40485           schema:
40486             $ref: "#/patchDefinitions/sriov-vf"
40487     delete:
40488       tags:
40489         - Network
40490       summary: delete an existing sriov-vf
40491       description: delete an existing sriov-vf
40492       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
40493       consumes:
40494         - application/json
40495         - application/xml
40496       produces:
40497         - application/json
40498         - application/xml
40499       responses:
40500         "default":
40501           description: Response codes found in [response codes](https://wiki.onap.org/).
40502       parameters:
40503         - name: vnf-id2
40504           in: path
40505           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40506           required: true
40507           type: string
40508           example: __VNF-ID2__
40509         - name: interface-name
40510           in: path
40511           description: Name given to the interface
40512           required: true
40513           type: string
40514           example: __INTERFACE-NAME__
40515         - name: pci-id
40516           in: path
40517           description: PCI ID used to identify the sriov-vf
40518           required: true
40519           type: string
40520           example: __PCI-ID__
40521         - name: resource-version
40522           in: query
40523           description: resource-version for concurrency
40524           required: true
40525           type: string
40526   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
40527     get:
40528       tags:
40529         - Network
40530       summary: returns sriov-vfs
40531       description: returns sriov-vfs
40532       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
40533       produces:
40534         - application/json
40535         - application/xml
40536       responses:
40537         "200":
40538           description: successful operation
40539           schema:
40540               $ref: "#/getDefinitions/sriov-vfs"
40541         "default":
40542           description: Response codes found in [response codes](https://wiki.onap.org/).
40543       parameters:
40544         - name: vnf-id2
40545           in: path
40546           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40547           required: true
40548           type: string
40549           example: __VNF-ID2__
40550         - name: interface-name
40551           in: path
40552           description: Name given to the interface
40553           required: true
40554           type: string
40555           example: __INTERFACE-NAME__
40556         - name: vnf-name
40557           in: query
40558           description: Name of VNF.
40559           required: false
40560           type: string
40561         - name: vnf-name2
40562           in: query
40563           description: Alternate name of VNF.
40564           required: false
40565           type: string
40566         - name: vnf-type
40567           in: query
40568           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40569           required: false
40570           type: string
40571         - name: prov-status
40572           in: query
40573           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40574           required: false
40575           type: string
40576         - name: heat-stack-id
40577           in: query
40578           description: Heat stack id corresponding to this instance, managed by MSO
40579           required: false
40580           type: string
40581         - name: interface-id
40582           in: query
40583           description: ID of interface
40584           required: false
40585           type: string
40586         - name: macaddr
40587           in: query
40588           description: MAC address for the interface
40589           required: false
40590           type: string
40591         - name: network-name
40592           in: query
40593           description: Name of the network
40594           required: false
40595           type: string
40596   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
40597     put:
40598       tags:
40599         - Network
40600       summary: see node definition for valid relationships
40601       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
40602       consumes:
40603         - application/json
40604         - application/xml
40605       produces:
40606         - application/json
40607         - application/xml
40608       responses:
40609         "default":
40610           description: Response codes found in [response codes](https://wiki.onap.org/).
40611       parameters:
40612         - name: vnf-id2
40613           in: path
40614           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40615           required: true
40616           type: string
40617           example: __VNF-ID2__
40618         - name: interface-name
40619           in: path
40620           description: Name given to the interface
40621           required: true
40622           type: string
40623           example: __INTERFACE-NAME__
40624         - name: body
40625           in: body
40626           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
40627           required: true
40628           schema:
40629             $ref: "#/definitions/relationship"
40630     delete:
40631       tags:
40632         - Network
40633       summary: delete an existing relationship
40634       description: delete an existing relationship
40635       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
40636       consumes:
40637         - application/json
40638         - application/xml
40639       produces:
40640         - application/json
40641         - application/xml
40642       responses:
40643         "default":
40644           description: Response codes found in [response codes](https://wiki.onap.org/).
40645       parameters:
40646         - name: vnf-id2
40647           in: path
40648           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40649           required: true
40650           type: string
40651           example: __VNF-ID2__
40652         - name: interface-name
40653           in: path
40654           description: Name given to the interface
40655           required: true
40656           type: string
40657           example: __INTERFACE-NAME__
40658   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
40659     put:
40660       tags:
40661         - Network
40662       summary: see node definition for valid relationships
40663       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40664       consumes:
40665         - application/json
40666         - application/xml
40667       produces:
40668         - application/json
40669         - application/xml
40670       responses:
40671         "default":
40672           description: Response codes found in [response codes](https://wiki.onap.org/).
40673       parameters:
40674         - name: vnf-id2
40675           in: path
40676           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40677           required: true
40678           type: string
40679           example: __VNF-ID2__
40680         - name: interface-name
40681           in: path
40682           description: Name given to the interface
40683           required: true
40684           type: string
40685           example: __INTERFACE-NAME__
40686         - name: l3-interface-ipv4-address
40687           in: path
40688           description: IP address
40689           required: true
40690           type: string
40691           example: __L3-INTERFACE-IPV4-ADDRESS__
40692         - name: body
40693           in: body
40694           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40695           required: true
40696           schema:
40697             $ref: "#/definitions/relationship"
40698     delete:
40699       tags:
40700         - Network
40701       summary: delete an existing relationship
40702       description: delete an existing relationship
40703       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
40704       consumes:
40705         - application/json
40706         - application/xml
40707       produces:
40708         - application/json
40709         - application/xml
40710       responses:
40711         "default":
40712           description: Response codes found in [response codes](https://wiki.onap.org/).
40713       parameters:
40714         - name: vnf-id2
40715           in: path
40716           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40717           required: true
40718           type: string
40719           example: __VNF-ID2__
40720         - name: interface-name
40721           in: path
40722           description: Name given to the interface
40723           required: true
40724           type: string
40725           example: __INTERFACE-NAME__
40726         - name: l3-interface-ipv4-address
40727           in: path
40728           description: IP address
40729           required: true
40730           type: string
40731           example: __L3-INTERFACE-IPV4-ADDRESS__
40732   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
40733     get:
40734       tags:
40735         - Network
40736       summary: returns l3-interface-ipv4-address-list
40737       description: returns l3-interface-ipv4-address-list
40738       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40739       produces:
40740         - application/json
40741         - application/xml
40742       responses:
40743         "200":
40744           description: successful operation
40745           schema:
40746               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
40747         "default":
40748           description: Response codes found in [response codes](https://wiki.onap.org/).
40749       parameters:
40750         - name: vnf-id2
40751           in: path
40752           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40753           required: true
40754           type: string
40755           example: __VNF-ID2__
40756         - name: interface-name
40757           in: path
40758           description: Name given to the interface
40759           required: true
40760           type: string
40761           example: __INTERFACE-NAME__
40762         - name: l3-interface-ipv4-address
40763           in: path
40764           description: IP address
40765           required: true
40766           type: string
40767           example: __L3-INTERFACE-IPV4-ADDRESS__
40768         - name: vnf-name
40769           in: query
40770           description: Name of VNF.
40771           required: false
40772           type: string
40773         - name: vnf-name2
40774           in: query
40775           description: Alternate name of VNF.
40776           required: false
40777           type: string
40778         - name: vnf-type
40779           in: query
40780           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
40781           required: false
40782           type: string
40783         - name: prov-status
40784           in: query
40785           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
40786           required: false
40787           type: string
40788         - name: heat-stack-id
40789           in: query
40790           description: Heat stack id corresponding to this instance, managed by MSO
40791           required: false
40792           type: string
40793         - name: interface-id
40794           in: query
40795           description: ID of interface
40796           required: false
40797           type: string
40798         - name: macaddr
40799           in: query
40800           description: MAC address for the interface
40801           required: false
40802           type: string
40803         - name: network-name
40804           in: query
40805           description: Name of the network
40806           required: false
40807           type: string
40808         - name: vlan-id-inner
40809           in: query
40810           description: Inner VLAN tag
40811           required: false
40812           type: integer
40813           format: int64
40814         - name: neutron-network-id
40815           in: query
40816           description: Neutron network id of the interface that address belongs to
40817           required: false
40818           type: string
40819         - name: neutron-subnet-id
40820           in: query
40821           description: Neutron id of subnet that address belongs to
40822           required: false
40823           type: string
40824     put:
40825       tags:
40826         - Network
40827       summary: create or update an existing l3-interface-ipv4-address-list
40828       description: |
40829         Create or update an existing l3-interface-ipv4-address-list.
40830         #
40831         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40832       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40833       consumes:
40834         - application/json
40835         - application/xml
40836       produces:
40837         - application/json
40838         - application/xml
40839       responses:
40840         "default":
40841           description: Response codes found in [response codes](https://wiki.onap.org/).
40842       parameters:
40843         - name: vnf-id2
40844           in: path
40845           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40846           required: true
40847           type: string
40848           example: __VNF-ID2__
40849         - name: interface-name
40850           in: path
40851           description: Name given to the interface
40852           required: true
40853           type: string
40854           example: __INTERFACE-NAME__
40855         - name: l3-interface-ipv4-address
40856           in: path
40857           description: IP address
40858           required: true
40859           type: string
40860           example: __L3-INTERFACE-IPV4-ADDRESS__
40861         - name: body
40862           in: body
40863           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
40864           required: true
40865           schema:
40866             $ref: "#/definitions/l3-interface-ipv4-address-list"
40867     patch:
40868       tags:
40869         - Network
40870       summary: update an existing l3-interface-ipv4-address-list
40871       description: |
40872         Update an existing l3-interface-ipv4-address-list
40873         #
40874         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40875         The PUT operation will entirely replace an existing object.
40876         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40877         #
40878         Other differences between PUT and PATCH are:
40879         #
40880         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40881         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40882         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40883       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40884       consumes:
40885         - application/json
40886         - application/xml
40887       produces:
40888         - application/json
40889         - application/xml
40890       responses:
40891         "default":
40892           description: Response codes found in [response codes](https://wiki.onap.org/).
40893       parameters:
40894         - name: vnf-id2
40895           in: path
40896           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40897           required: true
40898           type: string
40899           example: __VNF-ID2__
40900         - name: interface-name
40901           in: path
40902           description: Name given to the interface
40903           required: true
40904           type: string
40905           example: __INTERFACE-NAME__
40906         - name: l3-interface-ipv4-address
40907           in: path
40908           description: IP address
40909           required: true
40910           type: string
40911           example: __L3-INTERFACE-IPV4-ADDRESS__
40912         - name: body
40913           in: body
40914           description: l3-interface-ipv4-address-list object that needs to be created or updated.
40915           required: true
40916           schema:
40917             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
40918     delete:
40919       tags:
40920         - Network
40921       summary: delete an existing l3-interface-ipv4-address-list
40922       description: delete an existing l3-interface-ipv4-address-list
40923       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
40924       consumes:
40925         - application/json
40926         - application/xml
40927       produces:
40928         - application/json
40929         - application/xml
40930       responses:
40931         "default":
40932           description: Response codes found in [response codes](https://wiki.onap.org/).
40933       parameters:
40934         - name: vnf-id2
40935           in: path
40936           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40937           required: true
40938           type: string
40939           example: __VNF-ID2__
40940         - name: interface-name
40941           in: path
40942           description: Name given to the interface
40943           required: true
40944           type: string
40945           example: __INTERFACE-NAME__
40946         - name: l3-interface-ipv4-address
40947           in: path
40948           description: IP address
40949           required: true
40950           type: string
40951           example: __L3-INTERFACE-IPV4-ADDRESS__
40952         - name: resource-version
40953           in: query
40954           description: resource-version for concurrency
40955           required: true
40956           type: string
40957   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
40958     put:
40959       tags:
40960         - Network
40961       summary: see node definition for valid relationships
40962       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
40963       consumes:
40964         - application/json
40965         - application/xml
40966       produces:
40967         - application/json
40968         - application/xml
40969       responses:
40970         "default":
40971           description: Response codes found in [response codes](https://wiki.onap.org/).
40972       parameters:
40973         - name: vnf-id2
40974           in: path
40975           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
40976           required: true
40977           type: string
40978           example: __VNF-ID2__
40979         - name: interface-name
40980           in: path
40981           description: Name given to the interface
40982           required: true
40983           type: string
40984           example: __INTERFACE-NAME__
40985         - name: l3-interface-ipv6-address
40986           in: path
40987           description: IP address
40988           required: true
40989           type: string
40990           example: __L3-INTERFACE-IPV6-ADDRESS__
40991         - name: body
40992           in: body
40993           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
40994           required: true
40995           schema:
40996             $ref: "#/definitions/relationship"
40997     delete:
40998       tags:
40999         - Network
41000       summary: delete an existing relationship
41001       description: delete an existing relationship
41002       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
41003       consumes:
41004         - application/json
41005         - application/xml
41006       produces:
41007         - application/json
41008         - application/xml
41009       responses:
41010         "default":
41011           description: Response codes found in [response codes](https://wiki.onap.org/).
41012       parameters:
41013         - name: vnf-id2
41014           in: path
41015           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41016           required: true
41017           type: string
41018           example: __VNF-ID2__
41019         - name: interface-name
41020           in: path
41021           description: Name given to the interface
41022           required: true
41023           type: string
41024           example: __INTERFACE-NAME__
41025         - name: l3-interface-ipv6-address
41026           in: path
41027           description: IP address
41028           required: true
41029           type: string
41030           example: __L3-INTERFACE-IPV6-ADDRESS__
41031   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
41032     get:
41033       tags:
41034         - Network
41035       summary: returns l3-interface-ipv6-address-list
41036       description: returns l3-interface-ipv6-address-list
41037       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41038       produces:
41039         - application/json
41040         - application/xml
41041       responses:
41042         "200":
41043           description: successful operation
41044           schema:
41045               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
41046         "default":
41047           description: Response codes found in [response codes](https://wiki.onap.org/).
41048       parameters:
41049         - name: vnf-id2
41050           in: path
41051           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41052           required: true
41053           type: string
41054           example: __VNF-ID2__
41055         - name: interface-name
41056           in: path
41057           description: Name given to the interface
41058           required: true
41059           type: string
41060           example: __INTERFACE-NAME__
41061         - name: l3-interface-ipv6-address
41062           in: path
41063           description: IP address
41064           required: true
41065           type: string
41066           example: __L3-INTERFACE-IPV6-ADDRESS__
41067         - name: vnf-name
41068           in: query
41069           description: Name of VNF.
41070           required: false
41071           type: string
41072         - name: vnf-name2
41073           in: query
41074           description: Alternate name of VNF.
41075           required: false
41076           type: string
41077         - name: vnf-type
41078           in: query
41079           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
41080           required: false
41081           type: string
41082         - name: prov-status
41083           in: query
41084           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41085           required: false
41086           type: string
41087         - name: heat-stack-id
41088           in: query
41089           description: Heat stack id corresponding to this instance, managed by MSO
41090           required: false
41091           type: string
41092         - name: interface-id
41093           in: query
41094           description: ID of interface
41095           required: false
41096           type: string
41097         - name: macaddr
41098           in: query
41099           description: MAC address for the interface
41100           required: false
41101           type: string
41102         - name: network-name
41103           in: query
41104           description: Name of the network
41105           required: false
41106           type: string
41107         - name: vlan-id-inner
41108           in: query
41109           description: Inner VLAN tag
41110           required: false
41111           type: integer
41112           format: int64
41113         - name: neutron-network-id
41114           in: query
41115           description: Neutron network id of the interface that address belongs to
41116           required: false
41117           type: string
41118         - name: neutron-subnet-id
41119           in: query
41120           description: Neutron id of subnet that address belongs to
41121           required: false
41122           type: string
41123     put:
41124       tags:
41125         - Network
41126       summary: create or update an existing l3-interface-ipv6-address-list
41127       description: |
41128         Create or update an existing l3-interface-ipv6-address-list.
41129         #
41130         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41131       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41132       consumes:
41133         - application/json
41134         - application/xml
41135       produces:
41136         - application/json
41137         - application/xml
41138       responses:
41139         "default":
41140           description: Response codes found in [response codes](https://wiki.onap.org/).
41141       parameters:
41142         - name: vnf-id2
41143           in: path
41144           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41145           required: true
41146           type: string
41147           example: __VNF-ID2__
41148         - name: interface-name
41149           in: path
41150           description: Name given to the interface
41151           required: true
41152           type: string
41153           example: __INTERFACE-NAME__
41154         - name: l3-interface-ipv6-address
41155           in: path
41156           description: IP address
41157           required: true
41158           type: string
41159           example: __L3-INTERFACE-IPV6-ADDRESS__
41160         - name: body
41161           in: body
41162           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
41163           required: true
41164           schema:
41165             $ref: "#/definitions/l3-interface-ipv6-address-list"
41166     patch:
41167       tags:
41168         - Network
41169       summary: update an existing l3-interface-ipv6-address-list
41170       description: |
41171         Update an existing l3-interface-ipv6-address-list
41172         #
41173         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41174         The PUT operation will entirely replace an existing object.
41175         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41176         #
41177         Other differences between PUT and PATCH are:
41178         #
41179         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41180         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41181         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41182       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41183       consumes:
41184         - application/json
41185         - application/xml
41186       produces:
41187         - application/json
41188         - application/xml
41189       responses:
41190         "default":
41191           description: Response codes found in [response codes](https://wiki.onap.org/).
41192       parameters:
41193         - name: vnf-id2
41194           in: path
41195           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41196           required: true
41197           type: string
41198           example: __VNF-ID2__
41199         - name: interface-name
41200           in: path
41201           description: Name given to the interface
41202           required: true
41203           type: string
41204           example: __INTERFACE-NAME__
41205         - name: l3-interface-ipv6-address
41206           in: path
41207           description: IP address
41208           required: true
41209           type: string
41210           example: __L3-INTERFACE-IPV6-ADDRESS__
41211         - name: body
41212           in: body
41213           description: l3-interface-ipv6-address-list object that needs to be created or updated.
41214           required: true
41215           schema:
41216             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
41217     delete:
41218       tags:
41219         - Network
41220       summary: delete an existing l3-interface-ipv6-address-list
41221       description: delete an existing l3-interface-ipv6-address-list
41222       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
41223       consumes:
41224         - application/json
41225         - application/xml
41226       produces:
41227         - application/json
41228         - application/xml
41229       responses:
41230         "default":
41231           description: Response codes found in [response codes](https://wiki.onap.org/).
41232       parameters:
41233         - name: vnf-id2
41234           in: path
41235           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41236           required: true
41237           type: string
41238           example: __VNF-ID2__
41239         - name: interface-name
41240           in: path
41241           description: Name given to the interface
41242           required: true
41243           type: string
41244           example: __INTERFACE-NAME__
41245         - name: l3-interface-ipv6-address
41246           in: path
41247           description: IP address
41248           required: true
41249           type: string
41250           example: __L3-INTERFACE-IPV6-ADDRESS__
41251         - name: resource-version
41252           in: query
41253           description: resource-version for concurrency
41254           required: true
41255           type: string
41256   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
41257     get:
41258       tags:
41259         - Network
41260       summary: returns l-interface
41261       description: returns l-interface
41262       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
41263       produces:
41264         - application/json
41265         - application/xml
41266       responses:
41267         "200":
41268           description: successful operation
41269           schema:
41270               $ref: "#/getDefinitions/l-interface"
41271         "default":
41272           description: Response codes found in [response codes](https://wiki.onap.org/).
41273       parameters:
41274         - name: vnf-id2
41275           in: path
41276           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41277           required: true
41278           type: string
41279           example: __VNF-ID2__
41280         - name: interface-name
41281           in: path
41282           description: Name given to the interface
41283           required: true
41284           type: string
41285           example: __INTERFACE-NAME__
41286         - name: vnf-name
41287           in: query
41288           description: Name of VNF.
41289           required: false
41290           type: string
41291         - name: vnf-name2
41292           in: query
41293           description: Alternate name of VNF.
41294           required: false
41295           type: string
41296         - name: vnf-type
41297           in: query
41298           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
41299           required: false
41300           type: string
41301         - name: prov-status
41302           in: query
41303           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41304           required: false
41305           type: string
41306         - name: heat-stack-id
41307           in: query
41308           description: Heat stack id corresponding to this instance, managed by MSO
41309           required: false
41310           type: string
41311         - name: interface-id
41312           in: query
41313           description: ID of interface
41314           required: false
41315           type: string
41316         - name: macaddr
41317           in: query
41318           description: MAC address for the interface
41319           required: false
41320           type: string
41321         - name: network-name
41322           in: query
41323           description: Name of the network
41324           required: false
41325           type: string
41326     put:
41327       tags:
41328         - Network
41329       summary: create or update an existing l-interface
41330       description: |
41331         Create or update an existing l-interface.
41332         #
41333         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41334       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
41335       consumes:
41336         - application/json
41337         - application/xml
41338       produces:
41339         - application/json
41340         - application/xml
41341       responses:
41342         "default":
41343           description: Response codes found in [response codes](https://wiki.onap.org/).
41344       parameters:
41345         - name: vnf-id2
41346           in: path
41347           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41348           required: true
41349           type: string
41350           example: __VNF-ID2__
41351         - name: interface-name
41352           in: path
41353           description: Name given to the interface
41354           required: true
41355           type: string
41356           example: __INTERFACE-NAME__
41357         - name: body
41358           in: body
41359           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvceLInterfacesLInterface.json)
41360           required: true
41361           schema:
41362             $ref: "#/definitions/l-interface"
41363     patch:
41364       tags:
41365         - Network
41366       summary: update an existing l-interface
41367       description: |
41368         Update an existing l-interface
41369         #
41370         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41371         The PUT operation will entirely replace an existing object.
41372         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41373         #
41374         Other differences between PUT and PATCH are:
41375         #
41376         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41377         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41378         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41379       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
41380       consumes:
41381         - application/json
41382         - application/xml
41383       produces:
41384         - application/json
41385         - application/xml
41386       responses:
41387         "default":
41388           description: Response codes found in [response codes](https://wiki.onap.org/).
41389       parameters:
41390         - name: vnf-id2
41391           in: path
41392           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41393           required: true
41394           type: string
41395           example: __VNF-ID2__
41396         - name: interface-name
41397           in: path
41398           description: Name given to the interface
41399           required: true
41400           type: string
41401           example: __INTERFACE-NAME__
41402         - name: body
41403           in: body
41404           description: l-interface object that needs to be created or updated.
41405           required: true
41406           schema:
41407             $ref: "#/patchDefinitions/l-interface"
41408     delete:
41409       tags:
41410         - Network
41411       summary: delete an existing l-interface
41412       description: delete an existing l-interface
41413       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
41414       consumes:
41415         - application/json
41416         - application/xml
41417       produces:
41418         - application/json
41419         - application/xml
41420       responses:
41421         "default":
41422           description: Response codes found in [response codes](https://wiki.onap.org/).
41423       parameters:
41424         - name: vnf-id2
41425           in: path
41426           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41427           required: true
41428           type: string
41429           example: __VNF-ID2__
41430         - name: interface-name
41431           in: path
41432           description: Name given to the interface
41433           required: true
41434           type: string
41435           example: __INTERFACE-NAME__
41436         - name: resource-version
41437           in: query
41438           description: resource-version for concurrency
41439           required: true
41440           type: string
41441   /network/newvces/newvce/{vnf-id2}/l-interfaces:
41442     get:
41443       tags:
41444         - Network
41445       summary: returns l-interfaces
41446       description: returns l-interfaces
41447       operationId: getNetworkNewvcesNewvceLInterfaces
41448       produces:
41449         - application/json
41450         - application/xml
41451       responses:
41452         "200":
41453           description: successful operation
41454           schema:
41455               $ref: "#/getDefinitions/l-interfaces"
41456         "default":
41457           description: Response codes found in [response codes](https://wiki.onap.org/).
41458       parameters:
41459         - name: vnf-id2
41460           in: path
41461           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41462           required: true
41463           type: string
41464           example: __VNF-ID2__
41465         - name: vnf-name
41466           in: query
41467           description: Name of VNF.
41468           required: false
41469           type: string
41470         - name: vnf-name2
41471           in: query
41472           description: Alternate name of VNF.
41473           required: false
41474           type: string
41475         - name: vnf-type
41476           in: query
41477           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
41478           required: false
41479           type: string
41480         - name: prov-status
41481           in: query
41482           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41483           required: false
41484           type: string
41485         - name: heat-stack-id
41486           in: query
41487           description: Heat stack id corresponding to this instance, managed by MSO
41488           required: false
41489           type: string
41490   /network/newvces/newvce/{vnf-id2}:
41491     get:
41492       tags:
41493         - Network
41494       summary: returns newvce
41495       description: returns newvce
41496       operationId: getNetworkNewvcesNewvce
41497       produces:
41498         - application/json
41499         - application/xml
41500       responses:
41501         "200":
41502           description: successful operation
41503           schema:
41504               $ref: "#/getDefinitions/newvce"
41505         "default":
41506           description: Response codes found in [response codes](https://wiki.onap.org/).
41507       parameters:
41508         - name: vnf-id2
41509           in: path
41510           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41511           required: true
41512           type: string
41513           example: __VNF-ID2__
41514         - name: vnf-name
41515           in: query
41516           description: Name of VNF.
41517           required: false
41518           type: string
41519         - name: vnf-name2
41520           in: query
41521           description: Alternate name of VNF.
41522           required: false
41523           type: string
41524         - name: vnf-type
41525           in: query
41526           description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
41527           required: false
41528           type: string
41529         - name: prov-status
41530           in: query
41531           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
41532           required: false
41533           type: string
41534         - name: heat-stack-id
41535           in: query
41536           description: Heat stack id corresponding to this instance, managed by MSO
41537           required: false
41538           type: string
41539     put:
41540       tags:
41541         - Network
41542       summary: create or update an existing newvce
41543       description: |
41544         Create or update an existing newvce.
41545         #
41546         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41547       operationId: createOrUpdateNetworkNewvcesNewvce
41548       consumes:
41549         - application/json
41550         - application/xml
41551       produces:
41552         - application/json
41553         - application/xml
41554       responses:
41555         "default":
41556           description: Response codes found in [response codes](https://wiki.onap.org/).
41557       parameters:
41558         - name: vnf-id2
41559           in: path
41560           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41561           required: true
41562           type: string
41563           example: __VNF-ID2__
41564         - name: body
41565           in: body
41566           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkNewvcesNewvce.json)
41567           required: true
41568           schema:
41569             $ref: "#/definitions/newvce"
41570     patch:
41571       tags:
41572         - Network
41573       summary: update an existing newvce
41574       description: |
41575         Update an existing newvce
41576         #
41577         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41578         The PUT operation will entirely replace an existing object.
41579         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41580         #
41581         Other differences between PUT and PATCH are:
41582         #
41583         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41584         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41585         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41586       operationId: UpdateNetworkNewvcesNewvce
41587       consumes:
41588         - application/json
41589         - application/xml
41590       produces:
41591         - application/json
41592         - application/xml
41593       responses:
41594         "default":
41595           description: Response codes found in [response codes](https://wiki.onap.org/).
41596       parameters:
41597         - name: vnf-id2
41598           in: path
41599           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41600           required: true
41601           type: string
41602           example: __VNF-ID2__
41603         - name: body
41604           in: body
41605           description: newvce object that needs to be created or updated.
41606           required: true
41607           schema:
41608             $ref: "#/patchDefinitions/newvce"
41609     delete:
41610       tags:
41611         - Network
41612       summary: delete an existing newvce
41613       description: delete an existing newvce
41614       operationId: deleteNetworkNewvcesNewvce
41615       consumes:
41616         - application/json
41617         - application/xml
41618       produces:
41619         - application/json
41620         - application/xml
41621       responses:
41622         "default":
41623           description: Response codes found in [response codes](https://wiki.onap.org/).
41624       parameters:
41625         - name: vnf-id2
41626           in: path
41627           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
41628           required: true
41629           type: string
41630           example: __VNF-ID2__
41631         - name: resource-version
41632           in: query
41633           description: resource-version for concurrency
41634           required: true
41635           type: string
41636   /network/newvces:
41637     get:
41638       tags:
41639         - Network
41640       summary: returns newvces
41641       description: returns newvces
41642       operationId: getNetworkNewvces
41643       produces:
41644         - application/json
41645         - application/xml
41646       responses:
41647         "200":
41648           description: successful operation
41649           schema:
41650               $ref: "#/getDefinitions/newvces"
41651         "default":
41652           description: Response codes found in [response codes](https://wiki.onap.org/).
41653   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
41654     put:
41655       tags:
41656         - Network
41657       summary: see node definition for valid relationships
41658       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
41659       consumes:
41660         - application/json
41661         - application/xml
41662       produces:
41663         - application/json
41664         - application/xml
41665       responses:
41666         "default":
41667           description: Response codes found in [response codes](https://wiki.onap.org/).
41668       parameters:
41669         - name: pnf-name
41670           in: path
41671           description: unique name of Physical Network Function.
41672           required: true
41673           type: string
41674           example: __PNF-NAME__
41675         - name: body
41676           in: body
41677           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
41678           required: true
41679           schema:
41680             $ref: "#/definitions/relationship"
41681     delete:
41682       tags:
41683         - Network
41684       summary: delete an existing relationship
41685       description: delete an existing relationship
41686       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
41687       consumes:
41688         - application/json
41689         - application/xml
41690       produces:
41691         - application/json
41692         - application/xml
41693       responses:
41694         "default":
41695           description: Response codes found in [response codes](https://wiki.onap.org/).
41696       parameters:
41697         - name: pnf-name
41698           in: path
41699           description: unique name of Physical Network Function.
41700           required: true
41701           type: string
41702           example: __PNF-NAME__
41703   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
41704     put:
41705       tags:
41706         - Network
41707       summary: see node definition for valid relationships
41708       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
41709       consumes:
41710         - application/json
41711         - application/xml
41712       produces:
41713         - application/json
41714         - application/xml
41715       responses:
41716         "default":
41717           description: Response codes found in [response codes](https://wiki.onap.org/).
41718       parameters:
41719         - name: pnf-name
41720           in: path
41721           description: unique name of Physical Network Function.
41722           required: true
41723           type: string
41724           example: __PNF-NAME__
41725         - name: interface-name
41726           in: path
41727           description: Name that identifies the physical interface
41728           required: true
41729           type: string
41730           example: __INTERFACE-NAME__
41731         - name: body
41732           in: body
41733           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
41734           required: true
41735           schema:
41736             $ref: "#/definitions/relationship"
41737     delete:
41738       tags:
41739         - Network
41740       summary: delete an existing relationship
41741       description: delete an existing relationship
41742       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
41743       consumes:
41744         - application/json
41745         - application/xml
41746       produces:
41747         - application/json
41748         - application/xml
41749       responses:
41750         "default":
41751           description: Response codes found in [response codes](https://wiki.onap.org/).
41752       parameters:
41753         - name: pnf-name
41754           in: path
41755           description: unique name of Physical Network Function.
41756           required: true
41757           type: string
41758           example: __PNF-NAME__
41759         - name: interface-name
41760           in: path
41761           description: Name that identifies the physical interface
41762           required: true
41763           type: string
41764           example: __INTERFACE-NAME__
41765   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
41766     put:
41767       tags:
41768         - Network
41769       summary: see node definition for valid relationships
41770       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41771       consumes:
41772         - application/json
41773         - application/xml
41774       produces:
41775         - application/json
41776         - application/xml
41777       responses:
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 physical 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: vlan-interface
41800           in: path
41801           description: String that identifies the interface
41802           required: true
41803           type: string
41804           example: __VLAN-INTERFACE__
41805         - name: body
41806           in: body
41807           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
41808           required: true
41809           schema:
41810             $ref: "#/definitions/relationship"
41811     delete:
41812       tags:
41813         - Network
41814       summary: delete an existing relationship
41815       description: delete an existing relationship
41816       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
41817       consumes:
41818         - application/json
41819         - application/xml
41820       produces:
41821         - application/json
41822         - application/xml
41823       responses:
41824         "default":
41825           description: Response codes found in [response codes](https://wiki.onap.org/).
41826       parameters:
41827         - name: pnf-name
41828           in: path
41829           description: unique name of Physical Network Function.
41830           required: true
41831           type: string
41832           example: __PNF-NAME__
41833         - name: interface-name
41834           in: path
41835           description: Name that identifies the physical interface
41836           required: true
41837           type: string
41838           example: __INTERFACE-NAME__
41839         - name: interface-name
41840           in: path
41841           description: Name given to the interface
41842           required: true
41843           type: string
41844           example: __INTERFACE-NAME__
41845         - name: vlan-interface
41846           in: path
41847           description: String that identifies the interface
41848           required: true
41849           type: string
41850           example: __VLAN-INTERFACE__
41851   /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:
41852     put:
41853       tags:
41854         - Network
41855       summary: see node definition for valid relationships
41856       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41857       consumes:
41858         - application/json
41859         - application/xml
41860       produces:
41861         - application/json
41862         - application/xml
41863       responses:
41864         "default":
41865           description: Response codes found in [response codes](https://wiki.onap.org/).
41866       parameters:
41867         - name: pnf-name
41868           in: path
41869           description: unique name of Physical Network Function.
41870           required: true
41871           type: string
41872           example: __PNF-NAME__
41873         - name: interface-name
41874           in: path
41875           description: Name that identifies the physical interface
41876           required: true
41877           type: string
41878           example: __INTERFACE-NAME__
41879         - name: interface-name
41880           in: path
41881           description: Name given to the interface
41882           required: true
41883           type: string
41884           example: __INTERFACE-NAME__
41885         - name: vlan-interface
41886           in: path
41887           description: String that identifies the interface
41888           required: true
41889           type: string
41890           example: __VLAN-INTERFACE__
41891         - name: l3-interface-ipv4-address
41892           in: path
41893           description: IP address
41894           required: true
41895           type: string
41896           example: __L3-INTERFACE-IPV4-ADDRESS__
41897         - name: body
41898           in: body
41899           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
41900           required: true
41901           schema:
41902             $ref: "#/definitions/relationship"
41903     delete:
41904       tags:
41905         - Network
41906       summary: delete an existing relationship
41907       description: delete an existing relationship
41908       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
41909       consumes:
41910         - application/json
41911         - application/xml
41912       produces:
41913         - application/json
41914         - application/xml
41915       responses:
41916         "default":
41917           description: Response codes found in [response codes](https://wiki.onap.org/).
41918       parameters:
41919         - name: pnf-name
41920           in: path
41921           description: unique name of Physical Network Function.
41922           required: true
41923           type: string
41924           example: __PNF-NAME__
41925         - name: interface-name
41926           in: path
41927           description: Name that identifies the physical interface
41928           required: true
41929           type: string
41930           example: __INTERFACE-NAME__
41931         - name: interface-name
41932           in: path
41933           description: Name given to the interface
41934           required: true
41935           type: string
41936           example: __INTERFACE-NAME__
41937         - name: vlan-interface
41938           in: path
41939           description: String that identifies the interface
41940           required: true
41941           type: string
41942           example: __VLAN-INTERFACE__
41943         - name: l3-interface-ipv4-address
41944           in: path
41945           description: IP address
41946           required: true
41947           type: string
41948           example: __L3-INTERFACE-IPV4-ADDRESS__
41949   /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}:
41950     get:
41951       tags:
41952         - Network
41953       summary: returns l3-interface-ipv4-address-list
41954       description: returns l3-interface-ipv4-address-list
41955       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
41956       produces:
41957         - application/json
41958         - application/xml
41959       responses:
41960         "200":
41961           description: successful operation
41962           schema:
41963               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
41964         "default":
41965           description: Response codes found in [response codes](https://wiki.onap.org/).
41966       parameters:
41967         - name: pnf-name
41968           in: path
41969           description: unique name of Physical Network Function.
41970           required: true
41971           type: string
41972           example: __PNF-NAME__
41973         - name: interface-name
41974           in: path
41975           description: Name that identifies the physical interface
41976           required: true
41977           type: string
41978           example: __INTERFACE-NAME__
41979         - name: interface-name
41980           in: path
41981           description: Name given to the interface
41982           required: true
41983           type: string
41984           example: __INTERFACE-NAME__
41985         - name: vlan-interface
41986           in: path
41987           description: String that identifies the interface
41988           required: true
41989           type: string
41990           example: __VLAN-INTERFACE__
41991         - name: l3-interface-ipv4-address
41992           in: path
41993           description: IP address
41994           required: true
41995           type: string
41996           example: __L3-INTERFACE-IPV4-ADDRESS__
41997         - name: inv-status
41998           in: query
41999           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42000           required: false
42001           type: string
42002         - name: prov-status
42003           in: query
42004           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42005           required: false
42006           type: string
42007         - name: interface-id
42008           in: query
42009           description: ID of interface
42010           required: false
42011           type: string
42012         - name: macaddr
42013           in: query
42014           description: MAC address for the interface
42015           required: false
42016           type: string
42017         - name: network-name
42018           in: query
42019           description: Name of the network
42020           required: false
42021           type: string
42022         - name: vlan-id-inner
42023           in: query
42024           description: Inner VLAN tag
42025           required: false
42026           type: integer
42027           format: int64
42028         - name: vpn-id
42029           in: query
42030           description: This indicates the customers VPN ID associated with this vlan
42031           required: false
42032           type: string
42033         - name: vlan-id-inner
42034           in: query
42035           description: Inner VLAN tag
42036           required: false
42037           type: integer
42038           format: int64
42039         - name: neutron-network-id
42040           in: query
42041           description: Neutron network id of the interface that address belongs to
42042           required: false
42043           type: string
42044         - name: neutron-subnet-id
42045           in: query
42046           description: Neutron id of subnet that address belongs to
42047           required: false
42048           type: string
42049     put:
42050       tags:
42051         - Network
42052       summary: create or update an existing l3-interface-ipv4-address-list
42053       description: |
42054         Create or update an existing l3-interface-ipv4-address-list.
42055         #
42056         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42057       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42058       consumes:
42059         - application/json
42060         - application/xml
42061       produces:
42062         - application/json
42063         - application/xml
42064       responses:
42065         "default":
42066           description: Response codes found in [response codes](https://wiki.onap.org/).
42067       parameters:
42068         - name: pnf-name
42069           in: path
42070           description: unique name of Physical Network Function.
42071           required: true
42072           type: string
42073           example: __PNF-NAME__
42074         - name: interface-name
42075           in: path
42076           description: Name that identifies the physical interface
42077           required: true
42078           type: string
42079           example: __INTERFACE-NAME__
42080         - name: interface-name
42081           in: path
42082           description: Name given to the interface
42083           required: true
42084           type: string
42085           example: __INTERFACE-NAME__
42086         - name: vlan-interface
42087           in: path
42088           description: String that identifies the interface
42089           required: true
42090           type: string
42091           example: __VLAN-INTERFACE__
42092         - name: l3-interface-ipv4-address
42093           in: path
42094           description: IP address
42095           required: true
42096           type: string
42097           example: __L3-INTERFACE-IPV4-ADDRESS__
42098         - name: body
42099           in: body
42100           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42101           required: true
42102           schema:
42103             $ref: "#/definitions/l3-interface-ipv4-address-list"
42104     patch:
42105       tags:
42106         - Network
42107       summary: update an existing l3-interface-ipv4-address-list
42108       description: |
42109         Update an existing l3-interface-ipv4-address-list
42110         #
42111         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42112         The PUT operation will entirely replace an existing object.
42113         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42114         #
42115         Other differences between PUT and PATCH are:
42116         #
42117         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42118         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42119         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42120       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42121       consumes:
42122         - application/json
42123         - application/xml
42124       produces:
42125         - application/json
42126         - application/xml
42127       responses:
42128         "default":
42129           description: Response codes found in [response codes](https://wiki.onap.org/).
42130       parameters:
42131         - name: pnf-name
42132           in: path
42133           description: unique name of Physical Network Function.
42134           required: true
42135           type: string
42136           example: __PNF-NAME__
42137         - name: interface-name
42138           in: path
42139           description: Name that identifies the physical interface
42140           required: true
42141           type: string
42142           example: __INTERFACE-NAME__
42143         - name: interface-name
42144           in: path
42145           description: Name given to the interface
42146           required: true
42147           type: string
42148           example: __INTERFACE-NAME__
42149         - name: vlan-interface
42150           in: path
42151           description: String that identifies the interface
42152           required: true
42153           type: string
42154           example: __VLAN-INTERFACE__
42155         - name: l3-interface-ipv4-address
42156           in: path
42157           description: IP address
42158           required: true
42159           type: string
42160           example: __L3-INTERFACE-IPV4-ADDRESS__
42161         - name: body
42162           in: body
42163           description: l3-interface-ipv4-address-list object that needs to be created or updated.
42164           required: true
42165           schema:
42166             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42167     delete:
42168       tags:
42169         - Network
42170       summary: delete an existing l3-interface-ipv4-address-list
42171       description: delete an existing l3-interface-ipv4-address-list
42172       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42173       consumes:
42174         - application/json
42175         - application/xml
42176       produces:
42177         - application/json
42178         - application/xml
42179       responses:
42180         "default":
42181           description: Response codes found in [response codes](https://wiki.onap.org/).
42182       parameters:
42183         - name: pnf-name
42184           in: path
42185           description: unique name of Physical Network Function.
42186           required: true
42187           type: string
42188           example: __PNF-NAME__
42189         - name: interface-name
42190           in: path
42191           description: Name that identifies the physical interface
42192           required: true
42193           type: string
42194           example: __INTERFACE-NAME__
42195         - name: interface-name
42196           in: path
42197           description: Name given to the interface
42198           required: true
42199           type: string
42200           example: __INTERFACE-NAME__
42201         - name: vlan-interface
42202           in: path
42203           description: String that identifies the interface
42204           required: true
42205           type: string
42206           example: __VLAN-INTERFACE__
42207         - name: l3-interface-ipv4-address
42208           in: path
42209           description: IP address
42210           required: true
42211           type: string
42212           example: __L3-INTERFACE-IPV4-ADDRESS__
42213         - name: resource-version
42214           in: query
42215           description: resource-version for concurrency
42216           required: true
42217           type: string
42218   /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:
42219     put:
42220       tags:
42221         - Network
42222       summary: see node definition for valid relationships
42223       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42224       consumes:
42225         - application/json
42226         - application/xml
42227       produces:
42228         - application/json
42229         - application/xml
42230       responses:
42231         "default":
42232           description: Response codes found in [response codes](https://wiki.onap.org/).
42233       parameters:
42234         - name: pnf-name
42235           in: path
42236           description: unique name of Physical Network Function.
42237           required: true
42238           type: string
42239           example: __PNF-NAME__
42240         - name: interface-name
42241           in: path
42242           description: Name that identifies the physical interface
42243           required: true
42244           type: string
42245           example: __INTERFACE-NAME__
42246         - name: interface-name
42247           in: path
42248           description: Name given to the interface
42249           required: true
42250           type: string
42251           example: __INTERFACE-NAME__
42252         - name: vlan-interface
42253           in: path
42254           description: String that identifies the interface
42255           required: true
42256           type: string
42257           example: __VLAN-INTERFACE__
42258         - name: l3-interface-ipv6-address
42259           in: path
42260           description: IP address
42261           required: true
42262           type: string
42263           example: __L3-INTERFACE-IPV6-ADDRESS__
42264         - name: body
42265           in: body
42266           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42267           required: true
42268           schema:
42269             $ref: "#/definitions/relationship"
42270     delete:
42271       tags:
42272         - Network
42273       summary: delete an existing relationship
42274       description: delete an existing relationship
42275       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42276       consumes:
42277         - application/json
42278         - application/xml
42279       produces:
42280         - application/json
42281         - application/xml
42282       responses:
42283         "default":
42284           description: Response codes found in [response codes](https://wiki.onap.org/).
42285       parameters:
42286         - name: pnf-name
42287           in: path
42288           description: unique name of Physical Network Function.
42289           required: true
42290           type: string
42291           example: __PNF-NAME__
42292         - name: interface-name
42293           in: path
42294           description: Name that identifies the physical interface
42295           required: true
42296           type: string
42297           example: __INTERFACE-NAME__
42298         - name: interface-name
42299           in: path
42300           description: Name given to the interface
42301           required: true
42302           type: string
42303           example: __INTERFACE-NAME__
42304         - name: vlan-interface
42305           in: path
42306           description: String that identifies the interface
42307           required: true
42308           type: string
42309           example: __VLAN-INTERFACE__
42310         - name: l3-interface-ipv6-address
42311           in: path
42312           description: IP address
42313           required: true
42314           type: string
42315           example: __L3-INTERFACE-IPV6-ADDRESS__
42316   /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}:
42317     get:
42318       tags:
42319         - Network
42320       summary: returns l3-interface-ipv6-address-list
42321       description: returns l3-interface-ipv6-address-list
42322       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42323       produces:
42324         - application/json
42325         - application/xml
42326       responses:
42327         "200":
42328           description: successful operation
42329           schema:
42330               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42331         "default":
42332           description: Response codes found in [response codes](https://wiki.onap.org/).
42333       parameters:
42334         - name: pnf-name
42335           in: path
42336           description: unique name of Physical Network Function.
42337           required: true
42338           type: string
42339           example: __PNF-NAME__
42340         - name: interface-name
42341           in: path
42342           description: Name that identifies the physical interface
42343           required: true
42344           type: string
42345           example: __INTERFACE-NAME__
42346         - name: interface-name
42347           in: path
42348           description: Name given to the interface
42349           required: true
42350           type: string
42351           example: __INTERFACE-NAME__
42352         - name: vlan-interface
42353           in: path
42354           description: String that identifies the interface
42355           required: true
42356           type: string
42357           example: __VLAN-INTERFACE__
42358         - name: l3-interface-ipv6-address
42359           in: path
42360           description: IP address
42361           required: true
42362           type: string
42363           example: __L3-INTERFACE-IPV6-ADDRESS__
42364         - name: inv-status
42365           in: query
42366           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42367           required: false
42368           type: string
42369         - name: prov-status
42370           in: query
42371           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42372           required: false
42373           type: string
42374         - name: interface-id
42375           in: query
42376           description: ID of interface
42377           required: false
42378           type: string
42379         - name: macaddr
42380           in: query
42381           description: MAC address for the interface
42382           required: false
42383           type: string
42384         - name: network-name
42385           in: query
42386           description: Name of the network
42387           required: false
42388           type: string
42389         - name: vlan-id-inner
42390           in: query
42391           description: Inner VLAN tag
42392           required: false
42393           type: integer
42394           format: int64
42395         - name: vpn-id
42396           in: query
42397           description: This indicates the customers VPN ID associated with this vlan
42398           required: false
42399           type: string
42400         - name: vlan-id-inner
42401           in: query
42402           description: Inner VLAN tag
42403           required: false
42404           type: integer
42405           format: int64
42406         - name: neutron-network-id
42407           in: query
42408           description: Neutron network id of the interface that address belongs to
42409           required: false
42410           type: string
42411         - name: neutron-subnet-id
42412           in: query
42413           description: Neutron id of subnet that address belongs to
42414           required: false
42415           type: string
42416     put:
42417       tags:
42418         - Network
42419       summary: create or update an existing l3-interface-ipv6-address-list
42420       description: |
42421         Create or update an existing l3-interface-ipv6-address-list.
42422         #
42423         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42424       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42425       consumes:
42426         - application/json
42427         - application/xml
42428       produces:
42429         - application/json
42430         - application/xml
42431       responses:
42432         "default":
42433           description: Response codes found in [response codes](https://wiki.onap.org/).
42434       parameters:
42435         - name: pnf-name
42436           in: path
42437           description: unique name of Physical Network Function.
42438           required: true
42439           type: string
42440           example: __PNF-NAME__
42441         - name: interface-name
42442           in: path
42443           description: Name that identifies the physical interface
42444           required: true
42445           type: string
42446           example: __INTERFACE-NAME__
42447         - name: interface-name
42448           in: path
42449           description: Name given to the interface
42450           required: true
42451           type: string
42452           example: __INTERFACE-NAME__
42453         - name: vlan-interface
42454           in: path
42455           description: String that identifies the interface
42456           required: true
42457           type: string
42458           example: __VLAN-INTERFACE__
42459         - name: l3-interface-ipv6-address
42460           in: path
42461           description: IP address
42462           required: true
42463           type: string
42464           example: __L3-INTERFACE-IPV6-ADDRESS__
42465         - name: body
42466           in: body
42467           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42468           required: true
42469           schema:
42470             $ref: "#/definitions/l3-interface-ipv6-address-list"
42471     patch:
42472       tags:
42473         - Network
42474       summary: update an existing l3-interface-ipv6-address-list
42475       description: |
42476         Update an existing l3-interface-ipv6-address-list
42477         #
42478         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42479         The PUT operation will entirely replace an existing object.
42480         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42481         #
42482         Other differences between PUT and PATCH are:
42483         #
42484         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42485         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42486         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42487       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42488       consumes:
42489         - application/json
42490         - application/xml
42491       produces:
42492         - application/json
42493         - application/xml
42494       responses:
42495         "default":
42496           description: Response codes found in [response codes](https://wiki.onap.org/).
42497       parameters:
42498         - name: pnf-name
42499           in: path
42500           description: unique name of Physical Network Function.
42501           required: true
42502           type: string
42503           example: __PNF-NAME__
42504         - name: interface-name
42505           in: path
42506           description: Name that identifies the physical interface
42507           required: true
42508           type: string
42509           example: __INTERFACE-NAME__
42510         - name: interface-name
42511           in: path
42512           description: Name given to the interface
42513           required: true
42514           type: string
42515           example: __INTERFACE-NAME__
42516         - name: vlan-interface
42517           in: path
42518           description: String that identifies the interface
42519           required: true
42520           type: string
42521           example: __VLAN-INTERFACE__
42522         - name: l3-interface-ipv6-address
42523           in: path
42524           description: IP address
42525           required: true
42526           type: string
42527           example: __L3-INTERFACE-IPV6-ADDRESS__
42528         - name: body
42529           in: body
42530           description: l3-interface-ipv6-address-list object that needs to be created or updated.
42531           required: true
42532           schema:
42533             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
42534     delete:
42535       tags:
42536         - Network
42537       summary: delete an existing l3-interface-ipv6-address-list
42538       description: delete an existing l3-interface-ipv6-address-list
42539       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42540       consumes:
42541         - application/json
42542         - application/xml
42543       produces:
42544         - application/json
42545         - application/xml
42546       responses:
42547         "default":
42548           description: Response codes found in [response codes](https://wiki.onap.org/).
42549       parameters:
42550         - name: pnf-name
42551           in: path
42552           description: unique name of Physical Network Function.
42553           required: true
42554           type: string
42555           example: __PNF-NAME__
42556         - name: interface-name
42557           in: path
42558           description: Name that identifies the physical interface
42559           required: true
42560           type: string
42561           example: __INTERFACE-NAME__
42562         - name: interface-name
42563           in: path
42564           description: Name given to the interface
42565           required: true
42566           type: string
42567           example: __INTERFACE-NAME__
42568         - name: vlan-interface
42569           in: path
42570           description: String that identifies the interface
42571           required: true
42572           type: string
42573           example: __VLAN-INTERFACE__
42574         - name: l3-interface-ipv6-address
42575           in: path
42576           description: IP address
42577           required: true
42578           type: string
42579           example: __L3-INTERFACE-IPV6-ADDRESS__
42580         - name: resource-version
42581           in: query
42582           description: resource-version for concurrency
42583           required: true
42584           type: string
42585   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
42586     get:
42587       tags:
42588         - Network
42589       summary: returns vlan
42590       description: returns vlan
42591       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42592       produces:
42593         - application/json
42594         - application/xml
42595       responses:
42596         "200":
42597           description: successful operation
42598           schema:
42599               $ref: "#/getDefinitions/vlan"
42600         "default":
42601           description: Response codes found in [response codes](https://wiki.onap.org/).
42602       parameters:
42603         - name: pnf-name
42604           in: path
42605           description: unique name of Physical Network Function.
42606           required: true
42607           type: string
42608           example: __PNF-NAME__
42609         - name: interface-name
42610           in: path
42611           description: Name that identifies the physical interface
42612           required: true
42613           type: string
42614           example: __INTERFACE-NAME__
42615         - name: interface-name
42616           in: path
42617           description: Name given to the interface
42618           required: true
42619           type: string
42620           example: __INTERFACE-NAME__
42621         - name: vlan-interface
42622           in: path
42623           description: String that identifies the interface
42624           required: true
42625           type: string
42626           example: __VLAN-INTERFACE__
42627         - name: inv-status
42628           in: query
42629           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42630           required: false
42631           type: string
42632         - name: prov-status
42633           in: query
42634           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42635           required: false
42636           type: string
42637         - name: interface-id
42638           in: query
42639           description: ID of interface
42640           required: false
42641           type: string
42642         - name: macaddr
42643           in: query
42644           description: MAC address for the interface
42645           required: false
42646           type: string
42647         - name: network-name
42648           in: query
42649           description: Name of the network
42650           required: false
42651           type: string
42652         - name: vlan-id-inner
42653           in: query
42654           description: Inner VLAN tag
42655           required: false
42656           type: integer
42657           format: int64
42658         - name: vpn-id
42659           in: query
42660           description: This indicates the customers VPN ID associated with this vlan
42661           required: false
42662           type: string
42663     put:
42664       tags:
42665         - Network
42666       summary: create or update an existing vlan
42667       description: |
42668         Create or update an existing vlan.
42669         #
42670         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42671       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42672       consumes:
42673         - application/json
42674         - application/xml
42675       produces:
42676         - application/json
42677         - application/xml
42678       responses:
42679         "default":
42680           description: Response codes found in [response codes](https://wiki.onap.org/).
42681       parameters:
42682         - name: pnf-name
42683           in: path
42684           description: unique name of Physical Network Function.
42685           required: true
42686           type: string
42687           example: __PNF-NAME__
42688         - name: interface-name
42689           in: path
42690           description: Name that identifies the physical interface
42691           required: true
42692           type: string
42693           example: __INTERFACE-NAME__
42694         - name: interface-name
42695           in: path
42696           description: Name given to the interface
42697           required: true
42698           type: string
42699           example: __INTERFACE-NAME__
42700         - name: vlan-interface
42701           in: path
42702           description: String that identifies the interface
42703           required: true
42704           type: string
42705           example: __VLAN-INTERFACE__
42706         - name: body
42707           in: body
42708           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
42709           required: true
42710           schema:
42711             $ref: "#/definitions/vlan"
42712     patch:
42713       tags:
42714         - Network
42715       summary: update an existing vlan
42716       description: |
42717         Update an existing vlan
42718         #
42719         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42720         The PUT operation will entirely replace an existing object.
42721         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42722         #
42723         Other differences between PUT and PATCH are:
42724         #
42725         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42726         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42727         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42728       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42729       consumes:
42730         - application/json
42731         - application/xml
42732       produces:
42733         - application/json
42734         - application/xml
42735       responses:
42736         "default":
42737           description: Response codes found in [response codes](https://wiki.onap.org/).
42738       parameters:
42739         - name: pnf-name
42740           in: path
42741           description: unique name of Physical Network Function.
42742           required: true
42743           type: string
42744           example: __PNF-NAME__
42745         - name: interface-name
42746           in: path
42747           description: Name that identifies the physical interface
42748           required: true
42749           type: string
42750           example: __INTERFACE-NAME__
42751         - name: interface-name
42752           in: path
42753           description: Name given to the interface
42754           required: true
42755           type: string
42756           example: __INTERFACE-NAME__
42757         - name: vlan-interface
42758           in: path
42759           description: String that identifies the interface
42760           required: true
42761           type: string
42762           example: __VLAN-INTERFACE__
42763         - name: body
42764           in: body
42765           description: vlan object that needs to be created or updated.
42766           required: true
42767           schema:
42768             $ref: "#/patchDefinitions/vlan"
42769     delete:
42770       tags:
42771         - Network
42772       summary: delete an existing vlan
42773       description: delete an existing vlan
42774       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
42775       consumes:
42776         - application/json
42777         - application/xml
42778       produces:
42779         - application/json
42780         - application/xml
42781       responses:
42782         "default":
42783           description: Response codes found in [response codes](https://wiki.onap.org/).
42784       parameters:
42785         - name: pnf-name
42786           in: path
42787           description: unique name of Physical Network Function.
42788           required: true
42789           type: string
42790           example: __PNF-NAME__
42791         - name: interface-name
42792           in: path
42793           description: Name that identifies the physical interface
42794           required: true
42795           type: string
42796           example: __INTERFACE-NAME__
42797         - name: interface-name
42798           in: path
42799           description: Name given to the interface
42800           required: true
42801           type: string
42802           example: __INTERFACE-NAME__
42803         - name: vlan-interface
42804           in: path
42805           description: String that identifies the interface
42806           required: true
42807           type: string
42808           example: __VLAN-INTERFACE__
42809         - name: resource-version
42810           in: query
42811           description: resource-version for concurrency
42812           required: true
42813           type: string
42814   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
42815     get:
42816       tags:
42817         - Network
42818       summary: returns vlans
42819       description: returns vlans
42820       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
42821       produces:
42822         - application/json
42823         - application/xml
42824       responses:
42825         "200":
42826           description: successful operation
42827           schema:
42828               $ref: "#/getDefinitions/vlans"
42829         "default":
42830           description: Response codes found in [response codes](https://wiki.onap.org/).
42831       parameters:
42832         - name: pnf-name
42833           in: path
42834           description: unique name of Physical Network Function.
42835           required: true
42836           type: string
42837           example: __PNF-NAME__
42838         - name: interface-name
42839           in: path
42840           description: Name that identifies the physical interface
42841           required: true
42842           type: string
42843           example: __INTERFACE-NAME__
42844         - name: interface-name
42845           in: path
42846           description: Name given to the interface
42847           required: true
42848           type: string
42849           example: __INTERFACE-NAME__
42850         - name: inv-status
42851           in: query
42852           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
42853           required: false
42854           type: string
42855         - name: prov-status
42856           in: query
42857           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42858           required: false
42859           type: string
42860         - name: interface-id
42861           in: query
42862           description: ID of interface
42863           required: false
42864           type: string
42865         - name: macaddr
42866           in: query
42867           description: MAC address for the interface
42868           required: false
42869           type: string
42870         - name: network-name
42871           in: query
42872           description: Name of the network
42873           required: false
42874           type: string
42875   /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:
42876     put:
42877       tags:
42878         - Network
42879       summary: see node definition for valid relationships
42880       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42881       consumes:
42882         - application/json
42883         - application/xml
42884       produces:
42885         - application/json
42886         - application/xml
42887       responses:
42888         "default":
42889           description: Response codes found in [response codes](https://wiki.onap.org/).
42890       parameters:
42891         - name: pnf-name
42892           in: path
42893           description: unique name of Physical Network Function.
42894           required: true
42895           type: string
42896           example: __PNF-NAME__
42897         - name: interface-name
42898           in: path
42899           description: Name that identifies the physical interface
42900           required: true
42901           type: string
42902           example: __INTERFACE-NAME__
42903         - name: interface-name
42904           in: path
42905           description: Name given to the interface
42906           required: true
42907           type: string
42908           example: __INTERFACE-NAME__
42909         - name: pci-id
42910           in: path
42911           description: PCI ID used to identify the sriov-vf
42912           required: true
42913           type: string
42914           example: __PCI-ID__
42915         - name: body
42916           in: body
42917           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
42918           required: true
42919           schema:
42920             $ref: "#/definitions/relationship"
42921     delete:
42922       tags:
42923         - Network
42924       summary: delete an existing relationship
42925       description: delete an existing relationship
42926       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
42927       consumes:
42928         - application/json
42929         - application/xml
42930       produces:
42931         - application/json
42932         - application/xml
42933       responses:
42934         "default":
42935           description: Response codes found in [response codes](https://wiki.onap.org/).
42936       parameters:
42937         - name: pnf-name
42938           in: path
42939           description: unique name of Physical Network Function.
42940           required: true
42941           type: string
42942           example: __PNF-NAME__
42943         - name: interface-name
42944           in: path
42945           description: Name that identifies the physical interface
42946           required: true
42947           type: string
42948           example: __INTERFACE-NAME__
42949         - name: interface-name
42950           in: path
42951           description: Name given to the interface
42952           required: true
42953           type: string
42954           example: __INTERFACE-NAME__
42955         - name: pci-id
42956           in: path
42957           description: PCI ID used to identify the sriov-vf
42958           required: true
42959           type: string
42960           example: __PCI-ID__
42961   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
42962     get:
42963       tags:
42964         - Network
42965       summary: returns sriov-vf
42966       description: returns sriov-vf
42967       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
42968       produces:
42969         - application/json
42970         - application/xml
42971       responses:
42972         "200":
42973           description: successful operation
42974           schema:
42975               $ref: "#/getDefinitions/sriov-vf"
42976         "default":
42977           description: Response codes found in [response codes](https://wiki.onap.org/).
42978       parameters:
42979         - name: pnf-name
42980           in: path
42981           description: unique name of Physical Network Function.
42982           required: true
42983           type: string
42984           example: __PNF-NAME__
42985         - name: interface-name
42986           in: path
42987           description: Name that identifies the physical interface
42988           required: true
42989           type: string
42990           example: __INTERFACE-NAME__
42991         - name: interface-name
42992           in: path
42993           description: Name given to the interface
42994           required: true
42995           type: string
42996           example: __INTERFACE-NAME__
42997         - name: pci-id
42998           in: path
42999           description: PCI ID used to identify the sriov-vf
43000           required: true
43001           type: string
43002           example: __PCI-ID__
43003         - name: inv-status
43004           in: query
43005           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43006           required: false
43007           type: string
43008         - name: prov-status
43009           in: query
43010           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43011           required: false
43012           type: string
43013         - name: interface-id
43014           in: query
43015           description: ID of interface
43016           required: false
43017           type: string
43018         - name: macaddr
43019           in: query
43020           description: MAC address for the interface
43021           required: false
43022           type: string
43023         - name: network-name
43024           in: query
43025           description: Name of the network
43026           required: false
43027           type: string
43028         - name: vf-vlan-filter
43029           in: query
43030           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
43031           required: false
43032           type: string
43033         - name: vf-mac-filter
43034           in: query
43035           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
43036           required: false
43037           type: string
43038         - name: vf-vlan-strip
43039           in: query
43040           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
43041           required: false
43042           type: boolean
43043         - name: neutron-network-id
43044           in: query
43045           description: Neutron network id of the interface
43046           required: false
43047           type: string
43048     put:
43049       tags:
43050         - Network
43051       summary: create or update an existing sriov-vf
43052       description: |
43053         Create or update an existing sriov-vf.
43054         #
43055         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43056       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43057       consumes:
43058         - application/json
43059         - application/xml
43060       produces:
43061         - application/json
43062         - application/xml
43063       responses:
43064         "default":
43065           description: Response codes found in [response codes](https://wiki.onap.org/).
43066       parameters:
43067         - name: pnf-name
43068           in: path
43069           description: unique name of Physical Network Function.
43070           required: true
43071           type: string
43072           example: __PNF-NAME__
43073         - name: interface-name
43074           in: path
43075           description: Name that identifies the physical interface
43076           required: true
43077           type: string
43078           example: __INTERFACE-NAME__
43079         - name: interface-name
43080           in: path
43081           description: Name given to the interface
43082           required: true
43083           type: string
43084           example: __INTERFACE-NAME__
43085         - name: pci-id
43086           in: path
43087           description: PCI ID used to identify the sriov-vf
43088           required: true
43089           type: string
43090           example: __PCI-ID__
43091         - name: body
43092           in: body
43093           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
43094           required: true
43095           schema:
43096             $ref: "#/definitions/sriov-vf"
43097     patch:
43098       tags:
43099         - Network
43100       summary: update an existing sriov-vf
43101       description: |
43102         Update an existing sriov-vf
43103         #
43104         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43105         The PUT operation will entirely replace an existing object.
43106         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43107         #
43108         Other differences between PUT and PATCH are:
43109         #
43110         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43111         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43112         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43113       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43114       consumes:
43115         - application/json
43116         - application/xml
43117       produces:
43118         - application/json
43119         - application/xml
43120       responses:
43121         "default":
43122           description: Response codes found in [response codes](https://wiki.onap.org/).
43123       parameters:
43124         - name: pnf-name
43125           in: path
43126           description: unique name of Physical Network Function.
43127           required: true
43128           type: string
43129           example: __PNF-NAME__
43130         - name: interface-name
43131           in: path
43132           description: Name that identifies the physical interface
43133           required: true
43134           type: string
43135           example: __INTERFACE-NAME__
43136         - name: interface-name
43137           in: path
43138           description: Name given to the interface
43139           required: true
43140           type: string
43141           example: __INTERFACE-NAME__
43142         - name: pci-id
43143           in: path
43144           description: PCI ID used to identify the sriov-vf
43145           required: true
43146           type: string
43147           example: __PCI-ID__
43148         - name: body
43149           in: body
43150           description: sriov-vf object that needs to be created or updated.
43151           required: true
43152           schema:
43153             $ref: "#/patchDefinitions/sriov-vf"
43154     delete:
43155       tags:
43156         - Network
43157       summary: delete an existing sriov-vf
43158       description: delete an existing sriov-vf
43159       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
43160       consumes:
43161         - application/json
43162         - application/xml
43163       produces:
43164         - application/json
43165         - application/xml
43166       responses:
43167         "default":
43168           description: Response codes found in [response codes](https://wiki.onap.org/).
43169       parameters:
43170         - name: pnf-name
43171           in: path
43172           description: unique name of Physical Network Function.
43173           required: true
43174           type: string
43175           example: __PNF-NAME__
43176         - name: interface-name
43177           in: path
43178           description: Name that identifies the physical interface
43179           required: true
43180           type: string
43181           example: __INTERFACE-NAME__
43182         - name: interface-name
43183           in: path
43184           description: Name given to the interface
43185           required: true
43186           type: string
43187           example: __INTERFACE-NAME__
43188         - name: pci-id
43189           in: path
43190           description: PCI ID used to identify the sriov-vf
43191           required: true
43192           type: string
43193           example: __PCI-ID__
43194         - name: resource-version
43195           in: query
43196           description: resource-version for concurrency
43197           required: true
43198           type: string
43199   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43200     get:
43201       tags:
43202         - Network
43203       summary: returns sriov-vfs
43204       description: returns sriov-vfs
43205       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
43206       produces:
43207         - application/json
43208         - application/xml
43209       responses:
43210         "200":
43211           description: successful operation
43212           schema:
43213               $ref: "#/getDefinitions/sriov-vfs"
43214         "default":
43215           description: Response codes found in [response codes](https://wiki.onap.org/).
43216       parameters:
43217         - name: pnf-name
43218           in: path
43219           description: unique name of Physical Network Function.
43220           required: true
43221           type: string
43222           example: __PNF-NAME__
43223         - name: interface-name
43224           in: path
43225           description: Name that identifies the physical interface
43226           required: true
43227           type: string
43228           example: __INTERFACE-NAME__
43229         - name: interface-name
43230           in: path
43231           description: Name given to the interface
43232           required: true
43233           type: string
43234           example: __INTERFACE-NAME__
43235         - name: inv-status
43236           in: query
43237           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43238           required: false
43239           type: string
43240         - name: prov-status
43241           in: query
43242           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43243           required: false
43244           type: string
43245         - name: interface-id
43246           in: query
43247           description: ID of interface
43248           required: false
43249           type: string
43250         - name: macaddr
43251           in: query
43252           description: MAC address for the interface
43253           required: false
43254           type: string
43255         - name: network-name
43256           in: query
43257           description: Name of the network
43258           required: false
43259           type: string
43260   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43261     put:
43262       tags:
43263         - Network
43264       summary: see node definition for valid relationships
43265       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
43266       consumes:
43267         - application/json
43268         - application/xml
43269       produces:
43270         - application/json
43271         - application/xml
43272       responses:
43273         "default":
43274           description: Response codes found in [response codes](https://wiki.onap.org/).
43275       parameters:
43276         - name: pnf-name
43277           in: path
43278           description: unique name of Physical Network Function.
43279           required: true
43280           type: string
43281           example: __PNF-NAME__
43282         - name: interface-name
43283           in: path
43284           description: Name that identifies the physical interface
43285           required: true
43286           type: string
43287           example: __INTERFACE-NAME__
43288         - name: interface-name
43289           in: path
43290           description: Name given to the interface
43291           required: true
43292           type: string
43293           example: __INTERFACE-NAME__
43294         - name: body
43295           in: body
43296           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
43297           required: true
43298           schema:
43299             $ref: "#/definitions/relationship"
43300     delete:
43301       tags:
43302         - Network
43303       summary: delete an existing relationship
43304       description: delete an existing relationship
43305       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
43306       consumes:
43307         - application/json
43308         - application/xml
43309       produces:
43310         - application/json
43311         - application/xml
43312       responses:
43313         "default":
43314           description: Response codes found in [response codes](https://wiki.onap.org/).
43315       parameters:
43316         - name: pnf-name
43317           in: path
43318           description: unique name of Physical Network Function.
43319           required: true
43320           type: string
43321           example: __PNF-NAME__
43322         - name: interface-name
43323           in: path
43324           description: Name that identifies the physical interface
43325           required: true
43326           type: string
43327           example: __INTERFACE-NAME__
43328         - name: interface-name
43329           in: path
43330           description: Name given to the interface
43331           required: true
43332           type: string
43333           example: __INTERFACE-NAME__
43334   /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:
43335     put:
43336       tags:
43337         - Network
43338       summary: see node definition for valid relationships
43339       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43340       consumes:
43341         - application/json
43342         - application/xml
43343       produces:
43344         - application/json
43345         - application/xml
43346       responses:
43347         "default":
43348           description: Response codes found in [response codes](https://wiki.onap.org/).
43349       parameters:
43350         - name: pnf-name
43351           in: path
43352           description: unique name of Physical Network Function.
43353           required: true
43354           type: string
43355           example: __PNF-NAME__
43356         - name: interface-name
43357           in: path
43358           description: Name that identifies the physical interface
43359           required: true
43360           type: string
43361           example: __INTERFACE-NAME__
43362         - name: interface-name
43363           in: path
43364           description: Name given to the interface
43365           required: true
43366           type: string
43367           example: __INTERFACE-NAME__
43368         - name: l3-interface-ipv4-address
43369           in: path
43370           description: IP address
43371           required: true
43372           type: string
43373           example: __L3-INTERFACE-IPV4-ADDRESS__
43374         - name: body
43375           in: body
43376           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43377           required: true
43378           schema:
43379             $ref: "#/definitions/relationship"
43380     delete:
43381       tags:
43382         - Network
43383       summary: delete an existing relationship
43384       description: delete an existing relationship
43385       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43386       consumes:
43387         - application/json
43388         - application/xml
43389       produces:
43390         - application/json
43391         - application/xml
43392       responses:
43393         "default":
43394           description: Response codes found in [response codes](https://wiki.onap.org/).
43395       parameters:
43396         - name: pnf-name
43397           in: path
43398           description: unique name of Physical Network Function.
43399           required: true
43400           type: string
43401           example: __PNF-NAME__
43402         - name: interface-name
43403           in: path
43404           description: Name that identifies the physical interface
43405           required: true
43406           type: string
43407           example: __INTERFACE-NAME__
43408         - name: interface-name
43409           in: path
43410           description: Name given to the interface
43411           required: true
43412           type: string
43413           example: __INTERFACE-NAME__
43414         - name: l3-interface-ipv4-address
43415           in: path
43416           description: IP address
43417           required: true
43418           type: string
43419           example: __L3-INTERFACE-IPV4-ADDRESS__
43420   /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}:
43421     get:
43422       tags:
43423         - Network
43424       summary: returns l3-interface-ipv4-address-list
43425       description: returns l3-interface-ipv4-address-list
43426       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43427       produces:
43428         - application/json
43429         - application/xml
43430       responses:
43431         "200":
43432           description: successful operation
43433           schema:
43434               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
43435         "default":
43436           description: Response codes found in [response codes](https://wiki.onap.org/).
43437       parameters:
43438         - name: pnf-name
43439           in: path
43440           description: unique name of Physical Network Function.
43441           required: true
43442           type: string
43443           example: __PNF-NAME__
43444         - name: interface-name
43445           in: path
43446           description: Name that identifies the physical interface
43447           required: true
43448           type: string
43449           example: __INTERFACE-NAME__
43450         - name: interface-name
43451           in: path
43452           description: Name given to the interface
43453           required: true
43454           type: string
43455           example: __INTERFACE-NAME__
43456         - name: l3-interface-ipv4-address
43457           in: path
43458           description: IP address
43459           required: true
43460           type: string
43461           example: __L3-INTERFACE-IPV4-ADDRESS__
43462         - name: inv-status
43463           in: query
43464           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43465           required: false
43466           type: string
43467         - name: prov-status
43468           in: query
43469           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43470           required: false
43471           type: string
43472         - name: interface-id
43473           in: query
43474           description: ID of interface
43475           required: false
43476           type: string
43477         - name: macaddr
43478           in: query
43479           description: MAC address for the interface
43480           required: false
43481           type: string
43482         - name: network-name
43483           in: query
43484           description: Name of the network
43485           required: false
43486           type: string
43487         - name: vlan-id-inner
43488           in: query
43489           description: Inner VLAN tag
43490           required: false
43491           type: integer
43492           format: int64
43493         - name: neutron-network-id
43494           in: query
43495           description: Neutron network id of the interface that address belongs to
43496           required: false
43497           type: string
43498         - name: neutron-subnet-id
43499           in: query
43500           description: Neutron id of subnet that address belongs to
43501           required: false
43502           type: string
43503     put:
43504       tags:
43505         - Network
43506       summary: create or update an existing l3-interface-ipv4-address-list
43507       description: |
43508         Create or update an existing l3-interface-ipv4-address-list.
43509         #
43510         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43511       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43512       consumes:
43513         - application/json
43514         - application/xml
43515       produces:
43516         - application/json
43517         - application/xml
43518       responses:
43519         "default":
43520           description: Response codes found in [response codes](https://wiki.onap.org/).
43521       parameters:
43522         - name: pnf-name
43523           in: path
43524           description: unique name of Physical Network Function.
43525           required: true
43526           type: string
43527           example: __PNF-NAME__
43528         - name: interface-name
43529           in: path
43530           description: Name that identifies the physical interface
43531           required: true
43532           type: string
43533           example: __INTERFACE-NAME__
43534         - name: interface-name
43535           in: path
43536           description: Name given to the interface
43537           required: true
43538           type: string
43539           example: __INTERFACE-NAME__
43540         - name: l3-interface-ipv4-address
43541           in: path
43542           description: IP address
43543           required: true
43544           type: string
43545           example: __L3-INTERFACE-IPV4-ADDRESS__
43546         - name: body
43547           in: body
43548           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43549           required: true
43550           schema:
43551             $ref: "#/definitions/l3-interface-ipv4-address-list"
43552     patch:
43553       tags:
43554         - Network
43555       summary: update an existing l3-interface-ipv4-address-list
43556       description: |
43557         Update an existing l3-interface-ipv4-address-list
43558         #
43559         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43560         The PUT operation will entirely replace an existing object.
43561         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43562         #
43563         Other differences between PUT and PATCH are:
43564         #
43565         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43566         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43567         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43568       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43569       consumes:
43570         - application/json
43571         - application/xml
43572       produces:
43573         - application/json
43574         - application/xml
43575       responses:
43576         "default":
43577           description: Response codes found in [response codes](https://wiki.onap.org/).
43578       parameters:
43579         - name: pnf-name
43580           in: path
43581           description: unique name of Physical Network Function.
43582           required: true
43583           type: string
43584           example: __PNF-NAME__
43585         - name: interface-name
43586           in: path
43587           description: Name that identifies the physical interface
43588           required: true
43589           type: string
43590           example: __INTERFACE-NAME__
43591         - name: interface-name
43592           in: path
43593           description: Name given to the interface
43594           required: true
43595           type: string
43596           example: __INTERFACE-NAME__
43597         - name: l3-interface-ipv4-address
43598           in: path
43599           description: IP address
43600           required: true
43601           type: string
43602           example: __L3-INTERFACE-IPV4-ADDRESS__
43603         - name: body
43604           in: body
43605           description: l3-interface-ipv4-address-list object that needs to be created or updated.
43606           required: true
43607           schema:
43608             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
43609     delete:
43610       tags:
43611         - Network
43612       summary: delete an existing l3-interface-ipv4-address-list
43613       description: delete an existing l3-interface-ipv4-address-list
43614       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43615       consumes:
43616         - application/json
43617         - application/xml
43618       produces:
43619         - application/json
43620         - application/xml
43621       responses:
43622         "default":
43623           description: Response codes found in [response codes](https://wiki.onap.org/).
43624       parameters:
43625         - name: pnf-name
43626           in: path
43627           description: unique name of Physical Network Function.
43628           required: true
43629           type: string
43630           example: __PNF-NAME__
43631         - name: interface-name
43632           in: path
43633           description: Name that identifies the physical interface
43634           required: true
43635           type: string
43636           example: __INTERFACE-NAME__
43637         - name: interface-name
43638           in: path
43639           description: Name given to the interface
43640           required: true
43641           type: string
43642           example: __INTERFACE-NAME__
43643         - name: l3-interface-ipv4-address
43644           in: path
43645           description: IP address
43646           required: true
43647           type: string
43648           example: __L3-INTERFACE-IPV4-ADDRESS__
43649         - name: resource-version
43650           in: query
43651           description: resource-version for concurrency
43652           required: true
43653           type: string
43654   /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:
43655     put:
43656       tags:
43657         - Network
43658       summary: see node definition for valid relationships
43659       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43660       consumes:
43661         - application/json
43662         - application/xml
43663       produces:
43664         - application/json
43665         - application/xml
43666       responses:
43667         "default":
43668           description: Response codes found in [response codes](https://wiki.onap.org/).
43669       parameters:
43670         - name: pnf-name
43671           in: path
43672           description: unique name of Physical Network Function.
43673           required: true
43674           type: string
43675           example: __PNF-NAME__
43676         - name: interface-name
43677           in: path
43678           description: Name that identifies the physical interface
43679           required: true
43680           type: string
43681           example: __INTERFACE-NAME__
43682         - name: interface-name
43683           in: path
43684           description: Name given to the interface
43685           required: true
43686           type: string
43687           example: __INTERFACE-NAME__
43688         - name: l3-interface-ipv6-address
43689           in: path
43690           description: IP address
43691           required: true
43692           type: string
43693           example: __L3-INTERFACE-IPV6-ADDRESS__
43694         - name: body
43695           in: body
43696           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43697           required: true
43698           schema:
43699             $ref: "#/definitions/relationship"
43700     delete:
43701       tags:
43702         - Network
43703       summary: delete an existing relationship
43704       description: delete an existing relationship
43705       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
43706       consumes:
43707         - application/json
43708         - application/xml
43709       produces:
43710         - application/json
43711         - application/xml
43712       responses:
43713         "default":
43714           description: Response codes found in [response codes](https://wiki.onap.org/).
43715       parameters:
43716         - name: pnf-name
43717           in: path
43718           description: unique name of Physical Network Function.
43719           required: true
43720           type: string
43721           example: __PNF-NAME__
43722         - name: interface-name
43723           in: path
43724           description: Name that identifies the physical interface
43725           required: true
43726           type: string
43727           example: __INTERFACE-NAME__
43728         - name: interface-name
43729           in: path
43730           description: Name given to the interface
43731           required: true
43732           type: string
43733           example: __INTERFACE-NAME__
43734         - name: l3-interface-ipv6-address
43735           in: path
43736           description: IP address
43737           required: true
43738           type: string
43739           example: __L3-INTERFACE-IPV6-ADDRESS__
43740   /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}:
43741     get:
43742       tags:
43743         - Network
43744       summary: returns l3-interface-ipv6-address-list
43745       description: returns l3-interface-ipv6-address-list
43746       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43747       produces:
43748         - application/json
43749         - application/xml
43750       responses:
43751         "200":
43752           description: successful operation
43753           schema:
43754               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
43755         "default":
43756           description: Response codes found in [response codes](https://wiki.onap.org/).
43757       parameters:
43758         - name: pnf-name
43759           in: path
43760           description: unique name of Physical Network Function.
43761           required: true
43762           type: string
43763           example: __PNF-NAME__
43764         - name: interface-name
43765           in: path
43766           description: Name that identifies the physical interface
43767           required: true
43768           type: string
43769           example: __INTERFACE-NAME__
43770         - name: interface-name
43771           in: path
43772           description: Name given to the interface
43773           required: true
43774           type: string
43775           example: __INTERFACE-NAME__
43776         - name: l3-interface-ipv6-address
43777           in: path
43778           description: IP address
43779           required: true
43780           type: string
43781           example: __L3-INTERFACE-IPV6-ADDRESS__
43782         - name: inv-status
43783           in: query
43784           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
43785           required: false
43786           type: string
43787         - name: prov-status
43788           in: query
43789           description: Trigger for operational monitoring of this resource by Service Assurance systems.
43790           required: false
43791           type: string
43792         - name: interface-id
43793           in: query
43794           description: ID of interface
43795           required: false
43796           type: string
43797         - name: macaddr
43798           in: query
43799           description: MAC address for the interface
43800           required: false
43801           type: string
43802         - name: network-name
43803           in: query
43804           description: Name of the network
43805           required: false
43806           type: string
43807         - name: vlan-id-inner
43808           in: query
43809           description: Inner VLAN tag
43810           required: false
43811           type: integer
43812           format: int64
43813         - name: neutron-network-id
43814           in: query
43815           description: Neutron network id of the interface that address belongs to
43816           required: false
43817           type: string
43818         - name: neutron-subnet-id
43819           in: query
43820           description: Neutron id of subnet that address belongs to
43821           required: false
43822           type: string
43823     put:
43824       tags:
43825         - Network
43826       summary: create or update an existing l3-interface-ipv6-address-list
43827       description: |
43828         Create or update an existing l3-interface-ipv6-address-list.
43829         #
43830         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43831       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43832       consumes:
43833         - application/json
43834         - application/xml
43835       produces:
43836         - application/json
43837         - application/xml
43838       responses:
43839         "default":
43840           description: Response codes found in [response codes](https://wiki.onap.org/).
43841       parameters:
43842         - name: pnf-name
43843           in: path
43844           description: unique name of Physical Network Function.
43845           required: true
43846           type: string
43847           example: __PNF-NAME__
43848         - name: interface-name
43849           in: path
43850           description: Name that identifies the physical interface
43851           required: true
43852           type: string
43853           example: __INTERFACE-NAME__
43854         - name: interface-name
43855           in: path
43856           description: Name given to the interface
43857           required: true
43858           type: string
43859           example: __INTERFACE-NAME__
43860         - name: l3-interface-ipv6-address
43861           in: path
43862           description: IP address
43863           required: true
43864           type: string
43865           example: __L3-INTERFACE-IPV6-ADDRESS__
43866         - name: body
43867           in: body
43868           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
43869           required: true
43870           schema:
43871             $ref: "#/definitions/l3-interface-ipv6-address-list"
43872     patch:
43873       tags:
43874         - Network
43875       summary: update an existing l3-interface-ipv6-address-list
43876       description: |
43877         Update an existing l3-interface-ipv6-address-list
43878         #
43879         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43880         The PUT operation will entirely replace an existing object.
43881         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43882         #
43883         Other differences between PUT and PATCH are:
43884         #
43885         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43886         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43887         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43888       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43889       consumes:
43890         - application/json
43891         - application/xml
43892       produces:
43893         - application/json
43894         - application/xml
43895       responses:
43896         "default":
43897           description: Response codes found in [response codes](https://wiki.onap.org/).
43898       parameters:
43899         - name: pnf-name
43900           in: path
43901           description: unique name of Physical Network Function.
43902           required: true
43903           type: string
43904           example: __PNF-NAME__
43905         - name: interface-name
43906           in: path
43907           description: Name that identifies the physical interface
43908           required: true
43909           type: string
43910           example: __INTERFACE-NAME__
43911         - name: interface-name
43912           in: path
43913           description: Name given to the interface
43914           required: true
43915           type: string
43916           example: __INTERFACE-NAME__
43917         - name: l3-interface-ipv6-address
43918           in: path
43919           description: IP address
43920           required: true
43921           type: string
43922           example: __L3-INTERFACE-IPV6-ADDRESS__
43923         - name: body
43924           in: body
43925           description: l3-interface-ipv6-address-list object that needs to be created or updated.
43926           required: true
43927           schema:
43928             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43929     delete:
43930       tags:
43931         - Network
43932       summary: delete an existing l3-interface-ipv6-address-list
43933       description: delete an existing l3-interface-ipv6-address-list
43934       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
43935       consumes:
43936         - application/json
43937         - application/xml
43938       produces:
43939         - application/json
43940         - application/xml
43941       responses:
43942         "default":
43943           description: Response codes found in [response codes](https://wiki.onap.org/).
43944       parameters:
43945         - name: pnf-name
43946           in: path
43947           description: unique name of Physical Network Function.
43948           required: true
43949           type: string
43950           example: __PNF-NAME__
43951         - name: interface-name
43952           in: path
43953           description: Name that identifies the physical interface
43954           required: true
43955           type: string
43956           example: __INTERFACE-NAME__
43957         - name: interface-name
43958           in: path
43959           description: Name given to the interface
43960           required: true
43961           type: string
43962           example: __INTERFACE-NAME__
43963         - name: l3-interface-ipv6-address
43964           in: path
43965           description: IP address
43966           required: true
43967           type: string
43968           example: __L3-INTERFACE-IPV6-ADDRESS__
43969         - name: resource-version
43970           in: query
43971           description: resource-version for concurrency
43972           required: true
43973           type: string
43974   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
43975     get:
43976       tags:
43977         - Network
43978       summary: returns l-interface
43979       description: returns l-interface
43980       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
43981       produces:
43982         - application/json
43983         - application/xml
43984       responses:
43985         "200":
43986           description: successful operation
43987           schema:
43988               $ref: "#/getDefinitions/l-interface"
43989         "default":
43990           description: Response codes found in [response codes](https://wiki.onap.org/).
43991       parameters:
43992         - name: pnf-name
43993           in: path
43994           description: unique name of Physical Network Function.
43995           required: true
43996           type: string
43997           example: __PNF-NAME__
43998         - name: interface-name
43999           in: path
44000           description: Name that identifies the physical interface
44001           required: true
44002           type: string
44003           example: __INTERFACE-NAME__
44004         - name: interface-name
44005           in: path
44006           description: Name given to the interface
44007           required: true
44008           type: string
44009           example: __INTERFACE-NAME__
44010         - name: inv-status
44011           in: query
44012           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44013           required: false
44014           type: string
44015         - name: prov-status
44016           in: query
44017           description: Trigger for operational monitoring of this resource by Service Assurance systems.
44018           required: false
44019           type: string
44020         - name: interface-id
44021           in: query
44022           description: ID of interface
44023           required: false
44024           type: string
44025         - name: macaddr
44026           in: query
44027           description: MAC address for the interface
44028           required: false
44029           type: string
44030         - name: network-name
44031           in: query
44032           description: Name of the network
44033           required: false
44034           type: string
44035     put:
44036       tags:
44037         - Network
44038       summary: create or update an existing l-interface
44039       description: |
44040         Create or update an existing l-interface.
44041         #
44042         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44043       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
44044       consumes:
44045         - application/json
44046         - application/xml
44047       produces:
44048         - application/json
44049         - application/xml
44050       responses:
44051         "default":
44052           description: Response codes found in [response codes](https://wiki.onap.org/).
44053       parameters:
44054         - name: pnf-name
44055           in: path
44056           description: unique name of Physical Network Function.
44057           required: true
44058           type: string
44059           example: __PNF-NAME__
44060         - name: interface-name
44061           in: path
44062           description: Name that identifies the physical interface
44063           required: true
44064           type: string
44065           example: __INTERFACE-NAME__
44066         - name: interface-name
44067           in: path
44068           description: Name given to the interface
44069           required: true
44070           type: string
44071           example: __INTERFACE-NAME__
44072         - name: body
44073           in: body
44074           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
44075           required: true
44076           schema:
44077             $ref: "#/definitions/l-interface"
44078     patch:
44079       tags:
44080         - Network
44081       summary: update an existing l-interface
44082       description: |
44083         Update an existing l-interface
44084         #
44085         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44086         The PUT operation will entirely replace an existing object.
44087         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44088         #
44089         Other differences between PUT and PATCH are:
44090         #
44091         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44092         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44093         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44094       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
44095       consumes:
44096         - application/json
44097         - application/xml
44098       produces:
44099         - application/json
44100         - application/xml
44101       responses:
44102         "default":
44103           description: Response codes found in [response codes](https://wiki.onap.org/).
44104       parameters:
44105         - name: pnf-name
44106           in: path
44107           description: unique name of Physical Network Function.
44108           required: true
44109           type: string
44110           example: __PNF-NAME__
44111         - name: interface-name
44112           in: path
44113           description: Name that identifies the physical interface
44114           required: true
44115           type: string
44116           example: __INTERFACE-NAME__
44117         - name: interface-name
44118           in: path
44119           description: Name given to the interface
44120           required: true
44121           type: string
44122           example: __INTERFACE-NAME__
44123         - name: body
44124           in: body
44125           description: l-interface object that needs to be created or updated.
44126           required: true
44127           schema:
44128             $ref: "#/patchDefinitions/l-interface"
44129     delete:
44130       tags:
44131         - Network
44132       summary: delete an existing l-interface
44133       description: delete an existing l-interface
44134       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
44135       consumes:
44136         - application/json
44137         - application/xml
44138       produces:
44139         - application/json
44140         - application/xml
44141       responses:
44142         "default":
44143           description: Response codes found in [response codes](https://wiki.onap.org/).
44144       parameters:
44145         - name: pnf-name
44146           in: path
44147           description: unique name of Physical Network Function.
44148           required: true
44149           type: string
44150           example: __PNF-NAME__
44151         - name: interface-name
44152           in: path
44153           description: Name that identifies the physical interface
44154           required: true
44155           type: string
44156           example: __INTERFACE-NAME__
44157         - name: interface-name
44158           in: path
44159           description: Name given to the interface
44160           required: true
44161           type: string
44162           example: __INTERFACE-NAME__
44163         - name: resource-version
44164           in: query
44165           description: resource-version for concurrency
44166           required: true
44167           type: string
44168   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
44169     get:
44170       tags:
44171         - Network
44172       summary: returns l-interfaces
44173       description: returns l-interfaces
44174       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
44175       produces:
44176         - application/json
44177         - application/xml
44178       responses:
44179         "200":
44180           description: successful operation
44181           schema:
44182               $ref: "#/getDefinitions/l-interfaces"
44183         "default":
44184           description: Response codes found in [response codes](https://wiki.onap.org/).
44185       parameters:
44186         - name: pnf-name
44187           in: path
44188           description: unique name of Physical Network Function.
44189           required: true
44190           type: string
44191           example: __PNF-NAME__
44192         - name: interface-name
44193           in: path
44194           description: Name that identifies the physical interface
44195           required: true
44196           type: string
44197           example: __INTERFACE-NAME__
44198         - name: inv-status
44199           in: query
44200           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44201           required: false
44202           type: string
44203         - name: prov-status
44204           in: query
44205           description: Trigger for operational monitoring of this resource by Service Assurance systems.
44206           required: false
44207           type: string
44208   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
44209     get:
44210       tags:
44211         - Network
44212       summary: returns p-interface
44213       description: returns p-interface
44214       operationId: getNetworkPnfsPnfPInterfacesPInterface
44215       produces:
44216         - application/json
44217         - application/xml
44218       responses:
44219         "200":
44220           description: successful operation
44221           schema:
44222               $ref: "#/getDefinitions/p-interface"
44223         "default":
44224           description: Response codes found in [response codes](https://wiki.onap.org/).
44225       parameters:
44226         - name: pnf-name
44227           in: path
44228           description: unique name of Physical Network Function.
44229           required: true
44230           type: string
44231           example: __PNF-NAME__
44232         - name: interface-name
44233           in: path
44234           description: Name that identifies the physical interface
44235           required: true
44236           type: string
44237           example: __INTERFACE-NAME__
44238         - name: inv-status
44239           in: query
44240           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44241           required: false
44242           type: string
44243         - name: prov-status
44244           in: query
44245           description: Trigger for operational monitoring of this resource by Service Assurance systems.
44246           required: false
44247           type: string
44248     put:
44249       tags:
44250         - Network
44251       summary: create or update an existing p-interface
44252       description: |
44253         Create or update an existing p-interface.
44254         #
44255         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44256       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
44257       consumes:
44258         - application/json
44259         - application/xml
44260       produces:
44261         - application/json
44262         - application/xml
44263       responses:
44264         "default":
44265           description: Response codes found in [response codes](https://wiki.onap.org/).
44266       parameters:
44267         - name: pnf-name
44268           in: path
44269           description: unique name of Physical Network Function.
44270           required: true
44271           type: string
44272           example: __PNF-NAME__
44273         - name: interface-name
44274           in: path
44275           description: Name that identifies the physical interface
44276           required: true
44277           type: string
44278           example: __INTERFACE-NAME__
44279         - name: body
44280           in: body
44281           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfPInterfacesPInterface.json)
44282           required: true
44283           schema:
44284             $ref: "#/definitions/p-interface"
44285     patch:
44286       tags:
44287         - Network
44288       summary: update an existing p-interface
44289       description: |
44290         Update an existing p-interface
44291         #
44292         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44293         The PUT operation will entirely replace an existing object.
44294         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44295         #
44296         Other differences between PUT and PATCH are:
44297         #
44298         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44299         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44300         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44301       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
44302       consumes:
44303         - application/json
44304         - application/xml
44305       produces:
44306         - application/json
44307         - application/xml
44308       responses:
44309         "default":
44310           description: Response codes found in [response codes](https://wiki.onap.org/).
44311       parameters:
44312         - name: pnf-name
44313           in: path
44314           description: unique name of Physical Network Function.
44315           required: true
44316           type: string
44317           example: __PNF-NAME__
44318         - name: interface-name
44319           in: path
44320           description: Name that identifies the physical interface
44321           required: true
44322           type: string
44323           example: __INTERFACE-NAME__
44324         - name: body
44325           in: body
44326           description: p-interface object that needs to be created or updated.
44327           required: true
44328           schema:
44329             $ref: "#/patchDefinitions/p-interface"
44330     delete:
44331       tags:
44332         - Network
44333       summary: delete an existing p-interface
44334       description: delete an existing p-interface
44335       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
44336       consumes:
44337         - application/json
44338         - application/xml
44339       produces:
44340         - application/json
44341         - application/xml
44342       responses:
44343         "default":
44344           description: Response codes found in [response codes](https://wiki.onap.org/).
44345       parameters:
44346         - name: pnf-name
44347           in: path
44348           description: unique name of Physical Network Function.
44349           required: true
44350           type: string
44351           example: __PNF-NAME__
44352         - name: interface-name
44353           in: path
44354           description: Name that identifies the physical interface
44355           required: true
44356           type: string
44357           example: __INTERFACE-NAME__
44358         - name: resource-version
44359           in: query
44360           description: resource-version for concurrency
44361           required: true
44362           type: string
44363   /network/pnfs/pnf/{pnf-name}/p-interfaces:
44364     get:
44365       tags:
44366         - Network
44367       summary: returns p-interfaces
44368       description: returns p-interfaces
44369       operationId: getNetworkPnfsPnfPInterfaces
44370       produces:
44371         - application/json
44372         - application/xml
44373       responses:
44374         "200":
44375           description: successful operation
44376           schema:
44377               $ref: "#/getDefinitions/p-interfaces"
44378         "default":
44379           description: Response codes found in [response codes](https://wiki.onap.org/).
44380       parameters:
44381         - name: pnf-name
44382           in: path
44383           description: unique name of Physical Network Function.
44384           required: true
44385           type: string
44386           example: __PNF-NAME__
44387         - name: inv-status
44388           in: query
44389           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44390           required: false
44391           type: string
44392   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
44393     put:
44394       tags:
44395         - Network
44396       summary: see node definition for valid relationships
44397       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
44398       consumes:
44399         - application/json
44400         - application/xml
44401       produces:
44402         - application/json
44403         - application/xml
44404       responses:
44405         "default":
44406           description: Response codes found in [response codes](https://wiki.onap.org/).
44407       parameters:
44408         - name: pnf-name
44409           in: path
44410           description: unique name of Physical Network Function.
44411           required: true
44412           type: string
44413           example: __PNF-NAME__
44414         - name: interface-name
44415           in: path
44416           description: Name that identifies the link aggregate interface
44417           required: true
44418           type: string
44419           example: __INTERFACE-NAME__
44420         - name: body
44421           in: body
44422           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
44423           required: true
44424           schema:
44425             $ref: "#/definitions/relationship"
44426     delete:
44427       tags:
44428         - Network
44429       summary: delete an existing relationship
44430       description: delete an existing relationship
44431       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
44432       consumes:
44433         - application/json
44434         - application/xml
44435       produces:
44436         - application/json
44437         - application/xml
44438       responses:
44439         "default":
44440           description: Response codes found in [response codes](https://wiki.onap.org/).
44441       parameters:
44442         - name: pnf-name
44443           in: path
44444           description: unique name of Physical Network Function.
44445           required: true
44446           type: string
44447           example: __PNF-NAME__
44448         - name: interface-name
44449           in: path
44450           description: Name that identifies the link aggregate interface
44451           required: true
44452           type: string
44453           example: __INTERFACE-NAME__
44454   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
44455     put:
44456       tags:
44457         - Network
44458       summary: see node definition for valid relationships
44459       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
44460       consumes:
44461         - application/json
44462         - application/xml
44463       produces:
44464         - application/json
44465         - application/xml
44466       responses:
44467         "default":
44468           description: Response codes found in [response codes](https://wiki.onap.org/).
44469       parameters:
44470         - name: pnf-name
44471           in: path
44472           description: unique name of Physical Network Function.
44473           required: true
44474           type: string
44475           example: __PNF-NAME__
44476         - name: interface-name
44477           in: path
44478           description: Name that identifies the link aggregate interface
44479           required: true
44480           type: string
44481           example: __INTERFACE-NAME__
44482         - name: interface-name
44483           in: path
44484           description: Name given to the interface
44485           required: true
44486           type: string
44487           example: __INTERFACE-NAME__
44488         - name: vlan-interface
44489           in: path
44490           description: String that identifies the interface
44491           required: true
44492           type: string
44493           example: __VLAN-INTERFACE__
44494         - name: body
44495           in: body
44496           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
44497           required: true
44498           schema:
44499             $ref: "#/definitions/relationship"
44500     delete:
44501       tags:
44502         - Network
44503       summary: delete an existing relationship
44504       description: delete an existing relationship
44505       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
44506       consumes:
44507         - application/json
44508         - application/xml
44509       produces:
44510         - application/json
44511         - application/xml
44512       responses:
44513         "default":
44514           description: Response codes found in [response codes](https://wiki.onap.org/).
44515       parameters:
44516         - name: pnf-name
44517           in: path
44518           description: unique name of Physical Network Function.
44519           required: true
44520           type: string
44521           example: __PNF-NAME__
44522         - name: interface-name
44523           in: path
44524           description: Name that identifies the link aggregate interface
44525           required: true
44526           type: string
44527           example: __INTERFACE-NAME__
44528         - name: interface-name
44529           in: path
44530           description: Name given to the interface
44531           required: true
44532           type: string
44533           example: __INTERFACE-NAME__
44534         - name: vlan-interface
44535           in: path
44536           description: String that identifies the interface
44537           required: true
44538           type: string
44539           example: __VLAN-INTERFACE__
44540   /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:
44541     put:
44542       tags:
44543         - Network
44544       summary: see node definition for valid relationships
44545       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
44546       consumes:
44547         - application/json
44548         - application/xml
44549       produces:
44550         - application/json
44551         - application/xml
44552       responses:
44553         "default":
44554           description: Response codes found in [response codes](https://wiki.onap.org/).
44555       parameters:
44556         - name: pnf-name
44557           in: path
44558           description: unique name of Physical Network Function.
44559           required: true
44560           type: string
44561           example: __PNF-NAME__
44562         - name: interface-name
44563           in: path
44564           description: Name that identifies the link aggregate interface
44565           required: true
44566           type: string
44567           example: __INTERFACE-NAME__
44568         - name: interface-name
44569           in: path
44570           description: Name given to the interface
44571           required: true
44572           type: string
44573           example: __INTERFACE-NAME__
44574         - name: vlan-interface
44575           in: path
44576           description: String that identifies the interface
44577           required: true
44578           type: string
44579           example: __VLAN-INTERFACE__
44580         - name: l3-interface-ipv4-address
44581           in: path
44582           description: IP address
44583           required: true
44584           type: string
44585           example: __L3-INTERFACE-IPV4-ADDRESS__
44586         - name: body
44587           in: body
44588           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
44589           required: true
44590           schema:
44591             $ref: "#/definitions/relationship"
44592     delete:
44593       tags:
44594         - Network
44595       summary: delete an existing relationship
44596       description: delete an existing relationship
44597       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
44598       consumes:
44599         - application/json
44600         - application/xml
44601       produces:
44602         - application/json
44603         - application/xml
44604       responses:
44605         "default":
44606           description: Response codes found in [response codes](https://wiki.onap.org/).
44607       parameters:
44608         - name: pnf-name
44609           in: path
44610           description: unique name of Physical Network Function.
44611           required: true
44612           type: string
44613           example: __PNF-NAME__
44614         - name: interface-name
44615           in: path
44616           description: Name that identifies the link aggregate interface
44617           required: true
44618           type: string
44619           example: __INTERFACE-NAME__
44620         - name: interface-name
44621           in: path
44622           description: Name given to the interface
44623           required: true
44624           type: string
44625           example: __INTERFACE-NAME__
44626         - name: vlan-interface
44627           in: path
44628           description: String that identifies the interface
44629           required: true
44630           type: string
44631           example: __VLAN-INTERFACE__
44632         - name: l3-interface-ipv4-address
44633           in: path
44634           description: IP address
44635           required: true
44636           type: string
44637           example: __L3-INTERFACE-IPV4-ADDRESS__
44638   /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}:
44639     get:
44640       tags:
44641         - Network
44642       summary: returns l3-interface-ipv4-address-list
44643       description: returns l3-interface-ipv4-address-list
44644       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44645       produces:
44646         - application/json
44647         - application/xml
44648       responses:
44649         "200":
44650           description: successful operation
44651           schema:
44652               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
44653         "default":
44654           description: Response codes found in [response codes](https://wiki.onap.org/).
44655       parameters:
44656         - name: pnf-name
44657           in: path
44658           description: unique name of Physical Network Function.
44659           required: true
44660           type: string
44661           example: __PNF-NAME__
44662         - name: interface-name
44663           in: path
44664           description: Name that identifies the link aggregate interface
44665           required: true
44666           type: string
44667           example: __INTERFACE-NAME__
44668         - name: interface-name
44669           in: path
44670           description: Name given to the interface
44671           required: true
44672           type: string
44673           example: __INTERFACE-NAME__
44674         - name: vlan-interface
44675           in: path
44676           description: String that identifies the interface
44677           required: true
44678           type: string
44679           example: __VLAN-INTERFACE__
44680         - name: l3-interface-ipv4-address
44681           in: path
44682           description: IP address
44683           required: true
44684           type: string
44685           example: __L3-INTERFACE-IPV4-ADDRESS__
44686         - name: inv-status
44687           in: query
44688           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
44689           required: false
44690           type: string
44691         - name: interface-id
44692           in: query
44693           description: ID of interface
44694           required: false
44695           type: string
44696         - name: interface-role
44697           in: query
44698           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
44699           required: false
44700           type: string
44701         - name: interface-id
44702           in: query
44703           description: ID of interface
44704           required: false
44705           type: string
44706         - name: macaddr
44707           in: query
44708           description: MAC address for the interface
44709           required: false
44710           type: string
44711         - name: network-name
44712           in: query
44713           description: Name of the network
44714           required: false
44715           type: string
44716         - name: vlan-id-inner
44717           in: query
44718           description: Inner VLAN tag
44719           required: false
44720           type: integer
44721           format: int64
44722         - name: vpn-id
44723           in: query
44724           description: This indicates the customers VPN ID associated with this vlan
44725           required: false
44726           type: string
44727         - name: vlan-id-inner
44728           in: query
44729           description: Inner VLAN tag
44730           required: false
44731           type: integer
44732           format: int64
44733         - name: neutron-network-id
44734           in: query
44735           description: Neutron network id of the interface that address belongs to
44736           required: false
44737           type: string
44738         - name: neutron-subnet-id
44739           in: query
44740           description: Neutron id of subnet that address belongs to
44741           required: false
44742           type: string
44743     put:
44744       tags:
44745         - Network
44746       summary: create or update an existing l3-interface-ipv4-address-list
44747       description: |
44748         Create or update an existing l3-interface-ipv4-address-list.
44749         #
44750         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44751       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44752       consumes:
44753         - application/json
44754         - application/xml
44755       produces:
44756         - application/json
44757         - application/xml
44758       responses:
44759         "default":
44760           description: Response codes found in [response codes](https://wiki.onap.org/).
44761       parameters:
44762         - name: pnf-name
44763           in: path
44764           description: unique name of Physical Network Function.
44765           required: true
44766           type: string
44767           example: __PNF-NAME__
44768         - name: interface-name
44769           in: path
44770           description: Name that identifies the link aggregate interface
44771           required: true
44772           type: string
44773           example: __INTERFACE-NAME__
44774         - name: interface-name
44775           in: path
44776           description: Name given to the interface
44777           required: true
44778           type: string
44779           example: __INTERFACE-NAME__
44780         - name: vlan-interface
44781           in: path
44782           description: String that identifies the interface
44783           required: true
44784           type: string
44785           example: __VLAN-INTERFACE__
44786         - name: l3-interface-ipv4-address
44787           in: path
44788           description: IP address
44789           required: true
44790           type: string
44791           example: __L3-INTERFACE-IPV4-ADDRESS__
44792         - name: body
44793           in: body
44794           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
44795           required: true
44796           schema:
44797             $ref: "#/definitions/l3-interface-ipv4-address-list"
44798     patch:
44799       tags:
44800         - Network
44801       summary: update an existing l3-interface-ipv4-address-list
44802       description: |
44803         Update an existing l3-interface-ipv4-address-list
44804         #
44805         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44806         The PUT operation will entirely replace an existing object.
44807         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44808         #
44809         Other differences between PUT and PATCH are:
44810         #
44811         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44812         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44813         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44814       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44815       consumes:
44816         - application/json
44817         - application/xml
44818       produces:
44819         - application/json
44820         - application/xml
44821       responses:
44822         "default":
44823           description: Response codes found in [response codes](https://wiki.onap.org/).
44824       parameters:
44825         - name: pnf-name
44826           in: path
44827           description: unique name of Physical Network Function.
44828           required: true
44829           type: string
44830           example: __PNF-NAME__
44831         - name: interface-name
44832           in: path
44833           description: Name that identifies the link aggregate interface
44834           required: true
44835           type: string
44836           example: __INTERFACE-NAME__
44837         - name: interface-name
44838           in: path
44839           description: Name given to the interface
44840           required: true
44841           type: string
44842           example: __INTERFACE-NAME__
44843         - name: vlan-interface
44844           in: path
44845           description: String that identifies the interface
44846           required: true
44847           type: string
44848           example: __VLAN-INTERFACE__
44849         - name: l3-interface-ipv4-address
44850           in: path
44851           description: IP address
44852           required: true
44853           type: string
44854           example: __L3-INTERFACE-IPV4-ADDRESS__
44855         - name: body
44856           in: body
44857           description: l3-interface-ipv4-address-list object that needs to be created or updated.
44858           required: true
44859           schema:
44860             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
44861     delete:
44862       tags:
44863         - Network
44864       summary: delete an existing l3-interface-ipv4-address-list
44865       description: delete an existing l3-interface-ipv4-address-list
44866       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
44867       consumes:
44868         - application/json
44869         - application/xml
44870       produces:
44871         - application/json
44872         - application/xml
44873       responses:
44874         "default":
44875           description: Response codes found in [response codes](https://wiki.onap.org/).
44876       parameters:
44877         - name: pnf-name
44878           in: path
44879           description: unique name of Physical Network Function.
44880           required: true
44881           type: string
44882           example: __PNF-NAME__
44883         - name: interface-name
44884           in: path
44885           description: Name that identifies the link aggregate interface
44886           required: true
44887           type: string
44888           example: __INTERFACE-NAME__
44889         - name: interface-name
44890           in: path
44891           description: Name given to the interface
44892           required: true
44893           type: string
44894           example: __INTERFACE-NAME__
44895         - name: vlan-interface
44896           in: path
44897           description: String that identifies the interface
44898           required: true
44899           type: string
44900           example: __VLAN-INTERFACE__
44901         - name: l3-interface-ipv4-address
44902           in: path
44903           description: IP address
44904           required: true
44905           type: string
44906           example: __L3-INTERFACE-IPV4-ADDRESS__
44907         - name: resource-version
44908           in: query
44909           description: resource-version for concurrency
44910           required: true
44911           type: string
44912   /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:
44913     put:
44914       tags:
44915         - Network
44916       summary: see node definition for valid relationships
44917       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44918       consumes:
44919         - application/json
44920         - application/xml
44921       produces:
44922         - application/json
44923         - application/xml
44924       responses:
44925         "default":
44926           description: Response codes found in [response codes](https://wiki.onap.org/).
44927       parameters:
44928         - name: pnf-name
44929           in: path
44930           description: unique name of Physical Network Function.
44931           required: true
44932           type: string
44933           example: __PNF-NAME__
44934         - name: interface-name
44935           in: path
44936           description: Name that identifies the link aggregate interface
44937           required: true
44938           type: string
44939           example: __INTERFACE-NAME__
44940         - name: interface-name
44941           in: path
44942           description: Name given to the interface
44943           required: true
44944           type: string
44945           example: __INTERFACE-NAME__
44946         - name: vlan-interface
44947           in: path
44948           description: String that identifies the interface
44949           required: true
44950           type: string
44951           example: __VLAN-INTERFACE__
44952         - name: l3-interface-ipv6-address
44953           in: path
44954           description: IP address
44955           required: true
44956           type: string
44957           example: __L3-INTERFACE-IPV6-ADDRESS__
44958         - name: body
44959           in: body
44960           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
44961           required: true
44962           schema:
44963             $ref: "#/definitions/relationship"
44964     delete:
44965       tags:
44966         - Network
44967       summary: delete an existing relationship
44968       description: delete an existing relationship
44969       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
44970       consumes:
44971         - application/json
44972         - application/xml
44973       produces:
44974         - application/json
44975         - application/xml
44976       responses:
44977         "default":
44978           description: Response codes found in [response codes](https://wiki.onap.org/).
44979       parameters:
44980         - name: pnf-name
44981           in: path
44982           description: unique name of Physical Network Function.
44983           required: true
44984           type: string
44985           example: __PNF-NAME__
44986         - name: interface-name
44987           in: path
44988           description: Name that identifies the link aggregate interface
44989           required: true
44990           type: string
44991           example: __INTERFACE-NAME__
44992         - name: interface-name
44993           in: path
44994           description: Name given to the interface
44995           required: true
44996           type: string
44997           example: __INTERFACE-NAME__
44998         - name: vlan-interface
44999           in: path
45000           description: String that identifies the interface
45001           required: true
45002           type: string
45003           example: __VLAN-INTERFACE__
45004         - name: l3-interface-ipv6-address
45005           in: path
45006           description: IP address
45007           required: true
45008           type: string
45009           example: __L3-INTERFACE-IPV6-ADDRESS__
45010   /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}:
45011     get:
45012       tags:
45013         - Network
45014       summary: returns l3-interface-ipv6-address-list
45015       description: returns l3-interface-ipv6-address-list
45016       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45017       produces:
45018         - application/json
45019         - application/xml
45020       responses:
45021         "200":
45022           description: successful operation
45023           schema:
45024               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45025         "default":
45026           description: Response codes found in [response codes](https://wiki.onap.org/).
45027       parameters:
45028         - name: pnf-name
45029           in: path
45030           description: unique name of Physical Network Function.
45031           required: true
45032           type: string
45033           example: __PNF-NAME__
45034         - name: interface-name
45035           in: path
45036           description: Name that identifies the link aggregate interface
45037           required: true
45038           type: string
45039           example: __INTERFACE-NAME__
45040         - name: interface-name
45041           in: path
45042           description: Name given to the interface
45043           required: true
45044           type: string
45045           example: __INTERFACE-NAME__
45046         - name: vlan-interface
45047           in: path
45048           description: String that identifies the interface
45049           required: true
45050           type: string
45051           example: __VLAN-INTERFACE__
45052         - name: l3-interface-ipv6-address
45053           in: path
45054           description: IP address
45055           required: true
45056           type: string
45057           example: __L3-INTERFACE-IPV6-ADDRESS__
45058         - name: inv-status
45059           in: query
45060           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45061           required: false
45062           type: string
45063         - name: interface-id
45064           in: query
45065           description: ID of interface
45066           required: false
45067           type: string
45068         - name: interface-role
45069           in: query
45070           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45071           required: false
45072           type: string
45073         - name: interface-id
45074           in: query
45075           description: ID of interface
45076           required: false
45077           type: string
45078         - name: macaddr
45079           in: query
45080           description: MAC address for the interface
45081           required: false
45082           type: string
45083         - name: network-name
45084           in: query
45085           description: Name of the network
45086           required: false
45087           type: string
45088         - name: vlan-id-inner
45089           in: query
45090           description: Inner VLAN tag
45091           required: false
45092           type: integer
45093           format: int64
45094         - name: vpn-id
45095           in: query
45096           description: This indicates the customers VPN ID associated with this vlan
45097           required: false
45098           type: string
45099         - name: vlan-id-inner
45100           in: query
45101           description: Inner VLAN tag
45102           required: false
45103           type: integer
45104           format: int64
45105         - name: neutron-network-id
45106           in: query
45107           description: Neutron network id of the interface that address belongs to
45108           required: false
45109           type: string
45110         - name: neutron-subnet-id
45111           in: query
45112           description: Neutron id of subnet that address belongs to
45113           required: false
45114           type: string
45115     put:
45116       tags:
45117         - Network
45118       summary: create or update an existing l3-interface-ipv6-address-list
45119       description: |
45120         Create or update an existing l3-interface-ipv6-address-list.
45121         #
45122         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45123       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45124       consumes:
45125         - application/json
45126         - application/xml
45127       produces:
45128         - application/json
45129         - application/xml
45130       responses:
45131         "default":
45132           description: Response codes found in [response codes](https://wiki.onap.org/).
45133       parameters:
45134         - name: pnf-name
45135           in: path
45136           description: unique name of Physical Network Function.
45137           required: true
45138           type: string
45139           example: __PNF-NAME__
45140         - name: interface-name
45141           in: path
45142           description: Name that identifies the link aggregate interface
45143           required: true
45144           type: string
45145           example: __INTERFACE-NAME__
45146         - name: interface-name
45147           in: path
45148           description: Name given to the interface
45149           required: true
45150           type: string
45151           example: __INTERFACE-NAME__
45152         - name: vlan-interface
45153           in: path
45154           description: String that identifies the interface
45155           required: true
45156           type: string
45157           example: __VLAN-INTERFACE__
45158         - name: l3-interface-ipv6-address
45159           in: path
45160           description: IP address
45161           required: true
45162           type: string
45163           example: __L3-INTERFACE-IPV6-ADDRESS__
45164         - name: body
45165           in: body
45166           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
45167           required: true
45168           schema:
45169             $ref: "#/definitions/l3-interface-ipv6-address-list"
45170     patch:
45171       tags:
45172         - Network
45173       summary: update an existing l3-interface-ipv6-address-list
45174       description: |
45175         Update an existing l3-interface-ipv6-address-list
45176         #
45177         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45178         The PUT operation will entirely replace an existing object.
45179         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45180         #
45181         Other differences between PUT and PATCH are:
45182         #
45183         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45184         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45185         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45186       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45187       consumes:
45188         - application/json
45189         - application/xml
45190       produces:
45191         - application/json
45192         - application/xml
45193       responses:
45194         "default":
45195           description: Response codes found in [response codes](https://wiki.onap.org/).
45196       parameters:
45197         - name: pnf-name
45198           in: path
45199           description: unique name of Physical Network Function.
45200           required: true
45201           type: string
45202           example: __PNF-NAME__
45203         - name: interface-name
45204           in: path
45205           description: Name that identifies the link aggregate interface
45206           required: true
45207           type: string
45208           example: __INTERFACE-NAME__
45209         - name: interface-name
45210           in: path
45211           description: Name given to the interface
45212           required: true
45213           type: string
45214           example: __INTERFACE-NAME__
45215         - name: vlan-interface
45216           in: path
45217           description: String that identifies the interface
45218           required: true
45219           type: string
45220           example: __VLAN-INTERFACE__
45221         - name: l3-interface-ipv6-address
45222           in: path
45223           description: IP address
45224           required: true
45225           type: string
45226           example: __L3-INTERFACE-IPV6-ADDRESS__
45227         - name: body
45228           in: body
45229           description: l3-interface-ipv6-address-list object that needs to be created or updated.
45230           required: true
45231           schema:
45232             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
45233     delete:
45234       tags:
45235         - Network
45236       summary: delete an existing l3-interface-ipv6-address-list
45237       description: delete an existing l3-interface-ipv6-address-list
45238       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45239       consumes:
45240         - application/json
45241         - application/xml
45242       produces:
45243         - application/json
45244         - application/xml
45245       responses:
45246         "default":
45247           description: Response codes found in [response codes](https://wiki.onap.org/).
45248       parameters:
45249         - name: pnf-name
45250           in: path
45251           description: unique name of Physical Network Function.
45252           required: true
45253           type: string
45254           example: __PNF-NAME__
45255         - name: interface-name
45256           in: path
45257           description: Name that identifies the link aggregate interface
45258           required: true
45259           type: string
45260           example: __INTERFACE-NAME__
45261         - name: interface-name
45262           in: path
45263           description: Name given to the interface
45264           required: true
45265           type: string
45266           example: __INTERFACE-NAME__
45267         - name: vlan-interface
45268           in: path
45269           description: String that identifies the interface
45270           required: true
45271           type: string
45272           example: __VLAN-INTERFACE__
45273         - name: l3-interface-ipv6-address
45274           in: path
45275           description: IP address
45276           required: true
45277           type: string
45278           example: __L3-INTERFACE-IPV6-ADDRESS__
45279         - name: resource-version
45280           in: query
45281           description: resource-version for concurrency
45282           required: true
45283           type: string
45284   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
45285     get:
45286       tags:
45287         - Network
45288       summary: returns vlan
45289       description: returns vlan
45290       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45291       produces:
45292         - application/json
45293         - application/xml
45294       responses:
45295         "200":
45296           description: successful operation
45297           schema:
45298               $ref: "#/getDefinitions/vlan"
45299         "default":
45300           description: Response codes found in [response codes](https://wiki.onap.org/).
45301       parameters:
45302         - name: pnf-name
45303           in: path
45304           description: unique name of Physical Network Function.
45305           required: true
45306           type: string
45307           example: __PNF-NAME__
45308         - name: interface-name
45309           in: path
45310           description: Name that identifies the link aggregate interface
45311           required: true
45312           type: string
45313           example: __INTERFACE-NAME__
45314         - name: interface-name
45315           in: path
45316           description: Name given to the interface
45317           required: true
45318           type: string
45319           example: __INTERFACE-NAME__
45320         - name: vlan-interface
45321           in: path
45322           description: String that identifies the interface
45323           required: true
45324           type: string
45325           example: __VLAN-INTERFACE__
45326         - name: inv-status
45327           in: query
45328           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45329           required: false
45330           type: string
45331         - name: interface-id
45332           in: query
45333           description: ID of interface
45334           required: false
45335           type: string
45336         - name: interface-role
45337           in: query
45338           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45339           required: false
45340           type: string
45341         - name: interface-id
45342           in: query
45343           description: ID of interface
45344           required: false
45345           type: string
45346         - name: macaddr
45347           in: query
45348           description: MAC address for the interface
45349           required: false
45350           type: string
45351         - name: network-name
45352           in: query
45353           description: Name of the network
45354           required: false
45355           type: string
45356         - name: vlan-id-inner
45357           in: query
45358           description: Inner VLAN tag
45359           required: false
45360           type: integer
45361           format: int64
45362         - name: vpn-id
45363           in: query
45364           description: This indicates the customers VPN ID associated with this vlan
45365           required: false
45366           type: string
45367     put:
45368       tags:
45369         - Network
45370       summary: create or update an existing vlan
45371       description: |
45372         Create or update an existing vlan.
45373         #
45374         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45375       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45376       consumes:
45377         - application/json
45378         - application/xml
45379       produces:
45380         - application/json
45381         - application/xml
45382       responses:
45383         "default":
45384           description: Response codes found in [response codes](https://wiki.onap.org/).
45385       parameters:
45386         - name: pnf-name
45387           in: path
45388           description: unique name of Physical Network Function.
45389           required: true
45390           type: string
45391           example: __PNF-NAME__
45392         - name: interface-name
45393           in: path
45394           description: Name that identifies the link aggregate interface
45395           required: true
45396           type: string
45397           example: __INTERFACE-NAME__
45398         - name: interface-name
45399           in: path
45400           description: Name given to the interface
45401           required: true
45402           type: string
45403           example: __INTERFACE-NAME__
45404         - name: vlan-interface
45405           in: path
45406           description: String that identifies the interface
45407           required: true
45408           type: string
45409           example: __VLAN-INTERFACE__
45410         - name: body
45411           in: body
45412           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
45413           required: true
45414           schema:
45415             $ref: "#/definitions/vlan"
45416     patch:
45417       tags:
45418         - Network
45419       summary: update an existing vlan
45420       description: |
45421         Update an existing vlan
45422         #
45423         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45424         The PUT operation will entirely replace an existing object.
45425         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45426         #
45427         Other differences between PUT and PATCH are:
45428         #
45429         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45430         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45431         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45432       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45433       consumes:
45434         - application/json
45435         - application/xml
45436       produces:
45437         - application/json
45438         - application/xml
45439       responses:
45440         "default":
45441           description: Response codes found in [response codes](https://wiki.onap.org/).
45442       parameters:
45443         - name: pnf-name
45444           in: path
45445           description: unique name of Physical Network Function.
45446           required: true
45447           type: string
45448           example: __PNF-NAME__
45449         - name: interface-name
45450           in: path
45451           description: Name that identifies the link aggregate interface
45452           required: true
45453           type: string
45454           example: __INTERFACE-NAME__
45455         - name: interface-name
45456           in: path
45457           description: Name given to the interface
45458           required: true
45459           type: string
45460           example: __INTERFACE-NAME__
45461         - name: vlan-interface
45462           in: path
45463           description: String that identifies the interface
45464           required: true
45465           type: string
45466           example: __VLAN-INTERFACE__
45467         - name: body
45468           in: body
45469           description: vlan object that needs to be created or updated.
45470           required: true
45471           schema:
45472             $ref: "#/patchDefinitions/vlan"
45473     delete:
45474       tags:
45475         - Network
45476       summary: delete an existing vlan
45477       description: delete an existing vlan
45478       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
45479       consumes:
45480         - application/json
45481         - application/xml
45482       produces:
45483         - application/json
45484         - application/xml
45485       responses:
45486         "default":
45487           description: Response codes found in [response codes](https://wiki.onap.org/).
45488       parameters:
45489         - name: pnf-name
45490           in: path
45491           description: unique name of Physical Network Function.
45492           required: true
45493           type: string
45494           example: __PNF-NAME__
45495         - name: interface-name
45496           in: path
45497           description: Name that identifies the link aggregate interface
45498           required: true
45499           type: string
45500           example: __INTERFACE-NAME__
45501         - name: interface-name
45502           in: path
45503           description: Name given to the interface
45504           required: true
45505           type: string
45506           example: __INTERFACE-NAME__
45507         - name: vlan-interface
45508           in: path
45509           description: String that identifies the interface
45510           required: true
45511           type: string
45512           example: __VLAN-INTERFACE__
45513         - name: resource-version
45514           in: query
45515           description: resource-version for concurrency
45516           required: true
45517           type: string
45518   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
45519     get:
45520       tags:
45521         - Network
45522       summary: returns vlans
45523       description: returns vlans
45524       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
45525       produces:
45526         - application/json
45527         - application/xml
45528       responses:
45529         "200":
45530           description: successful operation
45531           schema:
45532               $ref: "#/getDefinitions/vlans"
45533         "default":
45534           description: Response codes found in [response codes](https://wiki.onap.org/).
45535       parameters:
45536         - name: pnf-name
45537           in: path
45538           description: unique name of Physical Network Function.
45539           required: true
45540           type: string
45541           example: __PNF-NAME__
45542         - name: interface-name
45543           in: path
45544           description: Name that identifies the link aggregate interface
45545           required: true
45546           type: string
45547           example: __INTERFACE-NAME__
45548         - name: interface-name
45549           in: path
45550           description: Name given to the interface
45551           required: true
45552           type: string
45553           example: __INTERFACE-NAME__
45554         - name: inv-status
45555           in: query
45556           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45557           required: false
45558           type: string
45559         - name: interface-id
45560           in: query
45561           description: ID of interface
45562           required: false
45563           type: string
45564         - name: interface-role
45565           in: query
45566           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45567           required: false
45568           type: string
45569         - name: interface-id
45570           in: query
45571           description: ID of interface
45572           required: false
45573           type: string
45574         - name: macaddr
45575           in: query
45576           description: MAC address for the interface
45577           required: false
45578           type: string
45579         - name: network-name
45580           in: query
45581           description: Name of the network
45582           required: false
45583           type: string
45584   /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:
45585     put:
45586       tags:
45587         - Network
45588       summary: see node definition for valid relationships
45589       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
45590       consumes:
45591         - application/json
45592         - application/xml
45593       produces:
45594         - application/json
45595         - application/xml
45596       responses:
45597         "default":
45598           description: Response codes found in [response codes](https://wiki.onap.org/).
45599       parameters:
45600         - name: pnf-name
45601           in: path
45602           description: unique name of Physical Network Function.
45603           required: true
45604           type: string
45605           example: __PNF-NAME__
45606         - name: interface-name
45607           in: path
45608           description: Name that identifies the link aggregate interface
45609           required: true
45610           type: string
45611           example: __INTERFACE-NAME__
45612         - name: interface-name
45613           in: path
45614           description: Name given to the interface
45615           required: true
45616           type: string
45617           example: __INTERFACE-NAME__
45618         - name: pci-id
45619           in: path
45620           description: PCI ID used to identify the sriov-vf
45621           required: true
45622           type: string
45623           example: __PCI-ID__
45624         - name: body
45625           in: body
45626           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
45627           required: true
45628           schema:
45629             $ref: "#/definitions/relationship"
45630     delete:
45631       tags:
45632         - Network
45633       summary: delete an existing relationship
45634       description: delete an existing relationship
45635       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
45636       consumes:
45637         - application/json
45638         - application/xml
45639       produces:
45640         - application/json
45641         - application/xml
45642       responses:
45643         "default":
45644           description: Response codes found in [response codes](https://wiki.onap.org/).
45645       parameters:
45646         - name: pnf-name
45647           in: path
45648           description: unique name of Physical Network Function.
45649           required: true
45650           type: string
45651           example: __PNF-NAME__
45652         - name: interface-name
45653           in: path
45654           description: Name that identifies the link aggregate interface
45655           required: true
45656           type: string
45657           example: __INTERFACE-NAME__
45658         - name: interface-name
45659           in: path
45660           description: Name given to the interface
45661           required: true
45662           type: string
45663           example: __INTERFACE-NAME__
45664         - name: pci-id
45665           in: path
45666           description: PCI ID used to identify the sriov-vf
45667           required: true
45668           type: string
45669           example: __PCI-ID__
45670   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
45671     get:
45672       tags:
45673         - Network
45674       summary: returns sriov-vf
45675       description: returns sriov-vf
45676       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45677       produces:
45678         - application/json
45679         - application/xml
45680       responses:
45681         "200":
45682           description: successful operation
45683           schema:
45684               $ref: "#/getDefinitions/sriov-vf"
45685         "default":
45686           description: Response codes found in [response codes](https://wiki.onap.org/).
45687       parameters:
45688         - name: pnf-name
45689           in: path
45690           description: unique name of Physical Network Function.
45691           required: true
45692           type: string
45693           example: __PNF-NAME__
45694         - name: interface-name
45695           in: path
45696           description: Name that identifies the link aggregate interface
45697           required: true
45698           type: string
45699           example: __INTERFACE-NAME__
45700         - name: interface-name
45701           in: path
45702           description: Name given to the interface
45703           required: true
45704           type: string
45705           example: __INTERFACE-NAME__
45706         - name: pci-id
45707           in: path
45708           description: PCI ID used to identify the sriov-vf
45709           required: true
45710           type: string
45711           example: __PCI-ID__
45712         - name: inv-status
45713           in: query
45714           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45715           required: false
45716           type: string
45717         - name: interface-id
45718           in: query
45719           description: ID of interface
45720           required: false
45721           type: string
45722         - name: interface-role
45723           in: query
45724           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45725           required: false
45726           type: string
45727         - name: interface-id
45728           in: query
45729           description: ID of interface
45730           required: false
45731           type: string
45732         - name: macaddr
45733           in: query
45734           description: MAC address for the interface
45735           required: false
45736           type: string
45737         - name: network-name
45738           in: query
45739           description: Name of the network
45740           required: false
45741           type: string
45742         - name: vf-vlan-filter
45743           in: query
45744           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
45745           required: false
45746           type: string
45747         - name: vf-mac-filter
45748           in: query
45749           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
45750           required: false
45751           type: string
45752         - name: vf-vlan-strip
45753           in: query
45754           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
45755           required: false
45756           type: boolean
45757         - name: neutron-network-id
45758           in: query
45759           description: Neutron network id of the interface
45760           required: false
45761           type: string
45762     put:
45763       tags:
45764         - Network
45765       summary: create or update an existing sriov-vf
45766       description: |
45767         Create or update an existing sriov-vf.
45768         #
45769         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45770       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45771       consumes:
45772         - application/json
45773         - application/xml
45774       produces:
45775         - application/json
45776         - application/xml
45777       responses:
45778         "default":
45779           description: Response codes found in [response codes](https://wiki.onap.org/).
45780       parameters:
45781         - name: pnf-name
45782           in: path
45783           description: unique name of Physical Network Function.
45784           required: true
45785           type: string
45786           example: __PNF-NAME__
45787         - name: interface-name
45788           in: path
45789           description: Name that identifies the link aggregate interface
45790           required: true
45791           type: string
45792           example: __INTERFACE-NAME__
45793         - name: interface-name
45794           in: path
45795           description: Name given to the interface
45796           required: true
45797           type: string
45798           example: __INTERFACE-NAME__
45799         - name: pci-id
45800           in: path
45801           description: PCI ID used to identify the sriov-vf
45802           required: true
45803           type: string
45804           example: __PCI-ID__
45805         - name: body
45806           in: body
45807           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
45808           required: true
45809           schema:
45810             $ref: "#/definitions/sriov-vf"
45811     patch:
45812       tags:
45813         - Network
45814       summary: update an existing sriov-vf
45815       description: |
45816         Update an existing sriov-vf
45817         #
45818         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45819         The PUT operation will entirely replace an existing object.
45820         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45821         #
45822         Other differences between PUT and PATCH are:
45823         #
45824         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45825         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45826         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45827       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45828       consumes:
45829         - application/json
45830         - application/xml
45831       produces:
45832         - application/json
45833         - application/xml
45834       responses:
45835         "default":
45836           description: Response codes found in [response codes](https://wiki.onap.org/).
45837       parameters:
45838         - name: pnf-name
45839           in: path
45840           description: unique name of Physical Network Function.
45841           required: true
45842           type: string
45843           example: __PNF-NAME__
45844         - name: interface-name
45845           in: path
45846           description: Name that identifies the link aggregate interface
45847           required: true
45848           type: string
45849           example: __INTERFACE-NAME__
45850         - name: interface-name
45851           in: path
45852           description: Name given to the interface
45853           required: true
45854           type: string
45855           example: __INTERFACE-NAME__
45856         - name: pci-id
45857           in: path
45858           description: PCI ID used to identify the sriov-vf
45859           required: true
45860           type: string
45861           example: __PCI-ID__
45862         - name: body
45863           in: body
45864           description: sriov-vf object that needs to be created or updated.
45865           required: true
45866           schema:
45867             $ref: "#/patchDefinitions/sriov-vf"
45868     delete:
45869       tags:
45870         - Network
45871       summary: delete an existing sriov-vf
45872       description: delete an existing sriov-vf
45873       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
45874       consumes:
45875         - application/json
45876         - application/xml
45877       produces:
45878         - application/json
45879         - application/xml
45880       responses:
45881         "default":
45882           description: Response codes found in [response codes](https://wiki.onap.org/).
45883       parameters:
45884         - name: pnf-name
45885           in: path
45886           description: unique name of Physical Network Function.
45887           required: true
45888           type: string
45889           example: __PNF-NAME__
45890         - name: interface-name
45891           in: path
45892           description: Name that identifies the link aggregate interface
45893           required: true
45894           type: string
45895           example: __INTERFACE-NAME__
45896         - name: interface-name
45897           in: path
45898           description: Name given to the interface
45899           required: true
45900           type: string
45901           example: __INTERFACE-NAME__
45902         - name: pci-id
45903           in: path
45904           description: PCI ID used to identify the sriov-vf
45905           required: true
45906           type: string
45907           example: __PCI-ID__
45908         - name: resource-version
45909           in: query
45910           description: resource-version for concurrency
45911           required: true
45912           type: string
45913   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
45914     get:
45915       tags:
45916         - Network
45917       summary: returns sriov-vfs
45918       description: returns sriov-vfs
45919       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
45920       produces:
45921         - application/json
45922         - application/xml
45923       responses:
45924         "200":
45925           description: successful operation
45926           schema:
45927               $ref: "#/getDefinitions/sriov-vfs"
45928         "default":
45929           description: Response codes found in [response codes](https://wiki.onap.org/).
45930       parameters:
45931         - name: pnf-name
45932           in: path
45933           description: unique name of Physical Network Function.
45934           required: true
45935           type: string
45936           example: __PNF-NAME__
45937         - name: interface-name
45938           in: path
45939           description: Name that identifies the link aggregate interface
45940           required: true
45941           type: string
45942           example: __INTERFACE-NAME__
45943         - name: interface-name
45944           in: path
45945           description: Name given to the interface
45946           required: true
45947           type: string
45948           example: __INTERFACE-NAME__
45949         - name: inv-status
45950           in: query
45951           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45952           required: false
45953           type: string
45954         - name: interface-id
45955           in: query
45956           description: ID of interface
45957           required: false
45958           type: string
45959         - name: interface-role
45960           in: query
45961           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
45962           required: false
45963           type: string
45964         - name: interface-id
45965           in: query
45966           description: ID of interface
45967           required: false
45968           type: string
45969         - name: macaddr
45970           in: query
45971           description: MAC address for the interface
45972           required: false
45973           type: string
45974         - name: network-name
45975           in: query
45976           description: Name of the network
45977           required: false
45978           type: string
45979   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
45980     put:
45981       tags:
45982         - Network
45983       summary: see node definition for valid relationships
45984       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
45985       consumes:
45986         - application/json
45987         - application/xml
45988       produces:
45989         - application/json
45990         - application/xml
45991       responses:
45992         "default":
45993           description: Response codes found in [response codes](https://wiki.onap.org/).
45994       parameters:
45995         - name: pnf-name
45996           in: path
45997           description: unique name of Physical Network Function.
45998           required: true
45999           type: string
46000           example: __PNF-NAME__
46001         - name: interface-name
46002           in: path
46003           description: Name that identifies the link aggregate interface
46004           required: true
46005           type: string
46006           example: __INTERFACE-NAME__
46007         - name: interface-name
46008           in: path
46009           description: Name given to the interface
46010           required: true
46011           type: string
46012           example: __INTERFACE-NAME__
46013         - name: body
46014           in: body
46015           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
46016           required: true
46017           schema:
46018             $ref: "#/definitions/relationship"
46019     delete:
46020       tags:
46021         - Network
46022       summary: delete an existing relationship
46023       description: delete an existing relationship
46024       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
46025       consumes:
46026         - application/json
46027         - application/xml
46028       produces:
46029         - application/json
46030         - application/xml
46031       responses:
46032         "default":
46033           description: Response codes found in [response codes](https://wiki.onap.org/).
46034       parameters:
46035         - name: pnf-name
46036           in: path
46037           description: unique name of Physical Network Function.
46038           required: true
46039           type: string
46040           example: __PNF-NAME__
46041         - name: interface-name
46042           in: path
46043           description: Name that identifies the link aggregate interface
46044           required: true
46045           type: string
46046           example: __INTERFACE-NAME__
46047         - name: interface-name
46048           in: path
46049           description: Name given to the interface
46050           required: true
46051           type: string
46052           example: __INTERFACE-NAME__
46053   /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:
46054     put:
46055       tags:
46056         - Network
46057       summary: see node definition for valid relationships
46058       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46059       consumes:
46060         - application/json
46061         - application/xml
46062       produces:
46063         - application/json
46064         - application/xml
46065       responses:
46066         "default":
46067           description: Response codes found in [response codes](https://wiki.onap.org/).
46068       parameters:
46069         - name: pnf-name
46070           in: path
46071           description: unique name of Physical Network Function.
46072           required: true
46073           type: string
46074           example: __PNF-NAME__
46075         - name: interface-name
46076           in: path
46077           description: Name that identifies the link aggregate interface
46078           required: true
46079           type: string
46080           example: __INTERFACE-NAME__
46081         - name: interface-name
46082           in: path
46083           description: Name given to the interface
46084           required: true
46085           type: string
46086           example: __INTERFACE-NAME__
46087         - name: l3-interface-ipv4-address
46088           in: path
46089           description: IP address
46090           required: true
46091           type: string
46092           example: __L3-INTERFACE-IPV4-ADDRESS__
46093         - name: body
46094           in: body
46095           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46096           required: true
46097           schema:
46098             $ref: "#/definitions/relationship"
46099     delete:
46100       tags:
46101         - Network
46102       summary: delete an existing relationship
46103       description: delete an existing relationship
46104       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46105       consumes:
46106         - application/json
46107         - application/xml
46108       produces:
46109         - application/json
46110         - application/xml
46111       responses:
46112         "default":
46113           description: Response codes found in [response codes](https://wiki.onap.org/).
46114       parameters:
46115         - name: pnf-name
46116           in: path
46117           description: unique name of Physical Network Function.
46118           required: true
46119           type: string
46120           example: __PNF-NAME__
46121         - name: interface-name
46122           in: path
46123           description: Name that identifies the link aggregate interface
46124           required: true
46125           type: string
46126           example: __INTERFACE-NAME__
46127         - name: interface-name
46128           in: path
46129           description: Name given to the interface
46130           required: true
46131           type: string
46132           example: __INTERFACE-NAME__
46133         - name: l3-interface-ipv4-address
46134           in: path
46135           description: IP address
46136           required: true
46137           type: string
46138           example: __L3-INTERFACE-IPV4-ADDRESS__
46139   /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}:
46140     get:
46141       tags:
46142         - Network
46143       summary: returns l3-interface-ipv4-address-list
46144       description: returns l3-interface-ipv4-address-list
46145       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46146       produces:
46147         - application/json
46148         - application/xml
46149       responses:
46150         "200":
46151           description: successful operation
46152           schema:
46153               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46154         "default":
46155           description: Response codes found in [response codes](https://wiki.onap.org/).
46156       parameters:
46157         - name: pnf-name
46158           in: path
46159           description: unique name of Physical Network Function.
46160           required: true
46161           type: string
46162           example: __PNF-NAME__
46163         - name: interface-name
46164           in: path
46165           description: Name that identifies the link aggregate interface
46166           required: true
46167           type: string
46168           example: __INTERFACE-NAME__
46169         - name: interface-name
46170           in: path
46171           description: Name given to the interface
46172           required: true
46173           type: string
46174           example: __INTERFACE-NAME__
46175         - name: l3-interface-ipv4-address
46176           in: path
46177           description: IP address
46178           required: true
46179           type: string
46180           example: __L3-INTERFACE-IPV4-ADDRESS__
46181         - name: inv-status
46182           in: query
46183           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46184           required: false
46185           type: string
46186         - name: interface-id
46187           in: query
46188           description: ID of interface
46189           required: false
46190           type: string
46191         - name: interface-role
46192           in: query
46193           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46194           required: false
46195           type: string
46196         - name: interface-id
46197           in: query
46198           description: ID of interface
46199           required: false
46200           type: string
46201         - name: macaddr
46202           in: query
46203           description: MAC address for the interface
46204           required: false
46205           type: string
46206         - name: network-name
46207           in: query
46208           description: Name of the network
46209           required: false
46210           type: string
46211         - name: vlan-id-inner
46212           in: query
46213           description: Inner VLAN tag
46214           required: false
46215           type: integer
46216           format: int64
46217         - name: neutron-network-id
46218           in: query
46219           description: Neutron network id of the interface that address belongs to
46220           required: false
46221           type: string
46222         - name: neutron-subnet-id
46223           in: query
46224           description: Neutron id of subnet that address belongs to
46225           required: false
46226           type: string
46227     put:
46228       tags:
46229         - Network
46230       summary: create or update an existing l3-interface-ipv4-address-list
46231       description: |
46232         Create or update an existing l3-interface-ipv4-address-list.
46233         #
46234         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46235       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46236       consumes:
46237         - application/json
46238         - application/xml
46239       produces:
46240         - application/json
46241         - application/xml
46242       responses:
46243         "default":
46244           description: Response codes found in [response codes](https://wiki.onap.org/).
46245       parameters:
46246         - name: pnf-name
46247           in: path
46248           description: unique name of Physical Network Function.
46249           required: true
46250           type: string
46251           example: __PNF-NAME__
46252         - name: interface-name
46253           in: path
46254           description: Name that identifies the link aggregate interface
46255           required: true
46256           type: string
46257           example: __INTERFACE-NAME__
46258         - name: interface-name
46259           in: path
46260           description: Name given to the interface
46261           required: true
46262           type: string
46263           example: __INTERFACE-NAME__
46264         - name: l3-interface-ipv4-address
46265           in: path
46266           description: IP address
46267           required: true
46268           type: string
46269           example: __L3-INTERFACE-IPV4-ADDRESS__
46270         - name: body
46271           in: body
46272           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46273           required: true
46274           schema:
46275             $ref: "#/definitions/l3-interface-ipv4-address-list"
46276     patch:
46277       tags:
46278         - Network
46279       summary: update an existing l3-interface-ipv4-address-list
46280       description: |
46281         Update an existing l3-interface-ipv4-address-list
46282         #
46283         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46284         The PUT operation will entirely replace an existing object.
46285         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46286         #
46287         Other differences between PUT and PATCH are:
46288         #
46289         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46290         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46291         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46292       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46293       consumes:
46294         - application/json
46295         - application/xml
46296       produces:
46297         - application/json
46298         - application/xml
46299       responses:
46300         "default":
46301           description: Response codes found in [response codes](https://wiki.onap.org/).
46302       parameters:
46303         - name: pnf-name
46304           in: path
46305           description: unique name of Physical Network Function.
46306           required: true
46307           type: string
46308           example: __PNF-NAME__
46309         - name: interface-name
46310           in: path
46311           description: Name that identifies the link aggregate interface
46312           required: true
46313           type: string
46314           example: __INTERFACE-NAME__
46315         - name: interface-name
46316           in: path
46317           description: Name given to the interface
46318           required: true
46319           type: string
46320           example: __INTERFACE-NAME__
46321         - name: l3-interface-ipv4-address
46322           in: path
46323           description: IP address
46324           required: true
46325           type: string
46326           example: __L3-INTERFACE-IPV4-ADDRESS__
46327         - name: body
46328           in: body
46329           description: l3-interface-ipv4-address-list object that needs to be created or updated.
46330           required: true
46331           schema:
46332             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
46333     delete:
46334       tags:
46335         - Network
46336       summary: delete an existing l3-interface-ipv4-address-list
46337       description: delete an existing l3-interface-ipv4-address-list
46338       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46339       consumes:
46340         - application/json
46341         - application/xml
46342       produces:
46343         - application/json
46344         - application/xml
46345       responses:
46346         "default":
46347           description: Response codes found in [response codes](https://wiki.onap.org/).
46348       parameters:
46349         - name: pnf-name
46350           in: path
46351           description: unique name of Physical Network Function.
46352           required: true
46353           type: string
46354           example: __PNF-NAME__
46355         - name: interface-name
46356           in: path
46357           description: Name that identifies the link aggregate interface
46358           required: true
46359           type: string
46360           example: __INTERFACE-NAME__
46361         - name: interface-name
46362           in: path
46363           description: Name given to the interface
46364           required: true
46365           type: string
46366           example: __INTERFACE-NAME__
46367         - name: l3-interface-ipv4-address
46368           in: path
46369           description: IP address
46370           required: true
46371           type: string
46372           example: __L3-INTERFACE-IPV4-ADDRESS__
46373         - name: resource-version
46374           in: query
46375           description: resource-version for concurrency
46376           required: true
46377           type: string
46378   /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:
46379     put:
46380       tags:
46381         - Network
46382       summary: see node definition for valid relationships
46383       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
46384       consumes:
46385         - application/json
46386         - application/xml
46387       produces:
46388         - application/json
46389         - application/xml
46390       responses:
46391         "default":
46392           description: Response codes found in [response codes](https://wiki.onap.org/).
46393       parameters:
46394         - name: pnf-name
46395           in: path
46396           description: unique name of Physical Network Function.
46397           required: true
46398           type: string
46399           example: __PNF-NAME__
46400         - name: interface-name
46401           in: path
46402           description: Name that identifies the link aggregate interface
46403           required: true
46404           type: string
46405           example: __INTERFACE-NAME__
46406         - name: interface-name
46407           in: path
46408           description: Name given to the interface
46409           required: true
46410           type: string
46411           example: __INTERFACE-NAME__
46412         - name: l3-interface-ipv6-address
46413           in: path
46414           description: IP address
46415           required: true
46416           type: string
46417           example: __L3-INTERFACE-IPV6-ADDRESS__
46418         - name: body
46419           in: body
46420           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
46421           required: true
46422           schema:
46423             $ref: "#/definitions/relationship"
46424     delete:
46425       tags:
46426         - Network
46427       summary: delete an existing relationship
46428       description: delete an existing relationship
46429       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
46430       consumes:
46431         - application/json
46432         - application/xml
46433       produces:
46434         - application/json
46435         - application/xml
46436       responses:
46437         "default":
46438           description: Response codes found in [response codes](https://wiki.onap.org/).
46439       parameters:
46440         - name: pnf-name
46441           in: path
46442           description: unique name of Physical Network Function.
46443           required: true
46444           type: string
46445           example: __PNF-NAME__
46446         - name: interface-name
46447           in: path
46448           description: Name that identifies the link aggregate interface
46449           required: true
46450           type: string
46451           example: __INTERFACE-NAME__
46452         - name: interface-name
46453           in: path
46454           description: Name given to the interface
46455           required: true
46456           type: string
46457           example: __INTERFACE-NAME__
46458         - name: l3-interface-ipv6-address
46459           in: path
46460           description: IP address
46461           required: true
46462           type: string
46463           example: __L3-INTERFACE-IPV6-ADDRESS__
46464   /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}:
46465     get:
46466       tags:
46467         - Network
46468       summary: returns l3-interface-ipv6-address-list
46469       description: returns l3-interface-ipv6-address-list
46470       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46471       produces:
46472         - application/json
46473         - application/xml
46474       responses:
46475         "200":
46476           description: successful operation
46477           schema:
46478               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
46479         "default":
46480           description: Response codes found in [response codes](https://wiki.onap.org/).
46481       parameters:
46482         - name: pnf-name
46483           in: path
46484           description: unique name of Physical Network Function.
46485           required: true
46486           type: string
46487           example: __PNF-NAME__
46488         - name: interface-name
46489           in: path
46490           description: Name that identifies the link aggregate interface
46491           required: true
46492           type: string
46493           example: __INTERFACE-NAME__
46494         - name: interface-name
46495           in: path
46496           description: Name given to the interface
46497           required: true
46498           type: string
46499           example: __INTERFACE-NAME__
46500         - name: l3-interface-ipv6-address
46501           in: path
46502           description: IP address
46503           required: true
46504           type: string
46505           example: __L3-INTERFACE-IPV6-ADDRESS__
46506         - name: inv-status
46507           in: query
46508           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46509           required: false
46510           type: string
46511         - name: interface-id
46512           in: query
46513           description: ID of interface
46514           required: false
46515           type: string
46516         - name: interface-role
46517           in: query
46518           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46519           required: false
46520           type: string
46521         - name: interface-id
46522           in: query
46523           description: ID of interface
46524           required: false
46525           type: string
46526         - name: macaddr
46527           in: query
46528           description: MAC address for the interface
46529           required: false
46530           type: string
46531         - name: network-name
46532           in: query
46533           description: Name of the network
46534           required: false
46535           type: string
46536         - name: vlan-id-inner
46537           in: query
46538           description: Inner VLAN tag
46539           required: false
46540           type: integer
46541           format: int64
46542         - name: neutron-network-id
46543           in: query
46544           description: Neutron network id of the interface that address belongs to
46545           required: false
46546           type: string
46547         - name: neutron-subnet-id
46548           in: query
46549           description: Neutron id of subnet that address belongs to
46550           required: false
46551           type: string
46552     put:
46553       tags:
46554         - Network
46555       summary: create or update an existing l3-interface-ipv6-address-list
46556       description: |
46557         Create or update an existing l3-interface-ipv6-address-list.
46558         #
46559         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46560       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46561       consumes:
46562         - application/json
46563         - application/xml
46564       produces:
46565         - application/json
46566         - application/xml
46567       responses:
46568         "default":
46569           description: Response codes found in [response codes](https://wiki.onap.org/).
46570       parameters:
46571         - name: pnf-name
46572           in: path
46573           description: unique name of Physical Network Function.
46574           required: true
46575           type: string
46576           example: __PNF-NAME__
46577         - name: interface-name
46578           in: path
46579           description: Name that identifies the link aggregate interface
46580           required: true
46581           type: string
46582           example: __INTERFACE-NAME__
46583         - name: interface-name
46584           in: path
46585           description: Name given to the interface
46586           required: true
46587           type: string
46588           example: __INTERFACE-NAME__
46589         - name: l3-interface-ipv6-address
46590           in: path
46591           description: IP address
46592           required: true
46593           type: string
46594           example: __L3-INTERFACE-IPV6-ADDRESS__
46595         - name: body
46596           in: body
46597           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
46598           required: true
46599           schema:
46600             $ref: "#/definitions/l3-interface-ipv6-address-list"
46601     patch:
46602       tags:
46603         - Network
46604       summary: update an existing l3-interface-ipv6-address-list
46605       description: |
46606         Update an existing l3-interface-ipv6-address-list
46607         #
46608         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46609         The PUT operation will entirely replace an existing object.
46610         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46611         #
46612         Other differences between PUT and PATCH are:
46613         #
46614         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46615         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46616         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46617       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46618       consumes:
46619         - application/json
46620         - application/xml
46621       produces:
46622         - application/json
46623         - application/xml
46624       responses:
46625         "default":
46626           description: Response codes found in [response codes](https://wiki.onap.org/).
46627       parameters:
46628         - name: pnf-name
46629           in: path
46630           description: unique name of Physical Network Function.
46631           required: true
46632           type: string
46633           example: __PNF-NAME__
46634         - name: interface-name
46635           in: path
46636           description: Name that identifies the link aggregate interface
46637           required: true
46638           type: string
46639           example: __INTERFACE-NAME__
46640         - name: interface-name
46641           in: path
46642           description: Name given to the interface
46643           required: true
46644           type: string
46645           example: __INTERFACE-NAME__
46646         - name: l3-interface-ipv6-address
46647           in: path
46648           description: IP address
46649           required: true
46650           type: string
46651           example: __L3-INTERFACE-IPV6-ADDRESS__
46652         - name: body
46653           in: body
46654           description: l3-interface-ipv6-address-list object that needs to be created or updated.
46655           required: true
46656           schema:
46657             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
46658     delete:
46659       tags:
46660         - Network
46661       summary: delete an existing l3-interface-ipv6-address-list
46662       description: delete an existing l3-interface-ipv6-address-list
46663       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
46664       consumes:
46665         - application/json
46666         - application/xml
46667       produces:
46668         - application/json
46669         - application/xml
46670       responses:
46671         "default":
46672           description: Response codes found in [response codes](https://wiki.onap.org/).
46673       parameters:
46674         - name: pnf-name
46675           in: path
46676           description: unique name of Physical Network Function.
46677           required: true
46678           type: string
46679           example: __PNF-NAME__
46680         - name: interface-name
46681           in: path
46682           description: Name that identifies the link aggregate interface
46683           required: true
46684           type: string
46685           example: __INTERFACE-NAME__
46686         - name: interface-name
46687           in: path
46688           description: Name given to the interface
46689           required: true
46690           type: string
46691           example: __INTERFACE-NAME__
46692         - name: l3-interface-ipv6-address
46693           in: path
46694           description: IP address
46695           required: true
46696           type: string
46697           example: __L3-INTERFACE-IPV6-ADDRESS__
46698         - name: resource-version
46699           in: query
46700           description: resource-version for concurrency
46701           required: true
46702           type: string
46703   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
46704     get:
46705       tags:
46706         - Network
46707       summary: returns l-interface
46708       description: returns l-interface
46709       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46710       produces:
46711         - application/json
46712         - application/xml
46713       responses:
46714         "200":
46715           description: successful operation
46716           schema:
46717               $ref: "#/getDefinitions/l-interface"
46718         "default":
46719           description: Response codes found in [response codes](https://wiki.onap.org/).
46720       parameters:
46721         - name: pnf-name
46722           in: path
46723           description: unique name of Physical Network Function.
46724           required: true
46725           type: string
46726           example: __PNF-NAME__
46727         - name: interface-name
46728           in: path
46729           description: Name that identifies the link aggregate interface
46730           required: true
46731           type: string
46732           example: __INTERFACE-NAME__
46733         - name: interface-name
46734           in: path
46735           description: Name given to the interface
46736           required: true
46737           type: string
46738           example: __INTERFACE-NAME__
46739         - name: inv-status
46740           in: query
46741           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46742           required: false
46743           type: string
46744         - name: interface-id
46745           in: query
46746           description: ID of interface
46747           required: false
46748           type: string
46749         - name: interface-role
46750           in: query
46751           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46752           required: false
46753           type: string
46754         - name: interface-id
46755           in: query
46756           description: ID of interface
46757           required: false
46758           type: string
46759         - name: macaddr
46760           in: query
46761           description: MAC address for the interface
46762           required: false
46763           type: string
46764         - name: network-name
46765           in: query
46766           description: Name of the network
46767           required: false
46768           type: string
46769     put:
46770       tags:
46771         - Network
46772       summary: create or update an existing l-interface
46773       description: |
46774         Create or update an existing l-interface.
46775         #
46776         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46777       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46778       consumes:
46779         - application/json
46780         - application/xml
46781       produces:
46782         - application/json
46783         - application/xml
46784       responses:
46785         "default":
46786           description: Response codes found in [response codes](https://wiki.onap.org/).
46787       parameters:
46788         - name: pnf-name
46789           in: path
46790           description: unique name of Physical Network Function.
46791           required: true
46792           type: string
46793           example: __PNF-NAME__
46794         - name: interface-name
46795           in: path
46796           description: Name that identifies the link aggregate interface
46797           required: true
46798           type: string
46799           example: __INTERFACE-NAME__
46800         - name: interface-name
46801           in: path
46802           description: Name given to the interface
46803           required: true
46804           type: string
46805           example: __INTERFACE-NAME__
46806         - name: body
46807           in: body
46808           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
46809           required: true
46810           schema:
46811             $ref: "#/definitions/l-interface"
46812     patch:
46813       tags:
46814         - Network
46815       summary: update an existing l-interface
46816       description: |
46817         Update an existing l-interface
46818         #
46819         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46820         The PUT operation will entirely replace an existing object.
46821         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46822         #
46823         Other differences between PUT and PATCH are:
46824         #
46825         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46826         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46827         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46828       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46829       consumes:
46830         - application/json
46831         - application/xml
46832       produces:
46833         - application/json
46834         - application/xml
46835       responses:
46836         "default":
46837           description: Response codes found in [response codes](https://wiki.onap.org/).
46838       parameters:
46839         - name: pnf-name
46840           in: path
46841           description: unique name of Physical Network Function.
46842           required: true
46843           type: string
46844           example: __PNF-NAME__
46845         - name: interface-name
46846           in: path
46847           description: Name that identifies the link aggregate interface
46848           required: true
46849           type: string
46850           example: __INTERFACE-NAME__
46851         - name: interface-name
46852           in: path
46853           description: Name given to the interface
46854           required: true
46855           type: string
46856           example: __INTERFACE-NAME__
46857         - name: body
46858           in: body
46859           description: l-interface object that needs to be created or updated.
46860           required: true
46861           schema:
46862             $ref: "#/patchDefinitions/l-interface"
46863     delete:
46864       tags:
46865         - Network
46866       summary: delete an existing l-interface
46867       description: delete an existing l-interface
46868       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
46869       consumes:
46870         - application/json
46871         - application/xml
46872       produces:
46873         - application/json
46874         - application/xml
46875       responses:
46876         "default":
46877           description: Response codes found in [response codes](https://wiki.onap.org/).
46878       parameters:
46879         - name: pnf-name
46880           in: path
46881           description: unique name of Physical Network Function.
46882           required: true
46883           type: string
46884           example: __PNF-NAME__
46885         - name: interface-name
46886           in: path
46887           description: Name that identifies the link aggregate interface
46888           required: true
46889           type: string
46890           example: __INTERFACE-NAME__
46891         - name: interface-name
46892           in: path
46893           description: Name given to the interface
46894           required: true
46895           type: string
46896           example: __INTERFACE-NAME__
46897         - name: resource-version
46898           in: query
46899           description: resource-version for concurrency
46900           required: true
46901           type: string
46902   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
46903     get:
46904       tags:
46905         - Network
46906       summary: returns l-interfaces
46907       description: returns l-interfaces
46908       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
46909       produces:
46910         - application/json
46911         - application/xml
46912       responses:
46913         "200":
46914           description: successful operation
46915           schema:
46916               $ref: "#/getDefinitions/l-interfaces"
46917         "default":
46918           description: Response codes found in [response codes](https://wiki.onap.org/).
46919       parameters:
46920         - name: pnf-name
46921           in: path
46922           description: unique name of Physical Network Function.
46923           required: true
46924           type: string
46925           example: __PNF-NAME__
46926         - name: interface-name
46927           in: path
46928           description: Name that identifies the link aggregate interface
46929           required: true
46930           type: string
46931           example: __INTERFACE-NAME__
46932         - name: inv-status
46933           in: query
46934           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46935           required: false
46936           type: string
46937         - name: interface-id
46938           in: query
46939           description: ID of interface
46940           required: false
46941           type: string
46942         - name: interface-role
46943           in: query
46944           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46945           required: false
46946           type: string
46947   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
46948     get:
46949       tags:
46950         - Network
46951       summary: returns lag-interface
46952       description: returns lag-interface
46953       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
46954       produces:
46955         - application/json
46956         - application/xml
46957       responses:
46958         "200":
46959           description: successful operation
46960           schema:
46961               $ref: "#/getDefinitions/lag-interface"
46962         "default":
46963           description: Response codes found in [response codes](https://wiki.onap.org/).
46964       parameters:
46965         - name: pnf-name
46966           in: path
46967           description: unique name of Physical Network Function.
46968           required: true
46969           type: string
46970           example: __PNF-NAME__
46971         - name: interface-name
46972           in: path
46973           description: Name that identifies the link aggregate interface
46974           required: true
46975           type: string
46976           example: __INTERFACE-NAME__
46977         - name: inv-status
46978           in: query
46979           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46980           required: false
46981           type: string
46982         - name: interface-id
46983           in: query
46984           description: ID of interface
46985           required: false
46986           type: string
46987         - name: interface-role
46988           in: query
46989           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
46990           required: false
46991           type: string
46992     put:
46993       tags:
46994         - Network
46995       summary: create or update an existing lag-interface
46996       description: |
46997         Create or update an existing lag-interface.
46998         #
46999         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47000       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
47001       consumes:
47002         - application/json
47003         - application/xml
47004       produces:
47005         - application/json
47006         - application/xml
47007       responses:
47008         "default":
47009           description: Response codes found in [response codes](https://wiki.onap.org/).
47010       parameters:
47011         - name: pnf-name
47012           in: path
47013           description: unique name of Physical Network Function.
47014           required: true
47015           type: string
47016           example: __PNF-NAME__
47017         - name: interface-name
47018           in: path
47019           description: Name that identifies the link aggregate interface
47020           required: true
47021           type: string
47022           example: __INTERFACE-NAME__
47023         - name: body
47024           in: body
47025           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnfLagInterfacesLagInterface.json)
47026           required: true
47027           schema:
47028             $ref: "#/definitions/lag-interface"
47029     patch:
47030       tags:
47031         - Network
47032       summary: update an existing lag-interface
47033       description: |
47034         Update an existing lag-interface
47035         #
47036         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47037         The PUT operation will entirely replace an existing object.
47038         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47039         #
47040         Other differences between PUT and PATCH are:
47041         #
47042         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47043         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47044         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47045       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
47046       consumes:
47047         - application/json
47048         - application/xml
47049       produces:
47050         - application/json
47051         - application/xml
47052       responses:
47053         "default":
47054           description: Response codes found in [response codes](https://wiki.onap.org/).
47055       parameters:
47056         - name: pnf-name
47057           in: path
47058           description: unique name of Physical Network Function.
47059           required: true
47060           type: string
47061           example: __PNF-NAME__
47062         - name: interface-name
47063           in: path
47064           description: Name that identifies the link aggregate interface
47065           required: true
47066           type: string
47067           example: __INTERFACE-NAME__
47068         - name: body
47069           in: body
47070           description: lag-interface object that needs to be created or updated.
47071           required: true
47072           schema:
47073             $ref: "#/patchDefinitions/lag-interface"
47074     delete:
47075       tags:
47076         - Network
47077       summary: delete an existing lag-interface
47078       description: delete an existing lag-interface
47079       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
47080       consumes:
47081         - application/json
47082         - application/xml
47083       produces:
47084         - application/json
47085         - application/xml
47086       responses:
47087         "default":
47088           description: Response codes found in [response codes](https://wiki.onap.org/).
47089       parameters:
47090         - name: pnf-name
47091           in: path
47092           description: unique name of Physical Network Function.
47093           required: true
47094           type: string
47095           example: __PNF-NAME__
47096         - name: interface-name
47097           in: path
47098           description: Name that identifies the link aggregate interface
47099           required: true
47100           type: string
47101           example: __INTERFACE-NAME__
47102         - name: resource-version
47103           in: query
47104           description: resource-version for concurrency
47105           required: true
47106           type: string
47107   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
47108     get:
47109       tags:
47110         - Network
47111       summary: returns lag-interfaces
47112       description: returns lag-interfaces
47113       operationId: getNetworkPnfsPnfLagInterfaces
47114       produces:
47115         - application/json
47116         - application/xml
47117       responses:
47118         "200":
47119           description: successful operation
47120           schema:
47121               $ref: "#/getDefinitions/lag-interfaces"
47122         "default":
47123           description: Response codes found in [response codes](https://wiki.onap.org/).
47124       parameters:
47125         - name: pnf-name
47126           in: path
47127           description: unique name of Physical Network Function.
47128           required: true
47129           type: string
47130           example: __PNF-NAME__
47131         - name: inv-status
47132           in: query
47133           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47134           required: false
47135           type: string
47136   /network/pnfs/pnf/{pnf-name}:
47137     get:
47138       tags:
47139         - Network
47140       summary: returns pnf
47141       description: returns pnf
47142       operationId: getNetworkPnfsPnf
47143       produces:
47144         - application/json
47145         - application/xml
47146       responses:
47147         "200":
47148           description: successful operation
47149           schema:
47150               $ref: "#/getDefinitions/pnf"
47151         "default":
47152           description: Response codes found in [response codes](https://wiki.onap.org/).
47153       parameters:
47154         - name: pnf-name
47155           in: path
47156           description: unique name of Physical Network Function.
47157           required: true
47158           type: string
47159           example: __PNF-NAME__
47160         - name: inv-status
47161           in: query
47162           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47163           required: false
47164           type: string
47165     put:
47166       tags:
47167         - Network
47168       summary: create or update an existing pnf
47169       description: |
47170         Create or update an existing pnf.
47171         #
47172         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47173       operationId: createOrUpdateNetworkPnfsPnf
47174       consumes:
47175         - application/json
47176         - application/xml
47177       produces:
47178         - application/json
47179         - application/xml
47180       responses:
47181         "default":
47182           description: Response codes found in [response codes](https://wiki.onap.org/).
47183       parameters:
47184         - name: pnf-name
47185           in: path
47186           description: unique name of Physical Network Function.
47187           required: true
47188           type: string
47189           example: __PNF-NAME__
47190         - name: body
47191           in: body
47192           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPnfsPnf.json)
47193           required: true
47194           schema:
47195             $ref: "#/definitions/pnf"
47196     patch:
47197       tags:
47198         - Network
47199       summary: update an existing pnf
47200       description: |
47201         Update an existing pnf
47202         #
47203         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47204         The PUT operation will entirely replace an existing object.
47205         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47206         #
47207         Other differences between PUT and PATCH are:
47208         #
47209         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47210         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47211         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47212       operationId: UpdateNetworkPnfsPnf
47213       consumes:
47214         - application/json
47215         - application/xml
47216       produces:
47217         - application/json
47218         - application/xml
47219       responses:
47220         "default":
47221           description: Response codes found in [response codes](https://wiki.onap.org/).
47222       parameters:
47223         - name: pnf-name
47224           in: path
47225           description: unique name of Physical Network Function.
47226           required: true
47227           type: string
47228           example: __PNF-NAME__
47229         - name: body
47230           in: body
47231           description: pnf object that needs to be created or updated.
47232           required: true
47233           schema:
47234             $ref: "#/patchDefinitions/pnf"
47235     delete:
47236       tags:
47237         - Network
47238       summary: delete an existing pnf
47239       description: delete an existing pnf
47240       operationId: deleteNetworkPnfsPnf
47241       consumes:
47242         - application/json
47243         - application/xml
47244       produces:
47245         - application/json
47246         - application/xml
47247       responses:
47248         "default":
47249           description: Response codes found in [response codes](https://wiki.onap.org/).
47250       parameters:
47251         - name: pnf-name
47252           in: path
47253           description: unique name of Physical Network Function.
47254           required: true
47255           type: string
47256           example: __PNF-NAME__
47257         - name: resource-version
47258           in: query
47259           description: resource-version for concurrency
47260           required: true
47261           type: string
47262   /network/pnfs:
47263     get:
47264       tags:
47265         - Network
47266       summary: returns pnfs
47267       description: returns pnfs
47268       operationId: getNetworkPnfs
47269       produces:
47270         - application/json
47271         - application/xml
47272       responses:
47273         "200":
47274           description: successful operation
47275           schema:
47276               $ref: "#/getDefinitions/pnfs"
47277         "default":
47278           description: Response codes found in [response codes](https://wiki.onap.org/).
47279   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
47280     put:
47281       tags:
47282         - Network
47283       summary: see node definition for valid relationships
47284       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
47285       consumes:
47286         - application/json
47287         - application/xml
47288       produces:
47289         - application/json
47290         - application/xml
47291       responses:
47292         "default":
47293           description: Response codes found in [response codes](https://wiki.onap.org/).
47294       parameters:
47295         - name: link-name
47296           in: path
47297           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47298           required: true
47299           type: string
47300           example: __LINK-NAME__
47301         - name: body
47302           in: body
47303           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
47304           required: true
47305           schema:
47306             $ref: "#/definitions/relationship"
47307     delete:
47308       tags:
47309         - Network
47310       summary: delete an existing relationship
47311       description: delete an existing relationship
47312       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
47313       consumes:
47314         - application/json
47315         - application/xml
47316       produces:
47317         - application/json
47318         - application/xml
47319       responses:
47320         "default":
47321           description: Response codes found in [response codes](https://wiki.onap.org/).
47322       parameters:
47323         - name: link-name
47324           in: path
47325           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47326           required: true
47327           type: string
47328           example: __LINK-NAME__
47329   /network/physical-links/physical-link/{link-name}:
47330     get:
47331       tags:
47332         - Network
47333       summary: returns physical-link
47334       description: returns physical-link
47335       operationId: getNetworkPhysicalLinksPhysicalLink
47336       produces:
47337         - application/json
47338         - application/xml
47339       responses:
47340         "200":
47341           description: successful operation
47342           schema:
47343               $ref: "#/getDefinitions/physical-link"
47344         "default":
47345           description: Response codes found in [response codes](https://wiki.onap.org/).
47346       parameters:
47347         - name: link-name
47348           in: path
47349           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47350           required: true
47351           type: string
47352           example: __LINK-NAME__
47353         - name: circuit-id
47354           in: query
47355           description: Circuit it
47356           required: false
47357           type: string
47358     put:
47359       tags:
47360         - Network
47361       summary: create or update an existing physical-link
47362       description: |
47363         Create or update an existing physical-link.
47364         #
47365         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47366       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
47367       consumes:
47368         - application/json
47369         - application/xml
47370       produces:
47371         - application/json
47372         - application/xml
47373       responses:
47374         "default":
47375           description: Response codes found in [response codes](https://wiki.onap.org/).
47376       parameters:
47377         - name: link-name
47378           in: path
47379           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47380           required: true
47381           type: string
47382           example: __LINK-NAME__
47383         - name: body
47384           in: body
47385           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkPhysicalLinksPhysicalLink.json)
47386           required: true
47387           schema:
47388             $ref: "#/definitions/physical-link"
47389     patch:
47390       tags:
47391         - Network
47392       summary: update an existing physical-link
47393       description: |
47394         Update an existing physical-link
47395         #
47396         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47397         The PUT operation will entirely replace an existing object.
47398         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47399         #
47400         Other differences between PUT and PATCH are:
47401         #
47402         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47403         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47404         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47405       operationId: UpdateNetworkPhysicalLinksPhysicalLink
47406       consumes:
47407         - application/json
47408         - application/xml
47409       produces:
47410         - application/json
47411         - application/xml
47412       responses:
47413         "default":
47414           description: Response codes found in [response codes](https://wiki.onap.org/).
47415       parameters:
47416         - name: link-name
47417           in: path
47418           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47419           required: true
47420           type: string
47421           example: __LINK-NAME__
47422         - name: body
47423           in: body
47424           description: physical-link object that needs to be created or updated.
47425           required: true
47426           schema:
47427             $ref: "#/patchDefinitions/physical-link"
47428     delete:
47429       tags:
47430         - Network
47431       summary: delete an existing physical-link
47432       description: delete an existing physical-link
47433       operationId: deleteNetworkPhysicalLinksPhysicalLink
47434       consumes:
47435         - application/json
47436         - application/xml
47437       produces:
47438         - application/json
47439         - application/xml
47440       responses:
47441         "default":
47442           description: Response codes found in [response codes](https://wiki.onap.org/).
47443       parameters:
47444         - name: link-name
47445           in: path
47446           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
47447           required: true
47448           type: string
47449           example: __LINK-NAME__
47450         - name: resource-version
47451           in: query
47452           description: resource-version for concurrency
47453           required: true
47454           type: string
47455   /network/physical-links:
47456     get:
47457       tags:
47458         - Network
47459       summary: returns physical-links
47460       description: returns physical-links
47461       operationId: getNetworkPhysicalLinks
47462       produces:
47463         - application/json
47464         - application/xml
47465       responses:
47466         "200":
47467           description: successful operation
47468           schema:
47469               $ref: "#/getDefinitions/physical-links"
47470         "default":
47471           description: Response codes found in [response codes](https://wiki.onap.org/).
47472   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
47473     put:
47474       tags:
47475         - Network
47476       summary: see node definition for valid relationships
47477       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
47478       consumes:
47479         - application/json
47480         - application/xml
47481       produces:
47482         - application/json
47483         - application/xml
47484       responses:
47485         "default":
47486           description: Response codes found in [response codes](https://wiki.onap.org/).
47487       parameters:
47488         - name: ipsec-configuration-id
47489           in: path
47490           description: UUID of this configuration
47491           required: true
47492           type: string
47493           example: __IPSEC-CONFIGURATION-ID__
47494         - name: body
47495           in: body
47496           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
47497           required: true
47498           schema:
47499             $ref: "#/definitions/relationship"
47500     delete:
47501       tags:
47502         - Network
47503       summary: delete an existing relationship
47504       description: delete an existing relationship
47505       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
47506       consumes:
47507         - application/json
47508         - application/xml
47509       produces:
47510         - application/json
47511         - application/xml
47512       responses:
47513         "default":
47514           description: Response codes found in [response codes](https://wiki.onap.org/).
47515       parameters:
47516         - name: ipsec-configuration-id
47517           in: path
47518           description: UUID of this configuration
47519           required: true
47520           type: string
47521           example: __IPSEC-CONFIGURATION-ID__
47522   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
47523     put:
47524       tags:
47525         - Network
47526       summary: see node definition for valid relationships
47527       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
47528       consumes:
47529         - application/json
47530         - application/xml
47531       produces:
47532         - application/json
47533         - application/xml
47534       responses:
47535         "default":
47536           description: Response codes found in [response codes](https://wiki.onap.org/).
47537       parameters:
47538         - name: ipsec-configuration-id
47539           in: path
47540           description: UUID of this configuration
47541           required: true
47542           type: string
47543           example: __IPSEC-CONFIGURATION-ID__
47544         - name: vig-address-type
47545           in: path
47546           description: indicates whether the VIG is for AVPN or INTERNET
47547           required: true
47548           type: string
47549           example: __VIG-ADDRESS-TYPE__
47550         - name: body
47551           in: body
47552           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
47553           required: true
47554           schema:
47555             $ref: "#/definitions/relationship"
47556     delete:
47557       tags:
47558         - Network
47559       summary: delete an existing relationship
47560       description: delete an existing relationship
47561       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
47562       consumes:
47563         - application/json
47564         - application/xml
47565       produces:
47566         - application/json
47567         - application/xml
47568       responses:
47569         "default":
47570           description: Response codes found in [response codes](https://wiki.onap.org/).
47571       parameters:
47572         - name: ipsec-configuration-id
47573           in: path
47574           description: UUID of this configuration
47575           required: true
47576           type: string
47577           example: __IPSEC-CONFIGURATION-ID__
47578         - name: vig-address-type
47579           in: path
47580           description: indicates whether the VIG is for AVPN or INTERNET
47581           required: true
47582           type: string
47583           example: __VIG-ADDRESS-TYPE__
47584   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
47585     get:
47586       tags:
47587         - Network
47588       summary: returns vig-server
47589       description: returns vig-server
47590       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47591       produces:
47592         - application/json
47593         - application/xml
47594       responses:
47595         "200":
47596           description: successful operation
47597           schema:
47598               $ref: "#/getDefinitions/vig-server"
47599         "default":
47600           description: Response codes found in [response codes](https://wiki.onap.org/).
47601       parameters:
47602         - name: ipsec-configuration-id
47603           in: path
47604           description: UUID of this configuration
47605           required: true
47606           type: string
47607           example: __IPSEC-CONFIGURATION-ID__
47608         - name: vig-address-type
47609           in: path
47610           description: indicates whether the VIG is for AVPN or INTERNET
47611           required: true
47612           type: string
47613           example: __VIG-ADDRESS-TYPE__
47614     put:
47615       tags:
47616         - Network
47617       summary: create or update an existing vig-server
47618       description: |
47619         Create or update an existing vig-server.
47620         #
47621         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47622       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47623       consumes:
47624         - application/json
47625         - application/xml
47626       produces:
47627         - application/json
47628         - application/xml
47629       responses:
47630         "default":
47631           description: Response codes found in [response codes](https://wiki.onap.org/).
47632       parameters:
47633         - name: ipsec-configuration-id
47634           in: path
47635           description: UUID of this configuration
47636           required: true
47637           type: string
47638           example: __IPSEC-CONFIGURATION-ID__
47639         - name: vig-address-type
47640           in: path
47641           description: indicates whether the VIG is for AVPN or INTERNET
47642           required: true
47643           type: string
47644           example: __VIG-ADDRESS-TYPE__
47645         - name: body
47646           in: body
47647           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
47648           required: true
47649           schema:
47650             $ref: "#/definitions/vig-server"
47651     patch:
47652       tags:
47653         - Network
47654       summary: update an existing vig-server
47655       description: |
47656         Update an existing vig-server
47657         #
47658         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47659         The PUT operation will entirely replace an existing object.
47660         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47661         #
47662         Other differences between PUT and PATCH are:
47663         #
47664         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47665         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47666         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47667       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47668       consumes:
47669         - application/json
47670         - application/xml
47671       produces:
47672         - application/json
47673         - application/xml
47674       responses:
47675         "default":
47676           description: Response codes found in [response codes](https://wiki.onap.org/).
47677       parameters:
47678         - name: ipsec-configuration-id
47679           in: path
47680           description: UUID of this configuration
47681           required: true
47682           type: string
47683           example: __IPSEC-CONFIGURATION-ID__
47684         - name: vig-address-type
47685           in: path
47686           description: indicates whether the VIG is for AVPN or INTERNET
47687           required: true
47688           type: string
47689           example: __VIG-ADDRESS-TYPE__
47690         - name: body
47691           in: body
47692           description: vig-server object that needs to be created or updated.
47693           required: true
47694           schema:
47695             $ref: "#/patchDefinitions/vig-server"
47696     delete:
47697       tags:
47698         - Network
47699       summary: delete an existing vig-server
47700       description: delete an existing vig-server
47701       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
47702       consumes:
47703         - application/json
47704         - application/xml
47705       produces:
47706         - application/json
47707         - application/xml
47708       responses:
47709         "default":
47710           description: Response codes found in [response codes](https://wiki.onap.org/).
47711       parameters:
47712         - name: ipsec-configuration-id
47713           in: path
47714           description: UUID of this configuration
47715           required: true
47716           type: string
47717           example: __IPSEC-CONFIGURATION-ID__
47718         - name: vig-address-type
47719           in: path
47720           description: indicates whether the VIG is for AVPN or INTERNET
47721           required: true
47722           type: string
47723           example: __VIG-ADDRESS-TYPE__
47724         - name: resource-version
47725           in: query
47726           description: resource-version for concurrency
47727           required: true
47728           type: string
47729   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
47730     get:
47731       tags:
47732         - Network
47733       summary: returns vig-servers
47734       description: returns vig-servers
47735       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
47736       produces:
47737         - application/json
47738         - application/xml
47739       responses:
47740         "200":
47741           description: successful operation
47742           schema:
47743               $ref: "#/getDefinitions/vig-servers"
47744         "default":
47745           description: Response codes found in [response codes](https://wiki.onap.org/).
47746       parameters:
47747         - name: ipsec-configuration-id
47748           in: path
47749           description: UUID of this configuration
47750           required: true
47751           type: string
47752           example: __IPSEC-CONFIGURATION-ID__
47753   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
47754     get:
47755       tags:
47756         - Network
47757       summary: returns ipsec-configuration
47758       description: returns ipsec-configuration
47759       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
47760       produces:
47761         - application/json
47762         - application/xml
47763       responses:
47764         "200":
47765           description: successful operation
47766           schema:
47767               $ref: "#/getDefinitions/ipsec-configuration"
47768         "default":
47769           description: Response codes found in [response codes](https://wiki.onap.org/).
47770       parameters:
47771         - name: ipsec-configuration-id
47772           in: path
47773           description: UUID of this configuration
47774           required: true
47775           type: string
47776           example: __IPSEC-CONFIGURATION-ID__
47777     put:
47778       tags:
47779         - Network
47780       summary: create or update an existing ipsec-configuration
47781       description: |
47782         Create or update an existing ipsec-configuration.
47783         #
47784         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47785       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
47786       consumes:
47787         - application/json
47788         - application/xml
47789       produces:
47790         - application/json
47791         - application/xml
47792       responses:
47793         "default":
47794           description: Response codes found in [response codes](https://wiki.onap.org/).
47795       parameters:
47796         - name: ipsec-configuration-id
47797           in: path
47798           description: UUID of this configuration
47799           required: true
47800           type: string
47801           example: __IPSEC-CONFIGURATION-ID__
47802         - name: body
47803           in: body
47804           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkIpsecConfigurationsIpsecConfiguration.json)
47805           required: true
47806           schema:
47807             $ref: "#/definitions/ipsec-configuration"
47808     patch:
47809       tags:
47810         - Network
47811       summary: update an existing ipsec-configuration
47812       description: |
47813         Update an existing ipsec-configuration
47814         #
47815         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47816         The PUT operation will entirely replace an existing object.
47817         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47818         #
47819         Other differences between PUT and PATCH are:
47820         #
47821         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47822         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47823         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47824       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
47825       consumes:
47826         - application/json
47827         - application/xml
47828       produces:
47829         - application/json
47830         - application/xml
47831       responses:
47832         "default":
47833           description: Response codes found in [response codes](https://wiki.onap.org/).
47834       parameters:
47835         - name: ipsec-configuration-id
47836           in: path
47837           description: UUID of this configuration
47838           required: true
47839           type: string
47840           example: __IPSEC-CONFIGURATION-ID__
47841         - name: body
47842           in: body
47843           description: ipsec-configuration object that needs to be created or updated.
47844           required: true
47845           schema:
47846             $ref: "#/patchDefinitions/ipsec-configuration"
47847     delete:
47848       tags:
47849         - Network
47850       summary: delete an existing ipsec-configuration
47851       description: delete an existing ipsec-configuration
47852       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
47853       consumes:
47854         - application/json
47855         - application/xml
47856       produces:
47857         - application/json
47858         - application/xml
47859       responses:
47860         "default":
47861           description: Response codes found in [response codes](https://wiki.onap.org/).
47862       parameters:
47863         - name: ipsec-configuration-id
47864           in: path
47865           description: UUID of this configuration
47866           required: true
47867           type: string
47868           example: __IPSEC-CONFIGURATION-ID__
47869         - name: resource-version
47870           in: query
47871           description: resource-version for concurrency
47872           required: true
47873           type: string
47874   /network/ipsec-configurations:
47875     get:
47876       tags:
47877         - Network
47878       summary: returns ipsec-configurations
47879       description: returns ipsec-configurations
47880       operationId: getNetworkIpsecConfigurations
47881       produces:
47882         - application/json
47883         - application/xml
47884       responses:
47885         "200":
47886           description: successful operation
47887           schema:
47888               $ref: "#/getDefinitions/ipsec-configurations"
47889         "default":
47890           description: Response codes found in [response codes](https://wiki.onap.org/).
47891   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
47892     put:
47893       tags:
47894         - Network
47895       summary: see node definition for valid relationships
47896       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47897       consumes:
47898         - application/json
47899         - application/xml
47900       produces:
47901         - application/json
47902         - application/xml
47903       responses:
47904         "default":
47905           description: Response codes found in [response codes](https://wiki.onap.org/).
47906       parameters:
47907         - name: route-table-reference-id
47908           in: path
47909           description: Route Table Reference id, UUID assigned to this instance.
47910           required: true
47911           type: string
47912           example: __ROUTE-TABLE-REFERENCE-ID__
47913         - name: body
47914           in: body
47915           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
47916           required: true
47917           schema:
47918             $ref: "#/definitions/relationship"
47919     delete:
47920       tags:
47921         - Network
47922       summary: delete an existing relationship
47923       description: delete an existing relationship
47924       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
47925       consumes:
47926         - application/json
47927         - application/xml
47928       produces:
47929         - application/json
47930         - application/xml
47931       responses:
47932         "default":
47933           description: Response codes found in [response codes](https://wiki.onap.org/).
47934       parameters:
47935         - name: route-table-reference-id
47936           in: path
47937           description: Route Table Reference id, UUID assigned to this instance.
47938           required: true
47939           type: string
47940           example: __ROUTE-TABLE-REFERENCE-ID__
47941   /network/route-table-references/route-table-reference/{route-table-reference-id}:
47942     get:
47943       tags:
47944         - Network
47945       summary: returns route-table-reference
47946       description: returns route-table-reference
47947       operationId: getNetworkRouteTableReferencesRouteTableReference
47948       produces:
47949         - application/json
47950         - application/xml
47951       responses:
47952         "200":
47953           description: successful operation
47954           schema:
47955               $ref: "#/getDefinitions/route-table-reference"
47956         "default":
47957           description: Response codes found in [response codes](https://wiki.onap.org/).
47958       parameters:
47959         - name: route-table-reference-id
47960           in: path
47961           description: Route Table Reference id, UUID assigned to this instance.
47962           required: true
47963           type: string
47964           example: __ROUTE-TABLE-REFERENCE-ID__
47965         - name: route-table-reference-fqdn
47966           in: query
47967           description: FQDN entry in the route table.
47968           required: false
47969           type: string
47970     put:
47971       tags:
47972         - Network
47973       summary: create or update an existing route-table-reference
47974       description: |
47975         Create or update an existing route-table-reference.
47976         #
47977         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47978       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
47979       consumes:
47980         - application/json
47981         - application/xml
47982       produces:
47983         - application/json
47984         - application/xml
47985       responses:
47986         "default":
47987           description: Response codes found in [response codes](https://wiki.onap.org/).
47988       parameters:
47989         - name: route-table-reference-id
47990           in: path
47991           description: Route Table Reference id, UUID assigned to this instance.
47992           required: true
47993           type: string
47994           example: __ROUTE-TABLE-REFERENCE-ID__
47995         - name: body
47996           in: body
47997           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkRouteTableReferencesRouteTableReference.json)
47998           required: true
47999           schema:
48000             $ref: "#/definitions/route-table-reference"
48001     patch:
48002       tags:
48003         - Network
48004       summary: update an existing route-table-reference
48005       description: |
48006         Update an existing route-table-reference
48007         #
48008         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48009         The PUT operation will entirely replace an existing object.
48010         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48011         #
48012         Other differences between PUT and PATCH are:
48013         #
48014         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48015         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48016         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48017       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
48018       consumes:
48019         - application/json
48020         - application/xml
48021       produces:
48022         - application/json
48023         - application/xml
48024       responses:
48025         "default":
48026           description: Response codes found in [response codes](https://wiki.onap.org/).
48027       parameters:
48028         - name: route-table-reference-id
48029           in: path
48030           description: Route Table Reference id, UUID assigned to this instance.
48031           required: true
48032           type: string
48033           example: __ROUTE-TABLE-REFERENCE-ID__
48034         - name: body
48035           in: body
48036           description: route-table-reference object that needs to be created or updated.
48037           required: true
48038           schema:
48039             $ref: "#/patchDefinitions/route-table-reference"
48040     delete:
48041       tags:
48042         - Network
48043       summary: delete an existing route-table-reference
48044       description: delete an existing route-table-reference
48045       operationId: deleteNetworkRouteTableReferencesRouteTableReference
48046       consumes:
48047         - application/json
48048         - application/xml
48049       produces:
48050         - application/json
48051         - application/xml
48052       responses:
48053         "default":
48054           description: Response codes found in [response codes](https://wiki.onap.org/).
48055       parameters:
48056         - name: route-table-reference-id
48057           in: path
48058           description: Route Table Reference id, UUID assigned to this instance.
48059           required: true
48060           type: string
48061           example: __ROUTE-TABLE-REFERENCE-ID__
48062         - name: resource-version
48063           in: query
48064           description: resource-version for concurrency
48065           required: true
48066           type: string
48067   /network/route-table-references:
48068     get:
48069       tags:
48070         - Network
48071       summary: returns route-table-references
48072       description: returns route-table-references
48073       operationId: getNetworkRouteTableReferences
48074       produces:
48075         - application/json
48076         - application/xml
48077       responses:
48078         "200":
48079           description: successful operation
48080           schema:
48081               $ref: "#/getDefinitions/route-table-references"
48082         "default":
48083           description: Response codes found in [response codes](https://wiki.onap.org/).
48084   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
48085     put:
48086       tags:
48087         - Network
48088       summary: see node definition for valid relationships
48089       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
48090       consumes:
48091         - application/json
48092         - application/xml
48093       produces:
48094         - application/json
48095         - application/xml
48096       responses:
48097         "default":
48098           description: Response codes found in [response codes](https://wiki.onap.org/).
48099       parameters:
48100         - name: id
48101           in: path
48102           description: Instance Group ID, UUID assigned to this instance.
48103           required: true
48104           type: string
48105           example: __ID__
48106         - name: body
48107           in: body
48108           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
48109           required: true
48110           schema:
48111             $ref: "#/definitions/relationship"
48112     delete:
48113       tags:
48114         - Network
48115       summary: delete an existing relationship
48116       description: delete an existing relationship
48117       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
48118       consumes:
48119         - application/json
48120         - application/xml
48121       produces:
48122         - application/json
48123         - application/xml
48124       responses:
48125         "default":
48126           description: Response codes found in [response codes](https://wiki.onap.org/).
48127       parameters:
48128         - name: id
48129           in: path
48130           description: Instance Group ID, UUID assigned to this instance.
48131           required: true
48132           type: string
48133           example: __ID__
48134   /network/instance-groups/instance-group/{id}:
48135     get:
48136       tags:
48137         - Network
48138       summary: returns instance-group
48139       description: returns instance-group
48140       operationId: getNetworkInstanceGroupsInstanceGroup
48141       produces:
48142         - application/json
48143         - application/xml
48144       responses:
48145         "200":
48146           description: successful operation
48147           schema:
48148               $ref: "#/getDefinitions/instance-group"
48149         "default":
48150           description: Response codes found in [response codes](https://wiki.onap.org/).
48151       parameters:
48152         - name: id
48153           in: path
48154           description: Instance Group ID, UUID assigned to this instance.
48155           required: true
48156           type: string
48157           example: __ID__
48158         - name: description
48159           in: query
48160           description: Descriptive text to help identify the usage of this instance-group
48161           required: false
48162           type: string
48163         - name: type
48164           in: query
48165           description: Only valid value today is lower case ha for high availability
48166           required: false
48167           type: string
48168         - name: sub-type
48169           in: query
48170           description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
48171           required: false
48172           type: string
48173     put:
48174       tags:
48175         - Network
48176       summary: create or update an existing instance-group
48177       description: |
48178         Create or update an existing instance-group.
48179         #
48180         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48181       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
48182       consumes:
48183         - application/json
48184         - application/xml
48185       produces:
48186         - application/json
48187         - application/xml
48188       responses:
48189         "default":
48190           description: Response codes found in [response codes](https://wiki.onap.org/).
48191       parameters:
48192         - name: id
48193           in: path
48194           description: Instance Group ID, UUID assigned to this instance.
48195           required: true
48196           type: string
48197           example: __ID__
48198         - name: body
48199           in: body
48200           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkInstanceGroupsInstanceGroup.json)
48201           required: true
48202           schema:
48203             $ref: "#/definitions/instance-group"
48204     patch:
48205       tags:
48206         - Network
48207       summary: update an existing instance-group
48208       description: |
48209         Update an existing instance-group
48210         #
48211         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48212         The PUT operation will entirely replace an existing object.
48213         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48214         #
48215         Other differences between PUT and PATCH are:
48216         #
48217         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48218         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48219         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48220       operationId: UpdateNetworkInstanceGroupsInstanceGroup
48221       consumes:
48222         - application/json
48223         - application/xml
48224       produces:
48225         - application/json
48226         - application/xml
48227       responses:
48228         "default":
48229           description: Response codes found in [response codes](https://wiki.onap.org/).
48230       parameters:
48231         - name: id
48232           in: path
48233           description: Instance Group ID, UUID assigned to this instance.
48234           required: true
48235           type: string
48236           example: __ID__
48237         - name: body
48238           in: body
48239           description: instance-group object that needs to be created or updated.
48240           required: true
48241           schema:
48242             $ref: "#/patchDefinitions/instance-group"
48243     delete:
48244       tags:
48245         - Network
48246       summary: delete an existing instance-group
48247       description: delete an existing instance-group
48248       operationId: deleteNetworkInstanceGroupsInstanceGroup
48249       consumes:
48250         - application/json
48251         - application/xml
48252       produces:
48253         - application/json
48254         - application/xml
48255       responses:
48256         "default":
48257           description: Response codes found in [response codes](https://wiki.onap.org/).
48258       parameters:
48259         - name: id
48260           in: path
48261           description: Instance Group ID, UUID assigned to this instance.
48262           required: true
48263           type: string
48264           example: __ID__
48265         - name: resource-version
48266           in: query
48267           description: resource-version for concurrency
48268           required: true
48269           type: string
48270   /network/instance-groups:
48271     get:
48272       tags:
48273         - Network
48274       summary: returns instance-groups
48275       description: returns instance-groups
48276       operationId: getNetworkInstanceGroups
48277       produces:
48278         - application/json
48279         - application/xml
48280       responses:
48281         "200":
48282           description: successful operation
48283           schema:
48284               $ref: "#/getDefinitions/instance-groups"
48285         "default":
48286           description: Response codes found in [response codes](https://wiki.onap.org/).
48287   /network/zones/zone/{zone-id}/relationship-list/relationship:
48288     put:
48289       tags:
48290         - Network
48291       summary: see node definition for valid relationships
48292       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
48293       consumes:
48294         - application/json
48295         - application/xml
48296       produces:
48297         - application/json
48298         - application/xml
48299       responses:
48300         "default":
48301           description: Response codes found in [response codes](https://wiki.onap.org/).
48302       parameters:
48303         - name: zone-id
48304           in: path
48305           description: Code assigned by AIC to the zone
48306           required: true
48307           type: string
48308           example: __ZONE-ID__
48309         - name: body
48310           in: body
48311           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
48312           required: true
48313           schema:
48314             $ref: "#/definitions/relationship"
48315     delete:
48316       tags:
48317         - Network
48318       summary: delete an existing relationship
48319       description: delete an existing relationship
48320       operationId: deleteNetworkZonesZoneRelationshipListRelationship
48321       consumes:
48322         - application/json
48323         - application/xml
48324       produces:
48325         - application/json
48326         - application/xml
48327       responses:
48328         "default":
48329           description: Response codes found in [response codes](https://wiki.onap.org/).
48330       parameters:
48331         - name: zone-id
48332           in: path
48333           description: Code assigned by AIC to the zone
48334           required: true
48335           type: string
48336           example: __ZONE-ID__
48337   /network/zones/zone/{zone-id}:
48338     get:
48339       tags:
48340         - Network
48341       summary: returns zone
48342       description: returns zone
48343       operationId: getNetworkZonesZone
48344       produces:
48345         - application/json
48346         - application/xml
48347       responses:
48348         "200":
48349           description: successful operation
48350           schema:
48351               $ref: "#/getDefinitions/zone"
48352         "default":
48353           description: Response codes found in [response codes](https://wiki.onap.org/).
48354       parameters:
48355         - name: zone-id
48356           in: path
48357           description: Code assigned by AIC to the zone
48358           required: true
48359           type: string
48360           example: __ZONE-ID__
48361         - name: design-type
48362           in: query
48363           description: Design of zone [Medium/Large?]
48364           required: false
48365           type: string
48366         - name: zone-context
48367           in: query
48368           description: Context of zone [production/test]
48369           required: false
48370           type: string
48371     put:
48372       tags:
48373         - Network
48374       summary: create or update an existing zone
48375       description: |
48376         Create or update an existing zone.
48377         #
48378         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48379       operationId: createOrUpdateNetworkZonesZone
48380       consumes:
48381         - application/json
48382         - application/xml
48383       produces:
48384         - application/json
48385         - application/xml
48386       responses:
48387         "default":
48388           description: Response codes found in [response codes](https://wiki.onap.org/).
48389       parameters:
48390         - name: zone-id
48391           in: path
48392           description: Code assigned by AIC to the zone
48393           required: true
48394           type: string
48395           example: __ZONE-ID__
48396         - name: body
48397           in: body
48398           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v10/NetworkZonesZone.json)
48399           required: true
48400           schema:
48401             $ref: "#/definitions/zone"
48402     patch:
48403       tags:
48404         - Network
48405       summary: update an existing zone
48406       description: |
48407         Update an existing zone
48408         #
48409         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48410         The PUT operation will entirely replace an existing object.
48411         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48412         #
48413         Other differences between PUT and PATCH are:
48414         #
48415         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48416         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48417         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48418       operationId: UpdateNetworkZonesZone
48419       consumes:
48420         - application/json
48421         - application/xml
48422       produces:
48423         - application/json
48424         - application/xml
48425       responses:
48426         "default":
48427           description: Response codes found in [response codes](https://wiki.onap.org/).
48428       parameters:
48429         - name: zone-id
48430           in: path
48431           description: Code assigned by AIC to the zone
48432           required: true
48433           type: string
48434           example: __ZONE-ID__
48435         - name: body
48436           in: body
48437           description: zone object that needs to be created or updated.
48438           required: true
48439           schema:
48440             $ref: "#/patchDefinitions/zone"
48441     delete:
48442       tags:
48443         - Network
48444       summary: delete an existing zone
48445       description: delete an existing zone
48446       operationId: deleteNetworkZonesZone
48447       consumes:
48448         - application/json
48449         - application/xml
48450       produces:
48451         - application/json
48452         - application/xml
48453       responses:
48454         "default":
48455           description: Response codes found in [response codes](https://wiki.onap.org/).
48456       parameters:
48457         - name: zone-id
48458           in: path
48459           description: Code assigned by AIC to the zone
48460           required: true
48461           type: string
48462           example: __ZONE-ID__
48463         - name: resource-version
48464           in: query
48465           description: resource-version for concurrency
48466           required: true
48467           type: string
48468   /network/zones:
48469     get:
48470       tags:
48471         - Network
48472       summary: returns zones
48473       description: returns zones
48474       operationId: getNetworkZones
48475       produces:
48476         - application/json
48477         - application/xml
48478       responses:
48479         "200":
48480           description: successful operation
48481           schema:
48482               $ref: "#/getDefinitions/zones"
48483         "default":
48484           description: Response codes found in [response codes](https://wiki.onap.org/).
48485 definitions:
48486   aai-internal:
48487     properties:
48488       property-name:
48489         type: string
48490       property-value:
48491         type: string
48492   action:
48493     properties:
48494       action-type:
48495         type: string
48496       action-data:
48497         type: array
48498         items:
48499           $ref: "#/definitions/action-data"
48500   action-data:
48501     properties:
48502       property-name:
48503         type: string
48504       property-value:
48505         type: string
48506   actions:
48507     description: |
48508       APIs that are more action related than REST (e.g., notify, update).
48509     properties:
48510       update:
48511         type: object
48512         $ref: "#/definitions/update"
48513       notify:
48514         type: object
48515         $ref: "#/definitions/notify"
48516   allotted-resource:
48517     description: |
48518       Represents a slice or partial piece of a resource that gets separately allotted
48519       ###### Related Nodes
48520       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
48521       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
48522       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
48523       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
48524       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
48525       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
48526       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
48527       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
48528       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
48529     required:
48530     - id
48531     properties:
48532       id:
48533         type: string
48534         description: Allotted Resource id UUID assigned to this instance.
48535       description:
48536         type: string
48537         description: The descriptive information assigned to this allotted resource instance
48538       selflink:
48539         type: string
48540         description: Link back to more information in the controller
48541       model-invariant-id:
48542         type: string
48543         description: the ASDC model id for this resource or service model.
48544       model-version-id:
48545         type: string
48546         description: the ASDC model version for this resource or service model.
48547       persona-model-version:
48548         type: string
48549         description: the ASDC model version for this resource or service model.
48550       resource-version:
48551         type: string
48552         description: Concurrency value
48553       orchestration-status:
48554         type: string
48555         description: Orchestration status
48556       operational-status:
48557         type: string
48558         description: Indicator for whether the resource is considered operational
48559       type:
48560         type: string
48561         description: Generic description of the type of allotted resource.
48562       role:
48563         type: string
48564         description: role in the network that this resource will be providing.
48565       tunnel-xconnects:
48566         type: array
48567         items:
48568           $ref: "#/definitions/tunnel-xconnect"
48569       relationship-list:
48570         type: array
48571         items:
48572           $ref: "#/definitions/relationship"
48573   allotted-resources:
48574     description: |
48575       This object is used to store slices of services being offered
48576     properties:
48577       allotted-resource:
48578         type: array
48579         items:
48580           $ref: "#/definitions/allotted-resource"
48581   availability-zone:
48582     description: |
48583       Availability zone, a collection of compute hosts/pservers
48584       ###### Related Nodes
48585       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48586       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
48587       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48588       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48589       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
48590       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48591       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
48592       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
48593       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
48594     required:
48595     - availability-zone-name
48596     - hypervisor-type
48597     properties:
48598       availability-zone-name:
48599         type: string
48600         description: Name of the availability zone.  Unique across a cloud region
48601       hypervisor-type:
48602         type: string
48603         description: Type of hypervisor.  Source of truth should define valid values.
48604       operational-status:
48605         type: string
48606         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
48607       resource-version:
48608         type: string
48609         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48610       relationship-list:
48611         type: array
48612         items:
48613           $ref: "#/definitions/relationship"
48614   availability-zones:
48615     description: |
48616       Collection of availability zones
48617     properties:
48618       availability-zone:
48619         type: array
48620         items:
48621           $ref: "#/definitions/availability-zone"
48622   az-and-dvs-switches:
48623     properties:
48624       dvs-switches:
48625         type: object
48626         $ref: "#/definitions/dvs-switches"
48627       availability-zone:
48628         type: object
48629         $ref: "#/definitions/availability-zone"
48630   business:
48631     description: |
48632       Namespace for business related constructs
48633     properties:
48634       connectors:
48635         type: array
48636         items:
48637           $ref: "#/definitions/connector"
48638       customers:
48639         type: array
48640         items:
48641           $ref: "#/definitions/customer"
48642   class-of-service:
48643     description: |
48644       ###### Related Nodes
48645       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
48646     required:
48647     - cos
48648     properties:
48649       cos:
48650         type: string
48651         description: unique identifier of probe
48652       probe-id:
48653         type: string
48654         description: identifier of probe
48655       probe-type:
48656         type: string
48657         description: type of probe
48658       resource-version:
48659         type: string
48660         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48661       relationship-list:
48662         type: array
48663         items:
48664           $ref: "#/definitions/relationship"
48665   classes-of-service:
48666     description: |
48667       class-of-service of probe
48668     properties:
48669       class-of-service:
48670         type: array
48671         items:
48672           $ref: "#/definitions/class-of-service"
48673   cloud-infrastructure:
48674     description: |
48675       Namespace for cloud infrastructure.
48676     properties:
48677       complexes:
48678         type: array
48679         items:
48680           $ref: "#/definitions/complex"
48681       cloud-regions:
48682         type: array
48683         items:
48684           $ref: "#/definitions/cloud-region"
48685       network-profiles:
48686         type: array
48687         items:
48688           $ref: "#/definitions/network-profile"
48689       pservers:
48690         type: array
48691         items:
48692           $ref: "#/definitions/pserver"
48693       virtual-data-centers:
48694         type: array
48695         items:
48696           $ref: "#/definitions/virtual-data-center"
48697   cloud-region:
48698     description: |
48699       cloud-region designates an installation of a cloud cluster or region or instantiation
48700       ###### Related Nodes
48701       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48702       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48703       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
48704       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48705       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48706       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48707       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48708       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48709       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48710       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48711       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48712       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
48713       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
48714       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
48715       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
48716       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
48717     required:
48718     - cloud-owner
48719     - cloud-region-id
48720     properties:
48721       cloud-owner:
48722         type: string
48723         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
48724       cloud-region-id:
48725         type: string
48726         description: Identifier used by the vendor for the region. Second part of composite key
48727       cloud-type:
48728         type: string
48729         description: Type of the cloud (e.g., openstack)
48730       owner-defined-type:
48731         type: string
48732         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
48733       cloud-region-version:
48734         type: string
48735         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
48736       identity-url:
48737         type: string
48738         description: URL of the keystone identity service
48739       cloud-zone:
48740         type: string
48741         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
48742       complex-name:
48743         type: string
48744         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
48745       resource-version:
48746         type: string
48747         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48748       volume-groups:
48749         type: array
48750         items:
48751           $ref: "#/definitions/volume-group"
48752       tenants:
48753         type: array
48754         items:
48755           $ref: "#/definitions/tenant"
48756       flavors:
48757         type: array
48758         items:
48759           $ref: "#/definitions/flavor"
48760       group-assignments:
48761         type: array
48762         items:
48763           $ref: "#/definitions/group-assignment"
48764       snapshots:
48765         type: array
48766         items:
48767           $ref: "#/definitions/snapshot"
48768       images:
48769         type: array
48770         items:
48771           $ref: "#/definitions/image"
48772       dvs-switches:
48773         type: array
48774         items:
48775           $ref: "#/definitions/dvs-switch"
48776       oam-networks:
48777         type: array
48778         items:
48779           $ref: "#/definitions/oam-network"
48780       availability-zones:
48781         type: array
48782         items:
48783           $ref: "#/definitions/availability-zone"
48784       relationship-list:
48785         type: array
48786         items:
48787           $ref: "#/definitions/relationship"
48788   cloud-regions:
48789     properties:
48790       cloud-region:
48791         type: array
48792         items:
48793           $ref: "#/definitions/cloud-region"
48794   complex:
48795     description: |
48796       Collection of physical locations that can house cloud-regions.
48797       ###### Related Nodes
48798       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
48799       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48800       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48801       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
48802       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
48803       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48804       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48805       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
48806       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48807       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48808       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
48809       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
48810       - COMPLEX is DELETED when these are DELETED CTAG-POOL
48811     required:
48812     - physical-location-id
48813     - physical-location-type
48814     - street1
48815     - city
48816     - postal-code
48817     - country
48818     - region
48819     properties:
48820       physical-location-id:
48821         type: string
48822         description: Unique identifier for physical location, e.g., CLLI
48823       data-center-code:
48824         type: string
48825         description: Data center code which can be an alternate way to identify a complex
48826       complex-name:
48827         type: string
48828         description: Gamma complex name for LCP instance.
48829       identity-url:
48830         type: string
48831         description: URL of the keystone identity service
48832       resource-version:
48833         type: string
48834         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48835       physical-location-type:
48836         type: string
48837         description: Type, e.g., central office, data center.
48838       street1:
48839         type: string
48840       street2:
48841         type: string
48842       city:
48843         type: string
48844       state:
48845         type: string
48846       postal-code:
48847         type: string
48848       country:
48849         type: string
48850       region:
48851         type: string
48852       latitude:
48853         type: string
48854       longitude:
48855         type: string
48856       elevation:
48857         type: string
48858       lata:
48859         type: string
48860       ctag-pools:
48861         type: array
48862         items:
48863           $ref: "#/definitions/ctag-pool"
48864       relationship-list:
48865         type: array
48866         items:
48867           $ref: "#/definitions/relationship"
48868   complexes:
48869     description: |
48870       Collection of physical locations that can house cloud-regions.
48871     properties:
48872       complex:
48873         type: array
48874         items:
48875           $ref: "#/definitions/complex"
48876   configuration:
48877     description: |
48878       Port Mirror Configuration.
48879       ###### Related Nodes
48880       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
48881       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
48882       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
48883       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48884       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
48885       - CONFIGURATION is DELETED when these are DELETED METADATUM
48886       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
48887     required:
48888     - configuration-id
48889     - configuration-type
48890     - configuration-sub-type
48891     - orchestration-status
48892     - operational-status
48893     - configuration-selflink
48894     - model-customization-id
48895     properties:
48896       configuration-id:
48897         type: string
48898         description: UUID assigned to configuration.
48899       management-option:
48900         type: string
48901         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
48902       configuration-name:
48903         type: string
48904         description: Name of the configuration.
48905       configuration-type:
48906         type: string
48907         description: port-mirroring-configuration.
48908       configuration-sub-type:
48909         type: string
48910         description: vprobe, pprobe.
48911       model-invariant-id:
48912         type: string
48913         description: the ASDC model id for this resource or service model.
48914       model-version-id:
48915         type: string
48916         description: the ASDC model version for this resource or service model.
48917       orchestration-status:
48918         type: string
48919         description: Orchestration status of the configuration.
48920       operational-status:
48921         type: string
48922         description: Indicator for whether the resource is considered operational.
48923       configuration-selflink:
48924         type: string
48925         description: URL to endpoint where AAI can get more details from SDN-GC.
48926       model-customization-id:
48927         type: string
48928         description: id of  the configuration used to customize the resource
48929       resource-version:
48930         type: string
48931         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48932       relationship-list:
48933         type: array
48934         items:
48935           $ref: "#/definitions/relationship"
48936       metadata:
48937         type: array
48938         items:
48939           $ref: "#/definitions/metadatum"
48940   configurations:
48941     description: |
48942       Collection of configurations
48943     properties:
48944       configuration:
48945         type: array
48946         items:
48947           $ref: "#/definitions/configuration"
48948   connector:
48949     description: |
48950       Collection of resource instances used to connect a variety of disparate inventory widgets
48951       ###### Related Nodes
48952       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
48953       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
48954       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
48955       - CONNECTOR is DELETED when these are DELETED METADATUM
48956     required:
48957     - resource-instance-id
48958     properties:
48959       resource-instance-id:
48960         type: string
48961         description: Unique id of resource instance.
48962       resource-version:
48963         type: string
48964         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
48965       model-invariant-id:
48966         type: string
48967         description: the ASDC model id for this resource or service model.
48968       model-version-id:
48969         type: string
48970         description: the ASDC model version for this resource or service model.
48971       persona-model-version:
48972         type: string
48973         description: the ASDC model version for this resource or service model.
48974       widget-model-id:
48975         type: string
48976         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
48977       widget-model-version:
48978         type: string
48979         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
48980       relationship-list:
48981         type: array
48982         items:
48983           $ref: "#/definitions/relationship"
48984       metadata:
48985         type: array
48986         items:
48987           $ref: "#/definitions/metadatum"
48988   connectors:
48989     description: |
48990       Collection of resource instances used to connect a variety of disparate inventory widgets
48991     properties:
48992       connector:
48993         type: array
48994         items:
48995           $ref: "#/definitions/connector"
48996   constrained-element-set:
48997     description: |
48998       This is how we would capture constraints defining allowed sets of elements.
48999       ###### Related Nodes
49000       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
49001       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
49002       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49003       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
49004     required:
49005     - constrained-element-set-uuid
49006     - constraint-type
49007     - check-type
49008     properties:
49009       constrained-element-set-uuid:
49010         type: string
49011       constraint-type:
49012         type: string
49013       check-type:
49014         type: string
49015       resource-version:
49016         type: string
49017       element-choice-sets:
49018         type: array
49019         items:
49020           $ref: "#/definitions/element-choice-set"
49021       relationship-list:
49022         type: array
49023         items:
49024           $ref: "#/definitions/relationship"
49025   constrained-element-sets:
49026     properties:
49027       constrained-element-set:
49028         type: array
49029         items:
49030           $ref: "#/definitions/constrained-element-set"
49031   ctag-assignment:
49032     description: |
49033       ###### Related Nodes
49034       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
49035       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
49036     required:
49037     - vlan-id-inner
49038     properties:
49039       vlan-id-inner:
49040         type: integer
49041         format: int64
49042         description: id.
49043       resource-version:
49044         type: string
49045         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49046       relationship-list:
49047         type: array
49048         items:
49049           $ref: "#/definitions/relationship"
49050   ctag-assignments:
49051     properties:
49052       ctag-assignment:
49053         type: array
49054         items:
49055           $ref: "#/definitions/ctag-assignment"
49056   ctag-pool:
49057     description: |
49058       A collection of C tags (vlan tags) grouped for a specific purpose.
49059       ###### Related Nodes
49060       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
49061       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49062       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
49063     required:
49064     - target-pe
49065     - availability-zone-name
49066     - ctag-pool-purpose
49067     properties:
49068       target-pe:
49069         type: string
49070         description: The Target provider edge router
49071       availability-zone-name:
49072         type: string
49073         description: Name of the availability zone
49074       ctag-pool-purpose:
49075         type: string
49076         description: Describes what the intended purpose of this pool is.
49077       ctag-values:
49078         type: string
49079         description: Comma separated list of ctags
49080       resource-version:
49081         type: string
49082         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49083       relationship-list:
49084         type: array
49085         items:
49086           $ref: "#/definitions/relationship"
49087   ctag-pools:
49088     properties:
49089       ctag-pool:
49090         type: array
49091         items:
49092           $ref: "#/definitions/ctag-pool"
49093   customer:
49094     description: |
49095       customer identifiers to provide linkage back to BSS information.
49096       ###### Related Nodes
49097       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
49098       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
49099     required:
49100     - global-customer-id
49101     - subscriber-name
49102     - subscriber-type
49103     properties:
49104       global-customer-id:
49105         type: string
49106         description: Global customer id used across ECOMP to uniquely identify customer.
49107       subscriber-name:
49108         type: string
49109         description: Subscriber name, an alternate way to retrieve a customer.
49110       subscriber-type:
49111         type: string
49112         description: Subscriber type, a way to provide VID with only the INFRA customers.
49113       resource-version:
49114         type: string
49115         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49116       service-subscriptions:
49117         type: array
49118         items:
49119           $ref: "#/definitions/service-subscription"
49120       relationship-list:
49121         type: array
49122         items:
49123           $ref: "#/definitions/relationship"
49124   customers:
49125     description: |
49126       Collection of customer identifiers to provide linkage back to BSS information.
49127     properties:
49128       customer:
49129         type: array
49130         items:
49131           $ref: "#/definitions/customer"
49132   cvlan-tag-entry:
49133     required:
49134     - cvlan-tag
49135     properties:
49136       cvlan-tag:
49137         type: integer
49138         format: int64
49139         description: See mis-na-virtualization-platform.yang
49140       resource-version:
49141         type: string
49142         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49143       relationship-list:
49144         type: array
49145         items:
49146           $ref: "#/definitions/relationship"
49147   cvlan-tags:
49148     properties:
49149       cvlan-tag-entry:
49150         type: array
49151         items:
49152           $ref: "#/definitions/cvlan-tag-entry"
49153   dvs-switch:
49154     description: |
49155       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.
49156       ###### Related Nodes
49157       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49158       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
49159     required:
49160     - switch-name
49161     - vcenter-url
49162     properties:
49163       switch-name:
49164         type: string
49165         description: DVS switch name
49166       vcenter-url:
49167         type: string
49168         description: URL used to reach the vcenter
49169       resource-version:
49170         type: string
49171         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49172       relationship-list:
49173         type: array
49174         items:
49175           $ref: "#/definitions/relationship"
49176   dvs-switches:
49177     description: |
49178       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
49179     properties:
49180       dvs-switch:
49181         type: array
49182         items:
49183           $ref: "#/definitions/dvs-switch"
49184   edge-prop-names:
49185     description: |
49186       Internal map to define the properties of an edge and interpret the map EdgeRules
49187     properties:
49188       edgeLabel:
49189         type: string
49190       direction:
49191         type: string
49192       multiplicityRule:
49193         type: string
49194       isParent:
49195         type: boolean
49196       usesResource:
49197         type: boolean
49198       hasDelTarget:
49199         type: boolean
49200       SVC-INFRA:
49201         type: boolean
49202       SVC-INFRA-REV:
49203         type: boolean
49204   edge-tag-query-request:
49205     properties:
49206       edge-tag:
49207         type: string
49208       result-detail:
49209         type: string
49210       start-node-type:
49211         type: string
49212       start-node-filter:
49213         type: array
49214         items:
49215           $ref: "#/definitions/start-node-filter"
49216       include-node-filter:
49217         type: array
49218         items:
49219           $ref: "#/definitions/include-node-filter"
49220       secondary-filter:
49221         type: array
49222         items:
49223           $ref: "#/definitions/secondary-filter"
49224   edge-tag-query-result:
49225     properties:
49226       tagged-inventory-item-list:
49227         type: array
49228         items:
49229           $ref: "#/definitions/tagged-inventory-item-list"
49230   element-choice-set:
49231     description: |
49232       This is how we would capture constraints defining allowed sets of elements.
49233       ###### Related Nodes
49234       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
49235       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
49236       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
49237     required:
49238     - element-choice-set-uuid
49239     - element-choice-set-name
49240     properties:
49241       element-choice-set-uuid:
49242         type: string
49243       element-choice-set-name:
49244         type: string
49245       cardinality:
49246         type: string
49247       resource-version:
49248         type: string
49249       model-elements:
49250         type: array
49251         items:
49252           $ref: "#/definitions/model-element"
49253       relationship-list:
49254         type: array
49255         items:
49256           $ref: "#/definitions/relationship"
49257   element-choice-sets:
49258     properties:
49259       element-choice-set:
49260         type: array
49261         items:
49262           $ref: "#/definitions/element-choice-set"
49263   entitlement:
49264     description: |
49265       Metadata for entitlement group.
49266       ###### Related Nodes
49267       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49268       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
49269     required:
49270     - group-uuid
49271     - resource-uuid
49272     properties:
49273       group-uuid:
49274         type: string
49275         description: Unique ID for the entitlement group the resource comes from, should be uuid.
49276       resource-uuid:
49277         type: string
49278         description: Unique ID of an entitlement resource.
49279       resource-version:
49280         type: string
49281         description: Concurrency value
49282       relationship-list:
49283         type: array
49284         items:
49285           $ref: "#/definitions/relationship"
49286   entitlements:
49287     description: |
49288       Entitlements, keyed by group-uuid and resource-uuid, related to license management
49289     properties:
49290       entitlement:
49291         type: array
49292         items:
49293           $ref: "#/definitions/entitlement"
49294   esr-ems:
49295     description: |
49296       Persist EMS address information used by EMS driver.
49297       ###### Related Nodes
49298       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
49299       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49300     required:
49301     - ems-id
49302     properties:
49303       ems-id:
49304         type: string
49305         description: Unique ID of EMS.
49306       resource-version:
49307         type: string
49308         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49309       esr-system-info-list:
49310         type: object
49311         $ref: "#/definitions/esr-system-info-list"
49312       relationship-list:
49313         type: object
49314         $ref: "#/definitions/relationship-list"
49315   esr-ems-list:
49316     properties:
49317       esr-ems:
49318         type: array
49319         items:
49320           $ref: "#/definitions/esr-ems"
49321   esr-system-info:
49322     description: |
49323       Persist common address information of external systems.
49324       ###### Related Nodes
49325       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
49326       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
49327       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
49328       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
49329     required:
49330     - esr-system-info-id
49331     - user-name
49332     - password
49333     - system-type
49334     properties:
49335       esr-system-info-id:
49336         type: string
49337         description: Unique ID of esr system info.
49338       system-name:
49339         type: string
49340         description: name of external system.
49341       type:
49342         type: string
49343         description: type of external systems.
49344       vendor:
49345         type: string
49346         description: vendor of external systems.
49347       version:
49348         type: string
49349         description: version of external systems.
49350       service-url:
49351         type: string
49352         description: url used to access external systems.
49353       user-name:
49354         type: string
49355         description: username used to access external systems.
49356       password:
49357         type: string
49358         description: password used to access external systems.
49359       system-type:
49360         type: string
49361         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
49362       protocol:
49363         type: string
49364         description: protocol of third party SDNC, for example netconf/snmp.
49365       ssl-cacert:
49366         type: string
49367         description: ca file content if enabled ssl on auth-url.
49368       ssl-insecure:
49369         type: boolean
49370         description: Whether to verify VIM's certificate.
49371       ip-address:
49372         type: string
49373         description: service IP of ftp server.
49374       port:
49375         type: string
49376         description: service port of ftp server.
49377       cloud-domain:
49378         type: string
49379         description: domain info for authentication.
49380       default-tenant:
49381         type: string
49382         description: default tenant of VIM.
49383       passive:
49384         type: boolean
49385         description: ftp passive mode or not.
49386       remote-path:
49387         type: string
49388         description: resource or performance data file path.
49389       system-status:
49390         type: string
49391         description: the status of external system.
49392       resource-version:
49393         type: string
49394         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49395       relationship-list:
49396         type: array
49397         items:
49398           $ref: "#/definitions/relationship"
49399   esr-system-info-list:
49400     description: |
49401       Collection of persistent block-level external system auth info.
49402     properties:
49403       esr-system-info:
49404         type: array
49405         items:
49406           $ref: "#/definitions/esr-system-info"
49407   esr-thirdparty-sdnc:
49408     description: |
49409       Persist SDNC address information used by ONAP SDNC.
49410       ###### Related Nodes
49411       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
49412       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
49413       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49414     required:
49415     - thirdparty-sdnc-id
49416     properties:
49417       thirdparty-sdnc-id:
49418         type: string
49419         description: Unique ID of SDNC.
49420       location:
49421         type: string
49422         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
49423       product-name:
49424         type: string
49425         description: password used to access SDNC server.
49426       resource-version:
49427         type: string
49428         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49429       esr-system-info-list:
49430         type: object
49431         $ref: "#/definitions/esr-system-info-list"
49432       relationship-list:
49433         type: object
49434         $ref: "#/definitions/relationship-list"
49435   esr-thirdparty-sdnc-list:
49436     properties:
49437       esr-thirdparty-sdnc:
49438         type: array
49439         items:
49440           $ref: "#/definitions/esr-thirdparty-sdnc"
49441   esr-vnfm:
49442     description: |
49443       Persist VNFM address information used by VF-C.
49444       ###### Related Nodes
49445       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
49446       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
49447     required:
49448     - vnfm-id
49449     properties:
49450       vnfm-id:
49451         type: string
49452         description: Unique ID of VNFM.
49453       vim-id:
49454         type: string
49455         description: indecate the VIM to deploy VNF.
49456       certificate-url:
49457         type: string
49458         description: certificate url of VNFM.
49459       resource-version:
49460         type: string
49461         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49462       esr-system-info-list:
49463         type: object
49464         $ref: "#/definitions/esr-system-info-list"
49465       relationship-list:
49466         type: object
49467         $ref: "#/definitions/relationship-list"
49468   esr-vnfm-list:
49469     properties:
49470       esr-vnfm:
49471         type: array
49472         items:
49473           $ref: "#/definitions/esr-vnfm"
49474   evc:
49475     description: |
49476       evc object is an optional child object of the Configuration object.
49477       ###### Related Nodes
49478       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49479     required:
49480     - evc-id
49481     properties:
49482       evc-id:
49483         type: string
49484         description: Unique/key field for the evc object
49485       forwarding-path-topology:
49486         type: string
49487         description: Point-to-Point, Multi-Point
49488       cir-value:
49489         type: string
49490         description: Commited Information Rate
49491       cir-units:
49492         type: string
49493         description: CIR units
49494       connection-diversity-group-id:
49495         type: string
49496         description: Diversity Group ID
49497       service-hours:
49498         type: string
49499         description: formerly Performance Group
49500       esp-evc-circuit-id:
49501         type: string
49502         description: EVC Circuit ID of ESP EVC
49503       esp-evc-cir-value:
49504         type: string
49505         description: Committed Information Rate (For ESP)
49506       esp-evc-cir-units:
49507         type: string
49508         description: CIR units (For ESP)
49509       esp-itu-code:
49510         type: string
49511         description: Identifies ESP
49512       collector-pop-clli:
49513         type: string
49514         description: Collector POP CLLI (from the hostname of the access pnf)
49515       inter-connect-type-ingress:
49516         type: string
49517         description: Interconnect type on ingress side of EVC.
49518       tagmode-access-ingress:
49519         type: string
49520         description: tagode for collector side of EVC
49521       tagmode-access-egress:
49522         type: string
49523         description: tagMode for network side of EVC
49524       relationship-list:
49525         type: array
49526         items:
49527           $ref: "#/definitions/relationship"
49528       resource-version:
49529         type: string
49530         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49531   evcs:
49532     properties:
49533       evc:
49534         type: array
49535         items:
49536           $ref: "#/definitions/evc"
49537   external-system:
49538     description: |
49539       Namespace for external system.
49540     properties:
49541       esr-ems-list:
49542         type: object
49543         $ref: "#/definitions/esr-ems-list"
49544       esr-vnfm-list:
49545         type: object
49546         $ref: "#/definitions/esr-vnfm-list"
49547       esr-thirdparty-sdnc-list:
49548         type: object
49549         $ref: "#/definitions/esr-thirdparty-sdnc-list"
49550   extra-properties:
49551     description: |
49552       Extra properties for inventory item for response list
49553     properties:
49554       extra-property:
49555         type: array
49556         items:
49557           $ref: "#/definitions/extra-property"
49558   extra-property:
49559     properties:
49560       property-name:
49561         type: string
49562       property-value:
49563         type: string
49564   flavor:
49565     description: |
49566       Openstack flavor.
49567       ###### Related Nodes
49568       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49569       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
49570       - FLAVOR cannot be deleted if linked to VSERVER
49571     required:
49572     - flavor-id
49573     - flavor-name
49574     - flavor-selflink
49575     properties:
49576       flavor-id:
49577         type: string
49578         description: Flavor id, expected to be unique across cloud-region.
49579       flavor-name:
49580         type: string
49581         description: Flavor name
49582       flavor-vcpus:
49583         type: integer
49584         format: int32
49585         description: Number of CPUs
49586       flavor-ram:
49587         type: integer
49588         format: int32
49589         description: Amount of memory
49590       flavor-disk:
49591         type: integer
49592         format: int32
49593         description: Disk space
49594       flavor-ephemeral:
49595         type: integer
49596         format: int32
49597         description: Amount of ephemeral disk space
49598       flavor-swap:
49599         type: string
49600         description: amount of swap space allocation
49601       flavor-is-public:
49602         type: boolean
49603         description: whether flavor is available to all users or private to the tenant it was created in.
49604       flavor-selflink:
49605         type: string
49606         description: URL to endpoint where AAI can get more details
49607       flavor-disabled:
49608         type: boolean
49609         description: Boolean as to whether this flavor is no longer enabled
49610       resource-version:
49611         type: string
49612         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49613       relationship-list:
49614         type: array
49615         items:
49616           $ref: "#/definitions/relationship"
49617   flavors:
49618     description: |
49619       Collection of openstack flavors.
49620     properties:
49621       flavor:
49622         type: array
49623         items:
49624           $ref: "#/definitions/flavor"
49625   forwarder:
49626     description: |
49627       Entity describing a sequenced segment of forwarding path
49628       ###### Related Nodes
49629       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49630       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
49631       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49632       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
49633       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
49634       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
49635     required:
49636     - sequence
49637     properties:
49638       sequence:
49639         type: integer
49640         format: int32
49641         description: Unique ID of this segmentation
49642       forwarder-role:
49643         type: string
49644         description: ingress, intermediate, egress
49645       relationship-list:
49646         type: array
49647         items:
49648           $ref: "#/definitions/relationship"
49649       resource-version:
49650         type: string
49651         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49652   forwarder-evc:
49653     description: |
49654       forwarder object is an optional child object of the Configuration object.
49655       ###### Related Nodes
49656       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
49657     required:
49658     - forwarder-evc-id
49659     properties:
49660       forwarder-evc-id:
49661         type: string
49662         description: Key for forwarder-evc object
49663       circuit-id:
49664         type: string
49665         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
49666       ivlan:
49667         type: string
49668         description: Internal VLAN.
49669       svlan:
49670         type: string
49671         description: SVLAN value for ingress of egress forwarder.
49672       cvlan:
49673         type: string
49674         description: CVLAN value for ingress of egress forwarder.
49675       relationship-list:
49676         type: array
49677         items:
49678           $ref: "#/definitions/relationship"
49679       resource-version:
49680         type: string
49681         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49682   forwarder-evcs:
49683     properties:
49684       forwarder-evc:
49685         type: array
49686         items:
49687           $ref: "#/definitions/forwarder-evc"
49688   forwarders:
49689     properties:
49690       forwarder:
49691         type: array
49692         items:
49693           $ref: "#/definitions/forwarder"
49694   forwarding-path:
49695     description: |
49696       Entity that describes the sequenced forwarding path between interfaces of services or resources
49697       ###### Related Nodes
49698       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
49699       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
49700       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
49701       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
49702       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
49703     required:
49704     - forwarding-path-id
49705     - forwarding-path-name
49706     properties:
49707       forwarding-path-id:
49708         type: string
49709         description: Unique ID of this FP
49710       forwarding-path-name:
49711         type: string
49712         description: Name of the FP
49713       relationship-list:
49714         type: array
49715         items:
49716           $ref: "#/definitions/relationship"
49717       resource-version:
49718         type: string
49719         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
49720       selflink:
49721         type: string
49722         description: the self link for this FP
49723       forwarders:
49724         type: array
49725         items:
49726           $ref: "#/definitions/forwarder"
49727   forwarding-paths:
49728     properties:
49729       forwarding-path:
49730         type: array
49731         items:
49732           $ref: "#/definitions/forwarding-path"
49733   generic-vnf:
49734     description: |
49735       General purpose VNF
49736       ###### Related Nodes
49737       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
49738       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
49739       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
49740       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
49741       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
49742       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
49743       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
49744       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
49745       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
49746       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
49747       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
49748       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49749       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49750       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49751       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49752       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49753       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49754       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
49755       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
49756       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
49757       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
49758       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
49759     required:
49760     - vnf-id
49761     - vnf-name
49762     - vnf-type
49763     - in-maint
49764     - is-closed-loop-disabled
49765     properties:
49766       vnf-id:
49767         type: string
49768         description: Unique id of VNF.  This is unique across the graph.
49769       vnf-name:
49770         type: string
49771         description: Name of VNF.
49772       vnf-name2:
49773         type: string
49774         description: Alternate name of VNF.
49775       vnf-type:
49776         type: string
49777         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
49778       service-id:
49779         type: string
49780         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
49781       regional-resource-zone:
49782         type: string
49783         description: Regional way of organizing pservers, source of truth should define values
49784       prov-status:
49785         type: string
49786         description: Trigger for operational monitoring of this resource by Service Assurance systems.
49787       operational-status:
49788         type: string
49789         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
49790       license-key:
49791         type: string
49792         description: OBSOLETE -  do not use
49793       equipment-role:
49794         type: string
49795         description: Client should send valid enumerated value
49796       orchestration-status:
49797         type: string
49798         description: Orchestration status of this VNF, used by MSO.
49799       heat-stack-id:
49800         type: string
49801         description: Heat stack id corresponding to this instance, managed by MSO
49802       mso-catalog-key:
49803         type: string
49804         description: Corresponds to the SDN-C catalog id used to configure this VCE
49805       management-option:
49806         type: string
49807         description: identifier of managed by company or customer
49808       ipv4-oam-address:
49809         type: string
49810         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
49811       ipv4-loopback0-address:
49812         type: string
49813         description: v4 Loopback0 address
49814       nm-lan-v6-address:
49815         type: string
49816         description: v6 Loopback address
49817       management-v6-address:
49818         type: string
49819         description: v6 management address
49820       vcpu:
49821         type: integer
49822         format: int64
49823         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
49824       vcpu-units:
49825         type: string
49826         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
49827       vmemory:
49828         type: integer
49829         format: int64
49830         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
49831       vmemory-units:
49832         type: string
49833         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
49834       vdisk:
49835         type: integer
49836         format: int64
49837         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
49838       vdisk-units:
49839         type: string
49840         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
49841       in-maint:
49842         type: boolean
49843       is-closed-loop-disabled:
49844         type: boolean
49845       resource-version:
49846         type: string
49847         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49848       summary-status:
49849         type: string
49850         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
49851       encrypted-access-flag:
49852         type: boolean
49853         description: indicates whether generic-vnf access uses SSH
49854       entitlement-assignment-group-uuid:
49855         type: string
49856         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
49857       entitlement-resource-uuid:
49858         type: string
49859         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
49860       license-assignment-group-uuid:
49861         type: string
49862         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
49863       license-key-uuid:
49864         type: string
49865         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
49866       model-invariant-id:
49867         type: string
49868         description: the ASDC model id for this resource or service model.
49869       model-version-id:
49870         type: string
49871         description: the ASDC model version for this resource or service model.
49872       persona-model-version:
49873         type: string
49874         description: the ASDC model version for this resource or service model.
49875       model-customization-id:
49876         type: string
49877         description: captures the id of all the configuration used to customize the resource for the service.
49878       widget-model-id:
49879         type: string
49880         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
49881       widget-model-version:
49882         type: string
49883         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
49884       as-number:
49885         type: string
49886         description: as-number of the VNF
49887       regional-resource-subzone:
49888         type: string
49889         description: represents sub zone of the rr plane
49890       nf-type:
49891         type: string
49892         description: Generic description of the type of NF
49893       nf-function:
49894         type: string
49895         description: English description of Network function that the specific VNF deployment is providing
49896       nf-role:
49897         type: string
49898         description: role in the network that this model will be providing
49899       nf-naming-code:
49900         type: string
49901         description: string assigned to this model used for naming purposes
49902       selflink:
49903         type: string
49904         description: Path to the controller object.
49905       relationship-list:
49906         type: array
49907         items:
49908           $ref: "#/definitions/relationship"
49909       l-interfaces:
49910         type: array
49911         items:
49912           $ref: "#/definitions/l-interface"
49913       lag-interfaces:
49914         type: array
49915         items:
49916           $ref: "#/definitions/lag-interface"
49917       vf-modules:
49918         type: array
49919         items:
49920           $ref: "#/definitions/vf-module"
49921       licenses:
49922         type: array
49923         items:
49924           $ref: "#/definitions/license"
49925       entitlements:
49926         type: array
49927         items:
49928           $ref: "#/definitions/entitlement"
49929   generic-vnfs:
49930     description: |
49931       Collection of VNFs
49932     properties:
49933       generic-vnf:
49934         type: array
49935         items:
49936           $ref: "#/definitions/generic-vnf"
49937   group-assignment:
49938     description: |
49939       Openstack group-assignment used to store exclusivity groups (EG).
49940       ###### Related Nodes
49941       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
49942       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
49943       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
49944     required:
49945     - group-id
49946     - group-type
49947     - group-name
49948     properties:
49949       group-id:
49950         type: string
49951         description: Group id, expected to be unique across cloud-region.
49952       group-type:
49953         type: string
49954         description: Group type - the type of group this instance refers to
49955       group-name:
49956         type: string
49957         description: Group name - name assigned to the group
49958       group-description:
49959         type: string
49960         description: Group description - description of the group
49961       resource-version:
49962         type: string
49963         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
49964       relationship-list:
49965         type: array
49966         items:
49967           $ref: "#/definitions/relationship"
49968   group-assignments:
49969     description: |
49970       Collection of openstack group assignments
49971     properties:
49972       group-assignment:
49973         type: array
49974         items:
49975           $ref: "#/definitions/group-assignment"
49976   host-route:
49977     description: |
49978       ###### Related Nodes
49979       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
49980     required:
49981     - host-route-id
49982     - route-prefix
49983     - next-hop
49984     properties:
49985       host-route-id:
49986         type: string
49987         description: host-route id
49988       route-prefix:
49989         type: string
49990         description: subnet prefix
49991       next-hop:
49992         type: string
49993         description: Could be ip-address, hostname, or service-instance
49994       next-hop-type:
49995         type: string
49996         description: Should be ip-address, hostname, or service-instance to match next-hop
49997       resource-version:
49998         type: string
49999         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50000       relationship-list:
50001         type: array
50002         items:
50003           $ref: "#/definitions/relationship"
50004   host-routes:
50005     properties:
50006       host-route:
50007         type: array
50008         items:
50009           $ref: "#/definitions/host-route"
50010   image:
50011     description: |
50012       Openstack image.
50013       ###### Related Nodes
50014       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
50015       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
50016       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
50017       - IMAGE cannot be deleted if linked to VSERVER
50018       - IMAGE is DELETED when these are DELETED METADATUM
50019     required:
50020     - image-id
50021     - image-name
50022     - image-os-distro
50023     - image-os-version
50024     - image-selflink
50025     properties:
50026       image-id:
50027         type: string
50028         description: Image id, expected to be unique across cloud region
50029       image-name:
50030         type: string
50031         description: Image name
50032       image-architecture:
50033         type: string
50034         description: Operating system architecture.
50035       image-os-distro:
50036         type: string
50037         description: The common name of the operating system distribution in lowercase
50038       image-os-version:
50039         type: string
50040         description: The operating system version as specified by the distributor.
50041       application:
50042         type: string
50043         description: The application that the image instantiates.
50044       application-vendor:
50045         type: string
50046         description: The vendor of the application.
50047       application-version:
50048         type: string
50049         description: The version of the application.
50050       image-selflink:
50051         type: string
50052         description: URL to endpoint where AAI can get more details
50053       resource-version:
50054         type: string
50055         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50056       relationship-list:
50057         type: array
50058         items:
50059           $ref: "#/definitions/relationship"
50060       metadata:
50061         type: array
50062         items:
50063           $ref: "#/definitions/metadatum"
50064   images:
50065     description: |
50066       Collectio of Openstack images.
50067     properties:
50068       image:
50069         type: array
50070         items:
50071           $ref: "#/definitions/image"
50072   include-node-filter:
50073     properties:
50074       include-node-type:
50075         type: string
50076   instance-filter:
50077     description: |
50078       InstanceFilter for performing a named-query or model query
50079   instance-filters:
50080     description: |
50081       InstanceFilters for performing a named-query or model query
50082     properties:
50083       instance-filter:
50084         type: array
50085         items:
50086           $ref: "#/definitions/instance-filter"
50087   instance-group:
50088     description: |
50089       General mechanism for grouping instances
50090       ###### Related Nodes
50091       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
50092       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50093       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50094       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50095       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50096       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50097       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50098       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50099     required:
50100     - id
50101     - description
50102     - type
50103     properties:
50104       id:
50105         type: string
50106         description: Instance Group ID, UUID assigned to this instance.
50107       description:
50108         type: string
50109         description: Descriptive text to help identify the usage of this instance-group
50110       type:
50111         type: string
50112         description: Only valid value today is lower case ha for high availability
50113       sub-type:
50114         type: string
50115         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
50116       resource-version:
50117         type: string
50118         description: Concurrency value
50119       relationship-list:
50120         type: array
50121         items:
50122           $ref: "#/definitions/relationship"
50123   instance-groups:
50124     description: |
50125       Collection of openstack route table references
50126     properties:
50127       instance-group:
50128         type: array
50129         items:
50130           $ref: "#/definitions/instance-group"
50131   inventory:
50132     properties:
50133       search:
50134         type: object
50135         $ref: "#/definitions/search"
50136       actions:
50137         type: object
50138         $ref: "#/definitions/actions"
50139       cloud-infrastructure:
50140         type: object
50141         $ref: "#/definitions/cloud-infrastructure"
50142       business:
50143         type: object
50144         $ref: "#/definitions/business"
50145       service-design-and-creation:
50146         type: object
50147         $ref: "#/definitions/service-design-and-creation"
50148       network:
50149         type: object
50150         $ref: "#/definitions/network"
50151       aai-internal:
50152         type: object
50153         $ref: "#/definitions/aai-internal"
50154       nodes:
50155         type: array
50156         items:
50157           $ref: "#/definitions/aai-internal"
50158   inventory-item:
50159     properties:
50160       inventory-item-type:
50161         type: string
50162       inventory-item-link:
50163         type: string
50164       inventory-item-data:
50165         type: array
50166         items:
50167           $ref: "#/definitions/inventory-item-data"
50168       tagged-inventory-item-list:
50169         type: array
50170         items:
50171           $ref: "#/definitions/tagged-inventory-item-list"
50172   inventory-item-data:
50173     properties:
50174       property-name:
50175         type: string
50176       property-value:
50177         type: string
50178   inventory-response-item:
50179     description: |
50180       Inventory item for response list
50181     properties:
50182       model-name:
50183         type: string
50184       extra-properties:
50185         type: object
50186         $ref: "#/definitions/extra-properties"
50187       inventory-response-items:
50188         type: object
50189         $ref: "#/definitions/inventory-response-items"
50190   inventory-response-items:
50191     description: |
50192       Container for inventory items in response list
50193     properties:
50194       inventory-response-item:
50195         type: array
50196         items:
50197           $ref: "#/definitions/inventory-response-item"
50198   ipsec-configuration:
50199     description: |
50200       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
50201       ###### Related Nodes
50202       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
50203       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
50204       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
50205     required:
50206     - ipsec-configuration-id
50207     properties:
50208       ipsec-configuration-id:
50209         type: string
50210         description: UUID of this configuration
50211       requested-vig-address-type:
50212         type: string
50213         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
50214       requested-encryption-strength:
50215         type: string
50216         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
50217       requested-dmz-type:
50218         type: string
50219         description: can offer a shared DMZ or a DMZ specific to a customer
50220       shared-dmz-network-address:
50221         type: string
50222         description: Network address of shared DMZ
50223       requested-customer-name:
50224         type: string
50225         description: If the DMZ is a custom DMZ, this field will indicate the customer information
50226       ike-version:
50227         type: string
50228         description: can be 1 or 2
50229       ikev1-authentication:
50230         type: string
50231         description: Contains values like md5, sha1, sha256, sha384
50232       ikev1-encryption:
50233         type: string
50234         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
50235       ikev1-dh-group:
50236         type: string
50237         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
50238       ikev1-am-group-id:
50239         type: string
50240         description: Group name defined in VIG for clients using aggressive mode
50241       ikev1-am-password:
50242         type: string
50243         description: pre-shared key for the above group name
50244       ikev1-sa-lifetime:
50245         type: string
50246         description: Lifetime for IKEv1 SA
50247       ipsec-authentication:
50248         type: string
50249         description: md5, sha1, sha256, sha384
50250       ipsec-encryption:
50251         type: string
50252         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
50253       ipsec-sa-lifetime:
50254         type: string
50255         description: Life time for IPSec SA
50256       ipsec-pfs:
50257         type: string
50258         description: enable PFS or not
50259       xauth-userid:
50260         type: string
50261         description: user ID for xAuth, sm-user, ,nmteHostName
50262       xauth-user-password:
50263         type: string
50264         description: Encrypted using the Juniper $9$ algorithm
50265       dpd-interval:
50266         type: string
50267         description: The time between DPD probe
50268       dpd-frequency:
50269         type: string
50270         description: Maximum number of DPD before claiming the tunnel is down
50271       resource-version:
50272         type: string
50273         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50274       relationship-list:
50275         type: array
50276         items:
50277           $ref: "#/definitions/relationship"
50278       vig-servers:
50279         type: array
50280         items:
50281           $ref: "#/definitions/vig-server"
50282   ipsec-configurations:
50283     properties:
50284       ipsec-configuration:
50285         type: array
50286         items:
50287           $ref: "#/definitions/ipsec-configuration"
50288   key-data:
50289     properties:
50290       key-name:
50291         type: string
50292       key-value:
50293         type: string
50294   l-interface:
50295     description: |
50296       Logical interfaces, e.g., a vnic.
50297       ###### Related Nodes
50298       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50299       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50300       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
50301       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50302       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50303       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
50304       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
50305       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
50306       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50307       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50308       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
50309       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
50310       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50311       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
50312       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
50313     required:
50314     - interface-name
50315     - is-port-mirrored
50316     - in-maint
50317     properties:
50318       interface-name:
50319         type: string
50320         description: Name given to the interface
50321       interface-role:
50322         type: string
50323         description: E.g., CUSTOMER, UPLINK, etc.
50324       v6-wan-link-ip:
50325         type: string
50326         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
50327       selflink:
50328         type: string
50329         description: URL to endpoint where AAI can get more details
50330       interface-id:
50331         type: string
50332         description: ID of interface
50333       macaddr:
50334         type: string
50335         description: MAC address for the interface
50336       network-name:
50337         type: string
50338         description: Name of the network
50339       management-option:
50340         type: string
50341         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
50342       interface-description:
50343         type: string
50344         description: Human friendly text regarding this interface.
50345       is-port-mirrored:
50346         type: boolean
50347       resource-version:
50348         type: string
50349         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50350       in-maint:
50351         type: boolean
50352       vlans:
50353         type: array
50354         items:
50355           $ref: "#/definitions/vlan"
50356       sriov-vfs:
50357         type: array
50358         items:
50359           $ref: "#/definitions/sriov-vf"
50360       l-interfaces:
50361         type: array
50362         items:
50363           $ref: "#/definitions/l-interface"
50364       relationship-list:
50365         type: array
50366         items:
50367           $ref: "#/definitions/relationship"
50368       l3-interface-ipv4-address-list:
50369         type: array
50370         items:
50371           $ref: "#/definitions/l3-interface-ipv4-address-list"
50372       l3-interface-ipv6-address-list:
50373         type: array
50374         items:
50375           $ref: "#/definitions/l3-interface-ipv6-address-list"
50376   l-interfaces:
50377     description: |
50378       Collection of logical interfaces.
50379     properties:
50380       l-interface:
50381         type: array
50382         items:
50383           $ref: "#/definitions/l-interface"
50384   l3-interface-ipv4-address-list:
50385     description: |
50386       IPv4 Address Range
50387       ###### Related Nodes
50388       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50389       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50390       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50391       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50392       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50393     required:
50394     - l3-interface-ipv4-address
50395     properties:
50396       l3-interface-ipv4-address:
50397         type: string
50398         description: IP address
50399       l3-interface-ipv4-prefix-length:
50400         type: integer
50401         format: int64
50402         description: Prefix length, 32 for single address
50403       vlan-id-inner:
50404         type: integer
50405         format: int64
50406         description: Inner VLAN tag
50407       vlan-id-outer:
50408         type: integer
50409         format: int64
50410         description: Outer VLAN tag
50411       is-floating:
50412         type: boolean
50413         description: Indicator of fixed or floating address
50414       resource-version:
50415         type: string
50416         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50417       neutron-network-id:
50418         type: string
50419         description: Neutron network id of the interface that address belongs to
50420       neutron-subnet-id:
50421         type: string
50422         description: Neutron id of subnet that address belongs to
50423       relationship-list:
50424         type: array
50425         items:
50426           $ref: "#/definitions/relationship"
50427   l3-interface-ipv6-address-list:
50428     description: |
50429       IPv6 Address Range
50430       ###### Related Nodes
50431       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
50432       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50433       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
50434       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
50435       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
50436     required:
50437     - l3-interface-ipv6-address
50438     properties:
50439       l3-interface-ipv6-address:
50440         type: string
50441         description: IP address
50442       l3-interface-ipv6-prefix-length:
50443         type: integer
50444         format: int64
50445         description: Prefix length, 128 for single address
50446       vlan-id-inner:
50447         type: integer
50448         format: int64
50449         description: Inner VLAN tag
50450       vlan-id-outer:
50451         type: integer
50452         format: int64
50453         description: Outer VLAN tag
50454       is-floating:
50455         type: boolean
50456         description: Indicator of fixed or floating address
50457       resource-version:
50458         type: string
50459         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50460       neutron-network-id:
50461         type: string
50462         description: Neutron network id of the interface that address belongs to
50463       neutron-subnet-id:
50464         type: string
50465         description: Neutron id of subnet that address belongs to
50466       relationship-list:
50467         type: array
50468         items:
50469           $ref: "#/definitions/relationship"
50470   l3-network:
50471     description: |
50472       Generic network definition
50473       ###### Related Nodes
50474       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
50475       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
50476       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
50477       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
50478       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50479       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50480       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50481       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50482       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
50483       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50484       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50485       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
50486       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
50487       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
50488       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
50489       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
50490     required:
50491     - network-id
50492     - network-name
50493     - is-bound-to-vpn
50494     - is-provider-network
50495     - is-shared-network
50496     - is-external-network
50497     properties:
50498       network-id:
50499         type: string
50500         description: Network ID, should be uuid. Unique across A&AI.
50501       network-name:
50502         type: string
50503         description: Name of the network, governed by some naming convention..
50504       network-type:
50505         type: string
50506         description: Type of the network - who defines these values?
50507       network-role:
50508         type: string
50509         description: Role the network plans - who defines these values?
50510       network-technology:
50511         type: string
50512         description: Network technology - who defines these values?
50513       neutron-network-id:
50514         type: string
50515         description: Neutron network id of this Interface
50516       is-bound-to-vpn:
50517         type: boolean
50518       service-id:
50519         type: string
50520         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
50521       network-role-instance:
50522         type: integer
50523         format: int64
50524         description: network role instance
50525       resource-version:
50526         type: string
50527         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50528       orchestration-status:
50529         type: string
50530         description: Orchestration status of this VNF, mastered by MSO
50531       heat-stack-id:
50532         type: string
50533         description: Heat stack id corresponding to this instance, managed by MSO
50534       mso-catalog-key:
50535         type: string
50536         description: Corresponds to the SDN-C catalog id used to configure this VCE
50537       contrail-network-fqdn:
50538         type: string
50539         description: Contrail FQDN for the network
50540       model-invariant-id:
50541         type: string
50542         description: the ASDC model id for this resource or service model.
50543       model-version-id:
50544         type: string
50545         description: the ASDC model version for this resource or service model.
50546       persona-model-version:
50547         type: string
50548         description: the ASDC model version for this resource or service model.
50549       model-customization-id:
50550         type: string
50551         description: captures the id of all the configuration used to customize the resource for the service.
50552       widget-model-id:
50553         type: string
50554         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
50555       widget-model-version:
50556         type: string
50557         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
50558       physical-network-name:
50559         type: string
50560         description: Name associated with the physical network.
50561       is-provider-network:
50562         type: boolean
50563       is-shared-network:
50564         type: boolean
50565       is-external-network:
50566         type: boolean
50567       selflink:
50568         type: string
50569         description: Path to the controller object.
50570       operational-status:
50571         type: string
50572         description: Indicator for whether the resource is considered operational.
50573       subnets:
50574         type: array
50575         items:
50576           $ref: "#/definitions/subnet"
50577       ctag-assignments:
50578         type: array
50579         items:
50580           $ref: "#/definitions/ctag-assignment"
50581       segmentation-assignments:
50582         type: array
50583         items:
50584           $ref: "#/definitions/segmentation-assignment"
50585       relationship-list:
50586         type: array
50587         items:
50588           $ref: "#/definitions/relationship"
50589         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
50590   l3-networks:
50591     properties:
50592       l3-network:
50593         type: array
50594         items:
50595           $ref: "#/definitions/l3-network"
50596   lag-interface:
50597     description: |
50598       Link aggregate interface
50599       ###### Related Nodes
50600       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50601       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50602       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50603       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
50604       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
50605       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
50606       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
50607       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
50608       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
50609       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
50610     required:
50611     - interface-name
50612     - in-maint
50613     properties:
50614       interface-name:
50615         type: string
50616         description: Name that identifies the link aggregate interface
50617       interface-description:
50618         type: string
50619         description: Human friendly text regarding this interface.
50620       resource-version:
50621         type: string
50622         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50623       speed-value:
50624         type: string
50625         description: Captures the numeric part of the speed
50626       speed-units:
50627         type: string
50628         description: Captures the units corresponding to the speed
50629       interface-id:
50630         type: string
50631         description: ID of interface
50632       interface-role:
50633         type: string
50634         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50635       prov-status:
50636         type: string
50637         description: Trigger for operational monitoring of this resource by Service Assurance systems.
50638       in-maint:
50639         type: boolean
50640       relationship-list:
50641         type: array
50642         items:
50643           $ref: "#/definitions/relationship"
50644       l-interfaces:
50645         type: array
50646         items:
50647           $ref: "#/definitions/l-interface"
50648   lag-interfaces:
50649     description: |
50650       Collection of link aggregate interfaces.
50651     properties:
50652       lag-interface:
50653         type: array
50654         items:
50655           $ref: "#/definitions/lag-interface"
50656   lag-link:
50657     description: |
50658       LAG links can connect lag-interfaces
50659       ###### Related Nodes
50660       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
50661       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50662     required:
50663     - link-name
50664     properties:
50665       link-name:
50666         type: string
50667         description: Alphabetical concatenation of lag-interface names
50668       resource-version:
50669         type: string
50670         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50671       relationship-list:
50672         type: array
50673         items:
50674           $ref: "#/definitions/relationship"
50675   lag-links:
50676     description: |
50677       Collection of link aggregation connections
50678     properties:
50679       lag-link:
50680         type: array
50681         items:
50682           $ref: "#/definitions/lag-link"
50683   license:
50684     description: |
50685       Metadata for license group.
50686       ###### Related Nodes
50687       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
50688       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
50689     required:
50690     - group-uuid
50691     - resource-uuid
50692     properties:
50693       group-uuid:
50694         type: string
50695         description: Unique ID for the license group the resource belongs to, should be uuid.
50696       resource-uuid:
50697         type: string
50698         description: Unique ID of a license resource.
50699       resource-version:
50700         type: string
50701         description: Concurrency value
50702       relationship-list:
50703         type: array
50704         items:
50705           $ref: "#/definitions/relationship"
50706   licenses:
50707     description: |
50708       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
50709     properties:
50710       license:
50711         type: array
50712         items:
50713           $ref: "#/definitions/license"
50714   line-of-business:
50715     description: |
50716       describes a line-of-business
50717       ###### Related Nodes
50718       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
50719     required:
50720     - line-of-business-name
50721     properties:
50722       line-of-business-name:
50723         type: string
50724         description: Name of the line-of-business (product)
50725       resource-version:
50726         type: string
50727         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50728       relationship-list:
50729         type: array
50730         items:
50731           $ref: "#/definitions/relationship"
50732   lines-of-business:
50733     description: |
50734       Collection of lines-of-business
50735     properties:
50736       line-of-business:
50737         type: array
50738         items:
50739           $ref: "#/definitions/line-of-business"
50740   logical-link:
50741     description: |
50742       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
50743       ###### Related Nodes
50744       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
50745       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
50746       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
50747       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50748       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
50749       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
50750       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
50751       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
50752       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50753       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
50754       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
50755       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
50756       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50757       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
50758     required:
50759     - link-name
50760     - link-type
50761     properties:
50762       link-name:
50763         type: string
50764         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
50765       link-type:
50766         type: string
50767         description: Type of logical link, e.g., evc
50768       speed-value:
50769         type: string
50770         description: Captures the numeric part of the speed
50771       speed-units:
50772         type: string
50773         description: Captures the units corresponding to the speed
50774       ip-version:
50775         type: string
50776         description: v4, v6, or ds for dual stack
50777       routing-protocol:
50778         type: string
50779         description: For example, static or BGP
50780       resource-version:
50781         type: string
50782         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50783       model-invariant-id:
50784         type: string
50785         description: the ASDC model id for this resource or service model.
50786       model-version-id:
50787         type: string
50788         description: the ASDC model version for this resource or service model.
50789       persona-model-version:
50790         type: string
50791         description: the ASDC model version for this resource or service model.
50792       widget-model-id:
50793         type: string
50794         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
50795       widget-model-version:
50796         type: string
50797         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
50798       operational-status:
50799         type: string
50800         description: Indication of operational status of the logical link.
50801       prov-status:
50802         type: string
50803         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
50804       link-role:
50805         type: string
50806         description: Indication of the network use of the logical link.
50807       link-name2:
50808         type: string
50809         description: Alias or alternate name (CLCI or D1 name).
50810       link-id:
50811         type: string
50812         description: UUID of the logical-link, SDNC generates this.
50813       circuit-id:
50814         type: string
50815         description: Circuit id
50816       purpose:
50817         type: string
50818         description: Reason for this entity, role it is playing
50819       relationship-list:
50820         type: array
50821         items:
50822           $ref: "#/definitions/relationship"
50823   logical-links:
50824     description: |
50825       Collection of logical connections
50826     properties:
50827       logical-link:
50828         type: array
50829         items:
50830           $ref: "#/definitions/logical-link"
50831   metadata:
50832     description: |
50833       Collection of metadatum (key/value pairs)
50834     properties:
50835       metadatum:
50836         type: array
50837         items:
50838           $ref: "#/definitions/metadatum"
50839   metadatum:
50840     description: |
50841       Key/value pairs
50842       ###### Related Nodes
50843       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
50844       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
50845       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
50846       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50847     required:
50848     - metaname
50849     - metaval
50850     properties:
50851       metaname:
50852         type: string
50853       metaval:
50854         type: string
50855       resource-version:
50856         type: string
50857         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50858   model:
50859     description: |
50860       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
50861       ###### Related Nodes
50862       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50863       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
50864       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50865       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
50866       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
50867       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
50868       - MODEL is DELETED when these are DELETED MODEL-VER
50869     required:
50870     - model-invariant-id
50871     - model-type
50872     properties:
50873       model-invariant-id:
50874         type: string
50875         description: Unique identifier corresponding to the main definition of a model in ASDC
50876       model-type:
50877         type: string
50878         description: Type of the model, e.g., service, resource, widget, etc.
50879       resource-version:
50880         type: string
50881         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50882       model-vers:
50883         type: array
50884         items:
50885           $ref: "#/definitions/model-ver"
50886       relationship-list:
50887         type: array
50888         items:
50889           $ref: "#/definitions/relationship"
50890   model-and-named-query-search:
50891     description: |
50892       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
50893     properties:
50894       query-parameters:
50895         type: object
50896         $ref: "#/definitions/query-parameters"
50897       instance-filters:
50898         type: object
50899         $ref: "#/definitions/instance-filters"
50900       secondary-filts:
50901         type: object
50902         $ref: "#/definitions/secondary-filts"
50903       top-node-type:
50904         type: string
50905       secondary-filter-cut-point:
50906         type: string
50907   model-constraint:
50908     description: |
50909       This is how we would capture constraints defining allowed sets of elements.
50910       ###### Related Nodes
50911       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50912       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
50913       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
50914     required:
50915     - model-constraint-uuid
50916     - constrained-element-set-uuid-to-replace
50917     properties:
50918       model-constraint-uuid:
50919         type: string
50920       constrained-element-set-uuid-to-replace:
50921         type: string
50922       constrained-element-sets:
50923         type: array
50924         items:
50925           $ref: "#/definitions/constrained-element-set"
50926       resource-version:
50927         type: string
50928         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50929   model-constraints:
50930     properties:
50931       model-constraint:
50932         type: array
50933         items:
50934           $ref: "#/definitions/model-constraint"
50935   model-element:
50936     description: |
50937       Defines how other models combine to make up a higher-level model.
50938       ###### Related Nodes
50939       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
50940       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50941       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50942       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50943       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50944       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50945       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
50946       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
50947     required:
50948     - model-element-uuid
50949     - new-data-del-flag
50950     - cardinality
50951     properties:
50952       model-element-uuid:
50953         type: string
50954       new-data-del-flag:
50955         type: string
50956         description: Indicates whether this element was created as part of instantiation from this model
50957       cardinality:
50958         type: string
50959         description: How many of this type of element are required/allowed
50960       linkage-points:
50961         type: string
50962       resource-version:
50963         type: string
50964         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
50965       model-elements:
50966         type: array
50967         items:
50968           $ref: "#/definitions/model-element"
50969         description: Defines how other models combine to make up a higher-level model
50970       model-constraints:
50971         type: array
50972         items:
50973           $ref: "#/definitions/model-constraint"
50974         description: Describes new constraints on this model element that are not part of that model's definition
50975       relationship-list:
50976         type: array
50977         items:
50978           $ref: "#/definitions/relationship"
50979   model-elements:
50980     properties:
50981       model-element:
50982         type: array
50983         items:
50984           $ref: "#/definitions/model-element"
50985   model-ver:
50986     description: |
50987       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
50988       ###### Related Nodes
50989       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
50990       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
50991       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50992       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
50993       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
50994       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
50995     required:
50996     - model-version-id
50997     - model-name
50998     - model-version
50999     properties:
51000       model-version-id:
51001         type: string
51002         description: Unique identifier corresponding to one version of a model in ASDC
51003       model-name:
51004         type: string
51005         description: Name of the model, which can change from version to version.
51006       model-version:
51007         type: string
51008         description: Version
51009       model-description:
51010         type: string
51011         description: Description
51012       resource-version:
51013         type: string
51014         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51015       model-elements:
51016         type: array
51017         items:
51018           $ref: "#/definitions/model-element"
51019       metadata:
51020         type: array
51021         items:
51022           $ref: "#/definitions/metadatum"
51023       relationship-list:
51024         type: array
51025         items:
51026           $ref: "#/definitions/relationship"
51027   model-vers:
51028     properties:
51029       model-ver:
51030         type: array
51031         items:
51032           $ref: "#/definitions/model-ver"
51033   models:
51034     description: |
51035       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
51036     properties:
51037       model:
51038         type: array
51039         items:
51040           $ref: "#/definitions/model"
51041   multicast-configuration:
51042     description: |
51043       ###### Related Nodes
51044       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
51045     required:
51046     - multicast-configuration-id
51047     - multicast-protocol
51048     - rp-type
51049     properties:
51050       multicast-configuration-id:
51051         type: string
51052         description: Unique id of multicast configuration.
51053       multicast-protocol:
51054         type: string
51055         description: protocol of multicast configuration
51056       rp-type:
51057         type: string
51058         description: rp type of multicast configuration
51059       resource-version:
51060         type: string
51061         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51062       relationship-list:
51063         type: array
51064         items:
51065           $ref: "#/definitions/relationship"
51066   multicast-configurations:
51067     description: |
51068       multicast configuration of generic-vnf ip-address
51069     properties:
51070       multicast-configuration:
51071         type: array
51072         items:
51073           $ref: "#/definitions/multicast-configuration"
51074   named-queries:
51075     properties:
51076       named-query:
51077         type: array
51078         items:
51079           $ref: "#/definitions/named-query"
51080   named-query:
51081     description: |
51082       TBD
51083       ###### Related Nodes
51084       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
51085       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
51086       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
51087       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
51088     required:
51089     - named-query-uuid
51090     - named-query-name
51091     - named-query-version
51092     properties:
51093       named-query-uuid:
51094         type: string
51095       named-query-name:
51096         type: string
51097       named-query-version:
51098         type: string
51099       required-input-param:
51100         type: string
51101       description:
51102         type: string
51103       resource-version:
51104         type: string
51105       named-query-elements:
51106         type: array
51107         items:
51108           $ref: "#/definitions/named-query-element"
51109       relationship-list:
51110         type: array
51111         items:
51112           $ref: "#/definitions/relationship"
51113   named-query-element:
51114     description: |
51115       TBD
51116       ###### Related Nodes
51117       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
51118       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
51119       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51120       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51121       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51122       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51123       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
51124     required:
51125     - named-query-element-uuid
51126     properties:
51127       named-query-element-uuid:
51128         type: string
51129       property-collect-list:
51130         type: string
51131       resource-version:
51132         type: string
51133       property-limit-desc:
51134         type: string
51135       do-not-output:
51136         type: string
51137       named-query-elements:
51138         type: array
51139         items:
51140           $ref: "#/definitions/named-query-element"
51141       related-lookups:
51142         type: array
51143         items:
51144           $ref: "#/definitions/related-lookup"
51145       property-constraints:
51146         type: array
51147         items:
51148           $ref: "#/definitions/property-constraint"
51149       relationship-list:
51150         type: array
51151         items:
51152           $ref: "#/definitions/relationship"
51153   named-query-elements:
51154     properties:
51155       named-query-element:
51156         type: array
51157         items:
51158           $ref: "#/definitions/named-query-element"
51159   network:
51160     description: |
51161       Namespace for network inventory resources.
51162     properties:
51163       logical-links:
51164         type: array
51165         items:
51166           $ref: "#/definitions/logical-link"
51167       site-pair-sets:
51168         type: array
51169         items:
51170           $ref: "#/definitions/site-pair-set"
51171       vpn-bindings:
51172         type: array
51173         items:
51174           $ref: "#/definitions/vpn-binding"
51175       vpls-pes:
51176         type: array
51177         items:
51178           $ref: "#/definitions/vpls-pe"
51179       multicast-configurations:
51180         type: array
51181         items:
51182           $ref: "#/definitions/multicast-configuration"
51183       vces:
51184         type: array
51185         items:
51186           $ref: "#/definitions/vce"
51187       vnfcs:
51188         type: array
51189         items:
51190           $ref: "#/definitions/vnfc"
51191       l3-networks:
51192         type: array
51193         items:
51194           $ref: "#/definitions/l3-network"
51195       network-policies:
51196         type: array
51197         items:
51198           $ref: "#/definitions/network-policy"
51199       generic-vnfs:
51200         type: array
51201         items:
51202           $ref: "#/definitions/generic-vnf"
51203       lag-links:
51204         type: array
51205         items:
51206           $ref: "#/definitions/lag-link"
51207       newvces:
51208         type: array
51209         items:
51210           $ref: "#/definitions/newvce"
51211       pnfs:
51212         type: array
51213         items:
51214           $ref: "#/definitions/pnf"
51215       physical-links:
51216         type: array
51217         items:
51218           $ref: "#/definitions/physical-link"
51219       ipsec-configurations:
51220         type: array
51221         items:
51222           $ref: "#/definitions/ipsec-configuration"
51223       route-table-references:
51224         type: array
51225         items:
51226           $ref: "#/definitions/route-table-reference"
51227       instance-groups:
51228         type: array
51229         items:
51230           $ref: "#/definitions/instance-group"
51231       zones:
51232         type: array
51233         items:
51234           $ref: "#/definitions/zone"
51235   network-policies:
51236     properties:
51237       network-policy:
51238         type: array
51239         items:
51240           $ref: "#/definitions/network-policy"
51241   network-policy:
51242     description: |
51243       ###### Related Nodes
51244       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
51245       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
51246     required:
51247     - network-policy-id
51248     properties:
51249       network-policy-id:
51250         type: string
51251         description: UUID representing unique key to this instance
51252       network-policy-fqdn:
51253         type: string
51254         description: Contrail FQDN for the policy
51255       heat-stack-id:
51256         type: string
51257         description: ID for the openStack Heat instance
51258       resource-version:
51259         type: string
51260         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51261       relationship-list:
51262         type: array
51263         items:
51264           $ref: "#/definitions/relationship"
51265   network-profile:
51266     description: |
51267       Network profile populated by SDN-GP for SNMP
51268       ###### Related Nodes
51269       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
51270     required:
51271     - nm-profile-name
51272     properties:
51273       nm-profile-name:
51274         type: string
51275         description: Unique name of network profile.
51276       community-string:
51277         type: string
51278         description: Encrypted SNMP community string
51279       resource-version:
51280         type: string
51281         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51282       relationship-list:
51283         type: array
51284         items:
51285           $ref: "#/definitions/relationship"
51286   network-profiles:
51287     description: |
51288       Collection of network profiles
51289     properties:
51290       network-profile:
51291         type: array
51292         items:
51293           $ref: "#/definitions/network-profile"
51294   newvce:
51295     description: |
51296       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
51297       ###### Related Nodes
51298       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
51299       - NEWVCE is DELETED when these are DELETED L-INTERFACE
51300     required:
51301     - vnf-id2
51302     - vnf-name
51303     - vnf-type
51304     properties:
51305       vnf-id2:
51306         type: string
51307         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
51308       vnf-name:
51309         type: string
51310         description: Name of VNF.
51311       vnf-name2:
51312         type: string
51313         description: Alternate name of VNF.
51314       vnf-type:
51315         type: string
51316         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
51317       prov-status:
51318         type: string
51319         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
51320       operational-status:
51321         type: string
51322         description: Indicator for whether the resource is considered operational
51323       license-key:
51324         type: string
51325         description: OBSOLETE -  do not use
51326       ipv4-oam-address:
51327         type: string
51328         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).
51329       equipment-role:
51330         type: string
51331         description: Client should send valid enumerated value.
51332       resource-version:
51333         type: string
51334         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51335       ipv4-loopback0-address:
51336         type: string
51337         description: v4 Loopback0 address
51338       orchestration-status:
51339         type: string
51340         description: Orchestration status of this VNF, mastered by MSO.
51341       heat-stack-id:
51342         type: string
51343         description: Heat stack id corresponding to this instance, managed by MSO
51344       mso-catalog-key:
51345         type: string
51346         description: Corresponds to the SDN-C catalog id used to configure this VCE
51347       relationship-list:
51348         type: array
51349         items:
51350           $ref: "#/definitions/relationship"
51351       l-interfaces:
51352         type: array
51353         items:
51354           $ref: "#/definitions/l-interface"
51355   newvces:
51356     description: |
51357       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
51358     properties:
51359       newvce:
51360         type: array
51361         items:
51362           $ref: "#/definitions/newvce"
51363   notification-event:
51364     properties:
51365       cambria.partition:
51366         type: string
51367       notification-event-header:
51368         type: object
51369         $ref: "#/definitions/notification-event-header"
51370   notification-event-header:
51371     properties:
51372       id:
51373         type: string
51374       timestamp:
51375         type: string
51376       source-name:
51377         type: string
51378       domain:
51379         type: string
51380       sequence-number:
51381         type: string
51382       severity:
51383         type: string
51384       event-type:
51385         type: string
51386       version:
51387         type: string
51388       action:
51389         type: string
51390       entity-type:
51391         type: string
51392       top-entity-type:
51393         type: string
51394       entity-link:
51395         type: string
51396       status:
51397         type: string
51398   notify:
51399     required:
51400     - event-id
51401     properties:
51402       event-id:
51403         type: string
51404       node-type:
51405         type: string
51406       event-trigger:
51407         type: string
51408       key-data:
51409         type: array
51410         items:
51411           $ref: "#/definitions/key-data"
51412       selflink:
51413         type: string
51414   oam-network:
51415     description: |
51416       OAM network, to be deprecated shortly.  Do not use for new purposes.
51417       ###### Related Nodes
51418       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
51419       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
51420       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
51421     required:
51422     - network-uuid
51423     - network-name
51424     - cvlan-tag
51425     properties:
51426       network-uuid:
51427         type: string
51428         description: UUID of the network. Unique across a cloud-region
51429       network-name:
51430         type: string
51431         description: Name of the network.
51432       cvlan-tag:
51433         type: integer
51434         format: int64
51435         description: cvlan-id
51436       ipv4-oam-gateway-address:
51437         type: string
51438         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
51439       ipv4-oam-gateway-address-prefix-length:
51440         type: integer
51441         format: int32
51442         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
51443       resource-version:
51444         type: string
51445         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51446       relationship-list:
51447         type: array
51448         items:
51449           $ref: "#/definitions/relationship"
51450   oam-networks:
51451     description: |
51452       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
51453     properties:
51454       oam-network:
51455         type: array
51456         items:
51457           $ref: "#/definitions/oam-network"
51458   operational-environment:
51459     description: |
51460       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
51461       ###### Related Nodes
51462       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
51463       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
51464     required:
51465     - operational-environment-id
51466     - operational-environment-name
51467     - operational-environment-type
51468     - operational-environment-status
51469     - tenant-context
51470     - workload-context
51471     properties:
51472       operational-environment-id:
51473         type: string
51474         description: UUID of an operational environment
51475       operational-environment-name:
51476         type: string
51477         description: Operational Environment name
51478       operational-environment-type:
51479         type: string
51480         description: Operational Environment Type.
51481       operational-environment-status:
51482         type: string
51483         description: Status
51484       tenant-context:
51485         type: string
51486         description: Tenant Context.
51487       workload-context:
51488         type: string
51489         description: Workload Context.
51490       resource-version:
51491         type: string
51492         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51493       relationship-list:
51494         type: array
51495         items:
51496           $ref: "#/definitions/relationship"
51497   operational-environments:
51498     description: |
51499       a logical partition of the cloud which allows to have multiple environments in the production AIC.
51500     properties:
51501       operational-environment:
51502         type: array
51503         items:
51504           $ref: "#/definitions/operational-environment"
51505   overloaded-model:
51506     description: |
51507       Allows for legacy POST of old-style and new-style models
51508     required:
51509     - model-invariant-id
51510     - model-name-version-id
51511     - model-type
51512     - model-name
51513     - model-id
51514     - model-version
51515     properties:
51516       model-invariant-id:
51517         type: string
51518         description: Unique identifier corresponding to the main definition of a model in ASDC
51519       model-name-version-id:
51520         type: string
51521         description: Unique identifier corresponding to one version of a model in ASDC
51522       model-type:
51523         type: string
51524         description: Type of the model, e.g., service, resource, widget, etc.
51525       model-name:
51526         type: string
51527         description: Name of the model, which can change from version to version.
51528       model-id:
51529         type: string
51530         description: Invariant unique ID which does not change from version to version
51531       model-version:
51532         type: string
51533         description: Version
51534       model-description:
51535         type: string
51536         description: Description
51537       resource-version:
51538         type: string
51539         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51540       model-vers:
51541         type: object
51542         $ref: "#/definitions/model-vers"
51543       relationship-list:
51544         type: object
51545         $ref: "#/definitions/relationship-list"
51546   owning-entities:
51547     description: |
51548       Collection of owning-entities
51549     properties:
51550       owning-entity:
51551         type: array
51552         items:
51553           $ref: "#/definitions/owning-entity"
51554   owning-entity:
51555     description: |
51556       describes an owning-entity
51557       ###### Related Nodes
51558       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
51559     required:
51560     - owning-entity-id
51561     - owning-entity-name
51562     properties:
51563       owning-entity-id:
51564         type: string
51565         description: UUID of an owning entity
51566       owning-entity-name:
51567         type: string
51568         description: Owning entity name
51569       resource-version:
51570         type: string
51571         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51572       relationship-list:
51573         type: array
51574         items:
51575           $ref: "#/definitions/relationship"
51576   p-interface:
51577     description: |
51578       Physical interface (e.g., nic)
51579       ###### Related Nodes
51580       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
51581       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
51582       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51583       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51584       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
51585       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
51586       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
51587       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
51588       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
51589     required:
51590     - interface-name
51591     - in-maint
51592     properties:
51593       interface-name:
51594         type: string
51595         description: Name that identifies the physical interface
51596       speed-value:
51597         type: string
51598         description: Captures the numeric part of the speed
51599       speed-units:
51600         type: string
51601         description: Captures the units corresponding to the speed
51602       port-description:
51603         type: string
51604         description: Nature of the services and connectivity on this port.
51605       equipment-identifier:
51606         type: string
51607         description: CLEI or other specification for p-interface hardware.
51608       interface-role:
51609         type: string
51610         description: Role specification for p-interface hardware.
51611       interface-type:
51612         type: string
51613         description: Indicates the physical properties of the interface.
51614       prov-status:
51615         type: string
51616         description: Trigger for operational monitoring of this resource by Service Assurance systems.
51617       resource-version:
51618         type: string
51619         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51620       in-maint:
51621         type: boolean
51622       relationship-list:
51623         type: array
51624         items:
51625           $ref: "#/definitions/relationship"
51626       l-interfaces:
51627         type: array
51628         items:
51629           $ref: "#/definitions/l-interface"
51630   p-interfaces:
51631     description: |
51632       Collection of physical interfaces.
51633     properties:
51634       p-interface:
51635         type: array
51636         items:
51637           $ref: "#/definitions/p-interface"
51638   physical-link:
51639     description: |
51640       Collection of physical connections, typically between p-interfaces
51641       ###### Related Nodes
51642       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
51643     required:
51644     - link-name
51645     properties:
51646       link-name:
51647         type: string
51648         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51649       speed-value:
51650         type: string
51651         description: Captures the numeric part of the speed
51652       speed-units:
51653         type: string
51654         description: Captures the units corresponding to the speed
51655       circuit-id:
51656         type: string
51657         description: Circuit it
51658       dual-mode:
51659         type: string
51660         description: Dual access mode (e.g., primary, secondary
51661       management-option:
51662         type: string
51663         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
51664       service-provider-name:
51665         type: string
51666         description: Name of the service Provider on this link.
51667       resource-version:
51668         type: string
51669         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51670       relationship-list:
51671         type: array
51672         items:
51673           $ref: "#/definitions/relationship"
51674   physical-links:
51675     description: |
51676       Collection of physical connections, typically between p-interfaces
51677     properties:
51678       physical-link:
51679         type: array
51680         items:
51681           $ref: "#/definitions/physical-link"
51682   platform:
51683     description: |
51684       describes a platform
51685       ###### Related Nodes
51686       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
51687     required:
51688     - platform-name
51689     properties:
51690       platform-name:
51691         type: string
51692         description: Name of the platform
51693       resource-version:
51694         type: string
51695         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51696       relationship-list:
51697         type: array
51698         items:
51699           $ref: "#/definitions/relationship"
51700   platforms:
51701     description: |
51702       Collection of platforms
51703     properties:
51704       platform:
51705         type: array
51706         items:
51707           $ref: "#/definitions/platform"
51708   pnf:
51709     description: |
51710       PNF represents a physical network function. typically equipment used in the D1 world.
51711       ###### Related Nodes
51712       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51713       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
51714       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
51715       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
51716       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51717       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
51718       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
51719       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51720     required:
51721     - pnf-name
51722     - in-maint
51723     properties:
51724       pnf-name:
51725         type: string
51726         description: unique name of Physical Network Function.
51727       pnf-name2:
51728         type: string
51729         description: name of Physical Network Function.
51730       pnf-name2-source:
51731         type: string
51732         description: source of name2
51733       pnf-id:
51734         type: string
51735         description: id of pnf
51736       equip-type:
51737         type: string
51738         description: Equipment type.  Source of truth should define valid values.
51739       equip-vendor:
51740         type: string
51741         description: Equipment vendor.  Source of truth should define valid values.
51742       equip-model:
51743         type: string
51744         description: Equipment model.  Source of truth should define valid values.
51745       management-option:
51746         type: string
51747         description: identifier of managed by company or customer
51748       ipaddress-v4-oam:
51749         type: string
51750         description: ipv4-oam-address with new naming convention for IP addresses
51751       sw-version:
51752         type: string
51753         description: sw-version is the version of SW for the hosted application on the PNF.
51754       in-maint:
51755         type: boolean
51756       frame-id:
51757         type: string
51758         description: ID of the physical frame (relay rack) where pnf is installed.
51759       serial-number:
51760         type: string
51761         description: Serial number of the device
51762       ipaddress-v4-loopback-0:
51763         type: string
51764         description: IPV4 Loopback 0 address
51765       ipaddress-v6-loopback-0:
51766         type: string
51767         description: IPV6 Loopback 0 address
51768       ipaddress-v4-aim:
51769         type: string
51770         description: IPV4 AIM address
51771       ipaddress-v6-aim:
51772         type: string
51773         description: IPV6 AIM address
51774       ipaddress-v6-oam:
51775         type: string
51776         description: IPV6 OAM address
51777       inv-status:
51778         type: string
51779         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
51780       resource-version:
51781         type: string
51782         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51783       prov-status:
51784         type: string
51785         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
51786       nf-role:
51787         type: string
51788         description: Nf Role is the role performed by this instance in the network.
51789       relationship-list:
51790         type: array
51791         items:
51792           $ref: "#/definitions/relationship"
51793       p-interfaces:
51794         type: array
51795         items:
51796           $ref: "#/definitions/p-interface"
51797       lag-interfaces:
51798         type: array
51799         items:
51800           $ref: "#/definitions/lag-interface"
51801   pnfs:
51802     description: |
51803       Collection of Physical Network Functions.
51804     properties:
51805       pnf:
51806         type: array
51807         items:
51808           $ref: "#/definitions/pnf"
51809   port-group:
51810     description: |
51811       Used to capture the network interfaces of this VCE
51812       ###### Related Nodes
51813       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
51814       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
51815       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
51816     required:
51817     - interface-id
51818     - orchestration-status
51819     properties:
51820       interface-id:
51821         type: string
51822         description: Unique ID of the interface
51823       neutron-network-id:
51824         type: string
51825         description: Neutron network id of this Interface
51826       neutron-network-name:
51827         type: string
51828         description: Neutron network name of this Interface
51829       interface-role:
51830         type: string
51831         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
51832       resource-version:
51833         type: string
51834         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51835       port-group-id:
51836         type: string
51837         description: Unique ID for port group in vmware
51838       port-group-name:
51839         type: string
51840         description: Likely to duplicate value of neutron network name
51841       switch-name:
51842         type: string
51843         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
51844       orchestration-status:
51845         type: string
51846         description: Orchestration status of this VNF, mastered by MSO
51847       heat-stack-id:
51848         type: string
51849         description: Heat stack id corresponding to this instance, managed by MSO
51850       mso-catalog-key:
51851         type: string
51852         description: Corresponds to the SDN-C catalog id used to configure this VCE
51853       cvlan-tags:
51854         type: array
51855         items:
51856           $ref: "#/definitions/cvlan-tag-entry"
51857       relationship-list:
51858         type: array
51859         items:
51860           $ref: "#/definitions/relationship"
51861   port-groups:
51862     properties:
51863       port-group:
51864         type: array
51865         items:
51866           $ref: "#/definitions/port-group"
51867   project:
51868     description: |
51869       describes the project
51870       ###### Related Nodes
51871       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
51872     required:
51873     - project-name
51874     properties:
51875       project-name:
51876         type: string
51877         description: Name of the project deploying a service
51878       resource-version:
51879         type: string
51880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
51881       relationship-list:
51882         type: array
51883         items:
51884           $ref: "#/definitions/relationship"
51885   projects:
51886     description: |
51887       Collection of projects
51888     properties:
51889       project:
51890         type: array
51891         items:
51892           $ref: "#/definitions/project"
51893   properties:
51894     description: |
51895       Property holder for query properties or instance properties
51896     properties:
51897       property-name:
51898         type: string
51899       property-value:
51900         type: string
51901   property-constraint:
51902     description: |
51903       TBD
51904       ###### Related Nodes
51905       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
51906     required:
51907     - property-constraint-uuid
51908     - constraint-type
51909     - property-name
51910     - property-value
51911     properties:
51912       property-constraint-uuid:
51913         type: string
51914       constraint-type:
51915         type: string
51916       property-name:
51917         type: string
51918       property-value:
51919         type: string
51920       resource-version:
51921         type: string
51922   property-constraints:
51923     properties:
51924       property-constraint:
51925         type: array
51926         items:
51927           $ref: "#/definitions/property-constraint"
51928   pserver:
51929     description: |
51930       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
51931       ###### Related Nodes
51932       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
51933       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
51934       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
51935       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
51936       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
51937       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
51938       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
51939       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51940       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
51941       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
51942       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
51943       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
51944       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
51945     required:
51946     - hostname
51947     - in-maint
51948     properties:
51949       hostname:
51950         type: string
51951         description: Value from executing hostname on the compute node.
51952       ptnii-equip-name:
51953         type: string
51954         description: PTNII name
51955       number-of-cpus:
51956         type: integer
51957         format: int32
51958         description: Number of cpus
51959       disk-in-gigabytes:
51960         type: integer
51961         format: int32
51962         description: Disk size, in GBs
51963       ram-in-megabytes:
51964         type: integer
51965         format: int32
51966         description: RAM size, in MBs
51967       equip-type:
51968         type: string
51969         description: Equipment type.  Source of truth should define valid values.
51970       equip-vendor:
51971         type: string
51972         description: Equipment vendor.  Source of truth should define valid values.
51973       equip-model:
51974         type: string
51975         description: Equipment model.  Source of truth should define valid values.
51976       fqdn:
51977         type: string
51978         description: Fully-qualified domain name
51979       pserver-selflink:
51980         type: string
51981         description: URL to endpoint where AAI can get more details
51982       ipv4-oam-address:
51983         type: string
51984         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
51985       serial-number:
51986         type: string
51987         description: Serial number, may be queried
51988       ipaddress-v4-loopback-0:
51989         type: string
51990         description: IPV4 Loopback 0 address
51991       ipaddress-v6-loopback-0:
51992         type: string
51993         description: IPV6 Loopback 0 address
51994       ipaddress-v4-aim:
51995         type: string
51996         description: IPV4 AIM address
51997       ipaddress-v6-aim:
51998         type: string
51999         description: IPV6 AIM address
52000       ipaddress-v6-oam:
52001         type: string
52002         description: IPV6 OAM address
52003       inv-status:
52004         type: string
52005         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
52006       pserver-id:
52007         type: string
52008         description: ID of Pserver
52009       internet-topology:
52010         type: string
52011         description: internet topology of Pserver
52012       in-maint:
52013         type: boolean
52014       resource-version:
52015         type: string
52016         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52017       pserver-name2:
52018         type: string
52019         description: alternative pserver name
52020       purpose:
52021         type: string
52022         description: purpose of pserver
52023       prov-status:
52024         type: string
52025         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
52026       relationship-list:
52027         type: array
52028         items:
52029           $ref: "#/definitions/relationship"
52030       p-interfaces:
52031         type: array
52032         items:
52033           $ref: "#/definitions/p-interface"
52034       lag-interfaces:
52035         type: array
52036         items:
52037           $ref: "#/definitions/lag-interface"
52038   pservers:
52039     description: |
52040       Collection of compute hosts.
52041     properties:
52042       pserver:
52043         type: array
52044         items:
52045           $ref: "#/definitions/pserver"
52046   query-parameters:
52047     description: |
52048       QueryParameters for performing a named-query or model query
52049     properties:
52050       named-query:
52051         type: object
52052         $ref: "#/definitions/named-query"
52053       overloaded-model:
52054         type: object
52055         $ref: "#/definitions/overloaded-model"
52056   related-lookup:
52057     description: |
52058       TBD
52059       ###### Related Nodes
52060       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
52061     required:
52062     - related-lookup-uuid
52063     - source-node-type
52064     - source-node-property
52065     - target-node-type
52066     - target-node-property
52067     properties:
52068       related-lookup-uuid:
52069         type: string
52070       source-node-type:
52071         type: string
52072       source-node-property:
52073         type: string
52074       target-node-type:
52075         type: string
52076       target-node-property:
52077         type: string
52078       property-collect-list:
52079         type: string
52080       resource-version:
52081         type: string
52082       relationship-list:
52083         type: array
52084         items:
52085           $ref: "#/definitions/relationship"
52086   related-lookups:
52087     properties:
52088       related-lookup:
52089         type: array
52090         items:
52091           $ref: "#/definitions/related-lookup"
52092   related-to-property:
52093     properties:
52094       property-key:
52095         type: string
52096         description: Key part of a key/value pair
52097       property-value:
52098         type: string
52099         description: Value part of a key/value pair
52100   relationship:
52101     properties:
52102       related-to:
52103         type: string
52104         description: A keyword provided by A&AI to indicate type of node.
52105       related-link:
52106         type: string
52107         description: URL to the object in A&AI.
52108       relationship-data:
52109         type: array
52110         items:
52111           $ref: "#/definitions/relationship-data"
52112   relationship-data:
52113     required:
52114     - relationship-key
52115     - relationship-value
52116     properties:
52117       relationship-key:
52118         type: string
52119         description: A keyword provided by A&AI to indicate an attribute.
52120       relationship-value:
52121         type: string
52122         description: Value of the attribute.
52123   relationship-list:
52124     properties:
52125       relationship:
52126         type: array
52127         items:
52128           $ref: "#/definitions/relationship"
52129   reserved-prop-names:
52130     description: |
52131       Internal map to define some reserved properties of a vertex
52132     properties:
52133       last-mod-source-of-truth:
52134         type: string
52135       aai-node-type:
52136         type: string
52137       aai-created-ts:
52138         type: integer
52139         format: int64
52140       aai-unique-key:
52141         type: string
52142       aai-last-mod-ts:
52143         type: integer
52144         format: int64
52145       source-of-truth:
52146         type: string
52147       aai-uri:
52148         type: string
52149   response-list:
52150     description: |
52151       Response container for the results of a named-query or model query
52152     properties:
52153       inventory-response-items:
52154         type: object
52155         $ref: "#/definitions/inventory-response-items"
52156   result-data:
52157     properties:
52158       resource-type:
52159         type: string
52160         description: The specific type of node in the A&AI graph
52161       resource-link:
52162         type: string
52163         description: The URL to the specific resource
52164   route-table-reference:
52165     description: |
52166       Openstack route table reference.
52167       ###### Related Nodes
52168       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
52169     required:
52170     - route-table-reference-id
52171     - route-table-reference-fqdn
52172     properties:
52173       route-table-reference-id:
52174         type: string
52175         description: Route Table Reference id, UUID assigned to this instance.
52176       route-table-reference-fqdn:
52177         type: string
52178         description: FQDN entry in the route table.
52179       resource-version:
52180         type: string
52181         description: Concurrency value
52182       relationship-list:
52183         type: array
52184         items:
52185           $ref: "#/definitions/relationship"
52186   route-table-references:
52187     description: |
52188       Collection of openstack route table references
52189     properties:
52190       route-table-reference:
52191         type: array
52192         items:
52193           $ref: "#/definitions/route-table-reference"
52194   route-target:
52195     description: |
52196       Route target information
52197       ###### Related Nodes
52198       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
52199     required:
52200     - global-route-target
52201     - route-target-role
52202     properties:
52203       global-route-target:
52204         type: string
52205         description: Number used to identify an RT, globally unique in the network
52206       route-target-role:
52207         type: string
52208         description: Role assigned to this route target
52209       resource-version:
52210         type: string
52211         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52212       relationship-list:
52213         type: array
52214         items:
52215           $ref: "#/definitions/relationship"
52216   route-targets:
52217     description: |
52218       Collection of route target information
52219     properties:
52220       route-target:
52221         type: array
52222         items:
52223           $ref: "#/definitions/route-target"
52224   routing-instance:
52225     description: |
52226       ###### Related Nodes
52227       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
52228       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
52229       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
52230     required:
52231     - routing-instance-id
52232     properties:
52233       routing-instance-id:
52234         type: string
52235         description: Unique id of routing instance
52236       rpm-owner:
52237         type: string
52238         description: rpm owner
52239       resource-version:
52240         type: string
52241         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52242       site-pairs:
52243         type: array
52244         items:
52245           $ref: "#/definitions/site-pair"
52246       relationship-list:
52247         type: array
52248         items:
52249           $ref: "#/definitions/relationship"
52250   routing-instances:
52251     description: |
52252       set of probes related to generic-vnf routing instance
52253     properties:
52254       routing-instance:
52255         type: array
52256         items:
52257           $ref: "#/definitions/routing-instance"
52258   sdn-zone-response:
52259     properties:
52260       oam-networks:
52261         type: object
52262         $ref: "#/definitions/oam-networks"
52263       az-and-dvs-switches:
52264         type: array
52265         items:
52266           $ref: "#/definitions/az-and-dvs-switches"
52267   search:
52268     properties:
52269       edge-tag-query-result:
52270         type: object
52271         $ref: "#/definitions/edge-tag-query-result"
52272       edge-tag-query-request:
52273         type: object
52274         $ref: "#/definitions/edge-tag-query-request"
52275       search-results:
52276         type: object
52277         $ref: "#/definitions/search-results"
52278       sdn-zone-response:
52279         type: object
52280         $ref: "#/definitions/sdn-zone-response"
52281   search-results:
52282     properties:
52283       result-data:
52284         type: array
52285         items:
52286           $ref: "#/definitions/result-data"
52287   secondary-filt:
52288     description: |
52289       SecondaryFilt for performing a named-query or model query
52290   secondary-filter:
52291     properties:
52292       property-name:
52293         type: string
52294       filter-type:
52295         type: string
52296       property-value:
52297         type: string
52298   secondary-filts:
52299     description: |
52300       SecondaryFilts for performing a named-query or model query
52301     properties:
52302       secondary-filt:
52303         type: array
52304         items:
52305           $ref: "#/definitions/secondary-filt"
52306   segmentation-assignment:
52307     description: |
52308       Openstack segmentation assignment.
52309       ###### Related Nodes
52310       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
52311     required:
52312     - segmentation-id
52313     properties:
52314       segmentation-id:
52315         type: string
52316         description: Route Table Reference id, UUID assigned to this instance.
52317       resource-version:
52318         type: string
52319         description: Concurrency value
52320       relationship-list:
52321         type: array
52322         items:
52323           $ref: "#/definitions/relationship"
52324   segmentation-assignments:
52325     description: |
52326       Collection of openstack segmentation assignments
52327     properties:
52328       segmentation-assignment:
52329         type: array
52330         items:
52331           $ref: "#/definitions/segmentation-assignment"
52332   service:
52333     description: |
52334       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
52335     required:
52336     - service-id
52337     - service-description
52338     properties:
52339       service-id:
52340         type: string
52341         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
52342       service-description:
52343         type: string
52344         description: Description of the service
52345       service-selflink:
52346         type: string
52347         description: URL to endpoint where AAI can get more details
52348       resource-version:
52349         type: string
52350         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52351       service-version:
52352         type: string
52353         description: service version
52354       relationship-list:
52355         type: array
52356         items:
52357           $ref: "#/definitions/relationship"
52358   service-capabilities:
52359     description: |
52360       Collection of service capabilities.
52361     properties:
52362       service-capability:
52363         type: array
52364         items:
52365           $ref: "#/definitions/service-capability"
52366   service-capability:
52367     description: |
52368       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
52369       ###### Related Nodes
52370       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52371       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52372       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
52373     required:
52374     - service-type
52375     - vnf-type
52376     properties:
52377       service-type:
52378         type: string
52379         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
52380       vnf-type:
52381         type: string
52382         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52383       resource-version:
52384         type: string
52385         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52386       relationship-list:
52387         type: array
52388         items:
52389           $ref: "#/definitions/relationship"
52390   service-design-and-creation:
52391     description: |
52392       Namespace for objects managed by ASDC
52393     properties:
52394       vnf-images:
52395         type: array
52396         items:
52397           $ref: "#/definitions/vnf-image"
52398       services:
52399         type: array
52400         items:
52401           $ref: "#/definitions/service"
52402       service-capabilities:
52403         type: array
52404         items:
52405           $ref: "#/definitions/service-capability"
52406       models:
52407         type: array
52408         items:
52409           $ref: "#/definitions/model"
52410       named-queries:
52411         type: array
52412         items:
52413           $ref: "#/definitions/named-query"
52414   service-instance:
52415     description: |
52416       Instance of a service
52417       ###### Related Nodes
52418       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
52419       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
52420       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52421       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
52422       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
52423       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
52424       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52425       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
52426       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
52427       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
52428       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
52429       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
52430       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
52431       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52432       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52433       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
52434       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
52435       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
52436     required:
52437     - service-instance-id
52438     properties:
52439       service-instance-id:
52440         type: string
52441         description: Uniquely identifies this instance of a service
52442       service-instance-name:
52443         type: string
52444         description: This field will store a name assigned to the service-instance.
52445       model-invariant-id:
52446         type: string
52447         description: the ASDC model id for this resource or service model.
52448       model-version-id:
52449         type: string
52450         description: the ASDC model version for this resource or service model.
52451       persona-model-version:
52452         type: string
52453         description: the ASDC model version for this resource or service model.
52454       widget-model-id:
52455         type: string
52456         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52457       widget-model-version:
52458         type: string
52459         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52460       bandwidth-total:
52461         type: string
52462         description: Indicates the total bandwidth to be used for this service.
52463       bandwidth-up-wan1:
52464         type: string
52465         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
52466       bandwidth-down-wan1:
52467         type: string
52468         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
52469       bandwidth-up-wan2:
52470         type: string
52471         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
52472       bandwidth-down-wan2:
52473         type: string
52474         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
52475       vhn-portal-url:
52476         type: string
52477         description: URL customers will use to access the vHN Portal.
52478       service-instance-location-id:
52479         type: string
52480         description: An identifier that customers assign to the location where this service is being used.
52481       resource-version:
52482         type: string
52483         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52484       selflink:
52485         type: string
52486         description: Path to the controller object.
52487       orchestration-status:
52488         type: string
52489         description: Orchestration status of this service.
52490       relationship-list:
52491         type: array
52492         items:
52493           $ref: "#/definitions/relationship"
52494       metadata:
52495         type: array
52496         items:
52497           $ref: "#/definitions/metadatum"
52498       allotted-resources:
52499         type: array
52500         items:
52501           $ref: "#/definitions/allotted-resource"
52502   service-instances:
52503     description: |
52504       Collection of service instances
52505     properties:
52506       service-instance:
52507         type: array
52508         items:
52509           $ref: "#/definitions/service-instance"
52510   service-subscription:
52511     description: |
52512       Object that group service instances.
52513       ###### Related Nodes
52514       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
52515       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
52516       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
52517       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
52518     required:
52519     - service-type
52520     properties:
52521       service-type:
52522         type: string
52523         description: Value defined by orchestration to identify this service across ECOMP.
52524       temp-ub-sub-account-id:
52525         type: string
52526         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
52527       resource-version:
52528         type: string
52529         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52530       service-instances:
52531         type: array
52532         items:
52533           $ref: "#/definitions/service-instance"
52534       relationship-list:
52535         type: array
52536         items:
52537           $ref: "#/definitions/relationship"
52538   service-subscriptions:
52539     description: |
52540       Collection of objects that group service instances.
52541     properties:
52542       service-subscription:
52543         type: array
52544         items:
52545           $ref: "#/definitions/service-subscription"
52546   services:
52547     description: |
52548       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
52549     properties:
52550       service:
52551         type: array
52552         items:
52553           $ref: "#/definitions/service"
52554   site-pair:
52555     description: |
52556       ###### Related Nodes
52557       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
52558       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52559       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
52560     required:
52561     - site-pair-id
52562     properties:
52563       site-pair-id:
52564         type: string
52565         description: unique identifier of probe
52566       source-ip:
52567         type: string
52568         description: Prefix address
52569       destination-ip:
52570         type: string
52571         description: Prefix address
52572       ip-version:
52573         type: string
52574         description: ip version, v4, v6
52575       destination-hostname:
52576         type: string
52577         description: Hostname of the destination equipment to which SLAs are measured against.
52578       destination-equip-type:
52579         type: string
52580         description: The type of destinatination equipment. Could be Router, etc.
52581       resource-version:
52582         type: string
52583         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52584       classes-of-service:
52585         type: array
52586         items:
52587           $ref: "#/definitions/class-of-service"
52588       relationship-list:
52589         type: array
52590         items:
52591           $ref: "#/definitions/relationship"
52592   site-pair-set:
52593     description: |
52594       Set of instances for probes used to measure service level agreements
52595       ###### Related Nodes
52596       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
52597       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
52598       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
52599     required:
52600     - site-pair-set-id
52601     properties:
52602       site-pair-set-id:
52603         type: string
52604         description: Unique id of site pair set.
52605       resource-version:
52606         type: string
52607         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52608       routing-instances:
52609         type: array
52610         items:
52611           $ref: "#/definitions/routing-instance"
52612       relationship-list:
52613         type: array
52614         items:
52615           $ref: "#/definitions/relationship"
52616   site-pair-sets:
52617     description: |
52618       Collection of sets of instances for probes related to generic-vnf
52619     properties:
52620       site-pair-set:
52621         type: array
52622         items:
52623           $ref: "#/definitions/site-pair-set"
52624   site-pairs:
52625     description: |
52626       probe within a set
52627     properties:
52628       site-pair:
52629         type: array
52630         items:
52631           $ref: "#/definitions/site-pair"
52632   snapshot:
52633     description: |
52634       Openstack snapshot
52635       ###### Related Nodes
52636       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52637       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
52638     required:
52639     - snapshot-id
52640     properties:
52641       snapshot-id:
52642         type: string
52643         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
52644       snapshot-name:
52645         type: string
52646         description: Snapshot name
52647       snapshot-architecture:
52648         type: string
52649         description: Operating system architecture
52650       snapshot-os-distro:
52651         type: string
52652         description: The common name of the operating system distribution in lowercase
52653       snapshot-os-version:
52654         type: string
52655         description: The operating system version as specified by the distributor.
52656       application:
52657         type: string
52658         description: The application that the image instantiates.
52659       application-vendor:
52660         type: string
52661         description: The vendor of the application.
52662       application-version:
52663         type: string
52664         description: The version of the application.
52665       snapshot-selflink:
52666         type: string
52667         description: URL to endpoint where AAI can get more details
52668       prev-snapshot-id:
52669         type: string
52670         description: This field contains the UUID of the previous snapshot (if any).
52671       resource-version:
52672         type: string
52673         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52674       relationship-list:
52675         type: array
52676         items:
52677           $ref: "#/definitions/relationship"
52678   snapshots:
52679     description: |
52680       Collection of openstack snapshots
52681     properties:
52682       snapshot:
52683         type: array
52684         items:
52685           $ref: "#/definitions/snapshot"
52686   sriov-pf:
52687     description: |
52688       SR-IOV Physical Function
52689       ###### Related Nodes
52690       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
52691       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
52692     required:
52693     - pf-pci-id
52694     properties:
52695       pf-pci-id:
52696         type: string
52697         description: Identifier for the sriov-pf
52698       resource-version:
52699         type: string
52700         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52701       relationship-list:
52702         type: array
52703         items:
52704           $ref: "#/definitions/relationship"
52705   sriov-pfs:
52706     description: |
52707       Collection of SR-IOV Physical Functions.
52708     properties:
52709       sriov-pf:
52710         type: array
52711         items:
52712           $ref: "#/definitions/sriov-pf"
52713   sriov-vf:
52714     description: |
52715       SR-IOV Virtual Function (not to be confused with virtual network function)
52716       ###### Related Nodes
52717       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
52718     required:
52719     - pci-id
52720     properties:
52721       pci-id:
52722         type: string
52723         description: PCI ID used to identify the sriov-vf
52724       vf-vlan-filter:
52725         type: string
52726         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
52727       vf-mac-filter:
52728         type: string
52729         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
52730       vf-vlan-strip:
52731         type: boolean
52732         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
52733       vf-vlan-anti-spoof-check:
52734         type: boolean
52735         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.
52736       vf-mac-anti-spoof-check:
52737         type: boolean
52738         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.
52739       vf-mirrors:
52740         type: string
52741         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
52742       vf-broadcast-allow:
52743         type: boolean
52744         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
52745       vf-unknown-multicast-allow:
52746         type: boolean
52747         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
52748       vf-unknown-unicast-allow:
52749         type: boolean
52750         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
52751       vf-insert-stag:
52752         type: boolean
52753         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
52754       vf-link-status:
52755         type: string
52756         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
52757       resource-version:
52758         type: string
52759         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52760       neutron-network-id:
52761         type: string
52762         description: Neutron network id of the interface
52763       relationship-list:
52764         type: array
52765         items:
52766           $ref: "#/definitions/relationship"
52767   sriov-vfs:
52768     description: |
52769       Collection of SR-IOV Virtual Functions.
52770     properties:
52771       sriov-vf:
52772         type: array
52773         items:
52774           $ref: "#/definitions/sriov-vf"
52775   start-node-filter:
52776     properties:
52777       property-name:
52778         type: string
52779       property-value:
52780         type: string
52781   subnet:
52782     description: |
52783       ###### Related Nodes
52784       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
52785       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
52786       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
52787       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
52788     required:
52789     - subnet-id
52790     - dhcp-enabled
52791     properties:
52792       subnet-id:
52793         type: string
52794         description: Subnet ID, should be UUID.
52795       subnet-name:
52796         type: string
52797         description: Name associated with the subnet.
52798       neutron-subnet-id:
52799         type: string
52800         description: Neutron id of this subnet
52801       gateway-address:
52802         type: string
52803         description: gateway ip address
52804       network-start-address:
52805         type: string
52806         description: network start address
52807       cidr-mask:
52808         type: string
52809         description: cidr mask
52810       ip-version:
52811         type: string
52812         description: ip version
52813       orchestration-status:
52814         type: string
52815         description: Orchestration status of this VNF, mastered by MSO
52816       dhcp-enabled:
52817         type: boolean
52818       dhcp-start:
52819         type: string
52820         description: the start address reserved for use by dhcp
52821       dhcp-end:
52822         type: string
52823         description: the last address reserved for use by dhcp
52824       resource-version:
52825         type: string
52826         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52827       relationship-list:
52828         type: array
52829         items:
52830           $ref: "#/definitions/relationship"
52831   subnets:
52832     properties:
52833       subnet:
52834         type: array
52835         items:
52836           $ref: "#/definitions/subnet"
52837   tagged-inventory-item-list:
52838     properties:
52839       inventory-item:
52840         type: array
52841         items:
52842           $ref: "#/definitions/inventory-item"
52843   tenant:
52844     description: |
52845       Openstack tenant
52846       ###### Related Nodes
52847       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52848       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
52849       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52850       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
52851       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
52852       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
52853       - TENANT cannot be deleted if linked to VSERVER
52854     required:
52855     - tenant-id
52856     - tenant-name
52857     properties:
52858       tenant-id:
52859         type: string
52860         description: Unique id relative to the cloud-region.
52861       tenant-name:
52862         type: string
52863         description: Readable name of tenant
52864       resource-version:
52865         type: string
52866         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52867       vservers:
52868         type: array
52869         items:
52870           $ref: "#/definitions/vserver"
52871       relationship-list:
52872         type: array
52873         items:
52874           $ref: "#/definitions/relationship"
52875   tenants:
52876     description: |
52877       Collection of openstack tenants.
52878     properties:
52879       tenant:
52880         type: array
52881         items:
52882           $ref: "#/definitions/tenant"
52883   tunnel-xconnect:
52884     description: |
52885       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
52886       ###### Related Nodes
52887       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52888     required:
52889     - id
52890     - bandwidth-up-wan1
52891     - bandwidth-down-wan1
52892     - bandwidth-up-wan2
52893     - bandwidth-down-wan2
52894     properties:
52895       id:
52896         type: string
52897         description: Allotted Resource id UUID assigned to this instance.
52898       bandwidth-up-wan1:
52899         type: string
52900         description: The WAN uplink bandwidth for WAN1
52901       bandwidth-down-wan1:
52902         type: string
52903         description: The WAN downlink bandwidth for WAN1
52904       bandwidth-up-wan2:
52905         type: string
52906         description: The WAN uplink bandwidth for WAN2
52907       bandwidth-down-wan2:
52908         type: string
52909         description: The WAN downlink bandwidth for WAN2
52910       resource-version:
52911         type: string
52912         description: Concurrency value
52913       relationship-list:
52914         type: array
52915         items:
52916           $ref: "#/definitions/relationship"
52917   tunnel-xconnects:
52918     description: |
52919       This object is used to store the specific tunnel cross connect aspects of an allotted resource
52920     properties:
52921       tunnel-xconnect:
52922         type: array
52923         items:
52924           $ref: "#/definitions/tunnel-xconnect"
52925   update:
52926     description: |
52927       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
52928     required:
52929     - update-node-type
52930     properties:
52931       update-node-type:
52932         type: string
52933       update-node-key:
52934         type: array
52935         items:
52936           $ref: "#/definitions/update-node-key"
52937       update-node-uri:
52938         type: string
52939       action:
52940         type: array
52941         items:
52942           $ref: "#/definitions/action"
52943   update-node-key:
52944     properties:
52945       key-name:
52946         type: string
52947       key-value:
52948         type: string
52949   vce:
52950     description: |
52951       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
52952       ###### Related Nodes
52953       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52954       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52955       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
52956       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
52957       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
52958       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
52959       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
52960       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
52961     required:
52962     - vnf-id
52963     - vnf-name
52964     - vnf-type
52965     properties:
52966       vnf-id:
52967         type: string
52968         description: Unique id of VNF.  This is unique across the graph.
52969       vnf-name:
52970         type: string
52971         description: Name of VNF.
52972       vnf-name2:
52973         type: string
52974         description: Alternate name of VNF.
52975       vnf-type:
52976         type: string
52977         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
52978       service-id:
52979         type: string
52980         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
52981       regional-resource-zone:
52982         type: string
52983         description: Regional way of organizing pservers, source of truth should define values
52984       prov-status:
52985         type: string
52986         description: Trigger for operational monitoring of this resource by Service Assurance systems.
52987       operational-status:
52988         type: string
52989         description: Indicator for whether the resource is considered operational
52990       license-key:
52991         type: string
52992         description: OBSOLETE -  do not use
52993       equipment-role:
52994         type: string
52995         description: Network role being played by this VNF
52996       orchestration-status:
52997         type: string
52998         description: Orchestration status of this VNF, mastered by MSO
52999       heat-stack-id:
53000         type: string
53001         description: Heat stack id corresponding to this instance, managed by MSO
53002       mso-catalog-key:
53003         type: string
53004         description: Corresponds to the SDN-C catalog id used to configure this VCE
53005       vpe-id:
53006         type: string
53007         description: Unique ID of VPE connected to this VCE.
53008       v6-vce-wan-address:
53009         type: string
53010         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
53011       ipv4-oam-address:
53012         type: string
53013         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
53014       resource-version:
53015         type: string
53016         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53017       ipv4-loopback0-address:
53018         type: string
53019         description: Loopback0 address
53020       entitlement-resource-uuid:
53021         type: string
53022         description: OBSOLETE -  see child relationships
53023       port-groups:
53024         type: array
53025         items:
53026           $ref: "#/definitions/port-group"
53027       licenses:
53028         type: array
53029         items:
53030           $ref: "#/definitions/license"
53031       entitlements:
53032         type: array
53033         items:
53034           $ref: "#/definitions/entitlement"
53035       relationship-list:
53036         type: array
53037         items:
53038           $ref: "#/definitions/relationship"
53039   vces:
53040     description: |
53041       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
53042     properties:
53043       vce:
53044         type: array
53045         items:
53046           $ref: "#/definitions/vce"
53047   vf-module:
53048     description: |
53049       a deployment unit of VNFCs
53050       ###### Related Nodes
53051       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53052       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
53053       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
53054       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
53055       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
53056       - VF-MODULE cannot be deleted if linked to VNFC
53057     required:
53058     - vf-module-id
53059     - is-base-vf-module
53060     properties:
53061       vf-module-id:
53062         type: string
53063         description: Unique ID of vf-module.
53064       vf-module-name:
53065         type: string
53066         description: Name of vf-module
53067       heat-stack-id:
53068         type: string
53069         description: Heat stack id corresponding to this instance.
53070       orchestration-status:
53071         type: string
53072         description: orchestration status of this vf-module, mastered by MSO
53073       is-base-vf-module:
53074         type: boolean
53075       resource-version:
53076         type: string
53077         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53078       model-invariant-id:
53079         type: string
53080         description: the ASDC model id for this resource or service model.
53081       model-version-id:
53082         type: string
53083         description: the ASDC model version for this resource or service model.
53084       persona-model-version:
53085         type: string
53086         description: the ASDC model version for this resource or service model.
53087       model-customization-id:
53088         type: string
53089         description: captures the id of all the configuration used to customize the resource for the service.
53090       widget-model-id:
53091         type: string
53092         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53093       widget-model-version:
53094         type: string
53095         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53096       contrail-service-instance-fqdn:
53097         type: string
53098         description: the Contrail unique ID for a service-instance
53099       module-index:
53100         type: integer
53101         format: int32
53102         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
53103       selflink:
53104         type: string
53105         description: Path to the controller object.
53106       relationship-list:
53107         type: array
53108         items:
53109           $ref: "#/definitions/relationship"
53110   vf-modules:
53111     description: |
53112       Collection of vf-modules, a deployment unit of VNFCs
53113     properties:
53114       vf-module:
53115         type: array
53116         items:
53117           $ref: "#/definitions/vf-module"
53118   vig-server:
53119     description: |
53120       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
53121       ###### Related Nodes
53122       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
53123     required:
53124     - vig-address-type
53125     properties:
53126       vig-address-type:
53127         type: string
53128         description: indicates whether the VIG is for AVPN or INTERNET
53129       ipaddress-v4-vig:
53130         type: string
53131         description: v4 IP of the vig server
53132       ipaddress-v6-vig:
53133         type: string
53134         description: v6 IP of the vig server
53135       resource-version:
53136         type: string
53137         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53138       relationship-list:
53139         type: array
53140         items:
53141           $ref: "#/definitions/relationship"
53142   vig-servers:
53143     properties:
53144       vig-server:
53145         type: array
53146         items:
53147           $ref: "#/definitions/vig-server"
53148   vip-ipv4-address-list:
53149     description: |
53150       IPv4 Address Range
53151       ###### Related Nodes
53152       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53153       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53154       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
53155       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
53156     required:
53157     - vip-ipv4-address
53158     properties:
53159       vip-ipv4-address:
53160         type: string
53161         description: IP address
53162       vip-ipv4-prefix-length:
53163         type: integer
53164         format: int64
53165         description: Prefix length, 32 for single address
53166       vlan-id-inner:
53167         type: integer
53168         format: int64
53169         description: Inner VLAN tag
53170       vlan-id-outer:
53171         type: integer
53172         format: int64
53173         description: Outer VLAN tag
53174       is-floating:
53175         type: boolean
53176         description: Indicator of fixed or floating address
53177       resource-version:
53178         type: string
53179         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53180       neutron-network-id:
53181         type: string
53182         description: Neutron network id of the interface that address belongs to
53183       neutron-subnet-id:
53184         type: string
53185         description: Neutron id of subnet that address belongs to
53186       relationship-list:
53187         type: array
53188         items:
53189           $ref: "#/definitions/relationship"
53190   vip-ipv6-address-list:
53191     description: |
53192       IPv6 Address Range
53193       ###### Related Nodes
53194       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53195       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53196       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
53197       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
53198     required:
53199     - vip-ipv6-address
53200     properties:
53201       vip-ipv6-address:
53202         type: string
53203         description: IP address
53204       vip-ipv6-prefix-length:
53205         type: integer
53206         format: int64
53207         description: Prefix length, 128 for single address
53208       vlan-id-inner:
53209         type: integer
53210         format: int64
53211         description: Inner VLAN tag
53212       vlan-id-outer:
53213         type: integer
53214         format: int64
53215         description: Outer VLAN tag
53216       is-floating:
53217         type: boolean
53218         description: Indicator of fixed or floating address
53219       resource-version:
53220         type: string
53221         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53222       neutron-network-id:
53223         type: string
53224         description: Neutron network id of the interface that address belongs to
53225       neutron-subnet-id:
53226         type: string
53227         description: Neutron id of subnet that address belongs to
53228       relationship-list:
53229         type: array
53230         items:
53231           $ref: "#/definitions/relationship"
53232   virtual-data-center:
53233     description: |
53234       Virtual organization of cloud infrastructure elements in a data center context
53235       ###### Related Nodes
53236       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53237       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53238       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53239     required:
53240     - vdc-id
53241     - vdc-name
53242     properties:
53243       vdc-id:
53244         type: string
53245         description: Unique ID of the vdc
53246       vdc-name:
53247         type: string
53248         description: Name of the virtual data center
53249       resource-version:
53250         type: string
53251         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53252       relationship-list:
53253         type: array
53254         items:
53255           $ref: "#/definitions/relationship"
53256   virtual-data-centers:
53257     description: |
53258       Virtual organization of cloud infrastructure elements in a data center context
53259     properties:
53260       virtual-data-center:
53261         type: array
53262         items:
53263           $ref: "#/definitions/virtual-data-center"
53264   vlan:
53265     description: |
53266       Definition of vlan
53267       ###### Related Nodes
53268       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
53269       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
53270       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
53271       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
53272       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
53273       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
53274       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
53275       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
53276       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
53277     required:
53278     - vlan-interface
53279     - in-maint
53280     properties:
53281       vlan-interface:
53282         type: string
53283         description: String that identifies the interface
53284       vlan-id-inner:
53285         type: integer
53286         format: int64
53287         description: Inner VLAN tag
53288       vlan-id-outer:
53289         type: integer
53290         format: int64
53291         description: Outer VLAN tag
53292       resource-version:
53293         type: string
53294         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53295       speed-value:
53296         type: string
53297         description: Captures the numeric part of the speed
53298       speed-units:
53299         type: string
53300         description: Captures the units corresponding to the speed
53301       vlan-description:
53302         type: string
53303         description: Used to describe (the service associated with) the vlan
53304       backdoor-connection:
53305         type: string
53306         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
53307       vpn-id:
53308         type: string
53309         description: This indicates the customers VPN ID associated with this vlan
53310       orchestration-status:
53311         type: string
53312         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
53313       in-maint:
53314         type: boolean
53315       relationship-list:
53316         type: array
53317         items:
53318           $ref: "#/definitions/relationship"
53319       l3-interface-ipv4-address-list:
53320         type: array
53321         items:
53322           $ref: "#/definitions/l3-interface-ipv4-address-list"
53323       l3-interface-ipv6-address-list:
53324         type: array
53325         items:
53326           $ref: "#/definitions/l3-interface-ipv6-address-list"
53327   vlans:
53328     properties:
53329       vlan:
53330         type: array
53331         items:
53332           $ref: "#/definitions/vlan"
53333   vnf:
53334     description: |
53335       Abstract vnf class
53336     required:
53337     - vnf-id
53338     properties:
53339       vnf-id:
53340         type: string
53341         description: Unique id of VNF.  This is unique across the graph.
53342   vnf-image:
53343     description: |
53344       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
53345       ###### Related Nodes
53346       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53347       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
53348     required:
53349     - vnf-image-uuid
53350     - application
53351     - application-vendor
53352     properties:
53353       vnf-image-uuid:
53354         type: string
53355         description: Unique ID of this asset
53356       application:
53357         type: string
53358         description: The application that the image instantiates.
53359       application-vendor:
53360         type: string
53361         description: The vendor of the application.
53362       application-version:
53363         type: string
53364         description: The version of the application.
53365       selflink:
53366         type: string
53367         description: URL to endpoint where AAI can get more details
53368       resource-version:
53369         type: string
53370         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53371       relationship-list:
53372         type: array
53373         items:
53374           $ref: "#/definitions/relationship"
53375   vnf-images:
53376     description: |
53377       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
53378     properties:
53379       vnf-image:
53380         type: array
53381         items:
53382           $ref: "#/definitions/vnf-image"
53383   vnfc:
53384     description: |
53385       ###### Related Nodes
53386       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53387       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
53388       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
53389     required:
53390     - vnfc-name
53391     - vnfc-function-code
53392     - vnfc-type
53393     - in-maint
53394     - is-closed-loop-disabled
53395     properties:
53396       vnfc-name:
53397         type: string
53398         description: Unique ID of vnfc.
53399       vnfc-function-code:
53400         type: string
53401         description: function code
53402       vnfc-type:
53403         type: string
53404         description: type
53405       prov-status:
53406         type: string
53407         description: prov status of this vnfc
53408       orchestration-status:
53409         type: string
53410         description: Orchestration status of this VNF, mastered by APP-C
53411       ipaddress-v4-oam-vip:
53412         type: string
53413         description: Oam V4 vip address of this vnfc
53414       in-maint:
53415         type: boolean
53416       is-closed-loop-disabled:
53417         type: boolean
53418       group-notation:
53419         type: string
53420         description: Group notation of VNFC
53421       resource-version:
53422         type: string
53423         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53424       relationship-list:
53425         type: array
53426         items:
53427           $ref: "#/definitions/relationship"
53428   vnfcs:
53429     description: |
53430       virtual network components associated with a vserver from application controller.
53431     properties:
53432       vnfc:
53433         type: array
53434         items:
53435           $ref: "#/definitions/vnfc"
53436   volume:
53437     description: |
53438       Ephemeral Block storage volume.
53439       ###### Related Nodes
53440       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
53441     required:
53442     - volume-id
53443     - volume-selflink
53444     properties:
53445       volume-id:
53446         type: string
53447         description: Unique ID of block storage volume relative to the vserver.
53448       volume-selflink:
53449         type: string
53450         description: URL to endpoint where AAI can get more details
53451       resource-version:
53452         type: string
53453         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53454       relationship-list:
53455         type: array
53456         items:
53457           $ref: "#/definitions/relationship"
53458   volume-group:
53459     description: |
53460       Persistent block-level storage.
53461       ###### Related Nodes
53462       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53463       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53464       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53465       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
53466       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53467     required:
53468     - volume-group-id
53469     - volume-group-name
53470     - vnf-type
53471     properties:
53472       volume-group-id:
53473         type: string
53474         description: Unique ID of volume-group.
53475       volume-group-name:
53476         type: string
53477         description: Name of the volume group.
53478       heat-stack-id:
53479         type: string
53480         description: Heat stack id corresponding to this volume-group
53481       vnf-type:
53482         type: string
53483         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
53484       orchestration-status:
53485         type: string
53486         description: Orchestration status of this volume-group
53487       model-customization-id:
53488         type: string
53489         description: captures the id of all the configuration used to customize the resource for the service.
53490       vf-module-model-customization-id:
53491         type: string
53492         description: helps relate the volume group to the vf-module whose components will require the volume group
53493       resource-version:
53494         type: string
53495         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53496       relationship-list:
53497         type: array
53498         items:
53499           $ref: "#/definitions/relationship"
53500   volume-groups:
53501     description: |
53502       Collection of persistent block-level storage.
53503     properties:
53504       volume-group:
53505         type: array
53506         items:
53507           $ref: "#/definitions/volume-group"
53508   volumes:
53509     description: |
53510       Collection of ephemeral Block storage volumes.
53511     properties:
53512       volume:
53513         type: array
53514         items:
53515           $ref: "#/definitions/volume"
53516   vpls-pe:
53517     description: |
53518       VPLS Provider Edge routers.
53519       ###### Related Nodes
53520       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53521       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53522       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
53523       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
53524       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
53525     required:
53526     - equipment-name
53527     properties:
53528       equipment-name:
53529         type: string
53530       prov-status:
53531         type: string
53532         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
53533       ipv4-oam-address:
53534         type: string
53535         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).
53536       equipment-role:
53537         type: string
53538         description: Client should send valid enumerated value, e.g., VPLS-PE.
53539       vlan-id-outer:
53540         type: integer
53541         format: int64
53542         description: Temporary location for stag to get to VCE
53543       resource-version:
53544         type: string
53545         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53546       relationship-list:
53547         type: array
53548         items:
53549           $ref: "#/definitions/relationship"
53550       p-interfaces:
53551         type: array
53552         items:
53553           $ref: "#/definitions/p-interface"
53554       lag-interfaces:
53555         type: array
53556         items:
53557           $ref: "#/definitions/lag-interface"
53558   vpls-pes:
53559     description: |
53560       Collection of VPLS Provider Edge routers
53561     properties:
53562       vpls-pe:
53563         type: array
53564         items:
53565           $ref: "#/definitions/vpls-pe"
53566   vpn-binding:
53567     description: |
53568       VPN binding
53569       ###### Related Nodes
53570       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
53571       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
53572       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
53573       - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
53574       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
53575     required:
53576     - vpn-id
53577     - vpn-name
53578     properties:
53579       vpn-id:
53580         type: string
53581         description: VPN ID, globally unique within A&AI
53582       vpn-name:
53583         type: string
53584         description: VPN Name
53585       vpn-platform:
53586         type: string
53587         description: the platform associated with the VPN example AVPN, Mobility
53588       vpn-type:
53589         type: string
53590         description: Type of the vpn, should be taken from enumerated/valid values
53591       route-distinguisher:
53592         type: string
53593         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
53594       resource-version:
53595         type: string
53596         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53597       route-targets:
53598         type: array
53599         items:
53600           $ref: "#/definitions/route-target"
53601       relationship-list:
53602         type: array
53603         items:
53604           $ref: "#/definitions/relationship"
53605         description: l3-networks relate to vpn-bindings
53606   vpn-bindings:
53607     properties:
53608       vpn-binding:
53609         type: array
53610         items:
53611           $ref: "#/definitions/vpn-binding"
53612   vserver:
53613     description: |
53614       Virtual Servers, aka virtual machine or VM.
53615       ###### Related Nodes
53616       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
53617       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53618       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
53619       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
53620       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
53621       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
53622       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53623       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
53624       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
53625       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
53626       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
53627       - VSERVER is DELETED when these are DELETED L-INTERFACE
53628       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
53629     required:
53630     - vserver-id
53631     - vserver-name
53632     - vserver-selflink
53633     - in-maint
53634     - is-closed-loop-disabled
53635     properties:
53636       vserver-id:
53637         type: string
53638         description: Unique identifier for this vserver relative to its tenant
53639       vserver-name:
53640         type: string
53641         description: Name of vserver
53642       vserver-name2:
53643         type: string
53644         description: Alternative name of vserver
53645       prov-status:
53646         type: string
53647         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53648       vserver-selflink:
53649         type: string
53650         description: URL to endpoint where AAI can get more details
53651       in-maint:
53652         type: boolean
53653       is-closed-loop-disabled:
53654         type: boolean
53655       resource-version:
53656         type: string
53657         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53658       volumes:
53659         type: array
53660         items:
53661           $ref: "#/definitions/volume"
53662       relationship-list:
53663         type: array
53664         items:
53665           $ref: "#/definitions/relationship"
53666       l-interfaces:
53667         type: array
53668         items:
53669           $ref: "#/definitions/l-interface"
53670   vservers:
53671     description: |
53672       Collection of virtual Servers, aka virtual machines or VMs.
53673     properties:
53674       vserver:
53675         type: array
53676         items:
53677           $ref: "#/definitions/vserver"
53678   zone:
53679     description: |
53680       A zone is a grouping of assets in a location homing to the same connections into the CBB
53681       ###### Related Nodes
53682       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53683       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53684       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53685       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53686     required:
53687     - zone-id
53688     - zone-name
53689     - design-type
53690     - zone-context
53691     properties:
53692       zone-id:
53693         type: string
53694         description: Code assigned by AIC to the zone
53695       zone-name:
53696         type: string
53697         description: English name associated with the zone
53698       design-type:
53699         type: string
53700         description: Design of zone [Medium/Large?]
53701       zone-context:
53702         type: string
53703         description: Context of zone [production/test]
53704       status:
53705         type: string
53706         description: Status of a zone.
53707       resource-version:
53708         type: string
53709         description: Concurrency value
53710       relationship-list:
53711         type: array
53712         items:
53713           $ref: "#/definitions/relationship"
53714   zones:
53715     description: |
53716       Collection of zones
53717     properties:
53718       zone:
53719         type: array
53720         items:
53721           $ref: "#/definitions/zone"
53722 patchDefinitions:
53723   aai-internal:
53724     properties:
53725       property-name:
53726         type: string
53727       property-value:
53728         type: string
53729   action:
53730     properties:
53731       action-type:
53732         type: string
53733       action-data:
53734         type: array
53735         items:
53736           $ref: "#/patchDefinitions/action-data"
53737   action-data:
53738     properties:
53739       property-name:
53740         type: string
53741       property-value:
53742         type: string
53743   actions:
53744     description: |
53745       APIs that are more action related than REST (e.g., notify, update).
53746     properties:
53747       update:
53748         type: object
53749         $ref: "#/patchDefinitions/update"
53750       notify:
53751         type: object
53752         $ref: "#/patchDefinitions/notify"
53753   allotted-resource:
53754     description: |
53755       Represents a slice or partial piece of a resource that gets separately allotted
53756       ###### Related Nodes
53757       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53758       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53759       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
53760       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
53761       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
53762       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
53763       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
53764       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
53765       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
53766     required:
53767     - id
53768     properties:
53769       id:
53770         type: string
53771         description: Allotted Resource id UUID assigned to this instance.
53772       description:
53773         type: string
53774         description: The descriptive information assigned to this allotted resource instance
53775       selflink:
53776         type: string
53777         description: Link back to more information in the controller
53778       model-invariant-id:
53779         type: string
53780         description: the ASDC model id for this resource or service model.
53781       model-version-id:
53782         type: string
53783         description: the ASDC model version for this resource or service model.
53784       persona-model-version:
53785         type: string
53786         description: the ASDC model version for this resource or service model.
53787   allotted-resources:
53788     description: |
53789       This object is used to store slices of services being offered
53790     properties:
53791       allotted-resource:
53792         type: array
53793         items:
53794           $ref: "#/patchDefinitions/allotted-resource"
53795   availability-zone:
53796     description: |
53797       Availability zone, a collection of compute hosts/pservers
53798       ###### Related Nodes
53799       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53800       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
53801       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53802       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53803       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53804       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53805       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
53806       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53807       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
53808     required:
53809     - availability-zone-name
53810     - hypervisor-type
53811     properties:
53812       availability-zone-name:
53813         type: string
53814         description: Name of the availability zone.  Unique across a cloud region
53815       hypervisor-type:
53816         type: string
53817         description: Type of hypervisor.  Source of truth should define valid values.
53818       operational-status:
53819         type: string
53820         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
53821   availability-zones:
53822     description: |
53823       Collection of availability zones
53824     properties:
53825       availability-zone:
53826         type: array
53827         items:
53828           $ref: "#/patchDefinitions/availability-zone"
53829   az-and-dvs-switches:
53830     properties:
53831       dvs-switches:
53832         type: object
53833         $ref: "#/patchDefinitions/dvs-switches"
53834       availability-zone:
53835         type: object
53836         $ref: "#/patchDefinitions/availability-zone"
53837   business:
53838     description: |
53839       Namespace for business related constructs
53840     properties:
53841       connectors:
53842         type: array
53843         items:
53844           $ref: "#/patchDefinitions/connector"
53845       customers:
53846         type: array
53847         items:
53848           $ref: "#/patchDefinitions/customer"
53849   class-of-service:
53850     description: |
53851       ###### Related Nodes
53852       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
53853     required:
53854     - cos
53855     properties:
53856       cos:
53857         type: string
53858         description: unique identifier of probe
53859       probe-id:
53860         type: string
53861         description: identifier of probe
53862       probe-type:
53863         type: string
53864         description: type of probe
53865   classes-of-service:
53866     description: |
53867       class-of-service of probe
53868     properties:
53869       class-of-service:
53870         type: array
53871         items:
53872           $ref: "#/patchDefinitions/class-of-service"
53873   cloud-infrastructure:
53874     description: |
53875       Namespace for cloud infrastructure.
53876     properties:
53877       complexes:
53878         type: array
53879         items:
53880           $ref: "#/patchDefinitions/complex"
53881       cloud-regions:
53882         type: array
53883         items:
53884           $ref: "#/patchDefinitions/cloud-region"
53885       network-profiles:
53886         type: array
53887         items:
53888           $ref: "#/patchDefinitions/network-profile"
53889       pservers:
53890         type: array
53891         items:
53892           $ref: "#/patchDefinitions/pserver"
53893       virtual-data-centers:
53894         type: array
53895         items:
53896           $ref: "#/patchDefinitions/virtual-data-center"
53897   cloud-region:
53898     description: |
53899       cloud-region designates an installation of a cloud cluster or region or instantiation
53900       ###### Related Nodes
53901       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53902       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53903       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
53904       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53905       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53906       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53907       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53908       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53909       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53910       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53911       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53912       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53913       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
53914       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
53915       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
53916       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
53917     required:
53918     - cloud-owner
53919     - cloud-region-id
53920     properties:
53921       cloud-owner:
53922         type: string
53923         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
53924       cloud-region-id:
53925         type: string
53926         description: Identifier used by the vendor for the region. Second part of composite key
53927       cloud-type:
53928         type: string
53929         description: Type of the cloud (e.g., openstack)
53930       owner-defined-type:
53931         type: string
53932         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
53933       cloud-region-version:
53934         type: string
53935         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
53936       identity-url:
53937         type: string
53938         description: URL of the keystone identity service
53939       cloud-zone:
53940         type: string
53941         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53942       complex-name:
53943         type: string
53944         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
53945   cloud-regions:
53946     properties:
53947       cloud-region:
53948         type: array
53949         items:
53950           $ref: "#/patchDefinitions/cloud-region"
53951   complex:
53952     description: |
53953       Collection of physical locations that can house cloud-regions.
53954       ###### Related Nodes
53955       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53956       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53957       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53958       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53959       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
53960       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53961       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53962       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53963       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53964       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53965       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
53966       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
53967       - COMPLEX is DELETED when these are DELETED CTAG-POOL
53968     required:
53969     - physical-location-id
53970     - physical-location-type
53971     - street1
53972     - city
53973     - postal-code
53974     - country
53975     - region
53976     properties:
53977       physical-location-id:
53978         type: string
53979         description: Unique identifier for physical location, e.g., CLLI
53980       data-center-code:
53981         type: string
53982         description: Data center code which can be an alternate way to identify a complex
53983       complex-name:
53984         type: string
53985         description: Gamma complex name for LCP instance.
53986       identity-url:
53987         type: string
53988         description: URL of the keystone identity service
53989   complexes:
53990     description: |
53991       Collection of physical locations that can house cloud-regions.
53992     properties:
53993       complex:
53994         type: array
53995         items:
53996           $ref: "#/patchDefinitions/complex"
53997   configuration:
53998     description: |
53999       Port Mirror Configuration.
54000       ###### Related Nodes
54001       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
54002       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54003       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
54004       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54005       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
54006       - CONFIGURATION is DELETED when these are DELETED METADATUM
54007       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
54008     required:
54009     - configuration-id
54010     - configuration-type
54011     - configuration-sub-type
54012     - orchestration-status
54013     - operational-status
54014     - configuration-selflink
54015     - model-customization-id
54016     properties:
54017       configuration-id:
54018         type: string
54019         description: UUID assigned to configuration.
54020       management-option:
54021         type: string
54022         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
54023       configuration-name:
54024         type: string
54025         description: Name of the configuration.
54026       configuration-type:
54027         type: string
54028         description: port-mirroring-configuration.
54029       configuration-sub-type:
54030         type: string
54031         description: vprobe, pprobe.
54032       model-invariant-id:
54033         type: string
54034         description: the ASDC model id for this resource or service model.
54035       model-version-id:
54036         type: string
54037         description: the ASDC model version for this resource or service model.
54038       orchestration-status:
54039         type: string
54040         description: Orchestration status of the configuration.
54041       operational-status:
54042         type: string
54043         description: Indicator for whether the resource is considered operational.
54044       configuration-selflink:
54045         type: string
54046         description: URL to endpoint where AAI can get more details from SDN-GC.
54047       model-customization-id:
54048         type: string
54049         description: id of  the configuration used to customize the resource
54050   configurations:
54051     description: |
54052       Collection of configurations
54053     properties:
54054       configuration:
54055         type: array
54056         items:
54057           $ref: "#/patchDefinitions/configuration"
54058   connector:
54059     description: |
54060       Collection of resource instances used to connect a variety of disparate inventory widgets
54061       ###### Related Nodes
54062       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54063       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54064       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
54065       - CONNECTOR is DELETED when these are DELETED METADATUM
54066     required:
54067     - resource-instance-id
54068     properties:
54069       resource-instance-id:
54070         type: string
54071         description: Unique id of resource instance.
54072   connectors:
54073     description: |
54074       Collection of resource instances used to connect a variety of disparate inventory widgets
54075     properties:
54076       connector:
54077         type: array
54078         items:
54079           $ref: "#/patchDefinitions/connector"
54080   constrained-element-set:
54081     description: |
54082       This is how we would capture constraints defining allowed sets of elements.
54083       ###### Related Nodes
54084       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54085       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54086       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
54087       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
54088     required:
54089     - constrained-element-set-uuid
54090     - constraint-type
54091     - check-type
54092     properties:
54093       constrained-element-set-uuid:
54094         type: string
54095       constraint-type:
54096         type: string
54097       check-type:
54098         type: string
54099   constrained-element-sets:
54100     properties:
54101       constrained-element-set:
54102         type: array
54103         items:
54104           $ref: "#/patchDefinitions/constrained-element-set"
54105   ctag-assignment:
54106     description: |
54107       ###### Related Nodes
54108       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54109       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
54110     required:
54111     - vlan-id-inner
54112     properties:
54113       vlan-id-inner:
54114         type: integer
54115         format: int64
54116         description: id.
54117   ctag-assignments:
54118     properties:
54119       ctag-assignment:
54120         type: array
54121         items:
54122           $ref: "#/patchDefinitions/ctag-assignment"
54123   ctag-pool:
54124     description: |
54125       A collection of C tags (vlan tags) grouped for a specific purpose.
54126       ###### Related Nodes
54127       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
54128       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54129       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
54130     required:
54131     - target-pe
54132     - availability-zone-name
54133     - ctag-pool-purpose
54134     properties:
54135       target-pe:
54136         type: string
54137         description: The Target provider edge router
54138       availability-zone-name:
54139         type: string
54140         description: Name of the availability zone
54141       ctag-pool-purpose:
54142         type: string
54143         description: Describes what the intended purpose of this pool is.
54144       ctag-values:
54145         type: string
54146         description: Comma separated list of ctags
54147   ctag-pools:
54148     properties:
54149       ctag-pool:
54150         type: array
54151         items:
54152           $ref: "#/patchDefinitions/ctag-pool"
54153   customer:
54154     description: |
54155       customer identifiers to provide linkage back to BSS information.
54156       ###### Related Nodes
54157       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
54158       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
54159     required:
54160     - global-customer-id
54161     - subscriber-name
54162     - subscriber-type
54163     properties:
54164       global-customer-id:
54165         type: string
54166         description: Global customer id used across ECOMP to uniquely identify customer.
54167       subscriber-name:
54168         type: string
54169         description: Subscriber name, an alternate way to retrieve a customer.
54170       subscriber-type:
54171         type: string
54172         description: Subscriber type, a way to provide VID with only the INFRA customers.
54173   customers:
54174     description: |
54175       Collection of customer identifiers to provide linkage back to BSS information.
54176     properties:
54177       customer:
54178         type: array
54179         items:
54180           $ref: "#/patchDefinitions/customer"
54181   cvlan-tag-entry:
54182     required:
54183     - cvlan-tag
54184     properties:
54185       cvlan-tag:
54186         type: integer
54187         format: int64
54188         description: See mis-na-virtualization-platform.yang
54189   cvlan-tags:
54190     properties:
54191       cvlan-tag-entry:
54192         type: array
54193         items:
54194           $ref: "#/patchDefinitions/cvlan-tag-entry"
54195   dvs-switch:
54196     description: |
54197       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.
54198       ###### Related Nodes
54199       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54200       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
54201     required:
54202     - switch-name
54203     - vcenter-url
54204     properties:
54205       switch-name:
54206         type: string
54207         description: DVS switch name
54208       vcenter-url:
54209         type: string
54210         description: URL used to reach the vcenter
54211   dvs-switches:
54212     description: |
54213       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
54214     properties:
54215       dvs-switch:
54216         type: array
54217         items:
54218           $ref: "#/patchDefinitions/dvs-switch"
54219   edge-prop-names:
54220     description: |
54221       Internal map to define the properties of an edge and interpret the map EdgeRules
54222     properties:
54223       edgeLabel:
54224         type: string
54225       direction:
54226         type: string
54227       multiplicityRule:
54228         type: string
54229       isParent:
54230         type: boolean
54231       usesResource:
54232         type: boolean
54233       hasDelTarget:
54234         type: boolean
54235       SVC-INFRA:
54236         type: boolean
54237       SVC-INFRA-REV:
54238         type: boolean
54239   edge-tag-query-request:
54240     properties:
54241       edge-tag:
54242         type: string
54243       result-detail:
54244         type: string
54245       start-node-type:
54246         type: string
54247       start-node-filter:
54248         type: array
54249         items:
54250           $ref: "#/patchDefinitions/start-node-filter"
54251       include-node-filter:
54252         type: array
54253         items:
54254           $ref: "#/patchDefinitions/include-node-filter"
54255       secondary-filter:
54256         type: array
54257         items:
54258           $ref: "#/patchDefinitions/secondary-filter"
54259   edge-tag-query-result:
54260     properties:
54261       tagged-inventory-item-list:
54262         type: array
54263         items:
54264           $ref: "#/patchDefinitions/tagged-inventory-item-list"
54265   element-choice-set:
54266     description: |
54267       This is how we would capture constraints defining allowed sets of elements.
54268       ###### Related Nodes
54269       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
54270       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
54271       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
54272     required:
54273     - element-choice-set-uuid
54274     - element-choice-set-name
54275     properties:
54276       element-choice-set-uuid:
54277         type: string
54278       element-choice-set-name:
54279         type: string
54280       cardinality:
54281         type: string
54282   element-choice-sets:
54283     properties:
54284       element-choice-set:
54285         type: array
54286         items:
54287           $ref: "#/patchDefinitions/element-choice-set"
54288   entitlement:
54289     description: |
54290       Metadata for entitlement group.
54291       ###### Related Nodes
54292       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54293       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54294     required:
54295     - group-uuid
54296     - resource-uuid
54297     properties:
54298       group-uuid:
54299         type: string
54300         description: Unique ID for the entitlement group the resource comes from, should be uuid.
54301       resource-uuid:
54302         type: string
54303         description: Unique ID of an entitlement resource.
54304   entitlements:
54305     description: |
54306       Entitlements, keyed by group-uuid and resource-uuid, related to license management
54307     properties:
54308       entitlement:
54309         type: array
54310         items:
54311           $ref: "#/patchDefinitions/entitlement"
54312   esr-ems:
54313     description: |
54314       Persist EMS address information used by EMS driver.
54315       ###### Related Nodes
54316       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
54317       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54318     required:
54319     - ems-id
54320     properties:
54321       ems-id:
54322         type: string
54323         description: Unique ID of EMS.
54324   esr-ems-list:
54325     properties:
54326       esr-ems:
54327         type: array
54328         items:
54329           $ref: "#/patchDefinitions/esr-ems"
54330   esr-system-info:
54331     description: |
54332       Persist common address information of external systems.
54333       ###### Related Nodes
54334       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
54335       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
54336       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
54337       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
54338     required:
54339     - esr-system-info-id
54340     - user-name
54341     - password
54342     - system-type
54343     properties:
54344       esr-system-info-id:
54345         type: string
54346         description: Unique ID of esr system info.
54347       system-name:
54348         type: string
54349         description: name of external system.
54350       type:
54351         type: string
54352         description: type of external systems.
54353       vendor:
54354         type: string
54355         description: vendor of external systems.
54356       version:
54357         type: string
54358         description: version of external systems.
54359       service-url:
54360         type: string
54361         description: url used to access external systems.
54362       user-name:
54363         type: string
54364         description: username used to access external systems.
54365       password:
54366         type: string
54367         description: password used to access external systems.
54368       system-type:
54369         type: string
54370         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
54371       protocol:
54372         type: string
54373         description: protocol of third party SDNC, for example netconf/snmp.
54374       ssl-cacert:
54375         type: string
54376         description: ca file content if enabled ssl on auth-url.
54377       ssl-insecure:
54378         type: boolean
54379         description: Whether to verify VIM's certificate.
54380       ip-address:
54381         type: string
54382         description: service IP of ftp server.
54383       port:
54384         type: string
54385         description: service port of ftp server.
54386       cloud-domain:
54387         type: string
54388         description: domain info for authentication.
54389       default-tenant:
54390         type: string
54391         description: default tenant of VIM.
54392       passive:
54393         type: boolean
54394         description: ftp passive mode or not.
54395       remote-path:
54396         type: string
54397         description: resource or performance data file path.
54398       system-status:
54399         type: string
54400         description: the status of external system.
54401   esr-system-info-list:
54402     description: |
54403       Collection of persistent block-level external system auth info.
54404     properties:
54405       esr-system-info:
54406         type: array
54407         items:
54408           $ref: "#/patchDefinitions/esr-system-info"
54409   esr-thirdparty-sdnc:
54410     description: |
54411       Persist SDNC address information used by ONAP SDNC.
54412       ###### Related Nodes
54413       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
54414       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
54415       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54416     required:
54417     - thirdparty-sdnc-id
54418     properties:
54419       thirdparty-sdnc-id:
54420         type: string
54421         description: Unique ID of SDNC.
54422       location:
54423         type: string
54424         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
54425       product-name:
54426         type: string
54427         description: password used to access SDNC server.
54428   esr-thirdparty-sdnc-list:
54429     properties:
54430       esr-thirdparty-sdnc:
54431         type: array
54432         items:
54433           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
54434   esr-vnfm:
54435     description: |
54436       Persist VNFM address information used by VF-C.
54437       ###### Related Nodes
54438       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
54439       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
54440     required:
54441     - vnfm-id
54442     properties:
54443       vnfm-id:
54444         type: string
54445         description: Unique ID of VNFM.
54446       vim-id:
54447         type: string
54448         description: indecate the VIM to deploy VNF.
54449       certificate-url:
54450         type: string
54451         description: certificate url of VNFM.
54452   esr-vnfm-list:
54453     properties:
54454       esr-vnfm:
54455         type: array
54456         items:
54457           $ref: "#/patchDefinitions/esr-vnfm"
54458   evc:
54459     description: |
54460       evc object is an optional child object of the Configuration object.
54461       ###### Related Nodes
54462       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54463     required:
54464     - evc-id
54465     properties:
54466       evc-id:
54467         type: string
54468         description: Unique/key field for the evc object
54469       forwarding-path-topology:
54470         type: string
54471         description: Point-to-Point, Multi-Point
54472       cir-value:
54473         type: string
54474         description: Commited Information Rate
54475       cir-units:
54476         type: string
54477         description: CIR units
54478       connection-diversity-group-id:
54479         type: string
54480         description: Diversity Group ID
54481       service-hours:
54482         type: string
54483         description: formerly Performance Group
54484       esp-evc-circuit-id:
54485         type: string
54486         description: EVC Circuit ID of ESP EVC
54487       esp-evc-cir-value:
54488         type: string
54489         description: Committed Information Rate (For ESP)
54490       esp-evc-cir-units:
54491         type: string
54492         description: CIR units (For ESP)
54493       esp-itu-code:
54494         type: string
54495         description: Identifies ESP
54496       collector-pop-clli:
54497         type: string
54498         description: Collector POP CLLI (from the hostname of the access pnf)
54499       inter-connect-type-ingress:
54500         type: string
54501         description: Interconnect type on ingress side of EVC.
54502       tagmode-access-ingress:
54503         type: string
54504         description: tagode for collector side of EVC
54505       tagmode-access-egress:
54506         type: string
54507         description: tagMode for network side of EVC
54508   evcs:
54509     properties:
54510       evc:
54511         type: array
54512         items:
54513           $ref: "#/patchDefinitions/evc"
54514   external-system:
54515     description: |
54516       Namespace for external system.
54517     properties:
54518       esr-ems-list:
54519         type: object
54520         $ref: "#/patchDefinitions/esr-ems-list"
54521       esr-vnfm-list:
54522         type: object
54523         $ref: "#/patchDefinitions/esr-vnfm-list"
54524       esr-thirdparty-sdnc-list:
54525         type: object
54526         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
54527   extra-properties:
54528     description: |
54529       Extra properties for inventory item for response list
54530     properties:
54531       extra-property:
54532         type: array
54533         items:
54534           $ref: "#/patchDefinitions/extra-property"
54535   extra-property:
54536     properties:
54537       property-name:
54538         type: string
54539       property-value:
54540         type: string
54541   flavor:
54542     description: |
54543       Openstack flavor.
54544       ###### Related Nodes
54545       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54546       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
54547       - FLAVOR cannot be deleted if linked to VSERVER
54548     required:
54549     - flavor-id
54550     - flavor-name
54551     - flavor-selflink
54552     properties:
54553       flavor-id:
54554         type: string
54555         description: Flavor id, expected to be unique across cloud-region.
54556       flavor-name:
54557         type: string
54558         description: Flavor name
54559       flavor-vcpus:
54560         type: integer
54561         format: int32
54562         description: Number of CPUs
54563       flavor-ram:
54564         type: integer
54565         format: int32
54566         description: Amount of memory
54567       flavor-disk:
54568         type: integer
54569         format: int32
54570         description: Disk space
54571       flavor-ephemeral:
54572         type: integer
54573         format: int32
54574         description: Amount of ephemeral disk space
54575       flavor-swap:
54576         type: string
54577         description: amount of swap space allocation
54578       flavor-is-public:
54579         type: boolean
54580         description: whether flavor is available to all users or private to the tenant it was created in.
54581       flavor-selflink:
54582         type: string
54583         description: URL to endpoint where AAI can get more details
54584       flavor-disabled:
54585         type: boolean
54586         description: Boolean as to whether this flavor is no longer enabled
54587   flavors:
54588     description: |
54589       Collection of openstack flavors.
54590     properties:
54591       flavor:
54592         type: array
54593         items:
54594           $ref: "#/patchDefinitions/flavor"
54595   forwarder:
54596     description: |
54597       Entity describing a sequenced segment of forwarding path
54598       ###### Related Nodes
54599       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
54600       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
54601       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54602       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
54603       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
54604       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
54605     required:
54606     - sequence
54607     properties:
54608       sequence:
54609         type: integer
54610         format: int32
54611         description: Unique ID of this segmentation
54612       forwarder-role:
54613         type: string
54614         description: ingress, intermediate, egress
54615   forwarder-evc:
54616     description: |
54617       forwarder object is an optional child object of the Configuration object.
54618       ###### Related Nodes
54619       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
54620     required:
54621     - forwarder-evc-id
54622     properties:
54623       forwarder-evc-id:
54624         type: string
54625         description: Key for forwarder-evc object
54626       circuit-id:
54627         type: string
54628         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
54629       ivlan:
54630         type: string
54631         description: Internal VLAN.
54632       svlan:
54633         type: string
54634         description: SVLAN value for ingress of egress forwarder.
54635       cvlan:
54636         type: string
54637         description: CVLAN value for ingress of egress forwarder.
54638   forwarder-evcs:
54639     properties:
54640       forwarder-evc:
54641         type: array
54642         items:
54643           $ref: "#/patchDefinitions/forwarder-evc"
54644   forwarders:
54645     properties:
54646       forwarder:
54647         type: array
54648         items:
54649           $ref: "#/patchDefinitions/forwarder"
54650   forwarding-path:
54651     description: |
54652       Entity that describes the sequenced forwarding path between interfaces of services or resources
54653       ###### Related Nodes
54654       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
54655       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
54656       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
54657       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
54658       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
54659     required:
54660     - forwarding-path-id
54661     - forwarding-path-name
54662     properties:
54663       forwarding-path-id:
54664         type: string
54665         description: Unique ID of this FP
54666       forwarding-path-name:
54667         type: string
54668         description: Name of the FP
54669   forwarding-paths:
54670     properties:
54671       forwarding-path:
54672         type: array
54673         items:
54674           $ref: "#/patchDefinitions/forwarding-path"
54675   generic-vnf:
54676     description: |
54677       General purpose VNF
54678       ###### Related Nodes
54679       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
54680       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54681       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54682       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54683       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
54684       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
54685       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
54686       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
54687       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
54688       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54689       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
54690       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54691       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54692       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54693       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54694       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54695       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54696       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
54697       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
54698       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54699       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54700       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
54701     required:
54702     - vnf-id
54703     - vnf-name
54704     - vnf-type
54705     - in-maint
54706     - is-closed-loop-disabled
54707     properties:
54708       vnf-id:
54709         type: string
54710         description: Unique id of VNF.  This is unique across the graph.
54711       vnf-name:
54712         type: string
54713         description: Name of VNF.
54714       vnf-name2:
54715         type: string
54716         description: Alternate name of VNF.
54717       vnf-type:
54718         type: string
54719         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
54720       service-id:
54721         type: string
54722         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
54723       regional-resource-zone:
54724         type: string
54725         description: Regional way of organizing pservers, source of truth should define values
54726       prov-status:
54727         type: string
54728         description: Trigger for operational monitoring of this resource by Service Assurance systems.
54729       operational-status:
54730         type: string
54731         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
54732       license-key:
54733         type: string
54734         description: OBSOLETE -  do not use
54735       equipment-role:
54736         type: string
54737         description: Client should send valid enumerated value
54738       orchestration-status:
54739         type: string
54740         description: Orchestration status of this VNF, used by MSO.
54741       heat-stack-id:
54742         type: string
54743         description: Heat stack id corresponding to this instance, managed by MSO
54744       mso-catalog-key:
54745         type: string
54746         description: Corresponds to the SDN-C catalog id used to configure this VCE
54747       management-option:
54748         type: string
54749         description: identifier of managed by company or customer
54750       ipv4-oam-address:
54751         type: string
54752         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
54753       ipv4-loopback0-address:
54754         type: string
54755         description: v4 Loopback0 address
54756       nm-lan-v6-address:
54757         type: string
54758         description: v6 Loopback address
54759       management-v6-address:
54760         type: string
54761         description: v6 management address
54762       vcpu:
54763         type: integer
54764         format: int64
54765         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
54766       vcpu-units:
54767         type: string
54768         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
54769       vmemory:
54770         type: integer
54771         format: int64
54772         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
54773       vmemory-units:
54774         type: string
54775         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
54776       vdisk:
54777         type: integer
54778         format: int64
54779         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
54780       vdisk-units:
54781         type: string
54782         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
54783       in-maint:
54784         type: boolean
54785       is-closed-loop-disabled:
54786         type: boolean
54787   generic-vnfs:
54788     description: |
54789       Collection of VNFs
54790     properties:
54791       generic-vnf:
54792         type: array
54793         items:
54794           $ref: "#/patchDefinitions/generic-vnf"
54795   group-assignment:
54796     description: |
54797       Openstack group-assignment used to store exclusivity groups (EG).
54798       ###### Related Nodes
54799       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54800       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
54801       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
54802     required:
54803     - group-id
54804     - group-type
54805     - group-name
54806     properties:
54807       group-id:
54808         type: string
54809         description: Group id, expected to be unique across cloud-region.
54810       group-type:
54811         type: string
54812         description: Group type - the type of group this instance refers to
54813       group-name:
54814         type: string
54815         description: Group name - name assigned to the group
54816       group-description:
54817         type: string
54818         description: Group description - description of the group
54819   group-assignments:
54820     description: |
54821       Collection of openstack group assignments
54822     properties:
54823       group-assignment:
54824         type: array
54825         items:
54826           $ref: "#/patchDefinitions/group-assignment"
54827   host-route:
54828     description: |
54829       ###### Related Nodes
54830       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
54831     required:
54832     - host-route-id
54833     - route-prefix
54834     - next-hop
54835     properties:
54836       host-route-id:
54837         type: string
54838         description: host-route id
54839       route-prefix:
54840         type: string
54841         description: subnet prefix
54842       next-hop:
54843         type: string
54844         description: Could be ip-address, hostname, or service-instance
54845       next-hop-type:
54846         type: string
54847         description: Should be ip-address, hostname, or service-instance to match next-hop
54848   host-routes:
54849     properties:
54850       host-route:
54851         type: array
54852         items:
54853           $ref: "#/patchDefinitions/host-route"
54854   image:
54855     description: |
54856       Openstack image.
54857       ###### Related Nodes
54858       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54859       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54860       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
54861       - IMAGE cannot be deleted if linked to VSERVER
54862       - IMAGE is DELETED when these are DELETED METADATUM
54863     required:
54864     - image-id
54865     - image-name
54866     - image-os-distro
54867     - image-os-version
54868     - image-selflink
54869     properties:
54870       image-id:
54871         type: string
54872         description: Image id, expected to be unique across cloud region
54873       image-name:
54874         type: string
54875         description: Image name
54876       image-architecture:
54877         type: string
54878         description: Operating system architecture.
54879       image-os-distro:
54880         type: string
54881         description: The common name of the operating system distribution in lowercase
54882       image-os-version:
54883         type: string
54884         description: The operating system version as specified by the distributor.
54885       application:
54886         type: string
54887         description: The application that the image instantiates.
54888       application-vendor:
54889         type: string
54890         description: The vendor of the application.
54891       application-version:
54892         type: string
54893         description: The version of the application.
54894       image-selflink:
54895         type: string
54896         description: URL to endpoint where AAI can get more details
54897   images:
54898     description: |
54899       Collectio of Openstack images.
54900     properties:
54901       image:
54902         type: array
54903         items:
54904           $ref: "#/patchDefinitions/image"
54905   include-node-filter:
54906     properties:
54907       include-node-type:
54908         type: string
54909   instance-filter:
54910     description: |
54911       InstanceFilter for performing a named-query or model query
54912   instance-filters:
54913     description: |
54914       InstanceFilters for performing a named-query or model query
54915     properties:
54916       instance-filter:
54917         type: array
54918         items:
54919           $ref: "#/patchDefinitions/instance-filter"
54920   instance-group:
54921     description: |
54922       General mechanism for grouping instances
54923       ###### Related Nodes
54924       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54925       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54926       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54927       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54928       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54929       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54930       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54931       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54932     required:
54933     - id
54934     - description
54935     - type
54936     properties:
54937       id:
54938         type: string
54939         description: Instance Group ID, UUID assigned to this instance.
54940       description:
54941         type: string
54942         description: Descriptive text to help identify the usage of this instance-group
54943       type:
54944         type: string
54945         description: Only valid value today is lower case ha for high availability
54946       sub-type:
54947         type: string
54948         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54949   instance-groups:
54950     description: |
54951       Collection of openstack route table references
54952     properties:
54953       instance-group:
54954         type: array
54955         items:
54956           $ref: "#/patchDefinitions/instance-group"
54957   inventory:
54958     properties:
54959       search:
54960         type: object
54961         $ref: "#/patchDefinitions/search"
54962       actions:
54963         type: object
54964         $ref: "#/patchDefinitions/actions"
54965       cloud-infrastructure:
54966         type: object
54967         $ref: "#/patchDefinitions/cloud-infrastructure"
54968       business:
54969         type: object
54970         $ref: "#/patchDefinitions/business"
54971       service-design-and-creation:
54972         type: object
54973         $ref: "#/patchDefinitions/service-design-and-creation"
54974       network:
54975         type: object
54976         $ref: "#/patchDefinitions/network"
54977       aai-internal:
54978         type: object
54979         $ref: "#/patchDefinitions/aai-internal"
54980       nodes:
54981         type: array
54982         items:
54983           $ref: "#/patchDefinitions/aai-internal"
54984   inventory-item:
54985     properties:
54986       inventory-item-type:
54987         type: string
54988       inventory-item-link:
54989         type: string
54990       inventory-item-data:
54991         type: array
54992         items:
54993           $ref: "#/patchDefinitions/inventory-item-data"
54994       tagged-inventory-item-list:
54995         type: array
54996         items:
54997           $ref: "#/patchDefinitions/tagged-inventory-item-list"
54998   inventory-item-data:
54999     properties:
55000       property-name:
55001         type: string
55002       property-value:
55003         type: string
55004   inventory-response-item:
55005     description: |
55006       Inventory item for response list
55007     properties:
55008       model-name:
55009         type: string
55010       extra-properties:
55011         type: object
55012         $ref: "#/patchDefinitions/extra-properties"
55013       inventory-response-items:
55014         type: object
55015         $ref: "#/patchDefinitions/inventory-response-items"
55016   inventory-response-items:
55017     description: |
55018       Container for inventory items in response list
55019     properties:
55020       inventory-response-item:
55021         type: array
55022         items:
55023           $ref: "#/patchDefinitions/inventory-response-item"
55024   ipsec-configuration:
55025     description: |
55026       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
55027       ###### Related Nodes
55028       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
55029       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
55030       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
55031     required:
55032     - ipsec-configuration-id
55033     properties:
55034       ipsec-configuration-id:
55035         type: string
55036         description: UUID of this configuration
55037       requested-vig-address-type:
55038         type: string
55039         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
55040       requested-encryption-strength:
55041         type: string
55042         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
55043       requested-dmz-type:
55044         type: string
55045         description: can offer a shared DMZ or a DMZ specific to a customer
55046       shared-dmz-network-address:
55047         type: string
55048         description: Network address of shared DMZ
55049       requested-customer-name:
55050         type: string
55051         description: If the DMZ is a custom DMZ, this field will indicate the customer information
55052       ike-version:
55053         type: string
55054         description: can be 1 or 2
55055       ikev1-authentication:
55056         type: string
55057         description: Contains values like md5, sha1, sha256, sha384
55058       ikev1-encryption:
55059         type: string
55060         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
55061       ikev1-dh-group:
55062         type: string
55063         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
55064       ikev1-am-group-id:
55065         type: string
55066         description: Group name defined in VIG for clients using aggressive mode
55067       ikev1-am-password:
55068         type: string
55069         description: pre-shared key for the above group name
55070       ikev1-sa-lifetime:
55071         type: string
55072         description: Lifetime for IKEv1 SA
55073       ipsec-authentication:
55074         type: string
55075         description: md5, sha1, sha256, sha384
55076       ipsec-encryption:
55077         type: string
55078         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
55079       ipsec-sa-lifetime:
55080         type: string
55081         description: Life time for IPSec SA
55082       ipsec-pfs:
55083         type: string
55084         description: enable PFS or not
55085       xauth-userid:
55086         type: string
55087         description: user ID for xAuth, sm-user, ,nmteHostName
55088       xauth-user-password:
55089         type: string
55090         description: Encrypted using the Juniper $9$ algorithm
55091       dpd-interval:
55092         type: string
55093         description: The time between DPD probe
55094       dpd-frequency:
55095         type: string
55096         description: Maximum number of DPD before claiming the tunnel is down
55097   ipsec-configurations:
55098     properties:
55099       ipsec-configuration:
55100         type: array
55101         items:
55102           $ref: "#/patchDefinitions/ipsec-configuration"
55103   key-data:
55104     properties:
55105       key-name:
55106         type: string
55107       key-value:
55108         type: string
55109   l-interface:
55110     description: |
55111       Logical interfaces, e.g., a vnic.
55112       ###### Related Nodes
55113       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55114       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
55115       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55116       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55117       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
55118       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55119       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55120       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
55121       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55122       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55123       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
55124       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
55125       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55126       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
55127       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
55128     required:
55129     - interface-name
55130     - is-port-mirrored
55131     - in-maint
55132     properties:
55133       interface-name:
55134         type: string
55135         description: Name given to the interface
55136       interface-role:
55137         type: string
55138         description: E.g., CUSTOMER, UPLINK, etc.
55139       v6-wan-link-ip:
55140         type: string
55141         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
55142       selflink:
55143         type: string
55144         description: URL to endpoint where AAI can get more details
55145       interface-id:
55146         type: string
55147         description: ID of interface
55148       macaddr:
55149         type: string
55150         description: MAC address for the interface
55151       network-name:
55152         type: string
55153         description: Name of the network
55154       management-option:
55155         type: string
55156         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
55157       interface-description:
55158         type: string
55159         description: Human friendly text regarding this interface.
55160       is-port-mirrored:
55161         type: boolean
55162   l-interfaces:
55163     description: |
55164       Collection of logical interfaces.
55165     properties:
55166       l-interface:
55167         type: array
55168         items:
55169           $ref: "#/patchDefinitions/l-interface"
55170   l3-interface-ipv4-address-list:
55171     description: |
55172       IPv4 Address Range
55173       ###### Related Nodes
55174       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55175       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55176       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
55177       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55178       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
55179     required:
55180     - l3-interface-ipv4-address
55181     properties:
55182       l3-interface-ipv4-address:
55183         type: string
55184         description: IP address
55185       l3-interface-ipv4-prefix-length:
55186         type: integer
55187         format: int64
55188         description: Prefix length, 32 for single address
55189       vlan-id-inner:
55190         type: integer
55191         format: int64
55192         description: Inner VLAN tag
55193       vlan-id-outer:
55194         type: integer
55195         format: int64
55196         description: Outer VLAN tag
55197       is-floating:
55198         type: boolean
55199         description: Indicator of fixed or floating address
55200   l3-interface-ipv6-address-list:
55201     description: |
55202       IPv6 Address Range
55203       ###### Related Nodes
55204       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
55205       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55206       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
55207       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
55208       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
55209     required:
55210     - l3-interface-ipv6-address
55211     properties:
55212       l3-interface-ipv6-address:
55213         type: string
55214         description: IP address
55215       l3-interface-ipv6-prefix-length:
55216         type: integer
55217         format: int64
55218         description: Prefix length, 128 for single address
55219       vlan-id-inner:
55220         type: integer
55221         format: int64
55222         description: Inner VLAN tag
55223       vlan-id-outer:
55224         type: integer
55225         format: int64
55226         description: Outer VLAN tag
55227       is-floating:
55228         type: boolean
55229         description: Indicator of fixed or floating address
55230   l3-network:
55231     description: |
55232       Generic network definition
55233       ###### Related Nodes
55234       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55235       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
55236       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
55237       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
55238       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55239       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55240       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55241       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55242       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
55243       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55244       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55245       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
55246       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
55247       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
55248       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
55249       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
55250     required:
55251     - network-id
55252     - network-name
55253     - is-bound-to-vpn
55254     - is-provider-network
55255     - is-shared-network
55256     - is-external-network
55257     properties:
55258       network-id:
55259         type: string
55260         description: Network ID, should be uuid. Unique across A&AI.
55261       network-name:
55262         type: string
55263         description: Name of the network, governed by some naming convention..
55264       network-type:
55265         type: string
55266         description: Type of the network - who defines these values?
55267       network-role:
55268         type: string
55269         description: Role the network plans - who defines these values?
55270       network-technology:
55271         type: string
55272         description: Network technology - who defines these values?
55273       neutron-network-id:
55274         type: string
55275         description: Neutron network id of this Interface
55276       is-bound-to-vpn:
55277         type: boolean
55278       service-id:
55279         type: string
55280         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
55281       network-role-instance:
55282         type: integer
55283         format: int64
55284         description: network role instance
55285   l3-networks:
55286     properties:
55287       l3-network:
55288         type: array
55289         items:
55290           $ref: "#/patchDefinitions/l3-network"
55291   lag-interface:
55292     description: |
55293       Link aggregate interface
55294       ###### Related Nodes
55295       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55296       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
55297       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55298       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55299       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55300       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55301       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55302       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
55303       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
55304       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
55305     required:
55306     - interface-name
55307     - in-maint
55308     properties:
55309       interface-name:
55310         type: string
55311         description: Name that identifies the link aggregate interface
55312       interface-description:
55313         type: string
55314         description: Human friendly text regarding this interface.
55315   lag-interfaces:
55316     description: |
55317       Collection of link aggregate interfaces.
55318     properties:
55319       lag-interface:
55320         type: array
55321         items:
55322           $ref: "#/patchDefinitions/lag-interface"
55323   lag-link:
55324     description: |
55325       LAG links can connect lag-interfaces
55326       ###### Related Nodes
55327       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
55328       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
55329     required:
55330     - link-name
55331     properties:
55332       link-name:
55333         type: string
55334         description: Alphabetical concatenation of lag-interface names
55335   lag-links:
55336     description: |
55337       Collection of link aggregation connections
55338     properties:
55339       lag-link:
55340         type: array
55341         items:
55342           $ref: "#/patchDefinitions/lag-link"
55343   license:
55344     description: |
55345       Metadata for license group.
55346       ###### Related Nodes
55347       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
55348       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55349     required:
55350     - group-uuid
55351     - resource-uuid
55352     properties:
55353       group-uuid:
55354         type: string
55355         description: Unique ID for the license group the resource belongs to, should be uuid.
55356       resource-uuid:
55357         type: string
55358         description: Unique ID of a license resource.
55359   licenses:
55360     description: |
55361       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
55362     properties:
55363       license:
55364         type: array
55365         items:
55366           $ref: "#/patchDefinitions/license"
55367   line-of-business:
55368     description: |
55369       describes a line-of-business
55370       ###### Related Nodes
55371       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55372     required:
55373     - line-of-business-name
55374     properties:
55375       line-of-business-name:
55376         type: string
55377         description: Name of the line-of-business (product)
55378   lines-of-business:
55379     description: |
55380       Collection of lines-of-business
55381     properties:
55382       line-of-business:
55383         type: array
55384         items:
55385           $ref: "#/patchDefinitions/line-of-business"
55386   logical-link:
55387     description: |
55388       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
55389       ###### Related Nodes
55390       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
55391       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
55392       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
55393       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55394       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55395       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
55396       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
55397       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
55398       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55399       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
55400       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55401       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
55402       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55403       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
55404     required:
55405     - link-name
55406     - link-type
55407     properties:
55408       link-name:
55409         type: string
55410         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
55411       link-type:
55412         type: string
55413         description: Type of logical link, e.g., evc
55414       speed-value:
55415         type: string
55416         description: Captures the numeric part of the speed
55417       speed-units:
55418         type: string
55419         description: Captures the units corresponding to the speed
55420       ip-version:
55421         type: string
55422         description: v4, v6, or ds for dual stack
55423       routing-protocol:
55424         type: string
55425         description: For example, static or BGP
55426   logical-links:
55427     description: |
55428       Collection of logical connections
55429     properties:
55430       logical-link:
55431         type: array
55432         items:
55433           $ref: "#/patchDefinitions/logical-link"
55434   metadata:
55435     description: |
55436       Collection of metadatum (key/value pairs)
55437     properties:
55438       metadatum:
55439         type: array
55440         items:
55441           $ref: "#/patchDefinitions/metadatum"
55442   metadatum:
55443     description: |
55444       Key/value pairs
55445       ###### Related Nodes
55446       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
55447       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
55448       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
55449       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55450     required:
55451     - metaname
55452     - metaval
55453     properties:
55454       metaname:
55455         type: string
55456       metaval:
55457         type: string
55458   model:
55459     description: |
55460       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
55461       ###### Related Nodes
55462       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55463       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
55464       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55465       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55466       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55467       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
55468       - MODEL is DELETED when these are DELETED MODEL-VER
55469     required:
55470     - model-invariant-id
55471     - model-type
55472     properties:
55473       model-invariant-id:
55474         type: string
55475         description: Unique identifier corresponding to the main definition of a model in ASDC
55476       model-type:
55477         type: string
55478         description: Type of the model, e.g., service, resource, widget, etc.
55479   model-and-named-query-search:
55480     description: |
55481       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
55482     properties:
55483       query-parameters:
55484         type: object
55485         $ref: "#/patchDefinitions/query-parameters"
55486       instance-filters:
55487         type: object
55488         $ref: "#/patchDefinitions/instance-filters"
55489       secondary-filts:
55490         type: object
55491         $ref: "#/patchDefinitions/secondary-filts"
55492       top-node-type:
55493         type: string
55494       secondary-filter-cut-point:
55495         type: string
55496   model-constraint:
55497     description: |
55498       This is how we would capture constraints defining allowed sets of elements.
55499       ###### Related Nodes
55500       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55501       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
55502       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
55503     required:
55504     - model-constraint-uuid
55505     - constrained-element-set-uuid-to-replace
55506     properties:
55507       model-constraint-uuid:
55508         type: string
55509       constrained-element-set-uuid-to-replace:
55510         type: string
55511       constrained-element-sets:
55512         type: array
55513         items:
55514           $ref: "#/patchDefinitions/constrained-element-set"
55515   model-constraints:
55516     properties:
55517       model-constraint:
55518         type: array
55519         items:
55520           $ref: "#/patchDefinitions/model-constraint"
55521   model-element:
55522     description: |
55523       Defines how other models combine to make up a higher-level model.
55524       ###### Related Nodes
55525       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55526       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55527       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55528       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55529       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55530       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55531       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55532       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
55533     required:
55534     - model-element-uuid
55535     - new-data-del-flag
55536     - cardinality
55537     properties:
55538       model-element-uuid:
55539         type: string
55540       new-data-del-flag:
55541         type: string
55542         description: Indicates whether this element was created as part of instantiation from this model
55543       cardinality:
55544         type: string
55545         description: How many of this type of element are required/allowed
55546       linkage-points:
55547         type: string
55548   model-elements:
55549     properties:
55550       model-element:
55551         type: array
55552         items:
55553           $ref: "#/patchDefinitions/model-element"
55554   model-ver:
55555     description: |
55556       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
55557       ###### Related Nodes
55558       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55559       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55560       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55561       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55562       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
55563       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
55564     required:
55565     - model-version-id
55566     - model-name
55567     - model-version
55568     properties:
55569       model-version-id:
55570         type: string
55571         description: Unique identifier corresponding to one version of a model in ASDC
55572       model-name:
55573         type: string
55574         description: Name of the model, which can change from version to version.
55575       model-version:
55576         type: string
55577         description: Version
55578       model-description:
55579         type: string
55580         description: Description
55581   model-vers:
55582     properties:
55583       model-ver:
55584         type: array
55585         items:
55586           $ref: "#/patchDefinitions/model-ver"
55587   models:
55588     description: |
55589       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
55590     properties:
55591       model:
55592         type: array
55593         items:
55594           $ref: "#/patchDefinitions/model"
55595   multicast-configuration:
55596     description: |
55597       ###### Related Nodes
55598       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
55599     required:
55600     - multicast-configuration-id
55601     - multicast-protocol
55602     - rp-type
55603     properties:
55604       multicast-configuration-id:
55605         type: string
55606         description: Unique id of multicast configuration.
55607       multicast-protocol:
55608         type: string
55609         description: protocol of multicast configuration
55610       rp-type:
55611         type: string
55612         description: rp type of multicast configuration
55613   multicast-configurations:
55614     description: |
55615       multicast configuration of generic-vnf ip-address
55616     properties:
55617       multicast-configuration:
55618         type: array
55619         items:
55620           $ref: "#/patchDefinitions/multicast-configuration"
55621   named-queries:
55622     properties:
55623       named-query:
55624         type: array
55625         items:
55626           $ref: "#/patchDefinitions/named-query"
55627   named-query:
55628     description: |
55629       TBD
55630       ###### Related Nodes
55631       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55632       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55633       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55634       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
55635     required:
55636     - named-query-uuid
55637     - named-query-name
55638     - named-query-version
55639     properties:
55640       named-query-uuid:
55641         type: string
55642       named-query-name:
55643         type: string
55644       named-query-version:
55645         type: string
55646       required-input-param:
55647         type: string
55648       description:
55649         type: string
55650   named-query-element:
55651     description: |
55652       TBD
55653       ###### Related Nodes
55654       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55655       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55656       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55657       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55658       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55659       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55660       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
55661     required:
55662     - named-query-element-uuid
55663     properties:
55664       named-query-element-uuid:
55665         type: string
55666       property-collect-list:
55667         type: string
55668   named-query-elements:
55669     properties:
55670       named-query-element:
55671         type: array
55672         items:
55673           $ref: "#/patchDefinitions/named-query-element"
55674   network:
55675     description: |
55676       Namespace for network inventory resources.
55677     properties:
55678       logical-links:
55679         type: array
55680         items:
55681           $ref: "#/patchDefinitions/logical-link"
55682       site-pair-sets:
55683         type: array
55684         items:
55685           $ref: "#/patchDefinitions/site-pair-set"
55686       vpn-bindings:
55687         type: array
55688         items:
55689           $ref: "#/patchDefinitions/vpn-binding"
55690       vpls-pes:
55691         type: array
55692         items:
55693           $ref: "#/patchDefinitions/vpls-pe"
55694       multicast-configurations:
55695         type: array
55696         items:
55697           $ref: "#/patchDefinitions/multicast-configuration"
55698       vces:
55699         type: array
55700         items:
55701           $ref: "#/patchDefinitions/vce"
55702       vnfcs:
55703         type: array
55704         items:
55705           $ref: "#/patchDefinitions/vnfc"
55706       l3-networks:
55707         type: array
55708         items:
55709           $ref: "#/patchDefinitions/l3-network"
55710       network-policies:
55711         type: array
55712         items:
55713           $ref: "#/patchDefinitions/network-policy"
55714       generic-vnfs:
55715         type: array
55716         items:
55717           $ref: "#/patchDefinitions/generic-vnf"
55718       lag-links:
55719         type: array
55720         items:
55721           $ref: "#/patchDefinitions/lag-link"
55722       newvces:
55723         type: array
55724         items:
55725           $ref: "#/patchDefinitions/newvce"
55726       pnfs:
55727         type: array
55728         items:
55729           $ref: "#/patchDefinitions/pnf"
55730       physical-links:
55731         type: array
55732         items:
55733           $ref: "#/patchDefinitions/physical-link"
55734       ipsec-configurations:
55735         type: array
55736         items:
55737           $ref: "#/patchDefinitions/ipsec-configuration"
55738       route-table-references:
55739         type: array
55740         items:
55741           $ref: "#/patchDefinitions/route-table-reference"
55742       instance-groups:
55743         type: array
55744         items:
55745           $ref: "#/patchDefinitions/instance-group"
55746       zones:
55747         type: array
55748         items:
55749           $ref: "#/patchDefinitions/zone"
55750   network-policies:
55751     properties:
55752       network-policy:
55753         type: array
55754         items:
55755           $ref: "#/patchDefinitions/network-policy"
55756   network-policy:
55757     description: |
55758       ###### Related Nodes
55759       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
55760       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55761     required:
55762     - network-policy-id
55763     properties:
55764       network-policy-id:
55765         type: string
55766         description: UUID representing unique key to this instance
55767       network-policy-fqdn:
55768         type: string
55769         description: Contrail FQDN for the policy
55770       heat-stack-id:
55771         type: string
55772         description: ID for the openStack Heat instance
55773   network-profile:
55774     description: |
55775       Network profile populated by SDN-GP for SNMP
55776       ###### Related Nodes
55777       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55778     required:
55779     - nm-profile-name
55780     properties:
55781       nm-profile-name:
55782         type: string
55783         description: Unique name of network profile.
55784       community-string:
55785         type: string
55786         description: Encrypted SNMP community string
55787   network-profiles:
55788     description: |
55789       Collection of network profiles
55790     properties:
55791       network-profile:
55792         type: array
55793         items:
55794           $ref: "#/patchDefinitions/network-profile"
55795   newvce:
55796     description: |
55797       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55798       ###### Related Nodes
55799       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55800       - NEWVCE is DELETED when these are DELETED L-INTERFACE
55801     required:
55802     - vnf-id2
55803     - vnf-name
55804     - vnf-type
55805     properties:
55806       vnf-id2:
55807         type: string
55808         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55809       vnf-name:
55810         type: string
55811         description: Name of VNF.
55812       vnf-name2:
55813         type: string
55814         description: Alternate name of VNF.
55815       vnf-type:
55816         type: string
55817         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
55818       prov-status:
55819         type: string
55820         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55821       operational-status:
55822         type: string
55823         description: Indicator for whether the resource is considered operational
55824       license-key:
55825         type: string
55826         description: OBSOLETE -  do not use
55827       ipv4-oam-address:
55828         type: string
55829         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).
55830       equipment-role:
55831         type: string
55832         description: Client should send valid enumerated value.
55833   newvces:
55834     description: |
55835       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55836     properties:
55837       newvce:
55838         type: array
55839         items:
55840           $ref: "#/patchDefinitions/newvce"
55841   notification-event:
55842     properties:
55843       cambria.partition:
55844         type: string
55845       notification-event-header:
55846         type: object
55847         $ref: "#/patchDefinitions/notification-event-header"
55848   notification-event-header:
55849     properties:
55850       id:
55851         type: string
55852       timestamp:
55853         type: string
55854       source-name:
55855         type: string
55856       domain:
55857         type: string
55858       sequence-number:
55859         type: string
55860       severity:
55861         type: string
55862       event-type:
55863         type: string
55864       version:
55865         type: string
55866       action:
55867         type: string
55868       entity-type:
55869         type: string
55870       top-entity-type:
55871         type: string
55872       entity-link:
55873         type: string
55874       status:
55875         type: string
55876   notify:
55877     required:
55878     - event-id
55879     properties:
55880       event-id:
55881         type: string
55882       node-type:
55883         type: string
55884       event-trigger:
55885         type: string
55886       key-data:
55887         type: array
55888         items:
55889           $ref: "#/patchDefinitions/key-data"
55890       selflink:
55891         type: string
55892   oam-network:
55893     description: |
55894       OAM network, to be deprecated shortly.  Do not use for new purposes.
55895       ###### Related Nodes
55896       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55897       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
55898       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55899     required:
55900     - network-uuid
55901     - network-name
55902     - cvlan-tag
55903     properties:
55904       network-uuid:
55905         type: string
55906         description: UUID of the network. Unique across a cloud-region
55907       network-name:
55908         type: string
55909         description: Name of the network.
55910       cvlan-tag:
55911         type: integer
55912         format: int64
55913         description: cvlan-id
55914       ipv4-oam-gateway-address:
55915         type: string
55916         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55917       ipv4-oam-gateway-address-prefix-length:
55918         type: integer
55919         format: int32
55920         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55921   oam-networks:
55922     description: |
55923       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
55924     properties:
55925       oam-network:
55926         type: array
55927         items:
55928           $ref: "#/patchDefinitions/oam-network"
55929   operational-environment:
55930     description: |
55931       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55932       ###### Related Nodes
55933       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55934       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55935     required:
55936     - operational-environment-id
55937     - operational-environment-name
55938     - operational-environment-type
55939     - operational-environment-status
55940     - tenant-context
55941     - workload-context
55942     properties:
55943       operational-environment-id:
55944         type: string
55945         description: UUID of an operational environment
55946       operational-environment-name:
55947         type: string
55948         description: Operational Environment name
55949       operational-environment-type:
55950         type: string
55951         description: Operational Environment Type.
55952       operational-environment-status:
55953         type: string
55954         description: Status
55955       tenant-context:
55956         type: string
55957         description: Tenant Context.
55958       workload-context:
55959         type: string
55960         description: Workload Context.
55961   operational-environments:
55962     description: |
55963       a logical partition of the cloud which allows to have multiple environments in the production AIC.
55964     properties:
55965       operational-environment:
55966         type: array
55967         items:
55968           $ref: "#/patchDefinitions/operational-environment"
55969   overloaded-model:
55970     description: |
55971       Allows for legacy POST of old-style and new-style models
55972     required:
55973     - model-invariant-id
55974     - model-name-version-id
55975     - model-type
55976     - model-name
55977     - model-id
55978     - model-version
55979     properties:
55980       model-invariant-id:
55981         type: string
55982         description: Unique identifier corresponding to the main definition of a model in ASDC
55983       model-name-version-id:
55984         type: string
55985         description: Unique identifier corresponding to one version of a model in ASDC
55986       model-type:
55987         type: string
55988         description: Type of the model, e.g., service, resource, widget, etc.
55989       model-name:
55990         type: string
55991         description: Name of the model, which can change from version to version.
55992       model-id:
55993         type: string
55994         description: Invariant unique ID which does not change from version to version
55995       model-version:
55996         type: string
55997         description: Version
55998       model-description:
55999         type: string
56000         description: Description
56001   owning-entities:
56002     description: |
56003       Collection of owning-entities
56004     properties:
56005       owning-entity:
56006         type: array
56007         items:
56008           $ref: "#/patchDefinitions/owning-entity"
56009   owning-entity:
56010     description: |
56011       describes an owning-entity
56012       ###### Related Nodes
56013       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
56014     required:
56015     - owning-entity-id
56016     - owning-entity-name
56017     properties:
56018       owning-entity-id:
56019         type: string
56020         description: UUID of an owning entity
56021       owning-entity-name:
56022         type: string
56023         description: Owning entity name
56024   p-interface:
56025     description: |
56026       Physical interface (e.g., nic)
56027       ###### Related Nodes
56028       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
56029       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
56030       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56031       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56032       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
56033       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
56034       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
56035       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
56036       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
56037     required:
56038     - interface-name
56039     - in-maint
56040     properties:
56041       interface-name:
56042         type: string
56043         description: Name that identifies the physical interface
56044       speed-value:
56045         type: string
56046         description: Captures the numeric part of the speed
56047       speed-units:
56048         type: string
56049         description: Captures the units corresponding to the speed
56050       port-description:
56051         type: string
56052         description: Nature of the services and connectivity on this port.
56053       equipment-identifier:
56054         type: string
56055         description: CLEI or other specification for p-interface hardware.
56056       interface-role:
56057         type: string
56058         description: Role specification for p-interface hardware.
56059       interface-type:
56060         type: string
56061         description: Indicates the physical properties of the interface.
56062       prov-status:
56063         type: string
56064         description: Trigger for operational monitoring of this resource by Service Assurance systems.
56065   p-interfaces:
56066     description: |
56067       Collection of physical interfaces.
56068     properties:
56069       p-interface:
56070         type: array
56071         items:
56072           $ref: "#/patchDefinitions/p-interface"
56073   physical-link:
56074     description: |
56075       Collection of physical connections, typically between p-interfaces
56076       ###### Related Nodes
56077       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
56078     required:
56079     - link-name
56080     properties:
56081       link-name:
56082         type: string
56083         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
56084       speed-value:
56085         type: string
56086         description: Captures the numeric part of the speed
56087       speed-units:
56088         type: string
56089         description: Captures the units corresponding to the speed
56090       circuit-id:
56091         type: string
56092         description: Circuit it
56093       dual-mode:
56094         type: string
56095         description: Dual access mode (e.g., primary, secondary
56096       management-option:
56097         type: string
56098         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
56099       service-provider-name:
56100         type: string
56101         description: Name of the service Provider on this link.
56102   physical-links:
56103     description: |
56104       Collection of physical connections, typically between p-interfaces
56105     properties:
56106       physical-link:
56107         type: array
56108         items:
56109           $ref: "#/patchDefinitions/physical-link"
56110   platform:
56111     description: |
56112       describes a platform
56113       ###### Related Nodes
56114       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
56115     required:
56116     - platform-name
56117     properties:
56118       platform-name:
56119         type: string
56120         description: Name of the platform
56121   platforms:
56122     description: |
56123       Collection of platforms
56124     properties:
56125       platform:
56126         type: array
56127         items:
56128           $ref: "#/patchDefinitions/platform"
56129   pnf:
56130     description: |
56131       PNF represents a physical network function. typically equipment used in the D1 world.
56132       ###### Related Nodes
56133       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56134       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56135       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56136       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
56137       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56138       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
56139       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56140       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56141     required:
56142     - pnf-name
56143     - in-maint
56144     properties:
56145       pnf-name:
56146         type: string
56147         description: unique name of Physical Network Function.
56148       pnf-name2:
56149         type: string
56150         description: name of Physical Network Function.
56151       pnf-name2-source:
56152         type: string
56153         description: source of name2
56154       pnf-id:
56155         type: string
56156         description: id of pnf
56157       equip-type:
56158         type: string
56159         description: Equipment type.  Source of truth should define valid values.
56160       equip-vendor:
56161         type: string
56162         description: Equipment vendor.  Source of truth should define valid values.
56163       equip-model:
56164         type: string
56165         description: Equipment model.  Source of truth should define valid values.
56166       management-option:
56167         type: string
56168         description: identifier of managed by company or customer
56169       ipaddress-v4-oam:
56170         type: string
56171         description: ipv4-oam-address with new naming convention for IP addresses
56172       sw-version:
56173         type: string
56174         description: sw-version is the version of SW for the hosted application on the PNF.
56175       in-maint:
56176         type: boolean
56177       frame-id:
56178         type: string
56179         description: ID of the physical frame (relay rack) where pnf is installed.
56180       serial-number:
56181         type: string
56182         description: Serial number of the device
56183       ipaddress-v4-loopback-0:
56184         type: string
56185         description: IPV4 Loopback 0 address
56186       ipaddress-v6-loopback-0:
56187         type: string
56188         description: IPV6 Loopback 0 address
56189       ipaddress-v4-aim:
56190         type: string
56191         description: IPV4 AIM address
56192       ipaddress-v6-aim:
56193         type: string
56194         description: IPV6 AIM address
56195       ipaddress-v6-oam:
56196         type: string
56197         description: IPV6 OAM address
56198       inv-status:
56199         type: string
56200         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
56201   pnfs:
56202     description: |
56203       Collection of Physical Network Functions.
56204     properties:
56205       pnf:
56206         type: array
56207         items:
56208           $ref: "#/patchDefinitions/pnf"
56209   port-group:
56210     description: |
56211       Used to capture the network interfaces of this VCE
56212       ###### Related Nodes
56213       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
56214       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
56215       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
56216     required:
56217     - interface-id
56218     - orchestration-status
56219     properties:
56220       interface-id:
56221         type: string
56222         description: Unique ID of the interface
56223       neutron-network-id:
56224         type: string
56225         description: Neutron network id of this Interface
56226       neutron-network-name:
56227         type: string
56228         description: Neutron network name of this Interface
56229       interface-role:
56230         type: string
56231         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
56232   port-groups:
56233     properties:
56234       port-group:
56235         type: array
56236         items:
56237           $ref: "#/patchDefinitions/port-group"
56238   project:
56239     description: |
56240       describes the project
56241       ###### Related Nodes
56242       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
56243     required:
56244     - project-name
56245     properties:
56246       project-name:
56247         type: string
56248         description: Name of the project deploying a service
56249   projects:
56250     description: |
56251       Collection of projects
56252     properties:
56253       project:
56254         type: array
56255         items:
56256           $ref: "#/patchDefinitions/project"
56257   properties:
56258     description: |
56259       Property holder for query properties or instance properties
56260     properties:
56261       property-name:
56262         type: string
56263       property-value:
56264         type: string
56265   property-constraint:
56266     description: |
56267       TBD
56268       ###### Related Nodes
56269       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56270     required:
56271     - property-constraint-uuid
56272     - constraint-type
56273     - property-name
56274     - property-value
56275     properties:
56276       property-constraint-uuid:
56277         type: string
56278       constraint-type:
56279         type: string
56280       property-name:
56281         type: string
56282       property-value:
56283         type: string
56284   property-constraints:
56285     properties:
56286       property-constraint:
56287         type: array
56288         items:
56289           $ref: "#/patchDefinitions/property-constraint"
56290   pserver:
56291     description: |
56292       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
56293       ###### Related Nodes
56294       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
56295       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56296       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
56297       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56298       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56299       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
56300       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
56301       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56302       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56303       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56304       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
56305       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56306       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
56307     required:
56308     - hostname
56309     - in-maint
56310     properties:
56311       hostname:
56312         type: string
56313         description: Value from executing hostname on the compute node.
56314       ptnii-equip-name:
56315         type: string
56316         description: PTNII name
56317       number-of-cpus:
56318         type: integer
56319         format: int32
56320         description: Number of cpus
56321       disk-in-gigabytes:
56322         type: integer
56323         format: int32
56324         description: Disk size, in GBs
56325       ram-in-megabytes:
56326         type: integer
56327         format: int32
56328         description: RAM size, in MBs
56329       equip-type:
56330         type: string
56331         description: Equipment type.  Source of truth should define valid values.
56332       equip-vendor:
56333         type: string
56334         description: Equipment vendor.  Source of truth should define valid values.
56335       equip-model:
56336         type: string
56337         description: Equipment model.  Source of truth should define valid values.
56338       fqdn:
56339         type: string
56340         description: Fully-qualified domain name
56341       pserver-selflink:
56342         type: string
56343         description: URL to endpoint where AAI can get more details
56344       ipv4-oam-address:
56345         type: string
56346         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
56347       serial-number:
56348         type: string
56349         description: Serial number, may be queried
56350       ipaddress-v4-loopback-0:
56351         type: string
56352         description: IPV4 Loopback 0 address
56353       ipaddress-v6-loopback-0:
56354         type: string
56355         description: IPV6 Loopback 0 address
56356       ipaddress-v4-aim:
56357         type: string
56358         description: IPV4 AIM address
56359       ipaddress-v6-aim:
56360         type: string
56361         description: IPV6 AIM address
56362       ipaddress-v6-oam:
56363         type: string
56364         description: IPV6 OAM address
56365       inv-status:
56366         type: string
56367         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
56368       pserver-id:
56369         type: string
56370         description: ID of Pserver
56371       internet-topology:
56372         type: string
56373         description: internet topology of Pserver
56374       in-maint:
56375         type: boolean
56376   pservers:
56377     description: |
56378       Collection of compute hosts.
56379     properties:
56380       pserver:
56381         type: array
56382         items:
56383           $ref: "#/patchDefinitions/pserver"
56384   query-parameters:
56385     description: |
56386       QueryParameters for performing a named-query or model query
56387     properties:
56388       named-query:
56389         type: object
56390         $ref: "#/patchDefinitions/named-query"
56391       overloaded-model:
56392         type: object
56393         $ref: "#/patchDefinitions/overloaded-model"
56394   related-lookup:
56395     description: |
56396       TBD
56397       ###### Related Nodes
56398       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56399     required:
56400     - related-lookup-uuid
56401     - source-node-type
56402     - source-node-property
56403     - target-node-type
56404     - target-node-property
56405     properties:
56406       related-lookup-uuid:
56407         type: string
56408       source-node-type:
56409         type: string
56410       source-node-property:
56411         type: string
56412       target-node-type:
56413         type: string
56414       target-node-property:
56415         type: string
56416       property-collect-list:
56417         type: string
56418   related-lookups:
56419     properties:
56420       related-lookup:
56421         type: array
56422         items:
56423           $ref: "#/patchDefinitions/related-lookup"
56424   related-to-property:
56425     properties:
56426       property-key:
56427         type: string
56428         description: Key part of a key/value pair
56429       property-value:
56430         type: string
56431         description: Value part of a key/value pair
56432   relationship:
56433     properties:
56434       related-to:
56435         type: string
56436         description: A keyword provided by A&AI to indicate type of node.
56437       related-link:
56438         type: string
56439         description: URL to the object in A&AI.
56440       relationship-data:
56441         type: array
56442         items:
56443           $ref: "#/patchDefinitions/relationship-data"
56444       related-to-property:
56445         type: array
56446         items:
56447           $ref: "#/patchDefinitions/related-to-property"
56448   relationship-data:
56449     required:
56450     - relationship-key
56451     - relationship-value
56452     properties:
56453       relationship-key:
56454         type: string
56455         description: A keyword provided by A&AI to indicate an attribute.
56456       relationship-value:
56457         type: string
56458         description: Value of the attribute.
56459   reserved-prop-names:
56460     description: |
56461       Internal map to define some reserved properties of a vertex
56462     properties:
56463       last-mod-source-of-truth:
56464         type: string
56465       aai-node-type:
56466         type: string
56467       aai-created-ts:
56468         type: integer
56469         format: int64
56470       aai-unique-key:
56471         type: string
56472       aai-last-mod-ts:
56473         type: integer
56474         format: int64
56475       source-of-truth:
56476         type: string
56477       aai-uri:
56478         type: string
56479   response-list:
56480     description: |
56481       Response container for the results of a named-query or model query
56482     properties:
56483       inventory-response-items:
56484         type: object
56485         $ref: "#/patchDefinitions/inventory-response-items"
56486   result-data:
56487     properties:
56488       resource-type:
56489         type: string
56490         description: The specific type of node in the A&AI graph
56491       resource-link:
56492         type: string
56493         description: The URL to the specific resource
56494   route-table-reference:
56495     description: |
56496       Openstack route table reference.
56497       ###### Related Nodes
56498       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56499     required:
56500     - route-table-reference-id
56501     - route-table-reference-fqdn
56502     properties:
56503       route-table-reference-id:
56504         type: string
56505         description: Route Table Reference id, UUID assigned to this instance.
56506       route-table-reference-fqdn:
56507         type: string
56508         description: FQDN entry in the route table.
56509   route-table-references:
56510     description: |
56511       Collection of openstack route table references
56512     properties:
56513       route-table-reference:
56514         type: array
56515         items:
56516           $ref: "#/patchDefinitions/route-table-reference"
56517   route-target:
56518     description: |
56519       Route target information
56520       ###### Related Nodes
56521       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
56522     required:
56523     - global-route-target
56524     - route-target-role
56525     properties:
56526       global-route-target:
56527         type: string
56528         description: Number used to identify an RT, globally unique in the network
56529       route-target-role:
56530         type: string
56531         description: Role assigned to this route target
56532   route-targets:
56533     description: |
56534       Collection of route target information
56535     properties:
56536       route-target:
56537         type: array
56538         items:
56539           $ref: "#/patchDefinitions/route-target"
56540   routing-instance:
56541     description: |
56542       ###### Related Nodes
56543       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56544       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56545       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
56546     required:
56547     - routing-instance-id
56548     properties:
56549       routing-instance-id:
56550         type: string
56551         description: Unique id of routing instance
56552       rpm-owner:
56553         type: string
56554         description: rpm owner
56555   routing-instances:
56556     description: |
56557       set of probes related to generic-vnf routing instance
56558     properties:
56559       routing-instance:
56560         type: array
56561         items:
56562           $ref: "#/patchDefinitions/routing-instance"
56563   sdn-zone-response:
56564     properties:
56565       oam-networks:
56566         type: object
56567         $ref: "#/patchDefinitions/oam-networks"
56568       az-and-dvs-switches:
56569         type: array
56570         items:
56571           $ref: "#/patchDefinitions/az-and-dvs-switches"
56572   search:
56573     properties:
56574       edge-tag-query-result:
56575         type: object
56576         $ref: "#/patchDefinitions/edge-tag-query-result"
56577       edge-tag-query-request:
56578         type: object
56579         $ref: "#/patchDefinitions/edge-tag-query-request"
56580       search-results:
56581         type: object
56582         $ref: "#/patchDefinitions/search-results"
56583       sdn-zone-response:
56584         type: object
56585         $ref: "#/patchDefinitions/sdn-zone-response"
56586   search-results:
56587     properties:
56588       result-data:
56589         type: array
56590         items:
56591           $ref: "#/patchDefinitions/result-data"
56592   secondary-filt:
56593     description: |
56594       SecondaryFilt for performing a named-query or model query
56595   secondary-filter:
56596     properties:
56597       property-name:
56598         type: string
56599       filter-type:
56600         type: string
56601       property-value:
56602         type: string
56603   secondary-filts:
56604     description: |
56605       SecondaryFilts for performing a named-query or model query
56606     properties:
56607       secondary-filt:
56608         type: array
56609         items:
56610           $ref: "#/patchDefinitions/secondary-filt"
56611   segmentation-assignment:
56612     description: |
56613       Openstack segmentation assignment.
56614       ###### Related Nodes
56615       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56616     required:
56617     - segmentation-id
56618     properties:
56619       segmentation-id:
56620         type: string
56621         description: Route Table Reference id, UUID assigned to this instance.
56622   segmentation-assignments:
56623     description: |
56624       Collection of openstack segmentation assignments
56625     properties:
56626       segmentation-assignment:
56627         type: array
56628         items:
56629           $ref: "#/patchDefinitions/segmentation-assignment"
56630   service:
56631     description: |
56632       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
56633     required:
56634     - service-id
56635     - service-description
56636     properties:
56637       service-id:
56638         type: string
56639         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56640       service-description:
56641         type: string
56642         description: Description of the service
56643       service-selflink:
56644         type: string
56645         description: URL to endpoint where AAI can get more details
56646   service-capabilities:
56647     description: |
56648       Collection of service capabilities.
56649     properties:
56650       service-capability:
56651         type: array
56652         items:
56653           $ref: "#/patchDefinitions/service-capability"
56654   service-capability:
56655     description: |
56656       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
56657       ###### Related Nodes
56658       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56659       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56660       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
56661     required:
56662     - service-type
56663     - vnf-type
56664     properties:
56665       service-type:
56666         type: string
56667         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56668       vnf-type:
56669         type: string
56670         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
56671   service-design-and-creation:
56672     description: |
56673       Namespace for objects managed by ASDC
56674     properties:
56675       vnf-images:
56676         type: array
56677         items:
56678           $ref: "#/patchDefinitions/vnf-image"
56679       services:
56680         type: array
56681         items:
56682           $ref: "#/patchDefinitions/service"
56683       service-capabilities:
56684         type: array
56685         items:
56686           $ref: "#/patchDefinitions/service-capability"
56687       models:
56688         type: array
56689         items:
56690           $ref: "#/patchDefinitions/model"
56691       named-queries:
56692         type: array
56693         items:
56694           $ref: "#/patchDefinitions/named-query"
56695   service-instance:
56696     description: |
56697       Instance of a service
56698       ###### Related Nodes
56699       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
56700       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56701       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
56702       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
56703       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
56704       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
56705       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56706       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56707       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56708       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56709       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56710       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56711       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56712       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56713       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56714       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56715       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
56716       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56717     required:
56718     - service-instance-id
56719     properties:
56720       service-instance-id:
56721         type: string
56722         description: Uniquely identifies this instance of a service
56723       service-instance-name:
56724         type: string
56725         description: This field will store a name assigned to the service-instance.
56726       model-invariant-id:
56727         type: string
56728         description: the ASDC model id for this resource or service model.
56729       model-version-id:
56730         type: string
56731         description: the ASDC model version for this resource or service model.
56732       persona-model-version:
56733         type: string
56734         description: the ASDC model version for this resource or service model.
56735       widget-model-id:
56736         type: string
56737         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56738       widget-model-version:
56739         type: string
56740         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56741       bandwidth-total:
56742         type: string
56743         description: Indicates the total bandwidth to be used for this service.
56744       bandwidth-up-wan1:
56745         type: string
56746         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56747       bandwidth-down-wan1:
56748         type: string
56749         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56750       bandwidth-up-wan2:
56751         type: string
56752         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56753       bandwidth-down-wan2:
56754         type: string
56755         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56756       vhn-portal-url:
56757         type: string
56758         description: URL customers will use to access the vHN Portal.
56759       service-instance-location-id:
56760         type: string
56761         description: An identifier that customers assign to the location where this service is being used.
56762   service-instances:
56763     description: |
56764       Collection of service instances
56765     properties:
56766       service-instance:
56767         type: array
56768         items:
56769           $ref: "#/patchDefinitions/service-instance"
56770   service-subscription:
56771     description: |
56772       Object that group service instances.
56773       ###### Related Nodes
56774       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
56775       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56776       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56777       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
56778     required:
56779     - service-type
56780     properties:
56781       service-type:
56782         type: string
56783         description: Value defined by orchestration to identify this service across ECOMP.
56784       temp-ub-sub-account-id:
56785         type: string
56786         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56787   service-subscriptions:
56788     description: |
56789       Collection of objects that group service instances.
56790     properties:
56791       service-subscription:
56792         type: array
56793         items:
56794           $ref: "#/patchDefinitions/service-subscription"
56795   services:
56796     description: |
56797       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
56798     properties:
56799       service:
56800         type: array
56801         items:
56802           $ref: "#/patchDefinitions/service"
56803   site-pair:
56804     description: |
56805       ###### Related Nodes
56806       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56807       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56808       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
56809     required:
56810     - site-pair-id
56811     properties:
56812       site-pair-id:
56813         type: string
56814         description: unique identifier of probe
56815       source-ip:
56816         type: string
56817         description: Prefix address
56818       destination-ip:
56819         type: string
56820         description: Prefix address
56821       ip-version:
56822         type: string
56823         description: ip version, v4, v6
56824       destination-hostname:
56825         type: string
56826         description: Hostname of the destination equipment to which SLAs are measured against.
56827       destination-equip-type:
56828         type: string
56829         description: The type of destinatination equipment. Could be Router, etc.
56830   site-pair-set:
56831     description: |
56832       Set of instances for probes used to measure service level agreements
56833       ###### Related Nodes
56834       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56835       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56836       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
56837     required:
56838     - site-pair-set-id
56839     properties:
56840       site-pair-set-id:
56841         type: string
56842         description: Unique id of site pair set.
56843   site-pair-sets:
56844     description: |
56845       Collection of sets of instances for probes related to generic-vnf
56846     properties:
56847       site-pair-set:
56848         type: array
56849         items:
56850           $ref: "#/patchDefinitions/site-pair-set"
56851   site-pairs:
56852     description: |
56853       probe within a set
56854     properties:
56855       site-pair:
56856         type: array
56857         items:
56858           $ref: "#/patchDefinitions/site-pair"
56859   snapshot:
56860     description: |
56861       Openstack snapshot
56862       ###### Related Nodes
56863       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56864       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56865     required:
56866     - snapshot-id
56867     properties:
56868       snapshot-id:
56869         type: string
56870         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56871       snapshot-name:
56872         type: string
56873         description: Snapshot name
56874       snapshot-architecture:
56875         type: string
56876         description: Operating system architecture
56877       snapshot-os-distro:
56878         type: string
56879         description: The common name of the operating system distribution in lowercase
56880       snapshot-os-version:
56881         type: string
56882         description: The operating system version as specified by the distributor.
56883       application:
56884         type: string
56885         description: The application that the image instantiates.
56886       application-vendor:
56887         type: string
56888         description: The vendor of the application.
56889       application-version:
56890         type: string
56891         description: The version of the application.
56892       snapshot-selflink:
56893         type: string
56894         description: URL to endpoint where AAI can get more details
56895       prev-snapshot-id:
56896         type: string
56897         description: This field contains the UUID of the previous snapshot (if any).
56898   snapshots:
56899     description: |
56900       Collection of openstack snapshots
56901     properties:
56902       snapshot:
56903         type: array
56904         items:
56905           $ref: "#/patchDefinitions/snapshot"
56906   sriov-pf:
56907     description: |
56908       SR-IOV Physical Function
56909       ###### Related Nodes
56910       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56911       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56912     required:
56913     - pf-pci-id
56914     properties:
56915       pf-pci-id:
56916         type: string
56917         description: Identifier for the sriov-pf
56918   sriov-pfs:
56919     description: |
56920       Collection of SR-IOV Physical Functions.
56921     properties:
56922       sriov-pf:
56923         type: array
56924         items:
56925           $ref: "#/patchDefinitions/sriov-pf"
56926   sriov-vf:
56927     description: |
56928       SR-IOV Virtual Function (not to be confused with virtual network function)
56929       ###### Related Nodes
56930       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56931     required:
56932     - pci-id
56933     properties:
56934       pci-id:
56935         type: string
56936         description: PCI ID used to identify the sriov-vf
56937       vf-vlan-filter:
56938         type: string
56939         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56940       vf-mac-filter:
56941         type: string
56942         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56943       vf-vlan-strip:
56944         type: boolean
56945         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56946       vf-vlan-anti-spoof-check:
56947         type: boolean
56948         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.
56949       vf-mac-anti-spoof-check:
56950         type: boolean
56951         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.
56952       vf-mirrors:
56953         type: string
56954         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56955       vf-broadcast-allow:
56956         type: boolean
56957         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56958       vf-unknown-multicast-allow:
56959         type: boolean
56960         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56961       vf-unknown-unicast-allow:
56962         type: boolean
56963         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56964       vf-insert-stag:
56965         type: boolean
56966         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56967       vf-link-status:
56968         type: string
56969         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
56970   sriov-vfs:
56971     description: |
56972       Collection of SR-IOV Virtual Functions.
56973     properties:
56974       sriov-vf:
56975         type: array
56976         items:
56977           $ref: "#/patchDefinitions/sriov-vf"
56978   start-node-filter:
56979     properties:
56980       property-name:
56981         type: string
56982       property-value:
56983         type: string
56984   subnet:
56985     description: |
56986       ###### Related Nodes
56987       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56988       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56989       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56990       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
56991     required:
56992     - subnet-id
56993     - dhcp-enabled
56994     properties:
56995       subnet-id:
56996         type: string
56997         description: Subnet ID, should be UUID.
56998       subnet-name:
56999         type: string
57000         description: Name associated with the subnet.
57001       neutron-subnet-id:
57002         type: string
57003         description: Neutron id of this subnet
57004       gateway-address:
57005         type: string
57006         description: gateway ip address
57007       network-start-address:
57008         type: string
57009         description: network start address
57010       cidr-mask:
57011         type: string
57012         description: cidr mask
57013       ip-version:
57014         type: string
57015         description: ip version
57016       orchestration-status:
57017         type: string
57018         description: Orchestration status of this VNF, mastered by MSO
57019       dhcp-enabled:
57020         type: boolean
57021       dhcp-start:
57022         type: string
57023         description: the start address reserved for use by dhcp
57024       dhcp-end:
57025         type: string
57026         description: the last address reserved for use by dhcp
57027   subnets:
57028     properties:
57029       subnet:
57030         type: array
57031         items:
57032           $ref: "#/patchDefinitions/subnet"
57033   tagged-inventory-item-list:
57034     properties:
57035       inventory-item:
57036         type: array
57037         items:
57038           $ref: "#/patchDefinitions/inventory-item"
57039   tenant:
57040     description: |
57041       Openstack tenant
57042       ###### Related Nodes
57043       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57044       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
57045       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57046       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57047       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
57048       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57049       - TENANT cannot be deleted if linked to VSERVER
57050     required:
57051     - tenant-id
57052     - tenant-name
57053     properties:
57054       tenant-id:
57055         type: string
57056         description: Unique id relative to the cloud-region.
57057       tenant-name:
57058         type: string
57059         description: Readable name of tenant
57060   tenants:
57061     description: |
57062       Collection of openstack tenants.
57063     properties:
57064       tenant:
57065         type: array
57066         items:
57067           $ref: "#/patchDefinitions/tenant"
57068   tunnel-xconnect:
57069     description: |
57070       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
57071       ###### Related Nodes
57072       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57073     required:
57074     - id
57075     - bandwidth-up-wan1
57076     - bandwidth-down-wan1
57077     - bandwidth-up-wan2
57078     - bandwidth-down-wan2
57079     properties:
57080       id:
57081         type: string
57082         description: Allotted Resource id UUID assigned to this instance.
57083       bandwidth-up-wan1:
57084         type: string
57085         description: The WAN uplink bandwidth for WAN1
57086       bandwidth-down-wan1:
57087         type: string
57088         description: The WAN downlink bandwidth for WAN1
57089       bandwidth-up-wan2:
57090         type: string
57091         description: The WAN uplink bandwidth for WAN2
57092       bandwidth-down-wan2:
57093         type: string
57094         description: The WAN downlink bandwidth for WAN2
57095   tunnel-xconnects:
57096     description: |
57097       This object is used to store the specific tunnel cross connect aspects of an allotted resource
57098     properties:
57099       tunnel-xconnect:
57100         type: array
57101         items:
57102           $ref: "#/patchDefinitions/tunnel-xconnect"
57103   update:
57104     description: |
57105       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
57106     required:
57107     - update-node-type
57108     properties:
57109       update-node-type:
57110         type: string
57111       update-node-key:
57112         type: array
57113         items:
57114           $ref: "#/patchDefinitions/update-node-key"
57115       update-node-uri:
57116         type: string
57117       action:
57118         type: array
57119         items:
57120           $ref: "#/patchDefinitions/action"
57121   update-node-key:
57122     properties:
57123       key-name:
57124         type: string
57125       key-value:
57126         type: string
57127   vce:
57128     description: |
57129       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
57130       ###### Related Nodes
57131       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57132       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
57133       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57134       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57135       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57136       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57137       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
57138       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
57139     required:
57140     - vnf-id
57141     - vnf-name
57142     - vnf-type
57143     properties:
57144       vnf-id:
57145         type: string
57146         description: Unique id of VNF.  This is unique across the graph.
57147       vnf-name:
57148         type: string
57149         description: Name of VNF.
57150       vnf-name2:
57151         type: string
57152         description: Alternate name of VNF.
57153       vnf-type:
57154         type: string
57155         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
57156       service-id:
57157         type: string
57158         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
57159       regional-resource-zone:
57160         type: string
57161         description: Regional way of organizing pservers, source of truth should define values
57162       prov-status:
57163         type: string
57164         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57165       operational-status:
57166         type: string
57167         description: Indicator for whether the resource is considered operational
57168       license-key:
57169         type: string
57170         description: OBSOLETE -  do not use
57171       equipment-role:
57172         type: string
57173         description: Network role being played by this VNF
57174       orchestration-status:
57175         type: string
57176         description: Orchestration status of this VNF, mastered by MSO
57177       heat-stack-id:
57178         type: string
57179         description: Heat stack id corresponding to this instance, managed by MSO
57180       mso-catalog-key:
57181         type: string
57182         description: Corresponds to the SDN-C catalog id used to configure this VCE
57183       vpe-id:
57184         type: string
57185         description: Unique ID of VPE connected to this VCE.
57186       v6-vce-wan-address:
57187         type: string
57188         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
57189       ipv4-oam-address:
57190         type: string
57191         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
57192   vces:
57193     description: |
57194       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
57195     properties:
57196       vce:
57197         type: array
57198         items:
57199           $ref: "#/patchDefinitions/vce"
57200   vf-module:
57201     description: |
57202       a deployment unit of VNFCs
57203       ###### Related Nodes
57204       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57205       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
57206       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57207       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57208       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57209       - VF-MODULE cannot be deleted if linked to VNFC
57210     required:
57211     - vf-module-id
57212     - is-base-vf-module
57213     properties:
57214       vf-module-id:
57215         type: string
57216         description: Unique ID of vf-module.
57217       vf-module-name:
57218         type: string
57219         description: Name of vf-module
57220       heat-stack-id:
57221         type: string
57222         description: Heat stack id corresponding to this instance.
57223       orchestration-status:
57224         type: string
57225         description: orchestration status of this vf-module, mastered by MSO
57226       is-base-vf-module:
57227         type: boolean
57228   vf-modules:
57229     description: |
57230       Collection of vf-modules, a deployment unit of VNFCs
57231     properties:
57232       vf-module:
57233         type: array
57234         items:
57235           $ref: "#/patchDefinitions/vf-module"
57236   vig-server:
57237     description: |
57238       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
57239       ###### Related Nodes
57240       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
57241     required:
57242     - vig-address-type
57243     properties:
57244       vig-address-type:
57245         type: string
57246         description: indicates whether the VIG is for AVPN or INTERNET
57247       ipaddress-v4-vig:
57248         type: string
57249         description: v4 IP of the vig server
57250       ipaddress-v6-vig:
57251         type: string
57252         description: v6 IP of the vig server
57253   vig-servers:
57254     properties:
57255       vig-server:
57256         type: array
57257         items:
57258           $ref: "#/patchDefinitions/vig-server"
57259   vip-ipv4-address-list:
57260     description: |
57261       IPv4 Address Range
57262       ###### Related Nodes
57263       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57264       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57265       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57266       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
57267     required:
57268     - vip-ipv4-address
57269     properties:
57270       vip-ipv4-address:
57271         type: string
57272         description: IP address
57273       vip-ipv4-prefix-length:
57274         type: integer
57275         format: int64
57276         description: Prefix length, 32 for single address
57277       vlan-id-inner:
57278         type: integer
57279         format: int64
57280         description: Inner VLAN tag
57281       vlan-id-outer:
57282         type: integer
57283         format: int64
57284         description: Outer VLAN tag
57285       is-floating:
57286         type: boolean
57287         description: Indicator of fixed or floating address
57288   vip-ipv6-address-list:
57289     description: |
57290       IPv6 Address Range
57291       ###### Related Nodes
57292       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57293       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57294       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57295       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57296     required:
57297     - vip-ipv6-address
57298     properties:
57299       vip-ipv6-address:
57300         type: string
57301         description: IP address
57302       vip-ipv6-prefix-length:
57303         type: integer
57304         format: int64
57305         description: Prefix length, 128 for single address
57306       vlan-id-inner:
57307         type: integer
57308         format: int64
57309         description: Inner VLAN tag
57310       vlan-id-outer:
57311         type: integer
57312         format: int64
57313         description: Outer VLAN tag
57314       is-floating:
57315         type: boolean
57316         description: Indicator of fixed or floating address
57317   virtual-data-center:
57318     description: |
57319       Virtual organization of cloud infrastructure elements in a data center context
57320       ###### Related Nodes
57321       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57322       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57323       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57324     required:
57325     - vdc-id
57326     - vdc-name
57327     properties:
57328       vdc-id:
57329         type: string
57330         description: Unique ID of the vdc
57331       vdc-name:
57332         type: string
57333         description: Name of the virtual data center
57334   virtual-data-centers:
57335     description: |
57336       Virtual organization of cloud infrastructure elements in a data center context
57337     properties:
57338       virtual-data-center:
57339         type: array
57340         items:
57341           $ref: "#/patchDefinitions/virtual-data-center"
57342   vlan:
57343     description: |
57344       Definition of vlan
57345       ###### Related Nodes
57346       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
57347       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57348       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57349       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57350       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57351       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57352       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57353       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57354       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57355     required:
57356     - vlan-interface
57357     - in-maint
57358     properties:
57359       vlan-interface:
57360         type: string
57361         description: String that identifies the interface
57362       vlan-id-inner:
57363         type: integer
57364         format: int64
57365         description: Inner VLAN tag
57366       vlan-id-outer:
57367         type: integer
57368         format: int64
57369         description: Outer VLAN tag
57370   vlans:
57371     properties:
57372       vlan:
57373         type: array
57374         items:
57375           $ref: "#/patchDefinitions/vlan"
57376   vnf:
57377     description: |
57378       Abstract vnf class
57379     required:
57380     - vnf-id
57381     properties:
57382       vnf-id:
57383         type: string
57384         description: Unique id of VNF.  This is unique across the graph.
57385   vnf-image:
57386     description: |
57387       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
57388       ###### Related Nodes
57389       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57390       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
57391     required:
57392     - vnf-image-uuid
57393     - application
57394     - application-vendor
57395     properties:
57396       vnf-image-uuid:
57397         type: string
57398         description: Unique ID of this asset
57399       application:
57400         type: string
57401         description: The application that the image instantiates.
57402       application-vendor:
57403         type: string
57404         description: The vendor of the application.
57405       application-version:
57406         type: string
57407         description: The version of the application.
57408       selflink:
57409         type: string
57410         description: URL to endpoint where AAI can get more details
57411   vnf-images:
57412     description: |
57413       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
57414     properties:
57415       vnf-image:
57416         type: array
57417         items:
57418           $ref: "#/patchDefinitions/vnf-image"
57419   vnfc:
57420     description: |
57421       ###### Related Nodes
57422       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57423       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57424       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57425     required:
57426     - vnfc-name
57427     - vnfc-function-code
57428     - vnfc-type
57429     - in-maint
57430     - is-closed-loop-disabled
57431     properties:
57432       vnfc-name:
57433         type: string
57434         description: Unique ID of vnfc.
57435       vnfc-function-code:
57436         type: string
57437         description: function code
57438       vnfc-type:
57439         type: string
57440         description: type
57441       prov-status:
57442         type: string
57443         description: prov status of this vnfc
57444       orchestration-status:
57445         type: string
57446         description: Orchestration status of this VNF, mastered by APP-C
57447       ipaddress-v4-oam-vip:
57448         type: string
57449         description: Oam V4 vip address of this vnfc
57450       in-maint:
57451         type: boolean
57452       is-closed-loop-disabled:
57453         type: boolean
57454       group-notation:
57455         type: string
57456         description: Group notation of VNFC
57457   vnfcs:
57458     description: |
57459       virtual network components associated with a vserver from application controller.
57460     properties:
57461       vnfc:
57462         type: array
57463         items:
57464           $ref: "#/patchDefinitions/vnfc"
57465   volume:
57466     description: |
57467       Ephemeral Block storage volume.
57468       ###### Related Nodes
57469       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
57470     required:
57471     - volume-id
57472     - volume-selflink
57473     properties:
57474       volume-id:
57475         type: string
57476         description: Unique ID of block storage volume relative to the vserver.
57477       volume-selflink:
57478         type: string
57479         description: URL to endpoint where AAI can get more details
57480   volume-group:
57481     description: |
57482       Persistent block-level storage.
57483       ###### Related Nodes
57484       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57485       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57486       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57487       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57488       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57489     required:
57490     - volume-group-id
57491     - volume-group-name
57492     - vnf-type
57493     properties:
57494       volume-group-id:
57495         type: string
57496         description: Unique ID of volume-group.
57497       volume-group-name:
57498         type: string
57499         description: Name of the volume group.
57500       heat-stack-id:
57501         type: string
57502         description: Heat stack id corresponding to this volume-group
57503       vnf-type:
57504         type: string
57505         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
57506       orchestration-status:
57507         type: string
57508         description: Orchestration status of this volume-group
57509       model-customization-id:
57510         type: string
57511         description: captures the id of all the configuration used to customize the resource for the service.
57512       vf-module-model-customization-id:
57513         type: string
57514         description: helps relate the volume group to the vf-module whose components will require the volume group
57515   volume-groups:
57516     description: |
57517       Collection of persistent block-level storage.
57518     properties:
57519       volume-group:
57520         type: array
57521         items:
57522           $ref: "#/patchDefinitions/volume-group"
57523   volumes:
57524     description: |
57525       Collection of ephemeral Block storage volumes.
57526     properties:
57527       volume:
57528         type: array
57529         items:
57530           $ref: "#/patchDefinitions/volume"
57531   vpls-pe:
57532     description: |
57533       VPLS Provider Edge routers.
57534       ###### Related Nodes
57535       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57536       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57537       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57538       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57539       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57540     required:
57541     - equipment-name
57542     properties:
57543       equipment-name:
57544         type: string
57545       prov-status:
57546         type: string
57547         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57548       ipv4-oam-address:
57549         type: string
57550         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).
57551       equipment-role:
57552         type: string
57553         description: Client should send valid enumerated value, e.g., VPLS-PE.
57554       vlan-id-outer:
57555         type: integer
57556         format: int64
57557         description: Temporary location for stag to get to VCE
57558   vpls-pes:
57559     description: |
57560       Collection of VPLS Provider Edge routers
57561     properties:
57562       vpls-pe:
57563         type: array
57564         items:
57565           $ref: "#/patchDefinitions/vpls-pe"
57566   vpn-binding:
57567     description: |
57568       VPN binding
57569       ###### Related Nodes
57570       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57571       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57572       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
57573       - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
57574       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
57575     required:
57576     - vpn-id
57577     - vpn-name
57578     properties:
57579       vpn-id:
57580         type: string
57581         description: VPN ID, globally unique within A&AI
57582       vpn-name:
57583         type: string
57584         description: VPN Name
57585       vpn-platform:
57586         type: string
57587         description: the platform associated with the VPN example AVPN, Mobility
57588       vpn-type:
57589         type: string
57590         description: Type of the vpn, should be taken from enumerated/valid values
57591       route-distinguisher:
57592         type: string
57593         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
57594   vpn-bindings:
57595     properties:
57596       vpn-binding:
57597         type: array
57598         items:
57599           $ref: "#/patchDefinitions/vpn-binding"
57600   vserver:
57601     description: |
57602       Virtual Servers, aka virtual machine or VM.
57603       ###### Related Nodes
57604       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57605       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57606       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
57607       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57608       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57609       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
57610       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57611       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57612       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
57613       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57614       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57615       - VSERVER is DELETED when these are DELETED L-INTERFACE
57616       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
57617     required:
57618     - vserver-id
57619     - vserver-name
57620     - vserver-selflink
57621     - in-maint
57622     - is-closed-loop-disabled
57623     properties:
57624       vserver-id:
57625         type: string
57626         description: Unique identifier for this vserver relative to its tenant
57627       vserver-name:
57628         type: string
57629         description: Name of vserver
57630       vserver-name2:
57631         type: string
57632         description: Alternative name of vserver
57633       prov-status:
57634         type: string
57635         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57636       vserver-selflink:
57637         type: string
57638         description: URL to endpoint where AAI can get more details
57639       in-maint:
57640         type: boolean
57641       is-closed-loop-disabled:
57642         type: boolean
57643   vservers:
57644     description: |
57645       Collection of virtual Servers, aka virtual machines or VMs.
57646     properties:
57647       vserver:
57648         type: array
57649         items:
57650           $ref: "#/patchDefinitions/vserver"
57651   zone:
57652     description: |
57653       A zone is a grouping of assets in a location homing to the same connections into the CBB
57654       ###### Related Nodes
57655       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57656       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57657       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57658       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57659     required:
57660     - zone-id
57661     - zone-name
57662     - design-type
57663     - zone-context
57664     properties:
57665       zone-id:
57666         type: string
57667         description: Code assigned by AIC to the zone
57668       zone-name:
57669         type: string
57670         description: English name associated with the zone
57671       design-type:
57672         type: string
57673         description: Design of zone [Medium/Large?]
57674       zone-context:
57675         type: string
57676         description: Context of zone [production/test]
57677       status:
57678         type: string
57679         description: Status of a zone.
57680   zones:
57681     description: |
57682       Collection of zones
57683     properties:
57684       zone:
57685         type: array
57686         items:
57687           $ref: "#/patchDefinitions/zone"
57688 getDefinitions:
57689   aai-internal:
57690     properties:
57691       property-name:
57692         type: string
57693       property-value:
57694         type: string
57695   action:
57696     properties:
57697       action-type:
57698         type: string
57699       action-data:
57700         type: array
57701         items:
57702           $ref: "#/getDefinitions/action-data"
57703   action-data:
57704     properties:
57705       property-name:
57706         type: string
57707       property-value:
57708         type: string
57709   actions:
57710     description: |
57711       APIs that are more action related than REST (e.g., notify, update).
57712     properties:
57713       update:
57714         type: object
57715         $ref: "#/getDefinitions/update"
57716       notify:
57717         type: object
57718         $ref: "#/getDefinitions/notify"
57719   allotted-resource:
57720     description: |
57721       Represents a slice or partial piece of a resource that gets separately allotted
57722       ###### Related Nodes
57723       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
57724       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57725       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
57726       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
57727       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57728       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
57729       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57730       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
57731       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
57732     required:
57733     - id
57734     properties:
57735       id:
57736         type: string
57737         description: Allotted Resource id UUID assigned to this instance.
57738       description:
57739         type: string
57740         description: The descriptive information assigned to this allotted resource instance
57741       selflink:
57742         type: string
57743         description: Link back to more information in the controller
57744       model-invariant-id:
57745         type: string
57746         description: the ASDC model id for this resource or service model.
57747       model-version-id:
57748         type: string
57749         description: the ASDC model version for this resource or service model.
57750       persona-model-version:
57751         type: string
57752         description: the ASDC model version for this resource or service model.
57753       resource-version:
57754         type: string
57755         description: Concurrency value
57756       orchestration-status:
57757         type: string
57758         description: Orchestration status
57759       operational-status:
57760         type: string
57761         description: Indicator for whether the resource is considered operational
57762       type:
57763         type: string
57764         description: Generic description of the type of allotted resource.
57765       role:
57766         type: string
57767         description: role in the network that this resource will be providing.
57768       tunnel-xconnects:
57769         type: array
57770         items:
57771           $ref: "#/getDefinitions/tunnel-xconnect"
57772       relationship-list:
57773         type: array
57774         items:
57775           $ref: "#/getDefinitions/relationship"
57776   allotted-resources:
57777     description: |
57778       This object is used to store slices of services being offered
57779     properties:
57780       allotted-resource:
57781         type: array
57782         items:
57783           $ref: "#/getDefinitions/allotted-resource"
57784   availability-zone:
57785     description: |
57786       Availability zone, a collection of compute hosts/pservers
57787       ###### Related Nodes
57788       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57789       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57790       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57791       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57792       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57793       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57794       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
57795       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57796       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
57797     required:
57798     - availability-zone-name
57799     - hypervisor-type
57800     properties:
57801       availability-zone-name:
57802         type: string
57803         description: Name of the availability zone.  Unique across a cloud region
57804       hypervisor-type:
57805         type: string
57806         description: Type of hypervisor.  Source of truth should define valid values.
57807       operational-status:
57808         type: string
57809         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
57810       resource-version:
57811         type: string
57812         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57813       relationship-list:
57814         type: array
57815         items:
57816           $ref: "#/getDefinitions/relationship"
57817   availability-zones:
57818     description: |
57819       Collection of availability zones
57820     properties:
57821       availability-zone:
57822         type: array
57823         items:
57824           $ref: "#/getDefinitions/availability-zone"
57825   az-and-dvs-switches:
57826     properties:
57827       dvs-switches:
57828         type: object
57829         $ref: "#/getDefinitions/dvs-switches"
57830       availability-zone:
57831         type: object
57832         $ref: "#/getDefinitions/availability-zone"
57833   business:
57834     description: |
57835       Namespace for business related constructs
57836     properties:
57837       connectors:
57838         type: array
57839         items:
57840           $ref: "#/getDefinitions/connector"
57841       customers:
57842         type: array
57843         items:
57844           $ref: "#/getDefinitions/customer"
57845   class-of-service:
57846     description: |
57847       ###### Related Nodes
57848       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
57849     required:
57850     - cos
57851     properties:
57852       cos:
57853         type: string
57854         description: unique identifier of probe
57855       probe-id:
57856         type: string
57857         description: identifier of probe
57858       probe-type:
57859         type: string
57860         description: type of probe
57861       resource-version:
57862         type: string
57863         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57864       relationship-list:
57865         type: array
57866         items:
57867           $ref: "#/getDefinitions/relationship"
57868   classes-of-service:
57869     description: |
57870       class-of-service of probe
57871     properties:
57872       class-of-service:
57873         type: array
57874         items:
57875           $ref: "#/getDefinitions/class-of-service"
57876   cloud-infrastructure:
57877     description: |
57878       Namespace for cloud infrastructure.
57879     properties:
57880       complexes:
57881         type: array
57882         items:
57883           $ref: "#/getDefinitions/complex"
57884       cloud-regions:
57885         type: array
57886         items:
57887           $ref: "#/getDefinitions/cloud-region"
57888       network-profiles:
57889         type: array
57890         items:
57891           $ref: "#/getDefinitions/network-profile"
57892       pservers:
57893         type: array
57894         items:
57895           $ref: "#/getDefinitions/pserver"
57896       virtual-data-centers:
57897         type: array
57898         items:
57899           $ref: "#/getDefinitions/virtual-data-center"
57900   cloud-region:
57901     description: |
57902       cloud-region designates an installation of a cloud cluster or region or instantiation
57903       ###### Related Nodes
57904       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57905       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57906       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57907       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57908       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57909       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57910       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57911       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57912       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57913       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57914       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57915       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57916       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
57917       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
57918       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VOLUME-GROUP
57919       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
57920     required:
57921     - cloud-owner
57922     - cloud-region-id
57923     properties:
57924       cloud-owner:
57925         type: string
57926         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
57927       cloud-region-id:
57928         type: string
57929         description: Identifier used by the vendor for the region. Second part of composite key
57930       cloud-type:
57931         type: string
57932         description: Type of the cloud (e.g., openstack)
57933       owner-defined-type:
57934         type: string
57935         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
57936       cloud-region-version:
57937         type: string
57938         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
57939       identity-url:
57940         type: string
57941         description: URL of the keystone identity service
57942       cloud-zone:
57943         type: string
57944         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57945       complex-name:
57946         type: string
57947         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
57948       resource-version:
57949         type: string
57950         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57951       volume-groups:
57952         type: array
57953         items:
57954           $ref: "#/getDefinitions/volume-group"
57955       tenants:
57956         type: array
57957         items:
57958           $ref: "#/getDefinitions/tenant"
57959       flavors:
57960         type: array
57961         items:
57962           $ref: "#/getDefinitions/flavor"
57963       group-assignments:
57964         type: array
57965         items:
57966           $ref: "#/getDefinitions/group-assignment"
57967       snapshots:
57968         type: array
57969         items:
57970           $ref: "#/getDefinitions/snapshot"
57971       images:
57972         type: array
57973         items:
57974           $ref: "#/getDefinitions/image"
57975       dvs-switches:
57976         type: array
57977         items:
57978           $ref: "#/getDefinitions/dvs-switch"
57979       oam-networks:
57980         type: array
57981         items:
57982           $ref: "#/getDefinitions/oam-network"
57983       availability-zones:
57984         type: array
57985         items:
57986           $ref: "#/getDefinitions/availability-zone"
57987       relationship-list:
57988         type: array
57989         items:
57990           $ref: "#/getDefinitions/relationship"
57991   cloud-regions:
57992     properties:
57993       cloud-region:
57994         type: array
57995         items:
57996           $ref: "#/getDefinitions/cloud-region"
57997   complex:
57998     description: |
57999       Collection of physical locations that can house cloud-regions.
58000       ###### Related Nodes
58001       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58002       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58003       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58004       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58005       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
58006       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58007       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58008       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58009       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58010       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58011       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58012       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
58013       - COMPLEX is DELETED when these are DELETED CTAG-POOL
58014     required:
58015     - physical-location-id
58016     - physical-location-type
58017     - street1
58018     - city
58019     - postal-code
58020     - country
58021     - region
58022     properties:
58023       physical-location-id:
58024         type: string
58025         description: Unique identifier for physical location, e.g., CLLI
58026       data-center-code:
58027         type: string
58028         description: Data center code which can be an alternate way to identify a complex
58029       complex-name:
58030         type: string
58031         description: Gamma complex name for LCP instance.
58032       identity-url:
58033         type: string
58034         description: URL of the keystone identity service
58035       resource-version:
58036         type: string
58037         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58038       physical-location-type:
58039         type: string
58040         description: Type, e.g., central office, data center.
58041       street1:
58042         type: string
58043       street2:
58044         type: string
58045       city:
58046         type: string
58047       state:
58048         type: string
58049       postal-code:
58050         type: string
58051       country:
58052         type: string
58053       region:
58054         type: string
58055       latitude:
58056         type: string
58057       longitude:
58058         type: string
58059       elevation:
58060         type: string
58061       lata:
58062         type: string
58063       ctag-pools:
58064         type: array
58065         items:
58066           $ref: "#/getDefinitions/ctag-pool"
58067       relationship-list:
58068         type: array
58069         items:
58070           $ref: "#/getDefinitions/relationship"
58071   complexes:
58072     description: |
58073       Collection of physical locations that can house cloud-regions.
58074     properties:
58075       complex:
58076         type: array
58077         items:
58078           $ref: "#/getDefinitions/complex"
58079   configuration:
58080     description: |
58081       Port Mirror Configuration.
58082       ###### Related Nodes
58083       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
58084       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58085       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
58086       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58087       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58088       - CONFIGURATION is DELETED when these are DELETED METADATUM
58089       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
58090     required:
58091     - configuration-id
58092     - configuration-type
58093     - configuration-sub-type
58094     - orchestration-status
58095     - operational-status
58096     - configuration-selflink
58097     - model-customization-id
58098     properties:
58099       configuration-id:
58100         type: string
58101         description: UUID assigned to configuration.
58102       management-option:
58103         type: string
58104         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
58105       configuration-name:
58106         type: string
58107         description: Name of the configuration.
58108       configuration-type:
58109         type: string
58110         description: port-mirroring-configuration.
58111       configuration-sub-type:
58112         type: string
58113         description: vprobe, pprobe.
58114       model-invariant-id:
58115         type: string
58116         description: the ASDC model id for this resource or service model.
58117       model-version-id:
58118         type: string
58119         description: the ASDC model version for this resource or service model.
58120       orchestration-status:
58121         type: string
58122         description: Orchestration status of the configuration.
58123       operational-status:
58124         type: string
58125         description: Indicator for whether the resource is considered operational.
58126       configuration-selflink:
58127         type: string
58128         description: URL to endpoint where AAI can get more details from SDN-GC.
58129       model-customization-id:
58130         type: string
58131         description: id of  the configuration used to customize the resource
58132       resource-version:
58133         type: string
58134         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58135       relationship-list:
58136         type: array
58137         items:
58138           $ref: "#/getDefinitions/relationship"
58139       metadata:
58140         type: array
58141         items:
58142           $ref: "#/getDefinitions/metadatum"
58143   configurations:
58144     description: |
58145       Collection of configurations
58146     properties:
58147       configuration:
58148         type: array
58149         items:
58150           $ref: "#/getDefinitions/configuration"
58151   connector:
58152     description: |
58153       Collection of resource instances used to connect a variety of disparate inventory widgets
58154       ###### Related Nodes
58155       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58156       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
58157       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
58158       - CONNECTOR is DELETED when these are DELETED METADATUM
58159     required:
58160     - resource-instance-id
58161     properties:
58162       resource-instance-id:
58163         type: string
58164         description: Unique id of resource instance.
58165       resource-version:
58166         type: string
58167         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58168       model-invariant-id:
58169         type: string
58170         description: the ASDC model id for this resource or service model.
58171       model-version-id:
58172         type: string
58173         description: the ASDC model version for this resource or service model.
58174       persona-model-version:
58175         type: string
58176         description: the ASDC model version for this resource or service model.
58177       widget-model-id:
58178         type: string
58179         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
58180       widget-model-version:
58181         type: string
58182         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
58183       relationship-list:
58184         type: array
58185         items:
58186           $ref: "#/getDefinitions/relationship"
58187       metadata:
58188         type: array
58189         items:
58190           $ref: "#/getDefinitions/metadatum"
58191   connectors:
58192     description: |
58193       Collection of resource instances used to connect a variety of disparate inventory widgets
58194     properties:
58195       connector:
58196         type: array
58197         items:
58198           $ref: "#/getDefinitions/connector"
58199   constrained-element-set:
58200     description: |
58201       This is how we would capture constraints defining allowed sets of elements.
58202       ###### Related Nodes
58203       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
58204       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
58205       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58206       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
58207     required:
58208     - constrained-element-set-uuid
58209     - constraint-type
58210     - check-type
58211     properties:
58212       constrained-element-set-uuid:
58213         type: string
58214       constraint-type:
58215         type: string
58216       check-type:
58217         type: string
58218       resource-version:
58219         type: string
58220       element-choice-sets:
58221         type: array
58222         items:
58223           $ref: "#/getDefinitions/element-choice-set"
58224       relationship-list:
58225         type: array
58226         items:
58227           $ref: "#/getDefinitions/relationship"
58228   constrained-element-sets:
58229     properties:
58230       constrained-element-set:
58231         type: array
58232         items:
58233           $ref: "#/getDefinitions/constrained-element-set"
58234   ctag-assignment:
58235     description: |
58236       ###### Related Nodes
58237       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58238       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
58239     required:
58240     - vlan-id-inner
58241     properties:
58242       vlan-id-inner:
58243         type: integer
58244         format: int64
58245         description: id.
58246       resource-version:
58247         type: string
58248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58249       relationship-list:
58250         type: array
58251         items:
58252           $ref: "#/getDefinitions/relationship"
58253   ctag-assignments:
58254     properties:
58255       ctag-assignment:
58256         type: array
58257         items:
58258           $ref: "#/getDefinitions/ctag-assignment"
58259   ctag-pool:
58260     description: |
58261       A collection of C tags (vlan tags) grouped for a specific purpose.
58262       ###### Related Nodes
58263       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58264       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58265       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58266     required:
58267     - target-pe
58268     - availability-zone-name
58269     - ctag-pool-purpose
58270     properties:
58271       target-pe:
58272         type: string
58273         description: The Target provider edge router
58274       availability-zone-name:
58275         type: string
58276         description: Name of the availability zone
58277       ctag-pool-purpose:
58278         type: string
58279         description: Describes what the intended purpose of this pool is.
58280       ctag-values:
58281         type: string
58282         description: Comma separated list of ctags
58283       resource-version:
58284         type: string
58285         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58286       relationship-list:
58287         type: array
58288         items:
58289           $ref: "#/getDefinitions/relationship"
58290   ctag-pools:
58291     properties:
58292       ctag-pool:
58293         type: array
58294         items:
58295           $ref: "#/getDefinitions/ctag-pool"
58296   customer:
58297     description: |
58298       customer identifiers to provide linkage back to BSS information.
58299       ###### Related Nodes
58300       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
58301       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
58302     required:
58303     - global-customer-id
58304     - subscriber-name
58305     - subscriber-type
58306     properties:
58307       global-customer-id:
58308         type: string
58309         description: Global customer id used across ECOMP to uniquely identify customer.
58310       subscriber-name:
58311         type: string
58312         description: Subscriber name, an alternate way to retrieve a customer.
58313       subscriber-type:
58314         type: string
58315         description: Subscriber type, a way to provide VID with only the INFRA customers.
58316       resource-version:
58317         type: string
58318         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58319       service-subscriptions:
58320         type: array
58321         items:
58322           $ref: "#/getDefinitions/service-subscription"
58323       relationship-list:
58324         type: array
58325         items:
58326           $ref: "#/getDefinitions/relationship"
58327   customers:
58328     description: |
58329       Collection of customer identifiers to provide linkage back to BSS information.
58330     properties:
58331       customer:
58332         type: array
58333         items:
58334           $ref: "#/getDefinitions/customer"
58335   cvlan-tag-entry:
58336     required:
58337     - cvlan-tag
58338     properties:
58339       cvlan-tag:
58340         type: integer
58341         format: int64
58342         description: See mis-na-virtualization-platform.yang
58343       resource-version:
58344         type: string
58345         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58346       relationship-list:
58347         type: array
58348         items:
58349           $ref: "#/getDefinitions/relationship"
58350   cvlan-tags:
58351     properties:
58352       cvlan-tag-entry:
58353         type: array
58354         items:
58355           $ref: "#/getDefinitions/cvlan-tag-entry"
58356   dvs-switch:
58357     description: |
58358       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.
58359       ###### Related Nodes
58360       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58361       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58362     required:
58363     - switch-name
58364     - vcenter-url
58365     properties:
58366       switch-name:
58367         type: string
58368         description: DVS switch name
58369       vcenter-url:
58370         type: string
58371         description: URL used to reach the vcenter
58372       resource-version:
58373         type: string
58374         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58375       relationship-list:
58376         type: array
58377         items:
58378           $ref: "#/getDefinitions/relationship"
58379   dvs-switches:
58380     description: |
58381       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
58382     properties:
58383       dvs-switch:
58384         type: array
58385         items:
58386           $ref: "#/getDefinitions/dvs-switch"
58387   edge-prop-names:
58388     description: |
58389       Internal map to define the properties of an edge and interpret the map EdgeRules
58390     properties:
58391       edgeLabel:
58392         type: string
58393       direction:
58394         type: string
58395       multiplicityRule:
58396         type: string
58397       isParent:
58398         type: boolean
58399       usesResource:
58400         type: boolean
58401       hasDelTarget:
58402         type: boolean
58403       SVC-INFRA:
58404         type: boolean
58405       SVC-INFRA-REV:
58406         type: boolean
58407   edge-tag-query-request:
58408     properties:
58409       edge-tag:
58410         type: string
58411       result-detail:
58412         type: string
58413       start-node-type:
58414         type: string
58415       start-node-filter:
58416         type: array
58417         items:
58418           $ref: "#/getDefinitions/start-node-filter"
58419       include-node-filter:
58420         type: array
58421         items:
58422           $ref: "#/getDefinitions/include-node-filter"
58423       secondary-filter:
58424         type: array
58425         items:
58426           $ref: "#/getDefinitions/secondary-filter"
58427   edge-tag-query-result:
58428     properties:
58429       tagged-inventory-item-list:
58430         type: array
58431         items:
58432           $ref: "#/getDefinitions/tagged-inventory-item-list"
58433   element-choice-set:
58434     description: |
58435       This is how we would capture constraints defining allowed sets of elements.
58436       ###### Related Nodes
58437       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58438       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
58439       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
58440     required:
58441     - element-choice-set-uuid
58442     - element-choice-set-name
58443     properties:
58444       element-choice-set-uuid:
58445         type: string
58446       element-choice-set-name:
58447         type: string
58448       cardinality:
58449         type: string
58450       resource-version:
58451         type: string
58452       model-elements:
58453         type: array
58454         items:
58455           $ref: "#/getDefinitions/model-element"
58456       relationship-list:
58457         type: array
58458         items:
58459           $ref: "#/getDefinitions/relationship"
58460   element-choice-sets:
58461     properties:
58462       element-choice-set:
58463         type: array
58464         items:
58465           $ref: "#/getDefinitions/element-choice-set"
58466   entitlement:
58467     description: |
58468       Metadata for entitlement group.
58469       ###### Related Nodes
58470       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58471       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58472     required:
58473     - group-uuid
58474     - resource-uuid
58475     properties:
58476       group-uuid:
58477         type: string
58478         description: Unique ID for the entitlement group the resource comes from, should be uuid.
58479       resource-uuid:
58480         type: string
58481         description: Unique ID of an entitlement resource.
58482       resource-version:
58483         type: string
58484         description: Concurrency value
58485       relationship-list:
58486         type: array
58487         items:
58488           $ref: "#/getDefinitions/relationship"
58489   entitlements:
58490     description: |
58491       Entitlements, keyed by group-uuid and resource-uuid, related to license management
58492     properties:
58493       entitlement:
58494         type: array
58495         items:
58496           $ref: "#/getDefinitions/entitlement"
58497   esr-ems:
58498     description: |
58499       Persist EMS address information used by EMS driver.
58500       ###### Related Nodes
58501       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
58502       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58503     required:
58504     - ems-id
58505     properties:
58506       ems-id:
58507         type: string
58508         description: Unique ID of EMS.
58509       resource-version:
58510         type: string
58511         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58512       esr-system-info-list:
58513         type: object
58514         $ref: "#/getDefinitions/esr-system-info-list"
58515       relationship-list:
58516         type: object
58517         $ref: "#/getDefinitions/relationship-list"
58518   esr-ems-list:
58519     properties:
58520       esr-ems:
58521         type: array
58522         items:
58523           $ref: "#/getDefinitions/esr-ems"
58524   esr-system-info:
58525     description: |
58526       Persist common address information of external systems.
58527       ###### Related Nodes
58528       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
58529       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
58530       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
58531       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
58532     required:
58533     - esr-system-info-id
58534     - user-name
58535     - password
58536     - system-type
58537     properties:
58538       esr-system-info-id:
58539         type: string
58540         description: Unique ID of esr system info.
58541       system-name:
58542         type: string
58543         description: name of external system.
58544       type:
58545         type: string
58546         description: type of external systems.
58547       vendor:
58548         type: string
58549         description: vendor of external systems.
58550       version:
58551         type: string
58552         description: version of external systems.
58553       service-url:
58554         type: string
58555         description: url used to access external systems.
58556       user-name:
58557         type: string
58558         description: username used to access external systems.
58559       password:
58560         type: string
58561         description: password used to access external systems.
58562       system-type:
58563         type: string
58564         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
58565       protocol:
58566         type: string
58567         description: protocol of third party SDNC, for example netconf/snmp.
58568       ssl-cacert:
58569         type: string
58570         description: ca file content if enabled ssl on auth-url.
58571       ssl-insecure:
58572         type: boolean
58573         description: Whether to verify VIM's certificate.
58574       ip-address:
58575         type: string
58576         description: service IP of ftp server.
58577       port:
58578         type: string
58579         description: service port of ftp server.
58580       cloud-domain:
58581         type: string
58582         description: domain info for authentication.
58583       default-tenant:
58584         type: string
58585         description: default tenant of VIM.
58586       passive:
58587         type: boolean
58588         description: ftp passive mode or not.
58589       remote-path:
58590         type: string
58591         description: resource or performance data file path.
58592       system-status:
58593         type: string
58594         description: the status of external system.
58595       resource-version:
58596         type: string
58597         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58598       relationship-list:
58599         type: array
58600         items:
58601           $ref: "#/getDefinitions/relationship"
58602   esr-system-info-list:
58603     description: |
58604       Collection of persistent block-level external system auth info.
58605     properties:
58606       esr-system-info:
58607         type: array
58608         items:
58609           $ref: "#/getDefinitions/esr-system-info"
58610   esr-thirdparty-sdnc:
58611     description: |
58612       Persist SDNC address information used by ONAP SDNC.
58613       ###### Related Nodes
58614       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
58615       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
58616       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58617     required:
58618     - thirdparty-sdnc-id
58619     properties:
58620       thirdparty-sdnc-id:
58621         type: string
58622         description: Unique ID of SDNC.
58623       location:
58624         type: string
58625         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
58626       product-name:
58627         type: string
58628         description: password used to access SDNC server.
58629       resource-version:
58630         type: string
58631         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58632       esr-system-info-list:
58633         type: object
58634         $ref: "#/getDefinitions/esr-system-info-list"
58635       relationship-list:
58636         type: object
58637         $ref: "#/getDefinitions/relationship-list"
58638   esr-thirdparty-sdnc-list:
58639     properties:
58640       esr-thirdparty-sdnc:
58641         type: array
58642         items:
58643           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
58644   esr-vnfm:
58645     description: |
58646       Persist VNFM address information used by VF-C.
58647       ###### Related Nodes
58648       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
58649       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58650     required:
58651     - vnfm-id
58652     properties:
58653       vnfm-id:
58654         type: string
58655         description: Unique ID of VNFM.
58656       vim-id:
58657         type: string
58658         description: indecate the VIM to deploy VNF.
58659       certificate-url:
58660         type: string
58661         description: certificate url of VNFM.
58662       resource-version:
58663         type: string
58664         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58665       esr-system-info-list:
58666         type: object
58667         $ref: "#/getDefinitions/esr-system-info-list"
58668       relationship-list:
58669         type: object
58670         $ref: "#/getDefinitions/relationship-list"
58671   esr-vnfm-list:
58672     properties:
58673       esr-vnfm:
58674         type: array
58675         items:
58676           $ref: "#/getDefinitions/esr-vnfm"
58677   evc:
58678     description: |
58679       evc object is an optional child object of the Configuration object.
58680       ###### Related Nodes
58681       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58682     required:
58683     - evc-id
58684     properties:
58685       evc-id:
58686         type: string
58687         description: Unique/key field for the evc object
58688       forwarding-path-topology:
58689         type: string
58690         description: Point-to-Point, Multi-Point
58691       cir-value:
58692         type: string
58693         description: Commited Information Rate
58694       cir-units:
58695         type: string
58696         description: CIR units
58697       connection-diversity-group-id:
58698         type: string
58699         description: Diversity Group ID
58700       service-hours:
58701         type: string
58702         description: formerly Performance Group
58703       esp-evc-circuit-id:
58704         type: string
58705         description: EVC Circuit ID of ESP EVC
58706       esp-evc-cir-value:
58707         type: string
58708         description: Committed Information Rate (For ESP)
58709       esp-evc-cir-units:
58710         type: string
58711         description: CIR units (For ESP)
58712       esp-itu-code:
58713         type: string
58714         description: Identifies ESP
58715       collector-pop-clli:
58716         type: string
58717         description: Collector POP CLLI (from the hostname of the access pnf)
58718       inter-connect-type-ingress:
58719         type: string
58720         description: Interconnect type on ingress side of EVC.
58721       tagmode-access-ingress:
58722         type: string
58723         description: tagode for collector side of EVC
58724       tagmode-access-egress:
58725         type: string
58726         description: tagMode for network side of EVC
58727       relationship-list:
58728         type: array
58729         items:
58730           $ref: "#/getDefinitions/relationship"
58731       resource-version:
58732         type: string
58733         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58734   evcs:
58735     properties:
58736       evc:
58737         type: array
58738         items:
58739           $ref: "#/getDefinitions/evc"
58740   external-system:
58741     description: |
58742       Namespace for external system.
58743     properties:
58744       esr-ems-list:
58745         type: object
58746         $ref: "#/getDefinitions/esr-ems-list"
58747       esr-vnfm-list:
58748         type: object
58749         $ref: "#/getDefinitions/esr-vnfm-list"
58750       esr-thirdparty-sdnc-list:
58751         type: object
58752         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
58753   extra-properties:
58754     description: |
58755       Extra properties for inventory item for response list
58756     properties:
58757       extra-property:
58758         type: array
58759         items:
58760           $ref: "#/getDefinitions/extra-property"
58761   extra-property:
58762     properties:
58763       property-name:
58764         type: string
58765       property-value:
58766         type: string
58767   flavor:
58768     description: |
58769       Openstack flavor.
58770       ###### Related Nodes
58771       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58772       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
58773       - FLAVOR cannot be deleted if linked to VSERVER
58774     required:
58775     - flavor-id
58776     - flavor-name
58777     - flavor-selflink
58778     properties:
58779       flavor-id:
58780         type: string
58781         description: Flavor id, expected to be unique across cloud-region.
58782       flavor-name:
58783         type: string
58784         description: Flavor name
58785       flavor-vcpus:
58786         type: integer
58787         format: int32
58788         description: Number of CPUs
58789       flavor-ram:
58790         type: integer
58791         format: int32
58792         description: Amount of memory
58793       flavor-disk:
58794         type: integer
58795         format: int32
58796         description: Disk space
58797       flavor-ephemeral:
58798         type: integer
58799         format: int32
58800         description: Amount of ephemeral disk space
58801       flavor-swap:
58802         type: string
58803         description: amount of swap space allocation
58804       flavor-is-public:
58805         type: boolean
58806         description: whether flavor is available to all users or private to the tenant it was created in.
58807       flavor-selflink:
58808         type: string
58809         description: URL to endpoint where AAI can get more details
58810       flavor-disabled:
58811         type: boolean
58812         description: Boolean as to whether this flavor is no longer enabled
58813       resource-version:
58814         type: string
58815         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
58816       relationship-list:
58817         type: array
58818         items:
58819           $ref: "#/getDefinitions/relationship"
58820   flavors:
58821     description: |
58822       Collection of openstack flavors.
58823     properties:
58824       flavor:
58825         type: array
58826         items:
58827           $ref: "#/getDefinitions/flavor"
58828   forwarder:
58829     description: |
58830       Entity describing a sequenced segment of forwarding path
58831       ###### Related Nodes
58832       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58833       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
58834       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58835       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
58836       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
58837       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
58838     required:
58839     - sequence
58840     properties:
58841       sequence:
58842         type: integer
58843         format: int32
58844         description: Unique ID of this segmentation
58845       forwarder-role:
58846         type: string
58847         description: ingress, intermediate, egress
58848       relationship-list:
58849         type: array
58850         items:
58851           $ref: "#/getDefinitions/relationship"
58852       resource-version:
58853         type: string
58854         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58855   forwarder-evc:
58856     description: |
58857       forwarder object is an optional child object of the Configuration object.
58858       ###### Related Nodes
58859       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58860     required:
58861     - forwarder-evc-id
58862     properties:
58863       forwarder-evc-id:
58864         type: string
58865         description: Key for forwarder-evc object
58866       circuit-id:
58867         type: string
58868         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58869       ivlan:
58870         type: string
58871         description: Internal VLAN.
58872       svlan:
58873         type: string
58874         description: SVLAN value for ingress of egress forwarder.
58875       cvlan:
58876         type: string
58877         description: CVLAN value for ingress of egress forwarder.
58878       relationship-list:
58879         type: array
58880         items:
58881           $ref: "#/getDefinitions/relationship"
58882       resource-version:
58883         type: string
58884         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58885   forwarder-evcs:
58886     properties:
58887       forwarder-evc:
58888         type: array
58889         items:
58890           $ref: "#/getDefinitions/forwarder-evc"
58891   forwarders:
58892     properties:
58893       forwarder:
58894         type: array
58895         items:
58896           $ref: "#/getDefinitions/forwarder"
58897   forwarding-path:
58898     description: |
58899       Entity that describes the sequenced forwarding path between interfaces of services or resources
58900       ###### Related Nodes
58901       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
58902       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58903       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58904       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
58905       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
58906     required:
58907     - forwarding-path-id
58908     - forwarding-path-name
58909     properties:
58910       forwarding-path-id:
58911         type: string
58912         description: Unique ID of this FP
58913       forwarding-path-name:
58914         type: string
58915         description: Name of the FP
58916       relationship-list:
58917         type: array
58918         items:
58919           $ref: "#/getDefinitions/relationship"
58920       resource-version:
58921         type: string
58922         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
58923       selflink:
58924         type: string
58925         description: the self link for this FP
58926       forwarders:
58927         type: array
58928         items:
58929           $ref: "#/getDefinitions/forwarder"
58930   forwarding-paths:
58931     properties:
58932       forwarding-path:
58933         type: array
58934         items:
58935           $ref: "#/getDefinitions/forwarding-path"
58936   generic-vnf:
58937     description: |
58938       General purpose VNF
58939       ###### Related Nodes
58940       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58941       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58942       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
58943       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58944       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
58945       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
58946       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
58947       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58948       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
58949       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58950       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
58951       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58952       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58953       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58954       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58955       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58956       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58957       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
58958       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58959       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58960       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
58961       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
58962     required:
58963     - vnf-id
58964     - vnf-name
58965     - vnf-type
58966     - in-maint
58967     - is-closed-loop-disabled
58968     properties:
58969       vnf-id:
58970         type: string
58971         description: Unique id of VNF.  This is unique across the graph.
58972       vnf-name:
58973         type: string
58974         description: Name of VNF.
58975       vnf-name2:
58976         type: string
58977         description: Alternate name of VNF.
58978       vnf-type:
58979         type: string
58980         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
58981       service-id:
58982         type: string
58983         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
58984       regional-resource-zone:
58985         type: string
58986         description: Regional way of organizing pservers, source of truth should define values
58987       prov-status:
58988         type: string
58989         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58990       operational-status:
58991         type: string
58992         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
58993       license-key:
58994         type: string
58995         description: OBSOLETE -  do not use
58996       equipment-role:
58997         type: string
58998         description: Client should send valid enumerated value
58999       orchestration-status:
59000         type: string
59001         description: Orchestration status of this VNF, used by MSO.
59002       heat-stack-id:
59003         type: string
59004         description: Heat stack id corresponding to this instance, managed by MSO
59005       mso-catalog-key:
59006         type: string
59007         description: Corresponds to the SDN-C catalog id used to configure this VCE
59008       management-option:
59009         type: string
59010         description: identifier of managed by company or customer
59011       ipv4-oam-address:
59012         type: string
59013         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
59014       ipv4-loopback0-address:
59015         type: string
59016         description: v4 Loopback0 address
59017       nm-lan-v6-address:
59018         type: string
59019         description: v6 Loopback address
59020       management-v6-address:
59021         type: string
59022         description: v6 management address
59023       vcpu:
59024         type: integer
59025         format: int64
59026         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
59027       vcpu-units:
59028         type: string
59029         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only in some usecases
59030       vmemory:
59031         type: integer
59032         format: int64
59033         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
59034       vmemory-units:
59035         type: string
59036         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only in some usecases
59037       vdisk:
59038         type: integer
59039         format: int64
59040         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only in some usecases
59041       vdisk-units:
59042         type: string
59043         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only in some usecases
59044       in-maint:
59045         type: boolean
59046       is-closed-loop-disabled:
59047         type: boolean
59048       resource-version:
59049         type: string
59050         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59051       summary-status:
59052         type: string
59053         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
59054       encrypted-access-flag:
59055         type: boolean
59056         description: indicates whether generic-vnf access uses SSH
59057       entitlement-assignment-group-uuid:
59058         type: string
59059         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
59060       entitlement-resource-uuid:
59061         type: string
59062         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
59063       license-assignment-group-uuid:
59064         type: string
59065         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
59066       license-key-uuid:
59067         type: string
59068         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
59069       model-invariant-id:
59070         type: string
59071         description: the ASDC model id for this resource or service model.
59072       model-version-id:
59073         type: string
59074         description: the ASDC model version for this resource or service model.
59075       persona-model-version:
59076         type: string
59077         description: the ASDC model version for this resource or service model.
59078       model-customization-id:
59079         type: string
59080         description: captures the id of all the configuration used to customize the resource for the service.
59081       widget-model-id:
59082         type: string
59083         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59084       widget-model-version:
59085         type: string
59086         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59087       as-number:
59088         type: string
59089         description: as-number of the VNF
59090       regional-resource-subzone:
59091         type: string
59092         description: represents sub zone of the rr plane
59093       nf-type:
59094         type: string
59095         description: Generic description of the type of NF
59096       nf-function:
59097         type: string
59098         description: English description of Network function that the specific VNF deployment is providing
59099       nf-role:
59100         type: string
59101         description: role in the network that this model will be providing
59102       nf-naming-code:
59103         type: string
59104         description: string assigned to this model used for naming purposes
59105       selflink:
59106         type: string
59107         description: Path to the controller object.
59108       relationship-list:
59109         type: array
59110         items:
59111           $ref: "#/getDefinitions/relationship"
59112       l-interfaces:
59113         type: array
59114         items:
59115           $ref: "#/getDefinitions/l-interface"
59116       lag-interfaces:
59117         type: array
59118         items:
59119           $ref: "#/getDefinitions/lag-interface"
59120       vf-modules:
59121         type: array
59122         items:
59123           $ref: "#/getDefinitions/vf-module"
59124       licenses:
59125         type: array
59126         items:
59127           $ref: "#/getDefinitions/license"
59128       entitlements:
59129         type: array
59130         items:
59131           $ref: "#/getDefinitions/entitlement"
59132   generic-vnfs:
59133     description: |
59134       Collection of VNFs
59135     properties:
59136       generic-vnf:
59137         type: array
59138         items:
59139           $ref: "#/getDefinitions/generic-vnf"
59140   group-assignment:
59141     description: |
59142       Openstack group-assignment used to store exclusivity groups (EG).
59143       ###### Related Nodes
59144       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59145       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
59146       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
59147     required:
59148     - group-id
59149     - group-type
59150     - group-name
59151     properties:
59152       group-id:
59153         type: string
59154         description: Group id, expected to be unique across cloud-region.
59155       group-type:
59156         type: string
59157         description: Group type - the type of group this instance refers to
59158       group-name:
59159         type: string
59160         description: Group name - name assigned to the group
59161       group-description:
59162         type: string
59163         description: Group description - description of the group
59164       resource-version:
59165         type: string
59166         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59167       relationship-list:
59168         type: array
59169         items:
59170           $ref: "#/getDefinitions/relationship"
59171   group-assignments:
59172     description: |
59173       Collection of openstack group assignments
59174     properties:
59175       group-assignment:
59176         type: array
59177         items:
59178           $ref: "#/getDefinitions/group-assignment"
59179   host-route:
59180     description: |
59181       ###### Related Nodes
59182       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
59183     required:
59184     - host-route-id
59185     - route-prefix
59186     - next-hop
59187     properties:
59188       host-route-id:
59189         type: string
59190         description: host-route id
59191       route-prefix:
59192         type: string
59193         description: subnet prefix
59194       next-hop:
59195         type: string
59196         description: Could be ip-address, hostname, or service-instance
59197       next-hop-type:
59198         type: string
59199         description: Should be ip-address, hostname, or service-instance to match next-hop
59200       resource-version:
59201         type: string
59202         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59203       relationship-list:
59204         type: array
59205         items:
59206           $ref: "#/getDefinitions/relationship"
59207   host-routes:
59208     properties:
59209       host-route:
59210         type: array
59211         items:
59212           $ref: "#/getDefinitions/host-route"
59213   image:
59214     description: |
59215       Openstack image.
59216       ###### Related Nodes
59217       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59218       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59219       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
59220       - IMAGE cannot be deleted if linked to VSERVER
59221       - IMAGE is DELETED when these are DELETED METADATUM
59222     required:
59223     - image-id
59224     - image-name
59225     - image-os-distro
59226     - image-os-version
59227     - image-selflink
59228     properties:
59229       image-id:
59230         type: string
59231         description: Image id, expected to be unique across cloud region
59232       image-name:
59233         type: string
59234         description: Image name
59235       image-architecture:
59236         type: string
59237         description: Operating system architecture.
59238       image-os-distro:
59239         type: string
59240         description: The common name of the operating system distribution in lowercase
59241       image-os-version:
59242         type: string
59243         description: The operating system version as specified by the distributor.
59244       application:
59245         type: string
59246         description: The application that the image instantiates.
59247       application-vendor:
59248         type: string
59249         description: The vendor of the application.
59250       application-version:
59251         type: string
59252         description: The version of the application.
59253       image-selflink:
59254         type: string
59255         description: URL to endpoint where AAI can get more details
59256       resource-version:
59257         type: string
59258         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59259       relationship-list:
59260         type: array
59261         items:
59262           $ref: "#/getDefinitions/relationship"
59263       metadata:
59264         type: array
59265         items:
59266           $ref: "#/getDefinitions/metadatum"
59267   images:
59268     description: |
59269       Collectio of Openstack images.
59270     properties:
59271       image:
59272         type: array
59273         items:
59274           $ref: "#/getDefinitions/image"
59275   include-node-filter:
59276     properties:
59277       include-node-type:
59278         type: string
59279   instance-filter:
59280     description: |
59281       InstanceFilter for performing a named-query or model query
59282   instance-filters:
59283     description: |
59284       InstanceFilters for performing a named-query or model query
59285     properties:
59286       instance-filter:
59287         type: array
59288         items:
59289           $ref: "#/getDefinitions/instance-filter"
59290   instance-group:
59291     description: |
59292       General mechanism for grouping instances
59293       ###### Related Nodes
59294       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59295       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59296       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59297       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59298       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59299       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59300       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59301       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59302     required:
59303     - id
59304     - description
59305     - type
59306     properties:
59307       id:
59308         type: string
59309         description: Instance Group ID, UUID assigned to this instance.
59310       description:
59311         type: string
59312         description: Descriptive text to help identify the usage of this instance-group
59313       type:
59314         type: string
59315         description: Only valid value today is lower case ha for high availability
59316       sub-type:
59317         type: string
59318         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
59319       resource-version:
59320         type: string
59321         description: Concurrency value
59322       relationship-list:
59323         type: array
59324         items:
59325           $ref: "#/getDefinitions/relationship"
59326   instance-groups:
59327     description: |
59328       Collection of openstack route table references
59329     properties:
59330       instance-group:
59331         type: array
59332         items:
59333           $ref: "#/getDefinitions/instance-group"
59334   inventory:
59335     properties:
59336       search:
59337         type: object
59338         $ref: "#/getDefinitions/search"
59339       actions:
59340         type: object
59341         $ref: "#/getDefinitions/actions"
59342       cloud-infrastructure:
59343         type: object
59344         $ref: "#/getDefinitions/cloud-infrastructure"
59345       business:
59346         type: object
59347         $ref: "#/getDefinitions/business"
59348       service-design-and-creation:
59349         type: object
59350         $ref: "#/getDefinitions/service-design-and-creation"
59351       network:
59352         type: object
59353         $ref: "#/getDefinitions/network"
59354       aai-internal:
59355         type: object
59356         $ref: "#/getDefinitions/aai-internal"
59357       nodes:
59358         type: array
59359         items:
59360           $ref: "#/getDefinitions/aai-internal"
59361   inventory-item:
59362     properties:
59363       inventory-item-type:
59364         type: string
59365       inventory-item-link:
59366         type: string
59367       inventory-item-data:
59368         type: array
59369         items:
59370           $ref: "#/getDefinitions/inventory-item-data"
59371       tagged-inventory-item-list:
59372         type: array
59373         items:
59374           $ref: "#/getDefinitions/tagged-inventory-item-list"
59375   inventory-item-data:
59376     properties:
59377       property-name:
59378         type: string
59379       property-value:
59380         type: string
59381   inventory-response-item:
59382     description: |
59383       Inventory item for response list
59384     properties:
59385       model-name:
59386         type: string
59387       extra-properties:
59388         type: object
59389         $ref: "#/getDefinitions/extra-properties"
59390       inventory-response-items:
59391         type: object
59392         $ref: "#/getDefinitions/inventory-response-items"
59393   inventory-response-items:
59394     description: |
59395       Container for inventory items in response list
59396     properties:
59397       inventory-response-item:
59398         type: array
59399         items:
59400           $ref: "#/getDefinitions/inventory-response-item"
59401   ipsec-configuration:
59402     description: |
59403       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
59404       ###### Related Nodes
59405       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
59406       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
59407       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
59408     required:
59409     - ipsec-configuration-id
59410     properties:
59411       ipsec-configuration-id:
59412         type: string
59413         description: UUID of this configuration
59414       requested-vig-address-type:
59415         type: string
59416         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
59417       requested-encryption-strength:
59418         type: string
59419         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
59420       requested-dmz-type:
59421         type: string
59422         description: can offer a shared DMZ or a DMZ specific to a customer
59423       shared-dmz-network-address:
59424         type: string
59425         description: Network address of shared DMZ
59426       requested-customer-name:
59427         type: string
59428         description: If the DMZ is a custom DMZ, this field will indicate the customer information
59429       ike-version:
59430         type: string
59431         description: can be 1 or 2
59432       ikev1-authentication:
59433         type: string
59434         description: Contains values like md5, sha1, sha256, sha384
59435       ikev1-encryption:
59436         type: string
59437         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59438       ikev1-dh-group:
59439         type: string
59440         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
59441       ikev1-am-group-id:
59442         type: string
59443         description: Group name defined in VIG for clients using aggressive mode
59444       ikev1-am-password:
59445         type: string
59446         description: pre-shared key for the above group name
59447       ikev1-sa-lifetime:
59448         type: string
59449         description: Lifetime for IKEv1 SA
59450       ipsec-authentication:
59451         type: string
59452         description: md5, sha1, sha256, sha384
59453       ipsec-encryption:
59454         type: string
59455         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59456       ipsec-sa-lifetime:
59457         type: string
59458         description: Life time for IPSec SA
59459       ipsec-pfs:
59460         type: string
59461         description: enable PFS or not
59462       xauth-userid:
59463         type: string
59464         description: user ID for xAuth, sm-user, ,nmteHostName
59465       xauth-user-password:
59466         type: string
59467         description: Encrypted using the Juniper $9$ algorithm
59468       dpd-interval:
59469         type: string
59470         description: The time between DPD probe
59471       dpd-frequency:
59472         type: string
59473         description: Maximum number of DPD before claiming the tunnel is down
59474       resource-version:
59475         type: string
59476         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59477       relationship-list:
59478         type: array
59479         items:
59480           $ref: "#/getDefinitions/relationship"
59481       vig-servers:
59482         type: array
59483         items:
59484           $ref: "#/getDefinitions/vig-server"
59485   ipsec-configurations:
59486     properties:
59487       ipsec-configuration:
59488         type: array
59489         items:
59490           $ref: "#/getDefinitions/ipsec-configuration"
59491   key-data:
59492     properties:
59493       key-name:
59494         type: string
59495       key-value:
59496         type: string
59497   l-interface:
59498     description: |
59499       Logical interfaces, e.g., a vnic.
59500       ###### Related Nodes
59501       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59502       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59503       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59504       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59505       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59506       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
59507       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
59508       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
59509       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59510       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59511       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
59512       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
59513       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59514       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
59515       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
59516     required:
59517     - interface-name
59518     - is-port-mirrored
59519     - in-maint
59520     properties:
59521       interface-name:
59522         type: string
59523         description: Name given to the interface
59524       interface-role:
59525         type: string
59526         description: E.g., CUSTOMER, UPLINK, etc.
59527       v6-wan-link-ip:
59528         type: string
59529         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59530       selflink:
59531         type: string
59532         description: URL to endpoint where AAI can get more details
59533       interface-id:
59534         type: string
59535         description: ID of interface
59536       macaddr:
59537         type: string
59538         description: MAC address for the interface
59539       network-name:
59540         type: string
59541         description: Name of the network
59542       management-option:
59543         type: string
59544         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59545       interface-description:
59546         type: string
59547         description: Human friendly text regarding this interface.
59548       is-port-mirrored:
59549         type: boolean
59550       resource-version:
59551         type: string
59552         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59553       in-maint:
59554         type: boolean
59555       vlans:
59556         type: array
59557         items:
59558           $ref: "#/getDefinitions/vlan"
59559       sriov-vfs:
59560         type: array
59561         items:
59562           $ref: "#/getDefinitions/sriov-vf"
59563       l-interfaces:
59564         type: array
59565         items:
59566           $ref: "#/getDefinitions/l-interface"
59567       relationship-list:
59568         type: array
59569         items:
59570           $ref: "#/getDefinitions/relationship"
59571       l3-interface-ipv4-address-list:
59572         type: array
59573         items:
59574           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
59575       l3-interface-ipv6-address-list:
59576         type: array
59577         items:
59578           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
59579   l-interfaces:
59580     description: |
59581       Collection of logical interfaces.
59582     properties:
59583       l-interface:
59584         type: array
59585         items:
59586           $ref: "#/getDefinitions/l-interface"
59587   l3-interface-ipv4-address-list:
59588     description: |
59589       IPv4 Address Range
59590       ###### Related Nodes
59591       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59592       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59593       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59594       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59595       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59596     required:
59597     - l3-interface-ipv4-address
59598     properties:
59599       l3-interface-ipv4-address:
59600         type: string
59601         description: IP address
59602       l3-interface-ipv4-prefix-length:
59603         type: integer
59604         format: int64
59605         description: Prefix length, 32 for single address
59606       vlan-id-inner:
59607         type: integer
59608         format: int64
59609         description: Inner VLAN tag
59610       vlan-id-outer:
59611         type: integer
59612         format: int64
59613         description: Outer VLAN tag
59614       is-floating:
59615         type: boolean
59616         description: Indicator of fixed or floating address
59617       resource-version:
59618         type: string
59619         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59620       neutron-network-id:
59621         type: string
59622         description: Neutron network id of the interface that address belongs to
59623       neutron-subnet-id:
59624         type: string
59625         description: Neutron id of subnet that address belongs to
59626       relationship-list:
59627         type: array
59628         items:
59629           $ref: "#/getDefinitions/relationship"
59630   l3-interface-ipv6-address-list:
59631     description: |
59632       IPv6 Address Range
59633       ###### Related Nodes
59634       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59635       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59636       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59637       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59638       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59639     required:
59640     - l3-interface-ipv6-address
59641     properties:
59642       l3-interface-ipv6-address:
59643         type: string
59644         description: IP address
59645       l3-interface-ipv6-prefix-length:
59646         type: integer
59647         format: int64
59648         description: Prefix length, 128 for single address
59649       vlan-id-inner:
59650         type: integer
59651         format: int64
59652         description: Inner VLAN tag
59653       vlan-id-outer:
59654         type: integer
59655         format: int64
59656         description: Outer VLAN tag
59657       is-floating:
59658         type: boolean
59659         description: Indicator of fixed or floating address
59660       resource-version:
59661         type: string
59662         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59663       neutron-network-id:
59664         type: string
59665         description: Neutron network id of the interface that address belongs to
59666       neutron-subnet-id:
59667         type: string
59668         description: Neutron id of subnet that address belongs to
59669       relationship-list:
59670         type: array
59671         items:
59672           $ref: "#/getDefinitions/relationship"
59673   l3-network:
59674     description: |
59675       Generic network definition
59676       ###### Related Nodes
59677       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
59678       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
59679       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59680       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
59681       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59682       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59683       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59684       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59685       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59686       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59687       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59688       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
59689       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59690       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59691       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
59692       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
59693     required:
59694     - network-id
59695     - network-name
59696     - is-bound-to-vpn
59697     - is-provider-network
59698     - is-shared-network
59699     - is-external-network
59700     properties:
59701       network-id:
59702         type: string
59703         description: Network ID, should be uuid. Unique across A&AI.
59704       network-name:
59705         type: string
59706         description: Name of the network, governed by some naming convention..
59707       network-type:
59708         type: string
59709         description: Type of the network - who defines these values?
59710       network-role:
59711         type: string
59712         description: Role the network plans - who defines these values?
59713       network-technology:
59714         type: string
59715         description: Network technology - who defines these values?
59716       neutron-network-id:
59717         type: string
59718         description: Neutron network id of this Interface
59719       is-bound-to-vpn:
59720         type: boolean
59721       service-id:
59722         type: string
59723         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
59724       network-role-instance:
59725         type: integer
59726         format: int64
59727         description: network role instance
59728       resource-version:
59729         type: string
59730         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59731       orchestration-status:
59732         type: string
59733         description: Orchestration status of this VNF, mastered by MSO
59734       heat-stack-id:
59735         type: string
59736         description: Heat stack id corresponding to this instance, managed by MSO
59737       mso-catalog-key:
59738         type: string
59739         description: Corresponds to the SDN-C catalog id used to configure this VCE
59740       contrail-network-fqdn:
59741         type: string
59742         description: Contrail FQDN for the network
59743       model-invariant-id:
59744         type: string
59745         description: the ASDC model id for this resource or service model.
59746       model-version-id:
59747         type: string
59748         description: the ASDC model version for this resource or service model.
59749       persona-model-version:
59750         type: string
59751         description: the ASDC model version for this resource or service model.
59752       model-customization-id:
59753         type: string
59754         description: captures the id of all the configuration used to customize the resource for the service.
59755       widget-model-id:
59756         type: string
59757         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59758       widget-model-version:
59759         type: string
59760         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
59761       physical-network-name:
59762         type: string
59763         description: Name associated with the physical network.
59764       is-provider-network:
59765         type: boolean
59766       is-shared-network:
59767         type: boolean
59768       is-external-network:
59769         type: boolean
59770       selflink:
59771         type: string
59772         description: Path to the controller object.
59773       operational-status:
59774         type: string
59775         description: Indicator for whether the resource is considered operational.
59776       subnets:
59777         type: array
59778         items:
59779           $ref: "#/getDefinitions/subnet"
59780       ctag-assignments:
59781         type: array
59782         items:
59783           $ref: "#/getDefinitions/ctag-assignment"
59784       segmentation-assignments:
59785         type: array
59786         items:
59787           $ref: "#/getDefinitions/segmentation-assignment"
59788       relationship-list:
59789         type: array
59790         items:
59791           $ref: "#/getDefinitions/relationship"
59792         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
59793   l3-networks:
59794     properties:
59795       l3-network:
59796         type: array
59797         items:
59798           $ref: "#/getDefinitions/l3-network"
59799   lag-interface:
59800     description: |
59801       Link aggregate interface
59802       ###### Related Nodes
59803       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59804       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59805       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59806       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
59807       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59808       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
59809       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59810       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59811       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
59812       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
59813     required:
59814     - interface-name
59815     - in-maint
59816     properties:
59817       interface-name:
59818         type: string
59819         description: Name that identifies the link aggregate interface
59820       interface-description:
59821         type: string
59822         description: Human friendly text regarding this interface.
59823       resource-version:
59824         type: string
59825         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59826       speed-value:
59827         type: string
59828         description: Captures the numeric part of the speed
59829       speed-units:
59830         type: string
59831         description: Captures the units corresponding to the speed
59832       interface-id:
59833         type: string
59834         description: ID of interface
59835       interface-role:
59836         type: string
59837         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
59838       prov-status:
59839         type: string
59840         description: Trigger for operational monitoring of this resource by Service Assurance systems.
59841       in-maint:
59842         type: boolean
59843       relationship-list:
59844         type: array
59845         items:
59846           $ref: "#/getDefinitions/relationship"
59847       l-interfaces:
59848         type: array
59849         items:
59850           $ref: "#/getDefinitions/l-interface"
59851   lag-interfaces:
59852     description: |
59853       Collection of link aggregate interfaces.
59854     properties:
59855       lag-interface:
59856         type: array
59857         items:
59858           $ref: "#/getDefinitions/lag-interface"
59859   lag-link:
59860     description: |
59861       LAG links can connect lag-interfaces
59862       ###### Related Nodes
59863       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59864       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59865     required:
59866     - link-name
59867     properties:
59868       link-name:
59869         type: string
59870         description: Alphabetical concatenation of lag-interface names
59871       resource-version:
59872         type: string
59873         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59874       relationship-list:
59875         type: array
59876         items:
59877           $ref: "#/getDefinitions/relationship"
59878   lag-links:
59879     description: |
59880       Collection of link aggregation connections
59881     properties:
59882       lag-link:
59883         type: array
59884         items:
59885           $ref: "#/getDefinitions/lag-link"
59886   license:
59887     description: |
59888       Metadata for license group.
59889       ###### Related Nodes
59890       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59891       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59892     required:
59893     - group-uuid
59894     - resource-uuid
59895     properties:
59896       group-uuid:
59897         type: string
59898         description: Unique ID for the license group the resource belongs to, should be uuid.
59899       resource-uuid:
59900         type: string
59901         description: Unique ID of a license resource.
59902       resource-version:
59903         type: string
59904         description: Concurrency value
59905       relationship-list:
59906         type: array
59907         items:
59908           $ref: "#/getDefinitions/relationship"
59909   licenses:
59910     description: |
59911       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59912     properties:
59913       license:
59914         type: array
59915         items:
59916           $ref: "#/getDefinitions/license"
59917   line-of-business:
59918     description: |
59919       describes a line-of-business
59920       ###### Related Nodes
59921       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59922     required:
59923     - line-of-business-name
59924     properties:
59925       line-of-business-name:
59926         type: string
59927         description: Name of the line-of-business (product)
59928       resource-version:
59929         type: string
59930         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59931       relationship-list:
59932         type: array
59933         items:
59934           $ref: "#/getDefinitions/relationship"
59935   lines-of-business:
59936     description: |
59937       Collection of lines-of-business
59938     properties:
59939       line-of-business:
59940         type: array
59941         items:
59942           $ref: "#/getDefinitions/line-of-business"
59943   logical-link:
59944     description: |
59945       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59946       ###### Related Nodes
59947       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
59948       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
59949       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59950       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59951       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
59952       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
59953       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59954       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59955       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59956       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59957       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
59958       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59959       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59960       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59961     required:
59962     - link-name
59963     - link-type
59964     properties:
59965       link-name:
59966         type: string
59967         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59968       link-type:
59969         type: string
59970         description: Type of logical link, e.g., evc
59971       speed-value:
59972         type: string
59973         description: Captures the numeric part of the speed
59974       speed-units:
59975         type: string
59976         description: Captures the units corresponding to the speed
59977       ip-version:
59978         type: string
59979         description: v4, v6, or ds for dual stack
59980       routing-protocol:
59981         type: string
59982         description: For example, static or BGP
59983       resource-version:
59984         type: string
59985         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
59986       model-invariant-id:
59987         type: string
59988         description: the ASDC model id for this resource or service model.
59989       model-version-id:
59990         type: string
59991         description: the ASDC model version for this resource or service model.
59992       persona-model-version:
59993         type: string
59994         description: the ASDC model version for this resource or service model.
59995       widget-model-id:
59996         type: string
59997         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
59998       widget-model-version:
59999         type: string
60000         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
60001       operational-status:
60002         type: string
60003         description: Indication of operational status of the logical link.
60004       prov-status:
60005         type: string
60006         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60007       link-role:
60008         type: string
60009         description: Indication of the network use of the logical link.
60010       link-name2:
60011         type: string
60012         description: Alias or alternate name (CLCI or D1 name).
60013       link-id:
60014         type: string
60015         description: UUID of the logical-link, SDNC generates this.
60016       circuit-id:
60017         type: string
60018         description: Circuit id
60019       purpose:
60020         type: string
60021         description: Reason for this entity, role it is playing
60022       relationship-list:
60023         type: array
60024         items:
60025           $ref: "#/getDefinitions/relationship"
60026   logical-links:
60027     description: |
60028       Collection of logical connections
60029     properties:
60030       logical-link:
60031         type: array
60032         items:
60033           $ref: "#/getDefinitions/logical-link"
60034   metadata:
60035     description: |
60036       Collection of metadatum (key/value pairs)
60037     properties:
60038       metadatum:
60039         type: array
60040         items:
60041           $ref: "#/getDefinitions/metadatum"
60042   metadatum:
60043     description: |
60044       Key/value pairs
60045       ###### Related Nodes
60046       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
60047       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
60048       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
60049       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60050     required:
60051     - metaname
60052     - metaval
60053     properties:
60054       metaname:
60055         type: string
60056       metaval:
60057         type: string
60058       resource-version:
60059         type: string
60060         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60061   model:
60062     description: |
60063       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
60064       ###### Related Nodes
60065       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60066       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
60067       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60068       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60069       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60070       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
60071       - MODEL is DELETED when these are DELETED MODEL-VER
60072     required:
60073     - model-invariant-id
60074     - model-type
60075     properties:
60076       model-invariant-id:
60077         type: string
60078         description: Unique identifier corresponding to the main definition of a model in ASDC
60079       model-type:
60080         type: string
60081         description: Type of the model, e.g., service, resource, widget, etc.
60082       resource-version:
60083         type: string
60084         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60085       model-vers:
60086         type: array
60087         items:
60088           $ref: "#/getDefinitions/model-ver"
60089       relationship-list:
60090         type: array
60091         items:
60092           $ref: "#/getDefinitions/relationship"
60093   model-and-named-query-search:
60094     description: |
60095       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
60096     properties:
60097       query-parameters:
60098         type: object
60099         $ref: "#/getDefinitions/query-parameters"
60100       instance-filters:
60101         type: object
60102         $ref: "#/getDefinitions/instance-filters"
60103       secondary-filts:
60104         type: object
60105         $ref: "#/getDefinitions/secondary-filts"
60106       top-node-type:
60107         type: string
60108       secondary-filter-cut-point:
60109         type: string
60110   model-constraint:
60111     description: |
60112       This is how we would capture constraints defining allowed sets of elements.
60113       ###### Related Nodes
60114       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60115       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
60116       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
60117     required:
60118     - model-constraint-uuid
60119     - constrained-element-set-uuid-to-replace
60120     properties:
60121       model-constraint-uuid:
60122         type: string
60123       constrained-element-set-uuid-to-replace:
60124         type: string
60125       constrained-element-sets:
60126         type: array
60127         items:
60128           $ref: "#/getDefinitions/constrained-element-set"
60129       resource-version:
60130         type: string
60131         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60132   model-constraints:
60133     properties:
60134       model-constraint:
60135         type: array
60136         items:
60137           $ref: "#/getDefinitions/model-constraint"
60138   model-element:
60139     description: |
60140       Defines how other models combine to make up a higher-level model.
60141       ###### Related Nodes
60142       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
60143       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60144       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
60145       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60146       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60147       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60148       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
60149       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
60150     required:
60151     - model-element-uuid
60152     - new-data-del-flag
60153     - cardinality
60154     properties:
60155       model-element-uuid:
60156         type: string
60157       new-data-del-flag:
60158         type: string
60159         description: Indicates whether this element was created as part of instantiation from this model
60160       cardinality:
60161         type: string
60162         description: How many of this type of element are required/allowed
60163       linkage-points:
60164         type: string
60165       resource-version:
60166         type: string
60167         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60168       model-elements:
60169         type: array
60170         items:
60171           $ref: "#/getDefinitions/model-element"
60172         description: Defines how other models combine to make up a higher-level model
60173       model-constraints:
60174         type: array
60175         items:
60176           $ref: "#/getDefinitions/model-constraint"
60177         description: Describes new constraints on this model element that are not part of that model's definition
60178       relationship-list:
60179         type: array
60180         items:
60181           $ref: "#/getDefinitions/relationship"
60182   model-elements:
60183     properties:
60184       model-element:
60185         type: array
60186         items:
60187           $ref: "#/getDefinitions/model-element"
60188   model-ver:
60189     description: |
60190       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
60191       ###### Related Nodes
60192       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
60193       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
60194       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60195       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
60196       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
60197       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
60198     required:
60199     - model-version-id
60200     - model-name
60201     - model-version
60202     properties:
60203       model-version-id:
60204         type: string
60205         description: Unique identifier corresponding to one version of a model in ASDC
60206       model-name:
60207         type: string
60208         description: Name of the model, which can change from version to version.
60209       model-version:
60210         type: string
60211         description: Version
60212       model-description:
60213         type: string
60214         description: Description
60215       resource-version:
60216         type: string
60217         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60218       model-elements:
60219         type: array
60220         items:
60221           $ref: "#/getDefinitions/model-element"
60222       metadata:
60223         type: array
60224         items:
60225           $ref: "#/getDefinitions/metadatum"
60226       relationship-list:
60227         type: array
60228         items:
60229           $ref: "#/getDefinitions/relationship"
60230   model-vers:
60231     properties:
60232       model-ver:
60233         type: array
60234         items:
60235           $ref: "#/getDefinitions/model-ver"
60236   models:
60237     description: |
60238       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
60239     properties:
60240       model:
60241         type: array
60242         items:
60243           $ref: "#/getDefinitions/model"
60244   multicast-configuration:
60245     description: |
60246       ###### Related Nodes
60247       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
60248     required:
60249     - multicast-configuration-id
60250     - multicast-protocol
60251     - rp-type
60252     properties:
60253       multicast-configuration-id:
60254         type: string
60255         description: Unique id of multicast configuration.
60256       multicast-protocol:
60257         type: string
60258         description: protocol of multicast configuration
60259       rp-type:
60260         type: string
60261         description: rp type of multicast configuration
60262       resource-version:
60263         type: string
60264         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60265       relationship-list:
60266         type: array
60267         items:
60268           $ref: "#/getDefinitions/relationship"
60269   multicast-configurations:
60270     description: |
60271       multicast configuration of generic-vnf ip-address
60272     properties:
60273       multicast-configuration:
60274         type: array
60275         items:
60276           $ref: "#/getDefinitions/multicast-configuration"
60277   named-queries:
60278     properties:
60279       named-query:
60280         type: array
60281         items:
60282           $ref: "#/getDefinitions/named-query"
60283   named-query:
60284     description: |
60285       TBD
60286       ###### Related Nodes
60287       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60288       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
60289       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60290       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
60291     required:
60292     - named-query-uuid
60293     - named-query-name
60294     - named-query-version
60295     properties:
60296       named-query-uuid:
60297         type: string
60298       named-query-name:
60299         type: string
60300       named-query-version:
60301         type: string
60302       required-input-param:
60303         type: string
60304       description:
60305         type: string
60306       resource-version:
60307         type: string
60308       named-query-elements:
60309         type: array
60310         items:
60311           $ref: "#/getDefinitions/named-query-element"
60312       relationship-list:
60313         type: array
60314         items:
60315           $ref: "#/getDefinitions/relationship"
60316   named-query-element:
60317     description: |
60318       TBD
60319       ###### Related Nodes
60320       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
60321       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
60322       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60323       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60324       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60325       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60326       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
60327     required:
60328     - named-query-element-uuid
60329     properties:
60330       named-query-element-uuid:
60331         type: string
60332       property-collect-list:
60333         type: string
60334       resource-version:
60335         type: string
60336       property-limit-desc:
60337         type: string
60338       do-not-output:
60339         type: string
60340       named-query-elements:
60341         type: array
60342         items:
60343           $ref: "#/getDefinitions/named-query-element"
60344       related-lookups:
60345         type: array
60346         items:
60347           $ref: "#/getDefinitions/related-lookup"
60348       property-constraints:
60349         type: array
60350         items:
60351           $ref: "#/getDefinitions/property-constraint"
60352       relationship-list:
60353         type: array
60354         items:
60355           $ref: "#/getDefinitions/relationship"
60356   named-query-elements:
60357     properties:
60358       named-query-element:
60359         type: array
60360         items:
60361           $ref: "#/getDefinitions/named-query-element"
60362   network:
60363     description: |
60364       Namespace for network inventory resources.
60365     properties:
60366       logical-links:
60367         type: array
60368         items:
60369           $ref: "#/getDefinitions/logical-link"
60370       site-pair-sets:
60371         type: array
60372         items:
60373           $ref: "#/getDefinitions/site-pair-set"
60374       vpn-bindings:
60375         type: array
60376         items:
60377           $ref: "#/getDefinitions/vpn-binding"
60378       vpls-pes:
60379         type: array
60380         items:
60381           $ref: "#/getDefinitions/vpls-pe"
60382       multicast-configurations:
60383         type: array
60384         items:
60385           $ref: "#/getDefinitions/multicast-configuration"
60386       vces:
60387         type: array
60388         items:
60389           $ref: "#/getDefinitions/vce"
60390       vnfcs:
60391         type: array
60392         items:
60393           $ref: "#/getDefinitions/vnfc"
60394       l3-networks:
60395         type: array
60396         items:
60397           $ref: "#/getDefinitions/l3-network"
60398       network-policies:
60399         type: array
60400         items:
60401           $ref: "#/getDefinitions/network-policy"
60402       generic-vnfs:
60403         type: array
60404         items:
60405           $ref: "#/getDefinitions/generic-vnf"
60406       lag-links:
60407         type: array
60408         items:
60409           $ref: "#/getDefinitions/lag-link"
60410       newvces:
60411         type: array
60412         items:
60413           $ref: "#/getDefinitions/newvce"
60414       pnfs:
60415         type: array
60416         items:
60417           $ref: "#/getDefinitions/pnf"
60418       physical-links:
60419         type: array
60420         items:
60421           $ref: "#/getDefinitions/physical-link"
60422       ipsec-configurations:
60423         type: array
60424         items:
60425           $ref: "#/getDefinitions/ipsec-configuration"
60426       route-table-references:
60427         type: array
60428         items:
60429           $ref: "#/getDefinitions/route-table-reference"
60430       instance-groups:
60431         type: array
60432         items:
60433           $ref: "#/getDefinitions/instance-group"
60434       zones:
60435         type: array
60436         items:
60437           $ref: "#/getDefinitions/zone"
60438   network-policies:
60439     properties:
60440       network-policy:
60441         type: array
60442         items:
60443           $ref: "#/getDefinitions/network-policy"
60444   network-policy:
60445     description: |
60446       ###### Related Nodes
60447       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
60448       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
60449     required:
60450     - network-policy-id
60451     properties:
60452       network-policy-id:
60453         type: string
60454         description: UUID representing unique key to this instance
60455       network-policy-fqdn:
60456         type: string
60457         description: Contrail FQDN for the policy
60458       heat-stack-id:
60459         type: string
60460         description: ID for the openStack Heat instance
60461       resource-version:
60462         type: string
60463         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60464       relationship-list:
60465         type: array
60466         items:
60467           $ref: "#/getDefinitions/relationship"
60468   network-profile:
60469     description: |
60470       Network profile populated by SDN-GP for SNMP
60471       ###### Related Nodes
60472       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60473     required:
60474     - nm-profile-name
60475     properties:
60476       nm-profile-name:
60477         type: string
60478         description: Unique name of network profile.
60479       community-string:
60480         type: string
60481         description: Encrypted SNMP community string
60482       resource-version:
60483         type: string
60484         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60485       relationship-list:
60486         type: array
60487         items:
60488           $ref: "#/getDefinitions/relationship"
60489   network-profiles:
60490     description: |
60491       Collection of network profiles
60492     properties:
60493       network-profile:
60494         type: array
60495         items:
60496           $ref: "#/getDefinitions/network-profile"
60497   newvce:
60498     description: |
60499       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60500       ###### Related Nodes
60501       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
60502       - NEWVCE is DELETED when these are DELETED L-INTERFACE
60503     required:
60504     - vnf-id2
60505     - vnf-name
60506     - vnf-type
60507     properties:
60508       vnf-id2:
60509         type: string
60510         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60511       vnf-name:
60512         type: string
60513         description: Name of VNF.
60514       vnf-name2:
60515         type: string
60516         description: Alternate name of VNF.
60517       vnf-type:
60518         type: string
60519         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
60520       prov-status:
60521         type: string
60522         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60523       operational-status:
60524         type: string
60525         description: Indicator for whether the resource is considered operational
60526       license-key:
60527         type: string
60528         description: OBSOLETE -  do not use
60529       ipv4-oam-address:
60530         type: string
60531         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).
60532       equipment-role:
60533         type: string
60534         description: Client should send valid enumerated value.
60535       resource-version:
60536         type: string
60537         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60538       ipv4-loopback0-address:
60539         type: string
60540         description: v4 Loopback0 address
60541       orchestration-status:
60542         type: string
60543         description: Orchestration status of this VNF, mastered by MSO.
60544       heat-stack-id:
60545         type: string
60546         description: Heat stack id corresponding to this instance, managed by MSO
60547       mso-catalog-key:
60548         type: string
60549         description: Corresponds to the SDN-C catalog id used to configure this VCE
60550       relationship-list:
60551         type: array
60552         items:
60553           $ref: "#/getDefinitions/relationship"
60554       l-interfaces:
60555         type: array
60556         items:
60557           $ref: "#/getDefinitions/l-interface"
60558   newvces:
60559     description: |
60560       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60561     properties:
60562       newvce:
60563         type: array
60564         items:
60565           $ref: "#/getDefinitions/newvce"
60566   notification-event:
60567     properties:
60568       cambria.partition:
60569         type: string
60570       notification-event-header:
60571         type: object
60572         $ref: "#/getDefinitions/notification-event-header"
60573   notification-event-header:
60574     properties:
60575       id:
60576         type: string
60577       timestamp:
60578         type: string
60579       source-name:
60580         type: string
60581       domain:
60582         type: string
60583       sequence-number:
60584         type: string
60585       severity:
60586         type: string
60587       event-type:
60588         type: string
60589       version:
60590         type: string
60591       action:
60592         type: string
60593       entity-type:
60594         type: string
60595       top-entity-type:
60596         type: string
60597       entity-link:
60598         type: string
60599       status:
60600         type: string
60601   notify:
60602     required:
60603     - event-id
60604     properties:
60605       event-id:
60606         type: string
60607       node-type:
60608         type: string
60609       event-trigger:
60610         type: string
60611       key-data:
60612         type: array
60613         items:
60614           $ref: "#/getDefinitions/key-data"
60615       selflink:
60616         type: string
60617   oam-network:
60618     description: |
60619       OAM network, to be deprecated shortly.  Do not use for new purposes.
60620       ###### Related Nodes
60621       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60622       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
60623       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60624     required:
60625     - network-uuid
60626     - network-name
60627     - cvlan-tag
60628     properties:
60629       network-uuid:
60630         type: string
60631         description: UUID of the network. Unique across a cloud-region
60632       network-name:
60633         type: string
60634         description: Name of the network.
60635       cvlan-tag:
60636         type: integer
60637         format: int64
60638         description: cvlan-id
60639       ipv4-oam-gateway-address:
60640         type: string
60641         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60642       ipv4-oam-gateway-address-prefix-length:
60643         type: integer
60644         format: int32
60645         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60646       resource-version:
60647         type: string
60648         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60649       relationship-list:
60650         type: array
60651         items:
60652           $ref: "#/getDefinitions/relationship"
60653   oam-networks:
60654     description: |
60655       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
60656     properties:
60657       oam-network:
60658         type: array
60659         items:
60660           $ref: "#/getDefinitions/oam-network"
60661   operational-environment:
60662     description: |
60663       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60664       ###### Related Nodes
60665       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60666       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60667     required:
60668     - operational-environment-id
60669     - operational-environment-name
60670     - operational-environment-type
60671     - operational-environment-status
60672     - tenant-context
60673     - workload-context
60674     properties:
60675       operational-environment-id:
60676         type: string
60677         description: UUID of an operational environment
60678       operational-environment-name:
60679         type: string
60680         description: Operational Environment name
60681       operational-environment-type:
60682         type: string
60683         description: Operational Environment Type.
60684       operational-environment-status:
60685         type: string
60686         description: Status
60687       tenant-context:
60688         type: string
60689         description: Tenant Context.
60690       workload-context:
60691         type: string
60692         description: Workload Context.
60693       resource-version:
60694         type: string
60695         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60696       relationship-list:
60697         type: array
60698         items:
60699           $ref: "#/getDefinitions/relationship"
60700   operational-environments:
60701     description: |
60702       a logical partition of the cloud which allows to have multiple environments in the production AIC.
60703     properties:
60704       operational-environment:
60705         type: array
60706         items:
60707           $ref: "#/getDefinitions/operational-environment"
60708   overloaded-model:
60709     description: |
60710       Allows for legacy POST of old-style and new-style models
60711     required:
60712     - model-invariant-id
60713     - model-name-version-id
60714     - model-type
60715     - model-name
60716     - model-id
60717     - model-version
60718     properties:
60719       model-invariant-id:
60720         type: string
60721         description: Unique identifier corresponding to the main definition of a model in ASDC
60722       model-name-version-id:
60723         type: string
60724         description: Unique identifier corresponding to one version of a model in ASDC
60725       model-type:
60726         type: string
60727         description: Type of the model, e.g., service, resource, widget, etc.
60728       model-name:
60729         type: string
60730         description: Name of the model, which can change from version to version.
60731       model-id:
60732         type: string
60733         description: Invariant unique ID which does not change from version to version
60734       model-version:
60735         type: string
60736         description: Version
60737       model-description:
60738         type: string
60739         description: Description
60740       resource-version:
60741         type: string
60742         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60743       model-vers:
60744         type: object
60745         $ref: "#/getDefinitions/model-vers"
60746       relationship-list:
60747         type: object
60748         $ref: "#/getDefinitions/relationship-list"
60749   owning-entities:
60750     description: |
60751       Collection of owning-entities
60752     properties:
60753       owning-entity:
60754         type: array
60755         items:
60756           $ref: "#/getDefinitions/owning-entity"
60757   owning-entity:
60758     description: |
60759       describes an owning-entity
60760       ###### Related Nodes
60761       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
60762     required:
60763     - owning-entity-id
60764     - owning-entity-name
60765     properties:
60766       owning-entity-id:
60767         type: string
60768         description: UUID of an owning entity
60769       owning-entity-name:
60770         type: string
60771         description: Owning entity name
60772       resource-version:
60773         type: string
60774         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60775       relationship-list:
60776         type: array
60777         items:
60778           $ref: "#/getDefinitions/relationship"
60779   p-interface:
60780     description: |
60781       Physical interface (e.g., nic)
60782       ###### Related Nodes
60783       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
60784       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60785       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60786       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60787       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60788       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
60789       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
60790       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE
60791       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
60792     required:
60793     - interface-name
60794     - in-maint
60795     properties:
60796       interface-name:
60797         type: string
60798         description: Name that identifies the physical interface
60799       speed-value:
60800         type: string
60801         description: Captures the numeric part of the speed
60802       speed-units:
60803         type: string
60804         description: Captures the units corresponding to the speed
60805       port-description:
60806         type: string
60807         description: Nature of the services and connectivity on this port.
60808       equipment-identifier:
60809         type: string
60810         description: CLEI or other specification for p-interface hardware.
60811       interface-role:
60812         type: string
60813         description: Role specification for p-interface hardware.
60814       interface-type:
60815         type: string
60816         description: Indicates the physical properties of the interface.
60817       prov-status:
60818         type: string
60819         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60820       resource-version:
60821         type: string
60822         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60823       in-maint:
60824         type: boolean
60825       relationship-list:
60826         type: array
60827         items:
60828           $ref: "#/getDefinitions/relationship"
60829       l-interfaces:
60830         type: array
60831         items:
60832           $ref: "#/getDefinitions/l-interface"
60833   p-interfaces:
60834     description: |
60835       Collection of physical interfaces.
60836     properties:
60837       p-interface:
60838         type: array
60839         items:
60840           $ref: "#/getDefinitions/p-interface"
60841   physical-link:
60842     description: |
60843       Collection of physical connections, typically between p-interfaces
60844       ###### Related Nodes
60845       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60846     required:
60847     - link-name
60848     properties:
60849       link-name:
60850         type: string
60851         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60852       speed-value:
60853         type: string
60854         description: Captures the numeric part of the speed
60855       speed-units:
60856         type: string
60857         description: Captures the units corresponding to the speed
60858       circuit-id:
60859         type: string
60860         description: Circuit it
60861       dual-mode:
60862         type: string
60863         description: Dual access mode (e.g., primary, secondary
60864       management-option:
60865         type: string
60866         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60867       service-provider-name:
60868         type: string
60869         description: Name of the service Provider on this link.
60870       resource-version:
60871         type: string
60872         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60873       relationship-list:
60874         type: array
60875         items:
60876           $ref: "#/getDefinitions/relationship"
60877   physical-links:
60878     description: |
60879       Collection of physical connections, typically between p-interfaces
60880     properties:
60881       physical-link:
60882         type: array
60883         items:
60884           $ref: "#/getDefinitions/physical-link"
60885   platform:
60886     description: |
60887       describes a platform
60888       ###### Related Nodes
60889       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60890     required:
60891     - platform-name
60892     properties:
60893       platform-name:
60894         type: string
60895         description: Name of the platform
60896       resource-version:
60897         type: string
60898         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60899       relationship-list:
60900         type: array
60901         items:
60902           $ref: "#/getDefinitions/relationship"
60903   platforms:
60904     description: |
60905       Collection of platforms
60906     properties:
60907       platform:
60908         type: array
60909         items:
60910           $ref: "#/getDefinitions/platform"
60911   pnf:
60912     description: |
60913       PNF represents a physical network function. typically equipment used in the D1 world.
60914       ###### Related Nodes
60915       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60916       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60917       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60918       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
60919       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60920       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60921       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
60922       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60923     required:
60924     - pnf-name
60925     - in-maint
60926     properties:
60927       pnf-name:
60928         type: string
60929         description: unique name of Physical Network Function.
60930       pnf-name2:
60931         type: string
60932         description: name of Physical Network Function.
60933       pnf-name2-source:
60934         type: string
60935         description: source of name2
60936       pnf-id:
60937         type: string
60938         description: id of pnf
60939       equip-type:
60940         type: string
60941         description: Equipment type.  Source of truth should define valid values.
60942       equip-vendor:
60943         type: string
60944         description: Equipment vendor.  Source of truth should define valid values.
60945       equip-model:
60946         type: string
60947         description: Equipment model.  Source of truth should define valid values.
60948       management-option:
60949         type: string
60950         description: identifier of managed by company or customer
60951       ipaddress-v4-oam:
60952         type: string
60953         description: ipv4-oam-address with new naming convention for IP addresses
60954       sw-version:
60955         type: string
60956         description: sw-version is the version of SW for the hosted application on the PNF.
60957       in-maint:
60958         type: boolean
60959       frame-id:
60960         type: string
60961         description: ID of the physical frame (relay rack) where pnf is installed.
60962       serial-number:
60963         type: string
60964         description: Serial number of the device
60965       ipaddress-v4-loopback-0:
60966         type: string
60967         description: IPV4 Loopback 0 address
60968       ipaddress-v6-loopback-0:
60969         type: string
60970         description: IPV6 Loopback 0 address
60971       ipaddress-v4-aim:
60972         type: string
60973         description: IPV4 AIM address
60974       ipaddress-v6-aim:
60975         type: string
60976         description: IPV6 AIM address
60977       ipaddress-v6-oam:
60978         type: string
60979         description: IPV6 OAM address
60980       inv-status:
60981         type: string
60982         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60983       resource-version:
60984         type: string
60985         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
60986       prov-status:
60987         type: string
60988         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
60989       nf-role:
60990         type: string
60991         description: Nf Role is the role performed by this instance in the network.
60992       relationship-list:
60993         type: array
60994         items:
60995           $ref: "#/getDefinitions/relationship"
60996       p-interfaces:
60997         type: array
60998         items:
60999           $ref: "#/getDefinitions/p-interface"
61000       lag-interfaces:
61001         type: array
61002         items:
61003           $ref: "#/getDefinitions/lag-interface"
61004   pnfs:
61005     description: |
61006       Collection of Physical Network Functions.
61007     properties:
61008       pnf:
61009         type: array
61010         items:
61011           $ref: "#/getDefinitions/pnf"
61012   port-group:
61013     description: |
61014       Used to capture the network interfaces of this VCE
61015       ###### Related Nodes
61016       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61017       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
61018       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
61019     required:
61020     - interface-id
61021     - orchestration-status
61022     properties:
61023       interface-id:
61024         type: string
61025         description: Unique ID of the interface
61026       neutron-network-id:
61027         type: string
61028         description: Neutron network id of this Interface
61029       neutron-network-name:
61030         type: string
61031         description: Neutron network name of this Interface
61032       interface-role:
61033         type: string
61034         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
61035       resource-version:
61036         type: string
61037         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61038       port-group-id:
61039         type: string
61040         description: Unique ID for port group in vmware
61041       port-group-name:
61042         type: string
61043         description: Likely to duplicate value of neutron network name
61044       switch-name:
61045         type: string
61046         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
61047       orchestration-status:
61048         type: string
61049         description: Orchestration status of this VNF, mastered by MSO
61050       heat-stack-id:
61051         type: string
61052         description: Heat stack id corresponding to this instance, managed by MSO
61053       mso-catalog-key:
61054         type: string
61055         description: Corresponds to the SDN-C catalog id used to configure this VCE
61056       cvlan-tags:
61057         type: array
61058         items:
61059           $ref: "#/getDefinitions/cvlan-tag-entry"
61060       relationship-list:
61061         type: array
61062         items:
61063           $ref: "#/getDefinitions/relationship"
61064   port-groups:
61065     properties:
61066       port-group:
61067         type: array
61068         items:
61069           $ref: "#/getDefinitions/port-group"
61070   project:
61071     description: |
61072       describes the project
61073       ###### Related Nodes
61074       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
61075     required:
61076     - project-name
61077     properties:
61078       project-name:
61079         type: string
61080         description: Name of the project deploying a service
61081       resource-version:
61082         type: string
61083         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61084       relationship-list:
61085         type: array
61086         items:
61087           $ref: "#/getDefinitions/relationship"
61088   projects:
61089     description: |
61090       Collection of projects
61091     properties:
61092       project:
61093         type: array
61094         items:
61095           $ref: "#/getDefinitions/project"
61096   properties:
61097     description: |
61098       Property holder for query properties or instance properties
61099     properties:
61100       property-name:
61101         type: string
61102       property-value:
61103         type: string
61104   property-constraint:
61105     description: |
61106       TBD
61107       ###### Related Nodes
61108       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61109     required:
61110     - property-constraint-uuid
61111     - constraint-type
61112     - property-name
61113     - property-value
61114     properties:
61115       property-constraint-uuid:
61116         type: string
61117       constraint-type:
61118         type: string
61119       property-name:
61120         type: string
61121       property-value:
61122         type: string
61123       resource-version:
61124         type: string
61125   property-constraints:
61126     properties:
61127       property-constraint:
61128         type: array
61129         items:
61130           $ref: "#/getDefinitions/property-constraint"
61131   pserver:
61132     description: |
61133       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
61134       ###### Related Nodes
61135       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
61136       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
61137       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
61138       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61139       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61140       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
61141       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
61142       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61143       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
61144       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
61145       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
61146       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61147       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
61148     required:
61149     - hostname
61150     - in-maint
61151     properties:
61152       hostname:
61153         type: string
61154         description: Value from executing hostname on the compute node.
61155       ptnii-equip-name:
61156         type: string
61157         description: PTNII name
61158       number-of-cpus:
61159         type: integer
61160         format: int32
61161         description: Number of cpus
61162       disk-in-gigabytes:
61163         type: integer
61164         format: int32
61165         description: Disk size, in GBs
61166       ram-in-megabytes:
61167         type: integer
61168         format: int32
61169         description: RAM size, in MBs
61170       equip-type:
61171         type: string
61172         description: Equipment type.  Source of truth should define valid values.
61173       equip-vendor:
61174         type: string
61175         description: Equipment vendor.  Source of truth should define valid values.
61176       equip-model:
61177         type: string
61178         description: Equipment model.  Source of truth should define valid values.
61179       fqdn:
61180         type: string
61181         description: Fully-qualified domain name
61182       pserver-selflink:
61183         type: string
61184         description: URL to endpoint where AAI can get more details
61185       ipv4-oam-address:
61186         type: string
61187         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
61188       serial-number:
61189         type: string
61190         description: Serial number, may be queried
61191       ipaddress-v4-loopback-0:
61192         type: string
61193         description: IPV4 Loopback 0 address
61194       ipaddress-v6-loopback-0:
61195         type: string
61196         description: IPV6 Loopback 0 address
61197       ipaddress-v4-aim:
61198         type: string
61199         description: IPV4 AIM address
61200       ipaddress-v6-aim:
61201         type: string
61202         description: IPV6 AIM address
61203       ipaddress-v6-oam:
61204         type: string
61205         description: IPV6 OAM address
61206       inv-status:
61207         type: string
61208         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
61209       pserver-id:
61210         type: string
61211         description: ID of Pserver
61212       internet-topology:
61213         type: string
61214         description: internet topology of Pserver
61215       in-maint:
61216         type: boolean
61217       resource-version:
61218         type: string
61219         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61220       pserver-name2:
61221         type: string
61222         description: alternative pserver name
61223       purpose:
61224         type: string
61225         description: purpose of pserver
61226       prov-status:
61227         type: string
61228         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
61229       relationship-list:
61230         type: array
61231         items:
61232           $ref: "#/getDefinitions/relationship"
61233       p-interfaces:
61234         type: array
61235         items:
61236           $ref: "#/getDefinitions/p-interface"
61237       lag-interfaces:
61238         type: array
61239         items:
61240           $ref: "#/getDefinitions/lag-interface"
61241   pservers:
61242     description: |
61243       Collection of compute hosts.
61244     properties:
61245       pserver:
61246         type: array
61247         items:
61248           $ref: "#/getDefinitions/pserver"
61249   query-parameters:
61250     description: |
61251       QueryParameters for performing a named-query or model query
61252     properties:
61253       named-query:
61254         type: object
61255         $ref: "#/getDefinitions/named-query"
61256       overloaded-model:
61257         type: object
61258         $ref: "#/getDefinitions/overloaded-model"
61259   related-lookup:
61260     description: |
61261       TBD
61262       ###### Related Nodes
61263       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
61264     required:
61265     - related-lookup-uuid
61266     - source-node-type
61267     - source-node-property
61268     - target-node-type
61269     - target-node-property
61270     properties:
61271       related-lookup-uuid:
61272         type: string
61273       source-node-type:
61274         type: string
61275       source-node-property:
61276         type: string
61277       target-node-type:
61278         type: string
61279       target-node-property:
61280         type: string
61281       property-collect-list:
61282         type: string
61283       resource-version:
61284         type: string
61285       relationship-list:
61286         type: array
61287         items:
61288           $ref: "#/getDefinitions/relationship"
61289   related-lookups:
61290     properties:
61291       related-lookup:
61292         type: array
61293         items:
61294           $ref: "#/getDefinitions/related-lookup"
61295   related-to-property:
61296     properties:
61297       property-key:
61298         type: string
61299         description: Key part of a key/value pair
61300       property-value:
61301         type: string
61302         description: Value part of a key/value pair
61303   relationship:
61304     properties:
61305       related-to:
61306         type: string
61307         description: A keyword provided by A&AI to indicate type of node.
61308       related-link:
61309         type: string
61310         description: URL to the object in A&AI.
61311       relationship-data:
61312         type: array
61313         items:
61314           $ref: "#/getDefinitions/relationship-data"
61315       related-to-property:
61316         type: array
61317         items:
61318           $ref: "#/getDefinitions/related-to-property"
61319   relationship-data:
61320     required:
61321     - relationship-key
61322     - relationship-value
61323     properties:
61324       relationship-key:
61325         type: string
61326         description: A keyword provided by A&AI to indicate an attribute.
61327       relationship-value:
61328         type: string
61329         description: Value of the attribute.
61330   relationship-list:
61331     properties:
61332       relationship:
61333         type: array
61334         items:
61335           $ref: "#/getDefinitions/relationship"
61336   reserved-prop-names:
61337     description: |
61338       Internal map to define some reserved properties of a vertex
61339     properties:
61340       last-mod-source-of-truth:
61341         type: string
61342       aai-node-type:
61343         type: string
61344       aai-created-ts:
61345         type: integer
61346         format: int64
61347       aai-unique-key:
61348         type: string
61349       aai-last-mod-ts:
61350         type: integer
61351         format: int64
61352       source-of-truth:
61353         type: string
61354       aai-uri:
61355         type: string
61356   response-list:
61357     description: |
61358       Response container for the results of a named-query or model query
61359     properties:
61360       inventory-response-items:
61361         type: object
61362         $ref: "#/getDefinitions/inventory-response-items"
61363   result-data:
61364     properties:
61365       resource-type:
61366         type: string
61367         description: The specific type of node in the A&AI graph
61368       resource-link:
61369         type: string
61370         description: The URL to the specific resource
61371   route-table-reference:
61372     description: |
61373       Openstack route table reference.
61374       ###### Related Nodes
61375       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
61376     required:
61377     - route-table-reference-id
61378     - route-table-reference-fqdn
61379     properties:
61380       route-table-reference-id:
61381         type: string
61382         description: Route Table Reference id, UUID assigned to this instance.
61383       route-table-reference-fqdn:
61384         type: string
61385         description: FQDN entry in the route table.
61386       resource-version:
61387         type: string
61388         description: Concurrency value
61389       relationship-list:
61390         type: array
61391         items:
61392           $ref: "#/getDefinitions/relationship"
61393   route-table-references:
61394     description: |
61395       Collection of openstack route table references
61396     properties:
61397       route-table-reference:
61398         type: array
61399         items:
61400           $ref: "#/getDefinitions/route-table-reference"
61401   route-target:
61402     description: |
61403       Route target information
61404       ###### Related Nodes
61405       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
61406     required:
61407     - global-route-target
61408     - route-target-role
61409     properties:
61410       global-route-target:
61411         type: string
61412         description: Number used to identify an RT, globally unique in the network
61413       route-target-role:
61414         type: string
61415         description: Role assigned to this route target
61416       resource-version:
61417         type: string
61418         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61419       relationship-list:
61420         type: array
61421         items:
61422           $ref: "#/getDefinitions/relationship"
61423   route-targets:
61424     description: |
61425       Collection of route target information
61426     properties:
61427       route-target:
61428         type: array
61429         items:
61430           $ref: "#/getDefinitions/route-target"
61431   routing-instance:
61432     description: |
61433       ###### Related Nodes
61434       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61435       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61436       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
61437     required:
61438     - routing-instance-id
61439     properties:
61440       routing-instance-id:
61441         type: string
61442         description: Unique id of routing instance
61443       rpm-owner:
61444         type: string
61445         description: rpm owner
61446       resource-version:
61447         type: string
61448         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61449       site-pairs:
61450         type: array
61451         items:
61452           $ref: "#/getDefinitions/site-pair"
61453       relationship-list:
61454         type: array
61455         items:
61456           $ref: "#/getDefinitions/relationship"
61457   routing-instances:
61458     description: |
61459       set of probes related to generic-vnf routing instance
61460     properties:
61461       routing-instance:
61462         type: array
61463         items:
61464           $ref: "#/getDefinitions/routing-instance"
61465   sdn-zone-response:
61466     properties:
61467       oam-networks:
61468         type: object
61469         $ref: "#/getDefinitions/oam-networks"
61470       az-and-dvs-switches:
61471         type: array
61472         items:
61473           $ref: "#/getDefinitions/az-and-dvs-switches"
61474   search:
61475     properties:
61476       edge-tag-query-result:
61477         type: object
61478         $ref: "#/getDefinitions/edge-tag-query-result"
61479       edge-tag-query-request:
61480         type: object
61481         $ref: "#/getDefinitions/edge-tag-query-request"
61482       search-results:
61483         type: object
61484         $ref: "#/getDefinitions/search-results"
61485       sdn-zone-response:
61486         type: object
61487         $ref: "#/getDefinitions/sdn-zone-response"
61488   search-results:
61489     properties:
61490       result-data:
61491         type: array
61492         items:
61493           $ref: "#/getDefinitions/result-data"
61494   secondary-filt:
61495     description: |
61496       SecondaryFilt for performing a named-query or model query
61497   secondary-filter:
61498     properties:
61499       property-name:
61500         type: string
61501       filter-type:
61502         type: string
61503       property-value:
61504         type: string
61505   secondary-filts:
61506     description: |
61507       SecondaryFilts for performing a named-query or model query
61508     properties:
61509       secondary-filt:
61510         type: array
61511         items:
61512           $ref: "#/getDefinitions/secondary-filt"
61513   segmentation-assignment:
61514     description: |
61515       Openstack segmentation assignment.
61516       ###### Related Nodes
61517       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61518     required:
61519     - segmentation-id
61520     properties:
61521       segmentation-id:
61522         type: string
61523         description: Route Table Reference id, UUID assigned to this instance.
61524       resource-version:
61525         type: string
61526         description: Concurrency value
61527       relationship-list:
61528         type: array
61529         items:
61530           $ref: "#/getDefinitions/relationship"
61531   segmentation-assignments:
61532     description: |
61533       Collection of openstack segmentation assignments
61534     properties:
61535       segmentation-assignment:
61536         type: array
61537         items:
61538           $ref: "#/getDefinitions/segmentation-assignment"
61539   service:
61540     description: |
61541       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
61542     required:
61543     - service-id
61544     - service-description
61545     properties:
61546       service-id:
61547         type: string
61548         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61549       service-description:
61550         type: string
61551         description: Description of the service
61552       service-selflink:
61553         type: string
61554         description: URL to endpoint where AAI can get more details
61555       resource-version:
61556         type: string
61557         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61558       service-version:
61559         type: string
61560         description: service version
61561       relationship-list:
61562         type: array
61563         items:
61564           $ref: "#/getDefinitions/relationship"
61565   service-capabilities:
61566     description: |
61567       Collection of service capabilities.
61568     properties:
61569       service-capability:
61570         type: array
61571         items:
61572           $ref: "#/getDefinitions/service-capability"
61573   service-capability:
61574     description: |
61575       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
61576       ###### Related Nodes
61577       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61578       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
61579       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
61580     required:
61581     - service-type
61582     - vnf-type
61583     properties:
61584       service-type:
61585         type: string
61586         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
61587       vnf-type:
61588         type: string
61589         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
61590       resource-version:
61591         type: string
61592         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61593       relationship-list:
61594         type: array
61595         items:
61596           $ref: "#/getDefinitions/relationship"
61597   service-design-and-creation:
61598     description: |
61599       Namespace for objects managed by ASDC
61600     properties:
61601       vnf-images:
61602         type: array
61603         items:
61604           $ref: "#/getDefinitions/vnf-image"
61605       services:
61606         type: array
61607         items:
61608           $ref: "#/getDefinitions/service"
61609       service-capabilities:
61610         type: array
61611         items:
61612           $ref: "#/getDefinitions/service-capability"
61613       models:
61614         type: array
61615         items:
61616           $ref: "#/getDefinitions/model"
61617       named-queries:
61618         type: array
61619         items:
61620           $ref: "#/getDefinitions/named-query"
61621   service-instance:
61622     description: |
61623       Instance of a service
61624       ###### Related Nodes
61625       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
61626       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
61627       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
61628       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
61629       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
61630       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
61631       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61632       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
61633       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
61634       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61635       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61636       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61637       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61638       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61639       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61640       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61641       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
61642       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61643     required:
61644     - service-instance-id
61645     properties:
61646       service-instance-id:
61647         type: string
61648         description: Uniquely identifies this instance of a service
61649       service-instance-name:
61650         type: string
61651         description: This field will store a name assigned to the service-instance.
61652       model-invariant-id:
61653         type: string
61654         description: the ASDC model id for this resource or service model.
61655       model-version-id:
61656         type: string
61657         description: the ASDC model version for this resource or service model.
61658       persona-model-version:
61659         type: string
61660         description: the ASDC model version for this resource or service model.
61661       widget-model-id:
61662         type: string
61663         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61664       widget-model-version:
61665         type: string
61666         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61667       bandwidth-total:
61668         type: string
61669         description: Indicates the total bandwidth to be used for this service.
61670       bandwidth-up-wan1:
61671         type: string
61672         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61673       bandwidth-down-wan1:
61674         type: string
61675         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61676       bandwidth-up-wan2:
61677         type: string
61678         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61679       bandwidth-down-wan2:
61680         type: string
61681         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61682       vhn-portal-url:
61683         type: string
61684         description: URL customers will use to access the vHN Portal.
61685       service-instance-location-id:
61686         type: string
61687         description: An identifier that customers assign to the location where this service is being used.
61688       resource-version:
61689         type: string
61690         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61691       selflink:
61692         type: string
61693         description: Path to the controller object.
61694       orchestration-status:
61695         type: string
61696         description: Orchestration status of this service.
61697       relationship-list:
61698         type: array
61699         items:
61700           $ref: "#/getDefinitions/relationship"
61701       metadata:
61702         type: array
61703         items:
61704           $ref: "#/getDefinitions/metadatum"
61705       allotted-resources:
61706         type: array
61707         items:
61708           $ref: "#/getDefinitions/allotted-resource"
61709   service-instances:
61710     description: |
61711       Collection of service instances
61712     properties:
61713       service-instance:
61714         type: array
61715         items:
61716           $ref: "#/getDefinitions/service-instance"
61717   service-subscription:
61718     description: |
61719       Object that group service instances.
61720       ###### Related Nodes
61721       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
61722       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61723       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61724       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
61725     required:
61726     - service-type
61727     properties:
61728       service-type:
61729         type: string
61730         description: Value defined by orchestration to identify this service across ECOMP.
61731       temp-ub-sub-account-id:
61732         type: string
61733         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61734       resource-version:
61735         type: string
61736         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61737       service-instances:
61738         type: array
61739         items:
61740           $ref: "#/getDefinitions/service-instance"
61741       relationship-list:
61742         type: array
61743         items:
61744           $ref: "#/getDefinitions/relationship"
61745   service-subscriptions:
61746     description: |
61747       Collection of objects that group service instances.
61748     properties:
61749       service-subscription:
61750         type: array
61751         items:
61752           $ref: "#/getDefinitions/service-subscription"
61753   services:
61754     description: |
61755       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
61756     properties:
61757       service:
61758         type: array
61759         items:
61760           $ref: "#/getDefinitions/service"
61761   site-pair:
61762     description: |
61763       ###### Related Nodes
61764       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61765       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
61766       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
61767     required:
61768     - site-pair-id
61769     properties:
61770       site-pair-id:
61771         type: string
61772         description: unique identifier of probe
61773       source-ip:
61774         type: string
61775         description: Prefix address
61776       destination-ip:
61777         type: string
61778         description: Prefix address
61779       ip-version:
61780         type: string
61781         description: ip version, v4, v6
61782       destination-hostname:
61783         type: string
61784         description: Hostname of the destination equipment to which SLAs are measured against.
61785       destination-equip-type:
61786         type: string
61787         description: The type of destinatination equipment. Could be Router, etc.
61788       resource-version:
61789         type: string
61790         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61791       classes-of-service:
61792         type: array
61793         items:
61794           $ref: "#/getDefinitions/class-of-service"
61795       relationship-list:
61796         type: array
61797         items:
61798           $ref: "#/getDefinitions/relationship"
61799   site-pair-set:
61800     description: |
61801       Set of instances for probes used to measure service level agreements
61802       ###### Related Nodes
61803       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61804       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61805       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
61806     required:
61807     - site-pair-set-id
61808     properties:
61809       site-pair-set-id:
61810         type: string
61811         description: Unique id of site pair set.
61812       resource-version:
61813         type: string
61814         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61815       routing-instances:
61816         type: array
61817         items:
61818           $ref: "#/getDefinitions/routing-instance"
61819       relationship-list:
61820         type: array
61821         items:
61822           $ref: "#/getDefinitions/relationship"
61823   site-pair-sets:
61824     description: |
61825       Collection of sets of instances for probes related to generic-vnf
61826     properties:
61827       site-pair-set:
61828         type: array
61829         items:
61830           $ref: "#/getDefinitions/site-pair-set"
61831   site-pairs:
61832     description: |
61833       probe within a set
61834     properties:
61835       site-pair:
61836         type: array
61837         items:
61838           $ref: "#/getDefinitions/site-pair"
61839   snapshot:
61840     description: |
61841       Openstack snapshot
61842       ###### Related Nodes
61843       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61844       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
61845     required:
61846     - snapshot-id
61847     properties:
61848       snapshot-id:
61849         type: string
61850         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61851       snapshot-name:
61852         type: string
61853         description: Snapshot name
61854       snapshot-architecture:
61855         type: string
61856         description: Operating system architecture
61857       snapshot-os-distro:
61858         type: string
61859         description: The common name of the operating system distribution in lowercase
61860       snapshot-os-version:
61861         type: string
61862         description: The operating system version as specified by the distributor.
61863       application:
61864         type: string
61865         description: The application that the image instantiates.
61866       application-vendor:
61867         type: string
61868         description: The vendor of the application.
61869       application-version:
61870         type: string
61871         description: The version of the application.
61872       snapshot-selflink:
61873         type: string
61874         description: URL to endpoint where AAI can get more details
61875       prev-snapshot-id:
61876         type: string
61877         description: This field contains the UUID of the previous snapshot (if any).
61878       resource-version:
61879         type: string
61880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61881       relationship-list:
61882         type: array
61883         items:
61884           $ref: "#/getDefinitions/relationship"
61885   snapshots:
61886     description: |
61887       Collection of openstack snapshots
61888     properties:
61889       snapshot:
61890         type: array
61891         items:
61892           $ref: "#/getDefinitions/snapshot"
61893   sriov-pf:
61894     description: |
61895       SR-IOV Physical Function
61896       ###### Related Nodes
61897       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
61898       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
61899     required:
61900     - pf-pci-id
61901     properties:
61902       pf-pci-id:
61903         type: string
61904         description: Identifier for the sriov-pf
61905       resource-version:
61906         type: string
61907         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61908       relationship-list:
61909         type: array
61910         items:
61911           $ref: "#/getDefinitions/relationship"
61912   sriov-pfs:
61913     description: |
61914       Collection of SR-IOV Physical Functions.
61915     properties:
61916       sriov-pf:
61917         type: array
61918         items:
61919           $ref: "#/getDefinitions/sriov-pf"
61920   sriov-vf:
61921     description: |
61922       SR-IOV Virtual Function (not to be confused with virtual network function)
61923       ###### Related Nodes
61924       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
61925     required:
61926     - pci-id
61927     properties:
61928       pci-id:
61929         type: string
61930         description: PCI ID used to identify the sriov-vf
61931       vf-vlan-filter:
61932         type: string
61933         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61934       vf-mac-filter:
61935         type: string
61936         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61937       vf-vlan-strip:
61938         type: boolean
61939         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61940       vf-vlan-anti-spoof-check:
61941         type: boolean
61942         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.
61943       vf-mac-anti-spoof-check:
61944         type: boolean
61945         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.
61946       vf-mirrors:
61947         type: string
61948         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61949       vf-broadcast-allow:
61950         type: boolean
61951         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61952       vf-unknown-multicast-allow:
61953         type: boolean
61954         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61955       vf-unknown-unicast-allow:
61956         type: boolean
61957         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61958       vf-insert-stag:
61959         type: boolean
61960         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61961       vf-link-status:
61962         type: string
61963         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
61964       resource-version:
61965         type: string
61966         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
61967       neutron-network-id:
61968         type: string
61969         description: Neutron network id of the interface
61970       relationship-list:
61971         type: array
61972         items:
61973           $ref: "#/getDefinitions/relationship"
61974   sriov-vfs:
61975     description: |
61976       Collection of SR-IOV Virtual Functions.
61977     properties:
61978       sriov-vf:
61979         type: array
61980         items:
61981           $ref: "#/getDefinitions/sriov-vf"
61982   start-node-filter:
61983     properties:
61984       property-name:
61985         type: string
61986       property-value:
61987         type: string
61988   subnet:
61989     description: |
61990       ###### Related Nodes
61991       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61992       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61993       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61994       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61995     required:
61996     - subnet-id
61997     - dhcp-enabled
61998     properties:
61999       subnet-id:
62000         type: string
62001         description: Subnet ID, should be UUID.
62002       subnet-name:
62003         type: string
62004         description: Name associated with the subnet.
62005       neutron-subnet-id:
62006         type: string
62007         description: Neutron id of this subnet
62008       gateway-address:
62009         type: string
62010         description: gateway ip address
62011       network-start-address:
62012         type: string
62013         description: network start address
62014       cidr-mask:
62015         type: string
62016         description: cidr mask
62017       ip-version:
62018         type: string
62019         description: ip version
62020       orchestration-status:
62021         type: string
62022         description: Orchestration status of this VNF, mastered by MSO
62023       dhcp-enabled:
62024         type: boolean
62025       dhcp-start:
62026         type: string
62027         description: the start address reserved for use by dhcp
62028       dhcp-end:
62029         type: string
62030         description: the last address reserved for use by dhcp
62031       resource-version:
62032         type: string
62033         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62034       relationship-list:
62035         type: array
62036         items:
62037           $ref: "#/getDefinitions/relationship"
62038   subnets:
62039     properties:
62040       subnet:
62041         type: array
62042         items:
62043           $ref: "#/getDefinitions/subnet"
62044   tagged-inventory-item-list:
62045     properties:
62046       inventory-item:
62047         type: array
62048         items:
62049           $ref: "#/getDefinitions/inventory-item"
62050   tenant:
62051     description: |
62052       Openstack tenant
62053       ###### Related Nodes
62054       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62055       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
62056       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62057       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62058       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
62059       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62060       - TENANT cannot be deleted if linked to VSERVER
62061     required:
62062     - tenant-id
62063     - tenant-name
62064     properties:
62065       tenant-id:
62066         type: string
62067         description: Unique id relative to the cloud-region.
62068       tenant-name:
62069         type: string
62070         description: Readable name of tenant
62071       resource-version:
62072         type: string
62073         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62074       vservers:
62075         type: array
62076         items:
62077           $ref: "#/getDefinitions/vserver"
62078       relationship-list:
62079         type: array
62080         items:
62081           $ref: "#/getDefinitions/relationship"
62082   tenants:
62083     description: |
62084       Collection of openstack tenants.
62085     properties:
62086       tenant:
62087         type: array
62088         items:
62089           $ref: "#/getDefinitions/tenant"
62090   tunnel-xconnect:
62091     description: |
62092       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
62093       ###### Related Nodes
62094       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
62095     required:
62096     - id
62097     - bandwidth-up-wan1
62098     - bandwidth-down-wan1
62099     - bandwidth-up-wan2
62100     - bandwidth-down-wan2
62101     properties:
62102       id:
62103         type: string
62104         description: Allotted Resource id UUID assigned to this instance.
62105       bandwidth-up-wan1:
62106         type: string
62107         description: The WAN uplink bandwidth for WAN1
62108       bandwidth-down-wan1:
62109         type: string
62110         description: The WAN downlink bandwidth for WAN1
62111       bandwidth-up-wan2:
62112         type: string
62113         description: The WAN uplink bandwidth for WAN2
62114       bandwidth-down-wan2:
62115         type: string
62116         description: The WAN downlink bandwidth for WAN2
62117       resource-version:
62118         type: string
62119         description: Concurrency value
62120       relationship-list:
62121         type: array
62122         items:
62123           $ref: "#/getDefinitions/relationship"
62124   tunnel-xconnects:
62125     description: |
62126       This object is used to store the specific tunnel cross connect aspects of an allotted resource
62127     properties:
62128       tunnel-xconnect:
62129         type: array
62130         items:
62131           $ref: "#/getDefinitions/tunnel-xconnect"
62132   update:
62133     description: |
62134       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
62135     required:
62136     - update-node-type
62137     properties:
62138       update-node-type:
62139         type: string
62140       update-node-key:
62141         type: array
62142         items:
62143           $ref: "#/getDefinitions/update-node-key"
62144       update-node-uri:
62145         type: string
62146       action:
62147         type: array
62148         items:
62149           $ref: "#/getDefinitions/action"
62150   update-node-key:
62151     properties:
62152       key-name:
62153         type: string
62154       key-value:
62155         type: string
62156   vce:
62157     description: |
62158       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
62159       ###### Related Nodes
62160       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62161       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62162       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62163       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62164       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62165       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62166       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
62167       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
62168     required:
62169     - vnf-id
62170     - vnf-name
62171     - vnf-type
62172     properties:
62173       vnf-id:
62174         type: string
62175         description: Unique id of VNF.  This is unique across the graph.
62176       vnf-name:
62177         type: string
62178         description: Name of VNF.
62179       vnf-name2:
62180         type: string
62181         description: Alternate name of VNF.
62182       vnf-type:
62183         type: string
62184         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
62185       service-id:
62186         type: string
62187         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
62188       regional-resource-zone:
62189         type: string
62190         description: Regional way of organizing pservers, source of truth should define values
62191       prov-status:
62192         type: string
62193         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62194       operational-status:
62195         type: string
62196         description: Indicator for whether the resource is considered operational
62197       license-key:
62198         type: string
62199         description: OBSOLETE -  do not use
62200       equipment-role:
62201         type: string
62202         description: Network role being played by this VNF
62203       orchestration-status:
62204         type: string
62205         description: Orchestration status of this VNF, mastered by MSO
62206       heat-stack-id:
62207         type: string
62208         description: Heat stack id corresponding to this instance, managed by MSO
62209       mso-catalog-key:
62210         type: string
62211         description: Corresponds to the SDN-C catalog id used to configure this VCE
62212       vpe-id:
62213         type: string
62214         description: Unique ID of VPE connected to this VCE.
62215       v6-vce-wan-address:
62216         type: string
62217         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
62218       ipv4-oam-address:
62219         type: string
62220         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
62221       resource-version:
62222         type: string
62223         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62224       ipv4-loopback0-address:
62225         type: string
62226         description: Loopback0 address
62227       entitlement-resource-uuid:
62228         type: string
62229         description: OBSOLETE -  see child relationships
62230       port-groups:
62231         type: array
62232         items:
62233           $ref: "#/getDefinitions/port-group"
62234       licenses:
62235         type: array
62236         items:
62237           $ref: "#/getDefinitions/license"
62238       entitlements:
62239         type: array
62240         items:
62241           $ref: "#/getDefinitions/entitlement"
62242       relationship-list:
62243         type: array
62244         items:
62245           $ref: "#/getDefinitions/relationship"
62246   vces:
62247     description: |
62248       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
62249     properties:
62250       vce:
62251         type: array
62252         items:
62253           $ref: "#/getDefinitions/vce"
62254   vf-module:
62255     description: |
62256       a deployment unit of VNFCs
62257       ###### Related Nodes
62258       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62259       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
62260       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
62261       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
62262       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
62263       - VF-MODULE cannot be deleted if linked to VNFC
62264     required:
62265     - vf-module-id
62266     - is-base-vf-module
62267     properties:
62268       vf-module-id:
62269         type: string
62270         description: Unique ID of vf-module.
62271       vf-module-name:
62272         type: string
62273         description: Name of vf-module
62274       heat-stack-id:
62275         type: string
62276         description: Heat stack id corresponding to this instance.
62277       orchestration-status:
62278         type: string
62279         description: orchestration status of this vf-module, mastered by MSO
62280       is-base-vf-module:
62281         type: boolean
62282       resource-version:
62283         type: string
62284         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62285       model-invariant-id:
62286         type: string
62287         description: the ASDC model id for this resource or service model.
62288       model-version-id:
62289         type: string
62290         description: the ASDC model version for this resource or service model.
62291       persona-model-version:
62292         type: string
62293         description: the ASDC model version for this resource or service model.
62294       model-customization-id:
62295         type: string
62296         description: captures the id of all the configuration used to customize the resource for the service.
62297       widget-model-id:
62298         type: string
62299         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62300       widget-model-version:
62301         type: string
62302         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62303       contrail-service-instance-fqdn:
62304         type: string
62305         description: the Contrail unique ID for a service-instance
62306       module-index:
62307         type: integer
62308         format: int32
62309         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
62310       selflink:
62311         type: string
62312         description: Path to the controller object.
62313       relationship-list:
62314         type: array
62315         items:
62316           $ref: "#/getDefinitions/relationship"
62317   vf-modules:
62318     description: |
62319       Collection of vf-modules, a deployment unit of VNFCs
62320     properties:
62321       vf-module:
62322         type: array
62323         items:
62324           $ref: "#/getDefinitions/vf-module"
62325   vig-server:
62326     description: |
62327       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
62328       ###### Related Nodes
62329       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
62330     required:
62331     - vig-address-type
62332     properties:
62333       vig-address-type:
62334         type: string
62335         description: indicates whether the VIG is for AVPN or INTERNET
62336       ipaddress-v4-vig:
62337         type: string
62338         description: v4 IP of the vig server
62339       ipaddress-v6-vig:
62340         type: string
62341         description: v6 IP of the vig server
62342       resource-version:
62343         type: string
62344         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62345       relationship-list:
62346         type: array
62347         items:
62348           $ref: "#/getDefinitions/relationship"
62349   vig-servers:
62350     properties:
62351       vig-server:
62352         type: array
62353         items:
62354           $ref: "#/getDefinitions/vig-server"
62355   vip-ipv4-address-list:
62356     description: |
62357       IPv4 Address Range
62358       ###### Related Nodes
62359       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62360       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62361       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62362       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
62363     required:
62364     - vip-ipv4-address
62365     properties:
62366       vip-ipv4-address:
62367         type: string
62368         description: IP address
62369       vip-ipv4-prefix-length:
62370         type: integer
62371         format: int64
62372         description: Prefix length, 32 for single address
62373       vlan-id-inner:
62374         type: integer
62375         format: int64
62376         description: Inner VLAN tag
62377       vlan-id-outer:
62378         type: integer
62379         format: int64
62380         description: Outer VLAN tag
62381       is-floating:
62382         type: boolean
62383         description: Indicator of fixed or floating address
62384       resource-version:
62385         type: string
62386         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62387       neutron-network-id:
62388         type: string
62389         description: Neutron network id of the interface that address belongs to
62390       neutron-subnet-id:
62391         type: string
62392         description: Neutron id of subnet that address belongs to
62393       relationship-list:
62394         type: array
62395         items:
62396           $ref: "#/getDefinitions/relationship"
62397   vip-ipv6-address-list:
62398     description: |
62399       IPv6 Address Range
62400       ###### Related Nodes
62401       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62402       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62403       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
62404       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
62405     required:
62406     - vip-ipv6-address
62407     properties:
62408       vip-ipv6-address:
62409         type: string
62410         description: IP address
62411       vip-ipv6-prefix-length:
62412         type: integer
62413         format: int64
62414         description: Prefix length, 128 for single address
62415       vlan-id-inner:
62416         type: integer
62417         format: int64
62418         description: Inner VLAN tag
62419       vlan-id-outer:
62420         type: integer
62421         format: int64
62422         description: Outer VLAN tag
62423       is-floating:
62424         type: boolean
62425         description: Indicator of fixed or floating address
62426       resource-version:
62427         type: string
62428         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62429       neutron-network-id:
62430         type: string
62431         description: Neutron network id of the interface that address belongs to
62432       neutron-subnet-id:
62433         type: string
62434         description: Neutron id of subnet that address belongs to
62435       relationship-list:
62436         type: array
62437         items:
62438           $ref: "#/getDefinitions/relationship"
62439   virtual-data-center:
62440     description: |
62441       Virtual organization of cloud infrastructure elements in a data center context
62442       ###### Related Nodes
62443       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62444       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62445       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62446     required:
62447     - vdc-id
62448     - vdc-name
62449     properties:
62450       vdc-id:
62451         type: string
62452         description: Unique ID of the vdc
62453       vdc-name:
62454         type: string
62455         description: Name of the virtual data center
62456       resource-version:
62457         type: string
62458         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62459       relationship-list:
62460         type: array
62461         items:
62462           $ref: "#/getDefinitions/relationship"
62463   virtual-data-centers:
62464     description: |
62465       Virtual organization of cloud infrastructure elements in a data center context
62466     properties:
62467       virtual-data-center:
62468         type: array
62469         items:
62470           $ref: "#/getDefinitions/virtual-data-center"
62471   vlan:
62472     description: |
62473       Definition of vlan
62474       ###### Related Nodes
62475       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
62476       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
62477       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
62478       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
62479       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
62480       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
62481       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
62482       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
62483       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
62484     required:
62485     - vlan-interface
62486     - in-maint
62487     properties:
62488       vlan-interface:
62489         type: string
62490         description: String that identifies the interface
62491       vlan-id-inner:
62492         type: integer
62493         format: int64
62494         description: Inner VLAN tag
62495       vlan-id-outer:
62496         type: integer
62497         format: int64
62498         description: Outer VLAN tag
62499       resource-version:
62500         type: string
62501         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62502       speed-value:
62503         type: string
62504         description: Captures the numeric part of the speed
62505       speed-units:
62506         type: string
62507         description: Captures the units corresponding to the speed
62508       vlan-description:
62509         type: string
62510         description: Used to describe (the service associated with) the vlan
62511       backdoor-connection:
62512         type: string
62513         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
62514       vpn-id:
62515         type: string
62516         description: This indicates the customers VPN ID associated with this vlan
62517       orchestration-status:
62518         type: string
62519         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
62520       in-maint:
62521         type: boolean
62522       relationship-list:
62523         type: array
62524         items:
62525           $ref: "#/getDefinitions/relationship"
62526       l3-interface-ipv4-address-list:
62527         type: array
62528         items:
62529           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
62530       l3-interface-ipv6-address-list:
62531         type: array
62532         items:
62533           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
62534   vlans:
62535     properties:
62536       vlan:
62537         type: array
62538         items:
62539           $ref: "#/getDefinitions/vlan"
62540   vnf:
62541     description: |
62542       Abstract vnf class
62543     required:
62544     - vnf-id
62545     properties:
62546       vnf-id:
62547         type: string
62548         description: Unique id of VNF.  This is unique across the graph.
62549   vnf-image:
62550     description: |
62551       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62552       ###### Related Nodes
62553       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
62554       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
62555     required:
62556     - vnf-image-uuid
62557     - application
62558     - application-vendor
62559     properties:
62560       vnf-image-uuid:
62561         type: string
62562         description: Unique ID of this asset
62563       application:
62564         type: string
62565         description: The application that the image instantiates.
62566       application-vendor:
62567         type: string
62568         description: The vendor of the application.
62569       application-version:
62570         type: string
62571         description: The version of the application.
62572       selflink:
62573         type: string
62574         description: URL to endpoint where AAI can get more details
62575       resource-version:
62576         type: string
62577         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62578       relationship-list:
62579         type: array
62580         items:
62581           $ref: "#/getDefinitions/relationship"
62582   vnf-images:
62583     description: |
62584       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
62585     properties:
62586       vnf-image:
62587         type: array
62588         items:
62589           $ref: "#/getDefinitions/vnf-image"
62590   vnfc:
62591     description: |
62592       ###### Related Nodes
62593       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62594       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
62595       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
62596     required:
62597     - vnfc-name
62598     - vnfc-function-code
62599     - vnfc-type
62600     - in-maint
62601     - is-closed-loop-disabled
62602     properties:
62603       vnfc-name:
62604         type: string
62605         description: Unique ID of vnfc.
62606       vnfc-function-code:
62607         type: string
62608         description: function code
62609       vnfc-type:
62610         type: string
62611         description: type
62612       prov-status:
62613         type: string
62614         description: prov status of this vnfc
62615       orchestration-status:
62616         type: string
62617         description: Orchestration status of this VNF, mastered by APP-C
62618       ipaddress-v4-oam-vip:
62619         type: string
62620         description: Oam V4 vip address of this vnfc
62621       in-maint:
62622         type: boolean
62623       is-closed-loop-disabled:
62624         type: boolean
62625       group-notation:
62626         type: string
62627         description: Group notation of VNFC
62628       resource-version:
62629         type: string
62630         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62631       relationship-list:
62632         type: array
62633         items:
62634           $ref: "#/getDefinitions/relationship"
62635   vnfcs:
62636     description: |
62637       virtual network components associated with a vserver from application controller.
62638     properties:
62639       vnfc:
62640         type: array
62641         items:
62642           $ref: "#/getDefinitions/vnfc"
62643   volume:
62644     description: |
62645       Ephemeral Block storage volume.
62646       ###### Related Nodes
62647       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
62648     required:
62649     - volume-id
62650     - volume-selflink
62651     properties:
62652       volume-id:
62653         type: string
62654         description: Unique ID of block storage volume relative to the vserver.
62655       volume-selflink:
62656         type: string
62657         description: URL to endpoint where AAI can get more details
62658       resource-version:
62659         type: string
62660         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62661       relationship-list:
62662         type: array
62663         items:
62664           $ref: "#/getDefinitions/relationship"
62665   volume-group:
62666     description: |
62667       Persistent block-level storage.
62668       ###### Related Nodes
62669       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62670       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62671       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62672       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
62673       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
62674     required:
62675     - volume-group-id
62676     - volume-group-name
62677     - vnf-type
62678     properties:
62679       volume-group-id:
62680         type: string
62681         description: Unique ID of volume-group.
62682       volume-group-name:
62683         type: string
62684         description: Name of the volume group.
62685       heat-stack-id:
62686         type: string
62687         description: Heat stack id corresponding to this volume-group
62688       vnf-type:
62689         type: string
62690         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
62691       orchestration-status:
62692         type: string
62693         description: Orchestration status of this volume-group
62694       model-customization-id:
62695         type: string
62696         description: captures the id of all the configuration used to customize the resource for the service.
62697       vf-module-model-customization-id:
62698         type: string
62699         description: helps relate the volume group to the vf-module whose components will require the volume group
62700       resource-version:
62701         type: string
62702         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62703       relationship-list:
62704         type: array
62705         items:
62706           $ref: "#/getDefinitions/relationship"
62707   volume-groups:
62708     description: |
62709       Collection of persistent block-level storage.
62710     properties:
62711       volume-group:
62712         type: array
62713         items:
62714           $ref: "#/getDefinitions/volume-group"
62715   volumes:
62716     description: |
62717       Collection of ephemeral Block storage volumes.
62718     properties:
62719       volume:
62720         type: array
62721         items:
62722           $ref: "#/getDefinitions/volume"
62723   vpls-pe:
62724     description: |
62725       VPLS Provider Edge routers.
62726       ###### Related Nodes
62727       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62728       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62729       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62730       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
62731       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
62732     required:
62733     - equipment-name
62734     properties:
62735       equipment-name:
62736         type: string
62737       prov-status:
62738         type: string
62739         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
62740       ipv4-oam-address:
62741         type: string
62742         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).
62743       equipment-role:
62744         type: string
62745         description: Client should send valid enumerated value, e.g., VPLS-PE.
62746       vlan-id-outer:
62747         type: integer
62748         format: int64
62749         description: Temporary location for stag to get to VCE
62750       resource-version:
62751         type: string
62752         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62753       relationship-list:
62754         type: array
62755         items:
62756           $ref: "#/getDefinitions/relationship"
62757       p-interfaces:
62758         type: array
62759         items:
62760           $ref: "#/getDefinitions/p-interface"
62761       lag-interfaces:
62762         type: array
62763         items:
62764           $ref: "#/getDefinitions/lag-interface"
62765   vpls-pes:
62766     description: |
62767       Collection of VPLS Provider Edge routers
62768     properties:
62769       vpls-pe:
62770         type: array
62771         items:
62772           $ref: "#/getDefinitions/vpls-pe"
62773   vpn-binding:
62774     description: |
62775       VPN binding
62776       ###### Related Nodes
62777       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62778       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
62779       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
62780       - VPN-BINDING cannot be deleted if linked to L3-NETWORK,LOGICAL-LINK
62781       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
62782     required:
62783     - vpn-id
62784     - vpn-name
62785     properties:
62786       vpn-id:
62787         type: string
62788         description: VPN ID, globally unique within A&AI
62789       vpn-name:
62790         type: string
62791         description: VPN Name
62792       vpn-platform:
62793         type: string
62794         description: the platform associated with the VPN example AVPN, Mobility
62795       vpn-type:
62796         type: string
62797         description: Type of the vpn, should be taken from enumerated/valid values
62798       route-distinguisher:
62799         type: string
62800         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
62801       resource-version:
62802         type: string
62803         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62804       route-targets:
62805         type: array
62806         items:
62807           $ref: "#/getDefinitions/route-target"
62808       relationship-list:
62809         type: array
62810         items:
62811           $ref: "#/getDefinitions/relationship"
62812         description: l3-networks relate to vpn-bindings
62813   vpn-bindings:
62814     properties:
62815       vpn-binding:
62816         type: array
62817         items:
62818           $ref: "#/getDefinitions/vpn-binding"
62819   vserver:
62820     description: |
62821       Virtual Servers, aka virtual machine or VM.
62822       ###### Related Nodes
62823       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
62824       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
62825       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
62826       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
62827       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
62828       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
62829       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
62830       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
62831       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
62832       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
62833       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
62834       - VSERVER is DELETED when these are DELETED L-INTERFACE
62835       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
62836     required:
62837     - vserver-id
62838     - vserver-name
62839     - vserver-selflink
62840     - in-maint
62841     - is-closed-loop-disabled
62842     properties:
62843       vserver-id:
62844         type: string
62845         description: Unique identifier for this vserver relative to its tenant
62846       vserver-name:
62847         type: string
62848         description: Name of vserver
62849       vserver-name2:
62850         type: string
62851         description: Alternative name of vserver
62852       prov-status:
62853         type: string
62854         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62855       vserver-selflink:
62856         type: string
62857         description: URL to endpoint where AAI can get more details
62858       in-maint:
62859         type: boolean
62860       is-closed-loop-disabled:
62861         type: boolean
62862       resource-version:
62863         type: string
62864         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62865       volumes:
62866         type: array
62867         items:
62868           $ref: "#/getDefinitions/volume"
62869       relationship-list:
62870         type: array
62871         items:
62872           $ref: "#/getDefinitions/relationship"
62873       l-interfaces:
62874         type: array
62875         items:
62876           $ref: "#/getDefinitions/l-interface"
62877   vservers:
62878     description: |
62879       Collection of virtual Servers, aka virtual machines or VMs.
62880     properties:
62881       vserver:
62882         type: array
62883         items:
62884           $ref: "#/getDefinitions/vserver"
62885   zone:
62886     description: |
62887       A zone is a grouping of assets in a location homing to the same connections into the CBB
62888       ###### Related Nodes
62889       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62890       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62891       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62892       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62893     required:
62894     - zone-id
62895     - zone-name
62896     - design-type
62897     - zone-context
62898     properties:
62899       zone-id:
62900         type: string
62901         description: Code assigned by AIC to the zone
62902       zone-name:
62903         type: string
62904         description: English name associated with the zone
62905       design-type:
62906         type: string
62907         description: Design of zone [Medium/Large?]
62908       zone-context:
62909         type: string
62910         description: Context of zone [production/test]
62911       status:
62912         type: string
62913         description: Status of a zone.
62914       resource-version:
62915         type: string
62916         description: Concurrency value
62917       relationship-list:
62918         type: array
62919         items:
62920           $ref: "#/getDefinitions/relationship"
62921   zones:
62922     description: |
62923       Collection of zones
62924     properties:
62925       zone:
62926         type: array
62927         items:
62928           $ref: "#/getDefinitions/zone"