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

   1 swagger: "2.0"
   2 info:
   3   description: |
   4
   5     [Differences versus the previous schema version](apidocs/aai_swagger_v11.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: "v11"
  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/v11
  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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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/v11/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: tenant-context
1004           in: query
1005           description: This field will store the tenant context.
1006           required: false
1007           type: string
1008         - name: vserver-name
1009           in: query
1010           description: Name of vserver
1011           required: false
1012           type: string
1013         - name: vserver-name2
1014           in: query
1015           description: Alternative name of vserver
1016           required: false
1017           type: string
1018         - name: prov-status
1019           in: query
1020           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1021           required: false
1022           type: string
1023         - name: in-maint
1024           in: query
1025           required: false
1026           type: boolean
1027         - name: is-closed-loop-disabled
1028           in: query
1029           required: false
1030           type: boolean
1031     put:
1032       tags:
1033         - CloudInfrastructure
1034       summary: create or update an existing volume
1035       description: |
1036         Create or update an existing volume.
1037         #
1038         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1039       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1040       consumes:
1041         - application/json
1042         - application/xml
1043       produces:
1044         - application/json
1045         - application/xml
1046       responses:
1047         "default":
1048           description: Response codes found in [response codes](https://wiki.onap.org/).
1049       parameters:
1050         - name: cloud-owner
1051           in: path
1052           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1053           required: true
1054           type: string
1055           example: __CLOUD-OWNER__
1056         - name: cloud-region-id
1057           in: path
1058           description: Identifier used by the vendor for the region. Second part of composite key
1059           required: true
1060           type: string
1061           example: __CLOUD-REGION-ID__
1062         - name: tenant-id
1063           in: path
1064           description: Unique id relative to the cloud-region.
1065           required: true
1066           type: string
1067           example: __TENANT-ID__
1068         - name: vserver-id
1069           in: path
1070           description: Unique identifier for this vserver relative to its tenant
1071           required: true
1072           type: string
1073           example: __VSERVER-ID__
1074         - name: volume-id
1075           in: path
1076           description: Unique ID of block storage volume relative to the vserver.
1077           required: true
1078           type: string
1079           example: __VOLUME-ID__
1080         - name: body
1081           in: body
1082           description: volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)
1083           required: true
1084           schema:
1085             $ref: "#/definitions/volume"
1086     patch:
1087       tags:
1088         - CloudInfrastructure
1089       summary: update an existing volume
1090       description: |
1091         Update an existing volume
1092         #
1093         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1094         The PUT operation will entirely replace an existing object.
1095         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1096         #
1097         Other differences between PUT and PATCH are:
1098         #
1099         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1100         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1101         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1102       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1103       consumes:
1104         - application/json
1105         - application/xml
1106       produces:
1107         - application/json
1108         - application/xml
1109       responses:
1110         "default":
1111           description: Response codes found in [response codes](https://wiki.onap.org/).
1112       parameters:
1113         - name: cloud-owner
1114           in: path
1115           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1116           required: true
1117           type: string
1118           example: __CLOUD-OWNER__
1119         - name: cloud-region-id
1120           in: path
1121           description: Identifier used by the vendor for the region. Second part of composite key
1122           required: true
1123           type: string
1124           example: __CLOUD-REGION-ID__
1125         - name: tenant-id
1126           in: path
1127           description: Unique id relative to the cloud-region.
1128           required: true
1129           type: string
1130           example: __TENANT-ID__
1131         - name: vserver-id
1132           in: path
1133           description: Unique identifier for this vserver relative to its tenant
1134           required: true
1135           type: string
1136           example: __VSERVER-ID__
1137         - name: volume-id
1138           in: path
1139           description: Unique ID of block storage volume relative to the vserver.
1140           required: true
1141           type: string
1142           example: __VOLUME-ID__
1143         - name: body
1144           in: body
1145           description: volume object that needs to be created or updated.
1146           required: true
1147           schema:
1148             $ref: "#/patchDefinitions/volume"
1149     delete:
1150       tags:
1151         - CloudInfrastructure
1152       summary: delete an existing volume
1153       description: delete an existing volume
1154       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume
1155       consumes:
1156         - application/json
1157         - application/xml
1158       produces:
1159         - application/json
1160         - application/xml
1161       responses:
1162         "default":
1163           description: Response codes found in [response codes](https://wiki.onap.org/).
1164       parameters:
1165         - name: cloud-owner
1166           in: path
1167           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1168           required: true
1169           type: string
1170           example: __CLOUD-OWNER__
1171         - name: cloud-region-id
1172           in: path
1173           description: Identifier used by the vendor for the region. Second part of composite key
1174           required: true
1175           type: string
1176           example: __CLOUD-REGION-ID__
1177         - name: tenant-id
1178           in: path
1179           description: Unique id relative to the cloud-region.
1180           required: true
1181           type: string
1182           example: __TENANT-ID__
1183         - name: vserver-id
1184           in: path
1185           description: Unique identifier for this vserver relative to its tenant
1186           required: true
1187           type: string
1188           example: __VSERVER-ID__
1189         - name: volume-id
1190           in: path
1191           description: Unique ID of block storage volume relative to the vserver.
1192           required: true
1193           type: string
1194           example: __VOLUME-ID__
1195         - name: resource-version
1196           in: query
1197           description: resource-version for concurrency
1198           required: true
1199           type: string
1200   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes:
1201     get:
1202       tags:
1203         - CloudInfrastructure
1204       summary: returns volumes
1205       description: returns volumes
1206       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumes
1207       produces:
1208         - application/json
1209         - application/xml
1210       responses:
1211         "200":
1212           description: successful operation
1213           schema:
1214               $ref: "#/getDefinitions/volumes"
1215         "default":
1216           description: Response codes found in [response codes](https://wiki.onap.org/).
1217       parameters:
1218         - name: cloud-owner
1219           in: path
1220           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1221           required: true
1222           type: string
1223           example: __CLOUD-OWNER__
1224         - name: cloud-region-id
1225           in: path
1226           description: Identifier used by the vendor for the region. Second part of composite key
1227           required: true
1228           type: string
1229           example: __CLOUD-REGION-ID__
1230         - name: tenant-id
1231           in: path
1232           description: Unique id relative to the cloud-region.
1233           required: true
1234           type: string
1235           example: __TENANT-ID__
1236         - name: vserver-id
1237           in: path
1238           description: Unique identifier for this vserver relative to its tenant
1239           required: true
1240           type: string
1241           example: __VSERVER-ID__
1242         - name: cloud-type
1243           in: query
1244           description: Type of the cloud (e.g., openstack)
1245           required: false
1246           type: string
1247         - name: owner-defined-type
1248           in: query
1249           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1250           required: false
1251           type: string
1252         - name: tenant-name
1253           in: query
1254           description: Readable name of tenant
1255           required: false
1256           type: string
1257         - name: tenant-context
1258           in: query
1259           description: This field will store the tenant context.
1260           required: false
1261           type: string
1262         - name: vserver-name
1263           in: query
1264           description: Name of vserver
1265           required: false
1266           type: string
1267         - name: vserver-name2
1268           in: query
1269           description: Alternative name of vserver
1270           required: false
1271           type: string
1272         - name: prov-status
1273           in: query
1274           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1275           required: false
1276           type: string
1277         - name: in-maint
1278           in: query
1279           required: false
1280           type: boolean
1281         - name: is-closed-loop-disabled
1282           in: query
1283           required: false
1284           type: boolean
1285   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship:
1286     put:
1287       tags:
1288         - CloudInfrastructure
1289       summary: see node definition for valid relationships
1290       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1291       consumes:
1292         - application/json
1293         - application/xml
1294       produces:
1295         - application/json
1296         - application/xml
1297       responses:
1298         "default":
1299           description: Response codes found in [response codes](https://wiki.onap.org/).
1300       parameters:
1301         - name: cloud-owner
1302           in: path
1303           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1304           required: true
1305           type: string
1306           example: __CLOUD-OWNER__
1307         - name: cloud-region-id
1308           in: path
1309           description: Identifier used by the vendor for the region. Second part of composite key
1310           required: true
1311           type: string
1312           example: __CLOUD-REGION-ID__
1313         - name: tenant-id
1314           in: path
1315           description: Unique id relative to the cloud-region.
1316           required: true
1317           type: string
1318           example: __TENANT-ID__
1319         - name: vserver-id
1320           in: path
1321           description: Unique identifier for this vserver relative to its tenant
1322           required: true
1323           type: string
1324           example: __VSERVER-ID__
1325         - name: body
1326           in: body
1327           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
1328           required: true
1329           schema:
1330             $ref: "#/definitions/relationship"
1331     delete:
1332       tags:
1333         - CloudInfrastructure
1334       summary: delete an existing relationship
1335       description: delete an existing relationship
1336       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverRelationshipListRelationship
1337       consumes:
1338         - application/json
1339         - application/xml
1340       produces:
1341         - application/json
1342         - application/xml
1343       responses:
1344         "default":
1345           description: Response codes found in [response codes](https://wiki.onap.org/).
1346       parameters:
1347         - name: cloud-owner
1348           in: path
1349           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1350           required: true
1351           type: string
1352           example: __CLOUD-OWNER__
1353         - name: cloud-region-id
1354           in: path
1355           description: Identifier used by the vendor for the region. Second part of composite key
1356           required: true
1357           type: string
1358           example: __CLOUD-REGION-ID__
1359         - name: tenant-id
1360           in: path
1361           description: Unique id relative to the cloud-region.
1362           required: true
1363           type: string
1364           example: __TENANT-ID__
1365         - name: vserver-id
1366           in: path
1367           description: Unique identifier for this vserver relative to its tenant
1368           required: true
1369           type: string
1370           example: __VSERVER-ID__
1371   /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:
1372     put:
1373       tags:
1374         - CloudInfrastructure
1375       summary: see node definition for valid relationships
1376       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1377       consumes:
1378         - application/json
1379         - application/xml
1380       produces:
1381         - application/json
1382         - application/xml
1383       responses:
1384         "default":
1385           description: Response codes found in [response codes](https://wiki.onap.org/).
1386       parameters:
1387         - name: cloud-owner
1388           in: path
1389           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1390           required: true
1391           type: string
1392           example: __CLOUD-OWNER__
1393         - name: cloud-region-id
1394           in: path
1395           description: Identifier used by the vendor for the region. Second part of composite key
1396           required: true
1397           type: string
1398           example: __CLOUD-REGION-ID__
1399         - name: tenant-id
1400           in: path
1401           description: Unique id relative to the cloud-region.
1402           required: true
1403           type: string
1404           example: __TENANT-ID__
1405         - name: vserver-id
1406           in: path
1407           description: Unique identifier for this vserver relative to its tenant
1408           required: true
1409           type: string
1410           example: __VSERVER-ID__
1411         - name: interface-name
1412           in: path
1413           description: Name given to the interface
1414           required: true
1415           type: string
1416           example: __INTERFACE-NAME__
1417         - name: vlan-interface
1418           in: path
1419           description: String that identifies the interface
1420           required: true
1421           type: string
1422           example: __VLAN-INTERFACE__
1423         - name: body
1424           in: body
1425           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
1426           required: true
1427           schema:
1428             $ref: "#/definitions/relationship"
1429     delete:
1430       tags:
1431         - CloudInfrastructure
1432       summary: delete an existing relationship
1433       description: delete an existing relationship
1434       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanRelationshipListRelationship
1435       consumes:
1436         - application/json
1437         - application/xml
1438       produces:
1439         - application/json
1440         - application/xml
1441       responses:
1442         "default":
1443           description: Response codes found in [response codes](https://wiki.onap.org/).
1444       parameters:
1445         - name: cloud-owner
1446           in: path
1447           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1448           required: true
1449           type: string
1450           example: __CLOUD-OWNER__
1451         - name: cloud-region-id
1452           in: path
1453           description: Identifier used by the vendor for the region. Second part of composite key
1454           required: true
1455           type: string
1456           example: __CLOUD-REGION-ID__
1457         - name: tenant-id
1458           in: path
1459           description: Unique id relative to the cloud-region.
1460           required: true
1461           type: string
1462           example: __TENANT-ID__
1463         - name: vserver-id
1464           in: path
1465           description: Unique identifier for this vserver relative to its tenant
1466           required: true
1467           type: string
1468           example: __VSERVER-ID__
1469         - name: interface-name
1470           in: path
1471           description: Name given to the interface
1472           required: true
1473           type: string
1474           example: __INTERFACE-NAME__
1475         - name: vlan-interface
1476           in: path
1477           description: String that identifies the interface
1478           required: true
1479           type: string
1480           example: __VLAN-INTERFACE__
1481   /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:
1482     put:
1483       tags:
1484         - CloudInfrastructure
1485       summary: see node definition for valid relationships
1486       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1487       consumes:
1488         - application/json
1489         - application/xml
1490       produces:
1491         - application/json
1492         - application/xml
1493       responses:
1494         "default":
1495           description: Response codes found in [response codes](https://wiki.onap.org/).
1496       parameters:
1497         - name: cloud-owner
1498           in: path
1499           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1500           required: true
1501           type: string
1502           example: __CLOUD-OWNER__
1503         - name: cloud-region-id
1504           in: path
1505           description: Identifier used by the vendor for the region. Second part of composite key
1506           required: true
1507           type: string
1508           example: __CLOUD-REGION-ID__
1509         - name: tenant-id
1510           in: path
1511           description: Unique id relative to the cloud-region.
1512           required: true
1513           type: string
1514           example: __TENANT-ID__
1515         - name: vserver-id
1516           in: path
1517           description: Unique identifier for this vserver relative to its tenant
1518           required: true
1519           type: string
1520           example: __VSERVER-ID__
1521         - name: interface-name
1522           in: path
1523           description: Name given to the interface
1524           required: true
1525           type: string
1526           example: __INTERFACE-NAME__
1527         - name: vlan-interface
1528           in: path
1529           description: String that identifies the interface
1530           required: true
1531           type: string
1532           example: __VLAN-INTERFACE__
1533         - name: l3-interface-ipv4-address
1534           in: path
1535           description: IP address
1536           required: true
1537           type: string
1538           example: __L3-INTERFACE-IPV4-ADDRESS__
1539         - name: body
1540           in: body
1541           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1542           required: true
1543           schema:
1544             $ref: "#/definitions/relationship"
1545     delete:
1546       tags:
1547         - CloudInfrastructure
1548       summary: delete an existing relationship
1549       description: delete an existing relationship
1550       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
1551       consumes:
1552         - application/json
1553         - application/xml
1554       produces:
1555         - application/json
1556         - application/xml
1557       responses:
1558         "default":
1559           description: Response codes found in [response codes](https://wiki.onap.org/).
1560       parameters:
1561         - name: cloud-owner
1562           in: path
1563           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1564           required: true
1565           type: string
1566           example: __CLOUD-OWNER__
1567         - name: cloud-region-id
1568           in: path
1569           description: Identifier used by the vendor for the region. Second part of composite key
1570           required: true
1571           type: string
1572           example: __CLOUD-REGION-ID__
1573         - name: tenant-id
1574           in: path
1575           description: Unique id relative to the cloud-region.
1576           required: true
1577           type: string
1578           example: __TENANT-ID__
1579         - name: vserver-id
1580           in: path
1581           description: Unique identifier for this vserver relative to its tenant
1582           required: true
1583           type: string
1584           example: __VSERVER-ID__
1585         - name: interface-name
1586           in: path
1587           description: Name given to the interface
1588           required: true
1589           type: string
1590           example: __INTERFACE-NAME__
1591         - name: vlan-interface
1592           in: path
1593           description: String that identifies the interface
1594           required: true
1595           type: string
1596           example: __VLAN-INTERFACE__
1597         - name: l3-interface-ipv4-address
1598           in: path
1599           description: IP address
1600           required: true
1601           type: string
1602           example: __L3-INTERFACE-IPV4-ADDRESS__
1603   /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}:
1604     get:
1605       tags:
1606         - CloudInfrastructure
1607       summary: returns l3-interface-ipv4-address-list
1608       description: returns l3-interface-ipv4-address-list
1609       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1610       produces:
1611         - application/json
1612         - application/xml
1613       responses:
1614         "200":
1615           description: successful operation
1616           schema:
1617               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
1618         "default":
1619           description: Response codes found in [response codes](https://wiki.onap.org/).
1620       parameters:
1621         - name: cloud-owner
1622           in: path
1623           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1624           required: true
1625           type: string
1626           example: __CLOUD-OWNER__
1627         - name: cloud-region-id
1628           in: path
1629           description: Identifier used by the vendor for the region. Second part of composite key
1630           required: true
1631           type: string
1632           example: __CLOUD-REGION-ID__
1633         - name: tenant-id
1634           in: path
1635           description: Unique id relative to the cloud-region.
1636           required: true
1637           type: string
1638           example: __TENANT-ID__
1639         - name: vserver-id
1640           in: path
1641           description: Unique identifier for this vserver relative to its tenant
1642           required: true
1643           type: string
1644           example: __VSERVER-ID__
1645         - name: interface-name
1646           in: path
1647           description: Name given to the interface
1648           required: true
1649           type: string
1650           example: __INTERFACE-NAME__
1651         - name: vlan-interface
1652           in: path
1653           description: String that identifies the interface
1654           required: true
1655           type: string
1656           example: __VLAN-INTERFACE__
1657         - name: l3-interface-ipv4-address
1658           in: path
1659           description: IP address
1660           required: true
1661           type: string
1662           example: __L3-INTERFACE-IPV4-ADDRESS__
1663         - name: cloud-type
1664           in: query
1665           description: Type of the cloud (e.g., openstack)
1666           required: false
1667           type: string
1668         - name: owner-defined-type
1669           in: query
1670           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
1671           required: false
1672           type: string
1673         - name: tenant-name
1674           in: query
1675           description: Readable name of tenant
1676           required: false
1677           type: string
1678         - name: tenant-context
1679           in: query
1680           description: This field will store the tenant context.
1681           required: false
1682           type: string
1683         - name: vserver-name
1684           in: query
1685           description: Name of vserver
1686           required: false
1687           type: string
1688         - name: vserver-name2
1689           in: query
1690           description: Alternative name of vserver
1691           required: false
1692           type: string
1693         - name: prov-status
1694           in: query
1695           description: Trigger for operational monitoring of this resource by Service Assurance systems.
1696           required: false
1697           type: string
1698         - name: in-maint
1699           in: query
1700           required: false
1701           type: boolean
1702         - name: is-closed-loop-disabled
1703           in: query
1704           required: false
1705           type: boolean
1706         - name: interface-id
1707           in: query
1708           description: ID of interface
1709           required: false
1710           type: string
1711         - name: macaddr
1712           in: query
1713           description: MAC address for the interface
1714           required: false
1715           type: string
1716         - name: network-name
1717           in: query
1718           description: Name of the network
1719           required: false
1720           type: string
1721         - name: vlan-id-inner
1722           in: query
1723           description: Inner VLAN tag
1724           required: false
1725           type: integer
1726           format: int64
1727         - name: vpn-key
1728           in: query
1729           description: This indicates the customers VPN ID associated with this vlan
1730           required: false
1731           type: string
1732         - name: vlan-id-inner
1733           in: query
1734           description: Inner VLAN tag
1735           required: false
1736           type: integer
1737           format: int64
1738         - name: neutron-network-id
1739           in: query
1740           description: Neutron network id of the interface that address belongs to
1741           required: false
1742           type: string
1743         - name: neutron-subnet-id
1744           in: query
1745           description: Neutron id of subnet that address belongs to
1746           required: false
1747           type: string
1748     put:
1749       tags:
1750         - CloudInfrastructure
1751       summary: create or update an existing l3-interface-ipv4-address-list
1752       description: |
1753         Create or update an existing l3-interface-ipv4-address-list.
1754         #
1755         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
1756       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1757       consumes:
1758         - application/json
1759         - application/xml
1760       produces:
1761         - application/json
1762         - application/xml
1763       responses:
1764         "default":
1765           description: Response codes found in [response codes](https://wiki.onap.org/).
1766       parameters:
1767         - name: cloud-owner
1768           in: path
1769           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1770           required: true
1771           type: string
1772           example: __CLOUD-OWNER__
1773         - name: cloud-region-id
1774           in: path
1775           description: Identifier used by the vendor for the region. Second part of composite key
1776           required: true
1777           type: string
1778           example: __CLOUD-REGION-ID__
1779         - name: tenant-id
1780           in: path
1781           description: Unique id relative to the cloud-region.
1782           required: true
1783           type: string
1784           example: __TENANT-ID__
1785         - name: vserver-id
1786           in: path
1787           description: Unique identifier for this vserver relative to its tenant
1788           required: true
1789           type: string
1790           example: __VSERVER-ID__
1791         - name: interface-name
1792           in: path
1793           description: Name given to the interface
1794           required: true
1795           type: string
1796           example: __INTERFACE-NAME__
1797         - name: vlan-interface
1798           in: path
1799           description: String that identifies the interface
1800           required: true
1801           type: string
1802           example: __VLAN-INTERFACE__
1803         - name: l3-interface-ipv4-address
1804           in: path
1805           description: IP address
1806           required: true
1807           type: string
1808           example: __L3-INTERFACE-IPV4-ADDRESS__
1809         - name: body
1810           in: body
1811           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
1812           required: true
1813           schema:
1814             $ref: "#/definitions/l3-interface-ipv4-address-list"
1815     patch:
1816       tags:
1817         - CloudInfrastructure
1818       summary: update an existing l3-interface-ipv4-address-list
1819       description: |
1820         Update an existing l3-interface-ipv4-address-list
1821         #
1822         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
1823         The PUT operation will entirely replace an existing object.
1824         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
1825         #
1826         Other differences between PUT and PATCH are:
1827         #
1828         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
1829         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
1830         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
1831       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1832       consumes:
1833         - application/json
1834         - application/xml
1835       produces:
1836         - application/json
1837         - application/xml
1838       responses:
1839         "default":
1840           description: Response codes found in [response codes](https://wiki.onap.org/).
1841       parameters:
1842         - name: cloud-owner
1843           in: path
1844           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1845           required: true
1846           type: string
1847           example: __CLOUD-OWNER__
1848         - name: cloud-region-id
1849           in: path
1850           description: Identifier used by the vendor for the region. Second part of composite key
1851           required: true
1852           type: string
1853           example: __CLOUD-REGION-ID__
1854         - name: tenant-id
1855           in: path
1856           description: Unique id relative to the cloud-region.
1857           required: true
1858           type: string
1859           example: __TENANT-ID__
1860         - name: vserver-id
1861           in: path
1862           description: Unique identifier for this vserver relative to its tenant
1863           required: true
1864           type: string
1865           example: __VSERVER-ID__
1866         - name: interface-name
1867           in: path
1868           description: Name given to the interface
1869           required: true
1870           type: string
1871           example: __INTERFACE-NAME__
1872         - name: vlan-interface
1873           in: path
1874           description: String that identifies the interface
1875           required: true
1876           type: string
1877           example: __VLAN-INTERFACE__
1878         - name: l3-interface-ipv4-address
1879           in: path
1880           description: IP address
1881           required: true
1882           type: string
1883           example: __L3-INTERFACE-IPV4-ADDRESS__
1884         - name: body
1885           in: body
1886           description: l3-interface-ipv4-address-list object that needs to be created or updated.
1887           required: true
1888           schema:
1889             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
1890     delete:
1891       tags:
1892         - CloudInfrastructure
1893       summary: delete an existing l3-interface-ipv4-address-list
1894       description: delete an existing l3-interface-ipv4-address-list
1895       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
1896       consumes:
1897         - application/json
1898         - application/xml
1899       produces:
1900         - application/json
1901         - application/xml
1902       responses:
1903         "default":
1904           description: Response codes found in [response codes](https://wiki.onap.org/).
1905       parameters:
1906         - name: cloud-owner
1907           in: path
1908           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1909           required: true
1910           type: string
1911           example: __CLOUD-OWNER__
1912         - name: cloud-region-id
1913           in: path
1914           description: Identifier used by the vendor for the region. Second part of composite key
1915           required: true
1916           type: string
1917           example: __CLOUD-REGION-ID__
1918         - name: tenant-id
1919           in: path
1920           description: Unique id relative to the cloud-region.
1921           required: true
1922           type: string
1923           example: __TENANT-ID__
1924         - name: vserver-id
1925           in: path
1926           description: Unique identifier for this vserver relative to its tenant
1927           required: true
1928           type: string
1929           example: __VSERVER-ID__
1930         - name: interface-name
1931           in: path
1932           description: Name given to the interface
1933           required: true
1934           type: string
1935           example: __INTERFACE-NAME__
1936         - name: vlan-interface
1937           in: path
1938           description: String that identifies the interface
1939           required: true
1940           type: string
1941           example: __VLAN-INTERFACE__
1942         - name: l3-interface-ipv4-address
1943           in: path
1944           description: IP address
1945           required: true
1946           type: string
1947           example: __L3-INTERFACE-IPV4-ADDRESS__
1948         - name: resource-version
1949           in: query
1950           description: resource-version for concurrency
1951           required: true
1952           type: string
1953   /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:
1954     put:
1955       tags:
1956         - CloudInfrastructure
1957       summary: see node definition for valid relationships
1958       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
1959       consumes:
1960         - application/json
1961         - application/xml
1962       produces:
1963         - application/json
1964         - application/xml
1965       responses:
1966         "default":
1967           description: Response codes found in [response codes](https://wiki.onap.org/).
1968       parameters:
1969         - name: cloud-owner
1970           in: path
1971           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
1972           required: true
1973           type: string
1974           example: __CLOUD-OWNER__
1975         - name: cloud-region-id
1976           in: path
1977           description: Identifier used by the vendor for the region. Second part of composite key
1978           required: true
1979           type: string
1980           example: __CLOUD-REGION-ID__
1981         - name: tenant-id
1982           in: path
1983           description: Unique id relative to the cloud-region.
1984           required: true
1985           type: string
1986           example: __TENANT-ID__
1987         - name: vserver-id
1988           in: path
1989           description: Unique identifier for this vserver relative to its tenant
1990           required: true
1991           type: string
1992           example: __VSERVER-ID__
1993         - name: interface-name
1994           in: path
1995           description: Name given to the interface
1996           required: true
1997           type: string
1998           example: __INTERFACE-NAME__
1999         - name: vlan-interface
2000           in: path
2001           description: String that identifies the interface
2002           required: true
2003           type: string
2004           example: __VLAN-INTERFACE__
2005         - name: l3-interface-ipv6-address
2006           in: path
2007           description: IP address
2008           required: true
2009           type: string
2010           example: __L3-INTERFACE-IPV6-ADDRESS__
2011         - name: body
2012           in: body
2013           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2014           required: true
2015           schema:
2016             $ref: "#/definitions/relationship"
2017     delete:
2018       tags:
2019         - CloudInfrastructure
2020       summary: delete an existing relationship
2021       description: delete an existing relationship
2022       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
2023       consumes:
2024         - application/json
2025         - application/xml
2026       produces:
2027         - application/json
2028         - application/xml
2029       responses:
2030         "default":
2031           description: Response codes found in [response codes](https://wiki.onap.org/).
2032       parameters:
2033         - name: cloud-owner
2034           in: path
2035           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2036           required: true
2037           type: string
2038           example: __CLOUD-OWNER__
2039         - name: cloud-region-id
2040           in: path
2041           description: Identifier used by the vendor for the region. Second part of composite key
2042           required: true
2043           type: string
2044           example: __CLOUD-REGION-ID__
2045         - name: tenant-id
2046           in: path
2047           description: Unique id relative to the cloud-region.
2048           required: true
2049           type: string
2050           example: __TENANT-ID__
2051         - name: vserver-id
2052           in: path
2053           description: Unique identifier for this vserver relative to its tenant
2054           required: true
2055           type: string
2056           example: __VSERVER-ID__
2057         - name: interface-name
2058           in: path
2059           description: Name given to the interface
2060           required: true
2061           type: string
2062           example: __INTERFACE-NAME__
2063         - name: vlan-interface
2064           in: path
2065           description: String that identifies the interface
2066           required: true
2067           type: string
2068           example: __VLAN-INTERFACE__
2069         - name: l3-interface-ipv6-address
2070           in: path
2071           description: IP address
2072           required: true
2073           type: string
2074           example: __L3-INTERFACE-IPV6-ADDRESS__
2075   /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}:
2076     get:
2077       tags:
2078         - CloudInfrastructure
2079       summary: returns l3-interface-ipv6-address-list
2080       description: returns l3-interface-ipv6-address-list
2081       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2082       produces:
2083         - application/json
2084         - application/xml
2085       responses:
2086         "200":
2087           description: successful operation
2088           schema:
2089               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
2090         "default":
2091           description: Response codes found in [response codes](https://wiki.onap.org/).
2092       parameters:
2093         - name: cloud-owner
2094           in: path
2095           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2096           required: true
2097           type: string
2098           example: __CLOUD-OWNER__
2099         - name: cloud-region-id
2100           in: path
2101           description: Identifier used by the vendor for the region. Second part of composite key
2102           required: true
2103           type: string
2104           example: __CLOUD-REGION-ID__
2105         - name: tenant-id
2106           in: path
2107           description: Unique id relative to the cloud-region.
2108           required: true
2109           type: string
2110           example: __TENANT-ID__
2111         - name: vserver-id
2112           in: path
2113           description: Unique identifier for this vserver relative to its tenant
2114           required: true
2115           type: string
2116           example: __VSERVER-ID__
2117         - name: interface-name
2118           in: path
2119           description: Name given to the interface
2120           required: true
2121           type: string
2122           example: __INTERFACE-NAME__
2123         - name: vlan-interface
2124           in: path
2125           description: String that identifies the interface
2126           required: true
2127           type: string
2128           example: __VLAN-INTERFACE__
2129         - name: l3-interface-ipv6-address
2130           in: path
2131           description: IP address
2132           required: true
2133           type: string
2134           example: __L3-INTERFACE-IPV6-ADDRESS__
2135         - name: cloud-type
2136           in: query
2137           description: Type of the cloud (e.g., openstack)
2138           required: false
2139           type: string
2140         - name: owner-defined-type
2141           in: query
2142           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2143           required: false
2144           type: string
2145         - name: tenant-name
2146           in: query
2147           description: Readable name of tenant
2148           required: false
2149           type: string
2150         - name: tenant-context
2151           in: query
2152           description: This field will store the tenant context.
2153           required: false
2154           type: string
2155         - name: vserver-name
2156           in: query
2157           description: Name of vserver
2158           required: false
2159           type: string
2160         - name: vserver-name2
2161           in: query
2162           description: Alternative name of vserver
2163           required: false
2164           type: string
2165         - name: prov-status
2166           in: query
2167           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2168           required: false
2169           type: string
2170         - name: in-maint
2171           in: query
2172           required: false
2173           type: boolean
2174         - name: is-closed-loop-disabled
2175           in: query
2176           required: false
2177           type: boolean
2178         - name: interface-id
2179           in: query
2180           description: ID of interface
2181           required: false
2182           type: string
2183         - name: macaddr
2184           in: query
2185           description: MAC address for the interface
2186           required: false
2187           type: string
2188         - name: network-name
2189           in: query
2190           description: Name of the network
2191           required: false
2192           type: string
2193         - name: vlan-id-inner
2194           in: query
2195           description: Inner VLAN tag
2196           required: false
2197           type: integer
2198           format: int64
2199         - name: vpn-key
2200           in: query
2201           description: This indicates the customers VPN ID associated with this vlan
2202           required: false
2203           type: string
2204         - name: vlan-id-inner
2205           in: query
2206           description: Inner VLAN tag
2207           required: false
2208           type: integer
2209           format: int64
2210         - name: neutron-network-id
2211           in: query
2212           description: Neutron network id of the interface that address belongs to
2213           required: false
2214           type: string
2215         - name: neutron-subnet-id
2216           in: query
2217           description: Neutron id of subnet that address belongs to
2218           required: false
2219           type: string
2220     put:
2221       tags:
2222         - CloudInfrastructure
2223       summary: create or update an existing l3-interface-ipv6-address-list
2224       description: |
2225         Create or update an existing l3-interface-ipv6-address-list.
2226         #
2227         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2228       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2229       consumes:
2230         - application/json
2231         - application/xml
2232       produces:
2233         - application/json
2234         - application/xml
2235       responses:
2236         "default":
2237           description: Response codes found in [response codes](https://wiki.onap.org/).
2238       parameters:
2239         - name: cloud-owner
2240           in: path
2241           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2242           required: true
2243           type: string
2244           example: __CLOUD-OWNER__
2245         - name: cloud-region-id
2246           in: path
2247           description: Identifier used by the vendor for the region. Second part of composite key
2248           required: true
2249           type: string
2250           example: __CLOUD-REGION-ID__
2251         - name: tenant-id
2252           in: path
2253           description: Unique id relative to the cloud-region.
2254           required: true
2255           type: string
2256           example: __TENANT-ID__
2257         - name: vserver-id
2258           in: path
2259           description: Unique identifier for this vserver relative to its tenant
2260           required: true
2261           type: string
2262           example: __VSERVER-ID__
2263         - name: interface-name
2264           in: path
2265           description: Name given to the interface
2266           required: true
2267           type: string
2268           example: __INTERFACE-NAME__
2269         - name: vlan-interface
2270           in: path
2271           description: String that identifies the interface
2272           required: true
2273           type: string
2274           example: __VLAN-INTERFACE__
2275         - name: l3-interface-ipv6-address
2276           in: path
2277           description: IP address
2278           required: true
2279           type: string
2280           example: __L3-INTERFACE-IPV6-ADDRESS__
2281         - name: body
2282           in: body
2283           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
2284           required: true
2285           schema:
2286             $ref: "#/definitions/l3-interface-ipv6-address-list"
2287     patch:
2288       tags:
2289         - CloudInfrastructure
2290       summary: update an existing l3-interface-ipv6-address-list
2291       description: |
2292         Update an existing l3-interface-ipv6-address-list
2293         #
2294         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2295         The PUT operation will entirely replace an existing object.
2296         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2297         #
2298         Other differences between PUT and PATCH are:
2299         #
2300         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2301         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2302         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2303       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2304       consumes:
2305         - application/json
2306         - application/xml
2307       produces:
2308         - application/json
2309         - application/xml
2310       responses:
2311         "default":
2312           description: Response codes found in [response codes](https://wiki.onap.org/).
2313       parameters:
2314         - name: cloud-owner
2315           in: path
2316           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2317           required: true
2318           type: string
2319           example: __CLOUD-OWNER__
2320         - name: cloud-region-id
2321           in: path
2322           description: Identifier used by the vendor for the region. Second part of composite key
2323           required: true
2324           type: string
2325           example: __CLOUD-REGION-ID__
2326         - name: tenant-id
2327           in: path
2328           description: Unique id relative to the cloud-region.
2329           required: true
2330           type: string
2331           example: __TENANT-ID__
2332         - name: vserver-id
2333           in: path
2334           description: Unique identifier for this vserver relative to its tenant
2335           required: true
2336           type: string
2337           example: __VSERVER-ID__
2338         - name: interface-name
2339           in: path
2340           description: Name given to the interface
2341           required: true
2342           type: string
2343           example: __INTERFACE-NAME__
2344         - name: vlan-interface
2345           in: path
2346           description: String that identifies the interface
2347           required: true
2348           type: string
2349           example: __VLAN-INTERFACE__
2350         - name: l3-interface-ipv6-address
2351           in: path
2352           description: IP address
2353           required: true
2354           type: string
2355           example: __L3-INTERFACE-IPV6-ADDRESS__
2356         - name: body
2357           in: body
2358           description: l3-interface-ipv6-address-list object that needs to be created or updated.
2359           required: true
2360           schema:
2361             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
2362     delete:
2363       tags:
2364         - CloudInfrastructure
2365       summary: delete an existing l3-interface-ipv6-address-list
2366       description: delete an existing l3-interface-ipv6-address-list
2367       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
2368       consumes:
2369         - application/json
2370         - application/xml
2371       produces:
2372         - application/json
2373         - application/xml
2374       responses:
2375         "default":
2376           description: Response codes found in [response codes](https://wiki.onap.org/).
2377       parameters:
2378         - name: cloud-owner
2379           in: path
2380           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2381           required: true
2382           type: string
2383           example: __CLOUD-OWNER__
2384         - name: cloud-region-id
2385           in: path
2386           description: Identifier used by the vendor for the region. Second part of composite key
2387           required: true
2388           type: string
2389           example: __CLOUD-REGION-ID__
2390         - name: tenant-id
2391           in: path
2392           description: Unique id relative to the cloud-region.
2393           required: true
2394           type: string
2395           example: __TENANT-ID__
2396         - name: vserver-id
2397           in: path
2398           description: Unique identifier for this vserver relative to its tenant
2399           required: true
2400           type: string
2401           example: __VSERVER-ID__
2402         - name: interface-name
2403           in: path
2404           description: Name given to the interface
2405           required: true
2406           type: string
2407           example: __INTERFACE-NAME__
2408         - name: vlan-interface
2409           in: path
2410           description: String that identifies the interface
2411           required: true
2412           type: string
2413           example: __VLAN-INTERFACE__
2414         - name: l3-interface-ipv6-address
2415           in: path
2416           description: IP address
2417           required: true
2418           type: string
2419           example: __L3-INTERFACE-IPV6-ADDRESS__
2420         - name: resource-version
2421           in: query
2422           description: resource-version for concurrency
2423           required: true
2424           type: string
2425   /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}:
2426     get:
2427       tags:
2428         - CloudInfrastructure
2429       summary: returns vlan
2430       description: returns vlan
2431       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2432       produces:
2433         - application/json
2434         - application/xml
2435       responses:
2436         "200":
2437           description: successful operation
2438           schema:
2439               $ref: "#/getDefinitions/vlan"
2440         "default":
2441           description: Response codes found in [response codes](https://wiki.onap.org/).
2442       parameters:
2443         - name: cloud-owner
2444           in: path
2445           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2446           required: true
2447           type: string
2448           example: __CLOUD-OWNER__
2449         - name: cloud-region-id
2450           in: path
2451           description: Identifier used by the vendor for the region. Second part of composite key
2452           required: true
2453           type: string
2454           example: __CLOUD-REGION-ID__
2455         - name: tenant-id
2456           in: path
2457           description: Unique id relative to the cloud-region.
2458           required: true
2459           type: string
2460           example: __TENANT-ID__
2461         - name: vserver-id
2462           in: path
2463           description: Unique identifier for this vserver relative to its tenant
2464           required: true
2465           type: string
2466           example: __VSERVER-ID__
2467         - name: interface-name
2468           in: path
2469           description: Name given to the interface
2470           required: true
2471           type: string
2472           example: __INTERFACE-NAME__
2473         - name: vlan-interface
2474           in: path
2475           description: String that identifies the interface
2476           required: true
2477           type: string
2478           example: __VLAN-INTERFACE__
2479         - name: cloud-type
2480           in: query
2481           description: Type of the cloud (e.g., openstack)
2482           required: false
2483           type: string
2484         - name: owner-defined-type
2485           in: query
2486           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2487           required: false
2488           type: string
2489         - name: tenant-name
2490           in: query
2491           description: Readable name of tenant
2492           required: false
2493           type: string
2494         - name: tenant-context
2495           in: query
2496           description: This field will store the tenant context.
2497           required: false
2498           type: string
2499         - name: vserver-name
2500           in: query
2501           description: Name of vserver
2502           required: false
2503           type: string
2504         - name: vserver-name2
2505           in: query
2506           description: Alternative name of vserver
2507           required: false
2508           type: string
2509         - name: prov-status
2510           in: query
2511           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2512           required: false
2513           type: string
2514         - name: in-maint
2515           in: query
2516           required: false
2517           type: boolean
2518         - name: is-closed-loop-disabled
2519           in: query
2520           required: false
2521           type: boolean
2522         - name: interface-id
2523           in: query
2524           description: ID of interface
2525           required: false
2526           type: string
2527         - name: macaddr
2528           in: query
2529           description: MAC address for the interface
2530           required: false
2531           type: string
2532         - name: network-name
2533           in: query
2534           description: Name of the network
2535           required: false
2536           type: string
2537         - name: vlan-id-inner
2538           in: query
2539           description: Inner VLAN tag
2540           required: false
2541           type: integer
2542           format: int64
2543         - name: vpn-key
2544           in: query
2545           description: This indicates the customers VPN ID associated with this vlan
2546           required: false
2547           type: string
2548     put:
2549       tags:
2550         - CloudInfrastructure
2551       summary: create or update an existing vlan
2552       description: |
2553         Create or update an existing vlan.
2554         #
2555         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
2556       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2557       consumes:
2558         - application/json
2559         - application/xml
2560       produces:
2561         - application/json
2562         - application/xml
2563       responses:
2564         "default":
2565           description: Response codes found in [response codes](https://wiki.onap.org/).
2566       parameters:
2567         - name: cloud-owner
2568           in: path
2569           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2570           required: true
2571           type: string
2572           example: __CLOUD-OWNER__
2573         - name: cloud-region-id
2574           in: path
2575           description: Identifier used by the vendor for the region. Second part of composite key
2576           required: true
2577           type: string
2578           example: __CLOUD-REGION-ID__
2579         - name: tenant-id
2580           in: path
2581           description: Unique id relative to the cloud-region.
2582           required: true
2583           type: string
2584           example: __TENANT-ID__
2585         - name: vserver-id
2586           in: path
2587           description: Unique identifier for this vserver relative to its tenant
2588           required: true
2589           type: string
2590           example: __VSERVER-ID__
2591         - name: interface-name
2592           in: path
2593           description: Name given to the interface
2594           required: true
2595           type: string
2596           example: __INTERFACE-NAME__
2597         - name: vlan-interface
2598           in: path
2599           description: String that identifies the interface
2600           required: true
2601           type: string
2602           example: __VLAN-INTERFACE__
2603         - name: body
2604           in: body
2605           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)
2606           required: true
2607           schema:
2608             $ref: "#/definitions/vlan"
2609     patch:
2610       tags:
2611         - CloudInfrastructure
2612       summary: update an existing vlan
2613       description: |
2614         Update an existing vlan
2615         #
2616         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
2617         The PUT operation will entirely replace an existing object.
2618         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
2619         #
2620         Other differences between PUT and PATCH are:
2621         #
2622         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
2623         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
2624         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
2625       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2626       consumes:
2627         - application/json
2628         - application/xml
2629       produces:
2630         - application/json
2631         - application/xml
2632       responses:
2633         "default":
2634           description: Response codes found in [response codes](https://wiki.onap.org/).
2635       parameters:
2636         - name: cloud-owner
2637           in: path
2638           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2639           required: true
2640           type: string
2641           example: __CLOUD-OWNER__
2642         - name: cloud-region-id
2643           in: path
2644           description: Identifier used by the vendor for the region. Second part of composite key
2645           required: true
2646           type: string
2647           example: __CLOUD-REGION-ID__
2648         - name: tenant-id
2649           in: path
2650           description: Unique id relative to the cloud-region.
2651           required: true
2652           type: string
2653           example: __TENANT-ID__
2654         - name: vserver-id
2655           in: path
2656           description: Unique identifier for this vserver relative to its tenant
2657           required: true
2658           type: string
2659           example: __VSERVER-ID__
2660         - name: interface-name
2661           in: path
2662           description: Name given to the interface
2663           required: true
2664           type: string
2665           example: __INTERFACE-NAME__
2666         - name: vlan-interface
2667           in: path
2668           description: String that identifies the interface
2669           required: true
2670           type: string
2671           example: __VLAN-INTERFACE__
2672         - name: body
2673           in: body
2674           description: vlan object that needs to be created or updated.
2675           required: true
2676           schema:
2677             $ref: "#/patchDefinitions/vlan"
2678     delete:
2679       tags:
2680         - CloudInfrastructure
2681       summary: delete an existing vlan
2682       description: delete an existing vlan
2683       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan
2684       consumes:
2685         - application/json
2686         - application/xml
2687       produces:
2688         - application/json
2689         - application/xml
2690       responses:
2691         "default":
2692           description: Response codes found in [response codes](https://wiki.onap.org/).
2693       parameters:
2694         - name: cloud-owner
2695           in: path
2696           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2697           required: true
2698           type: string
2699           example: __CLOUD-OWNER__
2700         - name: cloud-region-id
2701           in: path
2702           description: Identifier used by the vendor for the region. Second part of composite key
2703           required: true
2704           type: string
2705           example: __CLOUD-REGION-ID__
2706         - name: tenant-id
2707           in: path
2708           description: Unique id relative to the cloud-region.
2709           required: true
2710           type: string
2711           example: __TENANT-ID__
2712         - name: vserver-id
2713           in: path
2714           description: Unique identifier for this vserver relative to its tenant
2715           required: true
2716           type: string
2717           example: __VSERVER-ID__
2718         - name: interface-name
2719           in: path
2720           description: Name given to the interface
2721           required: true
2722           type: string
2723           example: __INTERFACE-NAME__
2724         - name: vlan-interface
2725           in: path
2726           description: String that identifies the interface
2727           required: true
2728           type: string
2729           example: __VLAN-INTERFACE__
2730         - name: resource-version
2731           in: query
2732           description: resource-version for concurrency
2733           required: true
2734           type: string
2735   /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:
2736     get:
2737       tags:
2738         - CloudInfrastructure
2739       summary: returns vlans
2740       description: returns vlans
2741       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlans
2742       produces:
2743         - application/json
2744         - application/xml
2745       responses:
2746         "200":
2747           description: successful operation
2748           schema:
2749               $ref: "#/getDefinitions/vlans"
2750         "default":
2751           description: Response codes found in [response codes](https://wiki.onap.org/).
2752       parameters:
2753         - name: cloud-owner
2754           in: path
2755           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2756           required: true
2757           type: string
2758           example: __CLOUD-OWNER__
2759         - name: cloud-region-id
2760           in: path
2761           description: Identifier used by the vendor for the region. Second part of composite key
2762           required: true
2763           type: string
2764           example: __CLOUD-REGION-ID__
2765         - name: tenant-id
2766           in: path
2767           description: Unique id relative to the cloud-region.
2768           required: true
2769           type: string
2770           example: __TENANT-ID__
2771         - name: vserver-id
2772           in: path
2773           description: Unique identifier for this vserver relative to its tenant
2774           required: true
2775           type: string
2776           example: __VSERVER-ID__
2777         - name: interface-name
2778           in: path
2779           description: Name given to the interface
2780           required: true
2781           type: string
2782           example: __INTERFACE-NAME__
2783         - name: cloud-type
2784           in: query
2785           description: Type of the cloud (e.g., openstack)
2786           required: false
2787           type: string
2788         - name: owner-defined-type
2789           in: query
2790           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2791           required: false
2792           type: string
2793         - name: tenant-name
2794           in: query
2795           description: Readable name of tenant
2796           required: false
2797           type: string
2798         - name: tenant-context
2799           in: query
2800           description: This field will store the tenant context.
2801           required: false
2802           type: string
2803         - name: vserver-name
2804           in: query
2805           description: Name of vserver
2806           required: false
2807           type: string
2808         - name: vserver-name2
2809           in: query
2810           description: Alternative name of vserver
2811           required: false
2812           type: string
2813         - name: prov-status
2814           in: query
2815           description: Trigger for operational monitoring of this resource by Service Assurance systems.
2816           required: false
2817           type: string
2818         - name: in-maint
2819           in: query
2820           required: false
2821           type: boolean
2822         - name: is-closed-loop-disabled
2823           in: query
2824           required: false
2825           type: boolean
2826         - name: interface-id
2827           in: query
2828           description: ID of interface
2829           required: false
2830           type: string
2831         - name: macaddr
2832           in: query
2833           description: MAC address for the interface
2834           required: false
2835           type: string
2836         - name: network-name
2837           in: query
2838           description: Name of the network
2839           required: false
2840           type: string
2841   /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:
2842     put:
2843       tags:
2844         - CloudInfrastructure
2845       summary: see node definition for valid relationships
2846       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2847       consumes:
2848         - application/json
2849         - application/xml
2850       produces:
2851         - application/json
2852         - application/xml
2853       responses:
2854         "default":
2855           description: Response codes found in [response codes](https://wiki.onap.org/).
2856       parameters:
2857         - name: cloud-owner
2858           in: path
2859           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2860           required: true
2861           type: string
2862           example: __CLOUD-OWNER__
2863         - name: cloud-region-id
2864           in: path
2865           description: Identifier used by the vendor for the region. Second part of composite key
2866           required: true
2867           type: string
2868           example: __CLOUD-REGION-ID__
2869         - name: tenant-id
2870           in: path
2871           description: Unique id relative to the cloud-region.
2872           required: true
2873           type: string
2874           example: __TENANT-ID__
2875         - name: vserver-id
2876           in: path
2877           description: Unique identifier for this vserver relative to its tenant
2878           required: true
2879           type: string
2880           example: __VSERVER-ID__
2881         - name: interface-name
2882           in: path
2883           description: Name given to the interface
2884           required: true
2885           type: string
2886           example: __INTERFACE-NAME__
2887         - name: pci-id
2888           in: path
2889           description: PCI ID used to identify the sriov-vf
2890           required: true
2891           type: string
2892           example: __PCI-ID__
2893         - name: body
2894           in: body
2895           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
2896           required: true
2897           schema:
2898             $ref: "#/definitions/relationship"
2899     delete:
2900       tags:
2901         - CloudInfrastructure
2902       summary: delete an existing relationship
2903       description: delete an existing relationship
2904       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
2905       consumes:
2906         - application/json
2907         - application/xml
2908       produces:
2909         - application/json
2910         - application/xml
2911       responses:
2912         "default":
2913           description: Response codes found in [response codes](https://wiki.onap.org/).
2914       parameters:
2915         - name: cloud-owner
2916           in: path
2917           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2918           required: true
2919           type: string
2920           example: __CLOUD-OWNER__
2921         - name: cloud-region-id
2922           in: path
2923           description: Identifier used by the vendor for the region. Second part of composite key
2924           required: true
2925           type: string
2926           example: __CLOUD-REGION-ID__
2927         - name: tenant-id
2928           in: path
2929           description: Unique id relative to the cloud-region.
2930           required: true
2931           type: string
2932           example: __TENANT-ID__
2933         - name: vserver-id
2934           in: path
2935           description: Unique identifier for this vserver relative to its tenant
2936           required: true
2937           type: string
2938           example: __VSERVER-ID__
2939         - name: interface-name
2940           in: path
2941           description: Name given to the interface
2942           required: true
2943           type: string
2944           example: __INTERFACE-NAME__
2945         - name: pci-id
2946           in: path
2947           description: PCI ID used to identify the sriov-vf
2948           required: true
2949           type: string
2950           example: __PCI-ID__
2951   /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}:
2952     get:
2953       tags:
2954         - CloudInfrastructure
2955       summary: returns sriov-vf
2956       description: returns sriov-vf
2957       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
2958       produces:
2959         - application/json
2960         - application/xml
2961       responses:
2962         "200":
2963           description: successful operation
2964           schema:
2965               $ref: "#/getDefinitions/sriov-vf"
2966         "default":
2967           description: Response codes found in [response codes](https://wiki.onap.org/).
2968       parameters:
2969         - name: cloud-owner
2970           in: path
2971           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
2972           required: true
2973           type: string
2974           example: __CLOUD-OWNER__
2975         - name: cloud-region-id
2976           in: path
2977           description: Identifier used by the vendor for the region. Second part of composite key
2978           required: true
2979           type: string
2980           example: __CLOUD-REGION-ID__
2981         - name: tenant-id
2982           in: path
2983           description: Unique id relative to the cloud-region.
2984           required: true
2985           type: string
2986           example: __TENANT-ID__
2987         - name: vserver-id
2988           in: path
2989           description: Unique identifier for this vserver relative to its tenant
2990           required: true
2991           type: string
2992           example: __VSERVER-ID__
2993         - name: interface-name
2994           in: path
2995           description: Name given to the interface
2996           required: true
2997           type: string
2998           example: __INTERFACE-NAME__
2999         - name: pci-id
3000           in: path
3001           description: PCI ID used to identify the sriov-vf
3002           required: true
3003           type: string
3004           example: __PCI-ID__
3005         - name: cloud-type
3006           in: query
3007           description: Type of the cloud (e.g., openstack)
3008           required: false
3009           type: string
3010         - name: owner-defined-type
3011           in: query
3012           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3013           required: false
3014           type: string
3015         - name: tenant-name
3016           in: query
3017           description: Readable name of tenant
3018           required: false
3019           type: string
3020         - name: tenant-context
3021           in: query
3022           description: This field will store the tenant context.
3023           required: false
3024           type: string
3025         - name: vserver-name
3026           in: query
3027           description: Name of vserver
3028           required: false
3029           type: string
3030         - name: vserver-name2
3031           in: query
3032           description: Alternative name of vserver
3033           required: false
3034           type: string
3035         - name: prov-status
3036           in: query
3037           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3038           required: false
3039           type: string
3040         - name: in-maint
3041           in: query
3042           required: false
3043           type: boolean
3044         - name: is-closed-loop-disabled
3045           in: query
3046           required: false
3047           type: boolean
3048         - name: interface-id
3049           in: query
3050           description: ID of interface
3051           required: false
3052           type: string
3053         - name: macaddr
3054           in: query
3055           description: MAC address for the interface
3056           required: false
3057           type: string
3058         - name: network-name
3059           in: query
3060           description: Name of the network
3061           required: false
3062           type: string
3063         - name: vf-vlan-filter
3064           in: query
3065           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
3066           required: false
3067           type: string
3068         - name: vf-mac-filter
3069           in: query
3070           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
3071           required: false
3072           type: string
3073         - name: vf-vlan-strip
3074           in: query
3075           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
3076           required: false
3077           type: boolean
3078         - name: neutron-network-id
3079           in: query
3080           description: Neutron network id of the interface
3081           required: false
3082           type: string
3083     put:
3084       tags:
3085         - CloudInfrastructure
3086       summary: create or update an existing sriov-vf
3087       description: |
3088         Create or update an existing sriov-vf.
3089         #
3090         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3091       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3092       consumes:
3093         - application/json
3094         - application/xml
3095       produces:
3096         - application/json
3097         - application/xml
3098       responses:
3099         "default":
3100           description: Response codes found in [response codes](https://wiki.onap.org/).
3101       parameters:
3102         - name: cloud-owner
3103           in: path
3104           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3105           required: true
3106           type: string
3107           example: __CLOUD-OWNER__
3108         - name: cloud-region-id
3109           in: path
3110           description: Identifier used by the vendor for the region. Second part of composite key
3111           required: true
3112           type: string
3113           example: __CLOUD-REGION-ID__
3114         - name: tenant-id
3115           in: path
3116           description: Unique id relative to the cloud-region.
3117           required: true
3118           type: string
3119           example: __TENANT-ID__
3120         - name: vserver-id
3121           in: path
3122           description: Unique identifier for this vserver relative to its tenant
3123           required: true
3124           type: string
3125           example: __VSERVER-ID__
3126         - name: interface-name
3127           in: path
3128           description: Name given to the interface
3129           required: true
3130           type: string
3131           example: __INTERFACE-NAME__
3132         - name: pci-id
3133           in: path
3134           description: PCI ID used to identify the sriov-vf
3135           required: true
3136           type: string
3137           example: __PCI-ID__
3138         - name: body
3139           in: body
3140           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)
3141           required: true
3142           schema:
3143             $ref: "#/definitions/sriov-vf"
3144     patch:
3145       tags:
3146         - CloudInfrastructure
3147       summary: update an existing sriov-vf
3148       description: |
3149         Update an existing sriov-vf
3150         #
3151         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3152         The PUT operation will entirely replace an existing object.
3153         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3154         #
3155         Other differences between PUT and PATCH are:
3156         #
3157         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3158         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3159         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3160       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3161       consumes:
3162         - application/json
3163         - application/xml
3164       produces:
3165         - application/json
3166         - application/xml
3167       responses:
3168         "default":
3169           description: Response codes found in [response codes](https://wiki.onap.org/).
3170       parameters:
3171         - name: cloud-owner
3172           in: path
3173           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3174           required: true
3175           type: string
3176           example: __CLOUD-OWNER__
3177         - name: cloud-region-id
3178           in: path
3179           description: Identifier used by the vendor for the region. Second part of composite key
3180           required: true
3181           type: string
3182           example: __CLOUD-REGION-ID__
3183         - name: tenant-id
3184           in: path
3185           description: Unique id relative to the cloud-region.
3186           required: true
3187           type: string
3188           example: __TENANT-ID__
3189         - name: vserver-id
3190           in: path
3191           description: Unique identifier for this vserver relative to its tenant
3192           required: true
3193           type: string
3194           example: __VSERVER-ID__
3195         - name: interface-name
3196           in: path
3197           description: Name given to the interface
3198           required: true
3199           type: string
3200           example: __INTERFACE-NAME__
3201         - name: pci-id
3202           in: path
3203           description: PCI ID used to identify the sriov-vf
3204           required: true
3205           type: string
3206           example: __PCI-ID__
3207         - name: body
3208           in: body
3209           description: sriov-vf object that needs to be created or updated.
3210           required: true
3211           schema:
3212             $ref: "#/patchDefinitions/sriov-vf"
3213     delete:
3214       tags:
3215         - CloudInfrastructure
3216       summary: delete an existing sriov-vf
3217       description: delete an existing sriov-vf
3218       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf
3219       consumes:
3220         - application/json
3221         - application/xml
3222       produces:
3223         - application/json
3224         - application/xml
3225       responses:
3226         "default":
3227           description: Response codes found in [response codes](https://wiki.onap.org/).
3228       parameters:
3229         - name: cloud-owner
3230           in: path
3231           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3232           required: true
3233           type: string
3234           example: __CLOUD-OWNER__
3235         - name: cloud-region-id
3236           in: path
3237           description: Identifier used by the vendor for the region. Second part of composite key
3238           required: true
3239           type: string
3240           example: __CLOUD-REGION-ID__
3241         - name: tenant-id
3242           in: path
3243           description: Unique id relative to the cloud-region.
3244           required: true
3245           type: string
3246           example: __TENANT-ID__
3247         - name: vserver-id
3248           in: path
3249           description: Unique identifier for this vserver relative to its tenant
3250           required: true
3251           type: string
3252           example: __VSERVER-ID__
3253         - name: interface-name
3254           in: path
3255           description: Name given to the interface
3256           required: true
3257           type: string
3258           example: __INTERFACE-NAME__
3259         - name: pci-id
3260           in: path
3261           description: PCI ID used to identify the sriov-vf
3262           required: true
3263           type: string
3264           example: __PCI-ID__
3265         - name: resource-version
3266           in: query
3267           description: resource-version for concurrency
3268           required: true
3269           type: string
3270   /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:
3271     get:
3272       tags:
3273         - CloudInfrastructure
3274       summary: returns sriov-vfs
3275       description: returns sriov-vfs
3276       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfs
3277       produces:
3278         - application/json
3279         - application/xml
3280       responses:
3281         "200":
3282           description: successful operation
3283           schema:
3284               $ref: "#/getDefinitions/sriov-vfs"
3285         "default":
3286           description: Response codes found in [response codes](https://wiki.onap.org/).
3287       parameters:
3288         - name: cloud-owner
3289           in: path
3290           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3291           required: true
3292           type: string
3293           example: __CLOUD-OWNER__
3294         - name: cloud-region-id
3295           in: path
3296           description: Identifier used by the vendor for the region. Second part of composite key
3297           required: true
3298           type: string
3299           example: __CLOUD-REGION-ID__
3300         - name: tenant-id
3301           in: path
3302           description: Unique id relative to the cloud-region.
3303           required: true
3304           type: string
3305           example: __TENANT-ID__
3306         - name: vserver-id
3307           in: path
3308           description: Unique identifier for this vserver relative to its tenant
3309           required: true
3310           type: string
3311           example: __VSERVER-ID__
3312         - name: interface-name
3313           in: path
3314           description: Name given to the interface
3315           required: true
3316           type: string
3317           example: __INTERFACE-NAME__
3318         - name: cloud-type
3319           in: query
3320           description: Type of the cloud (e.g., openstack)
3321           required: false
3322           type: string
3323         - name: owner-defined-type
3324           in: query
3325           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3326           required: false
3327           type: string
3328         - name: tenant-name
3329           in: query
3330           description: Readable name of tenant
3331           required: false
3332           type: string
3333         - name: tenant-context
3334           in: query
3335           description: This field will store the tenant context.
3336           required: false
3337           type: string
3338         - name: vserver-name
3339           in: query
3340           description: Name of vserver
3341           required: false
3342           type: string
3343         - name: vserver-name2
3344           in: query
3345           description: Alternative name of vserver
3346           required: false
3347           type: string
3348         - name: prov-status
3349           in: query
3350           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3351           required: false
3352           type: string
3353         - name: in-maint
3354           in: query
3355           required: false
3356           type: boolean
3357         - name: is-closed-loop-disabled
3358           in: query
3359           required: false
3360           type: boolean
3361         - name: interface-id
3362           in: query
3363           description: ID of interface
3364           required: false
3365           type: string
3366         - name: macaddr
3367           in: query
3368           description: MAC address for the interface
3369           required: false
3370           type: string
3371         - name: network-name
3372           in: query
3373           description: Name of the network
3374           required: false
3375           type: string
3376   /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:
3377     put:
3378       tags:
3379         - CloudInfrastructure
3380       summary: see node definition for valid relationships
3381       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3382       consumes:
3383         - application/json
3384         - application/xml
3385       produces:
3386         - application/json
3387         - application/xml
3388       responses:
3389         "default":
3390           description: Response codes found in [response codes](https://wiki.onap.org/).
3391       parameters:
3392         - name: cloud-owner
3393           in: path
3394           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3395           required: true
3396           type: string
3397           example: __CLOUD-OWNER__
3398         - name: cloud-region-id
3399           in: path
3400           description: Identifier used by the vendor for the region. Second part of composite key
3401           required: true
3402           type: string
3403           example: __CLOUD-REGION-ID__
3404         - name: tenant-id
3405           in: path
3406           description: Unique id relative to the cloud-region.
3407           required: true
3408           type: string
3409           example: __TENANT-ID__
3410         - name: vserver-id
3411           in: path
3412           description: Unique identifier for this vserver relative to its tenant
3413           required: true
3414           type: string
3415           example: __VSERVER-ID__
3416         - name: interface-name
3417           in: path
3418           description: Name given to the interface
3419           required: true
3420           type: string
3421           example: __INTERFACE-NAME__
3422         - name: body
3423           in: body
3424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
3425           required: true
3426           schema:
3427             $ref: "#/definitions/relationship"
3428     delete:
3429       tags:
3430         - CloudInfrastructure
3431       summary: delete an existing relationship
3432       description: delete an existing relationship
3433       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceRelationshipListRelationship
3434       consumes:
3435         - application/json
3436         - application/xml
3437       produces:
3438         - application/json
3439         - application/xml
3440       responses:
3441         "default":
3442           description: Response codes found in [response codes](https://wiki.onap.org/).
3443       parameters:
3444         - name: cloud-owner
3445           in: path
3446           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3447           required: true
3448           type: string
3449           example: __CLOUD-OWNER__
3450         - name: cloud-region-id
3451           in: path
3452           description: Identifier used by the vendor for the region. Second part of composite key
3453           required: true
3454           type: string
3455           example: __CLOUD-REGION-ID__
3456         - name: tenant-id
3457           in: path
3458           description: Unique id relative to the cloud-region.
3459           required: true
3460           type: string
3461           example: __TENANT-ID__
3462         - name: vserver-id
3463           in: path
3464           description: Unique identifier for this vserver relative to its tenant
3465           required: true
3466           type: string
3467           example: __VSERVER-ID__
3468         - name: interface-name
3469           in: path
3470           description: Name given to the interface
3471           required: true
3472           type: string
3473           example: __INTERFACE-NAME__
3474   /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:
3475     put:
3476       tags:
3477         - CloudInfrastructure
3478       summary: see node definition for valid relationships
3479       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3480       consumes:
3481         - application/json
3482         - application/xml
3483       produces:
3484         - application/json
3485         - application/xml
3486       responses:
3487         "default":
3488           description: Response codes found in [response codes](https://wiki.onap.org/).
3489       parameters:
3490         - name: cloud-owner
3491           in: path
3492           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3493           required: true
3494           type: string
3495           example: __CLOUD-OWNER__
3496         - name: cloud-region-id
3497           in: path
3498           description: Identifier used by the vendor for the region. Second part of composite key
3499           required: true
3500           type: string
3501           example: __CLOUD-REGION-ID__
3502         - name: tenant-id
3503           in: path
3504           description: Unique id relative to the cloud-region.
3505           required: true
3506           type: string
3507           example: __TENANT-ID__
3508         - name: vserver-id
3509           in: path
3510           description: Unique identifier for this vserver relative to its tenant
3511           required: true
3512           type: string
3513           example: __VSERVER-ID__
3514         - name: interface-name
3515           in: path
3516           description: Name given to the interface
3517           required: true
3518           type: string
3519           example: __INTERFACE-NAME__
3520         - name: l3-interface-ipv4-address
3521           in: path
3522           description: IP address
3523           required: true
3524           type: string
3525           example: __L3-INTERFACE-IPV4-ADDRESS__
3526         - name: body
3527           in: body
3528           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3529           required: true
3530           schema:
3531             $ref: "#/definitions/relationship"
3532     delete:
3533       tags:
3534         - CloudInfrastructure
3535       summary: delete an existing relationship
3536       description: delete an existing relationship
3537       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
3538       consumes:
3539         - application/json
3540         - application/xml
3541       produces:
3542         - application/json
3543         - application/xml
3544       responses:
3545         "default":
3546           description: Response codes found in [response codes](https://wiki.onap.org/).
3547       parameters:
3548         - name: cloud-owner
3549           in: path
3550           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3551           required: true
3552           type: string
3553           example: __CLOUD-OWNER__
3554         - name: cloud-region-id
3555           in: path
3556           description: Identifier used by the vendor for the region. Second part of composite key
3557           required: true
3558           type: string
3559           example: __CLOUD-REGION-ID__
3560         - name: tenant-id
3561           in: path
3562           description: Unique id relative to the cloud-region.
3563           required: true
3564           type: string
3565           example: __TENANT-ID__
3566         - name: vserver-id
3567           in: path
3568           description: Unique identifier for this vserver relative to its tenant
3569           required: true
3570           type: string
3571           example: __VSERVER-ID__
3572         - name: interface-name
3573           in: path
3574           description: Name given to the interface
3575           required: true
3576           type: string
3577           example: __INTERFACE-NAME__
3578         - name: l3-interface-ipv4-address
3579           in: path
3580           description: IP address
3581           required: true
3582           type: string
3583           example: __L3-INTERFACE-IPV4-ADDRESS__
3584   /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}:
3585     get:
3586       tags:
3587         - CloudInfrastructure
3588       summary: returns l3-interface-ipv4-address-list
3589       description: returns l3-interface-ipv4-address-list
3590       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3591       produces:
3592         - application/json
3593         - application/xml
3594       responses:
3595         "200":
3596           description: successful operation
3597           schema:
3598               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
3599         "default":
3600           description: Response codes found in [response codes](https://wiki.onap.org/).
3601       parameters:
3602         - name: cloud-owner
3603           in: path
3604           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3605           required: true
3606           type: string
3607           example: __CLOUD-OWNER__
3608         - name: cloud-region-id
3609           in: path
3610           description: Identifier used by the vendor for the region. Second part of composite key
3611           required: true
3612           type: string
3613           example: __CLOUD-REGION-ID__
3614         - name: tenant-id
3615           in: path
3616           description: Unique id relative to the cloud-region.
3617           required: true
3618           type: string
3619           example: __TENANT-ID__
3620         - name: vserver-id
3621           in: path
3622           description: Unique identifier for this vserver relative to its tenant
3623           required: true
3624           type: string
3625           example: __VSERVER-ID__
3626         - name: interface-name
3627           in: path
3628           description: Name given to the interface
3629           required: true
3630           type: string
3631           example: __INTERFACE-NAME__
3632         - name: l3-interface-ipv4-address
3633           in: path
3634           description: IP address
3635           required: true
3636           type: string
3637           example: __L3-INTERFACE-IPV4-ADDRESS__
3638         - name: cloud-type
3639           in: query
3640           description: Type of the cloud (e.g., openstack)
3641           required: false
3642           type: string
3643         - name: owner-defined-type
3644           in: query
3645           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
3646           required: false
3647           type: string
3648         - name: tenant-name
3649           in: query
3650           description: Readable name of tenant
3651           required: false
3652           type: string
3653         - name: tenant-context
3654           in: query
3655           description: This field will store the tenant context.
3656           required: false
3657           type: string
3658         - name: vserver-name
3659           in: query
3660           description: Name of vserver
3661           required: false
3662           type: string
3663         - name: vserver-name2
3664           in: query
3665           description: Alternative name of vserver
3666           required: false
3667           type: string
3668         - name: prov-status
3669           in: query
3670           description: Trigger for operational monitoring of this resource by Service Assurance systems.
3671           required: false
3672           type: string
3673         - name: in-maint
3674           in: query
3675           required: false
3676           type: boolean
3677         - name: is-closed-loop-disabled
3678           in: query
3679           required: false
3680           type: boolean
3681         - name: interface-id
3682           in: query
3683           description: ID of interface
3684           required: false
3685           type: string
3686         - name: macaddr
3687           in: query
3688           description: MAC address for the interface
3689           required: false
3690           type: string
3691         - name: network-name
3692           in: query
3693           description: Name of the network
3694           required: false
3695           type: string
3696         - name: vlan-id-inner
3697           in: query
3698           description: Inner VLAN tag
3699           required: false
3700           type: integer
3701           format: int64
3702         - name: neutron-network-id
3703           in: query
3704           description: Neutron network id of the interface that address belongs to
3705           required: false
3706           type: string
3707         - name: neutron-subnet-id
3708           in: query
3709           description: Neutron id of subnet that address belongs to
3710           required: false
3711           type: string
3712     put:
3713       tags:
3714         - CloudInfrastructure
3715       summary: create or update an existing l3-interface-ipv4-address-list
3716       description: |
3717         Create or update an existing l3-interface-ipv4-address-list.
3718         #
3719         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
3720       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3721       consumes:
3722         - application/json
3723         - application/xml
3724       produces:
3725         - application/json
3726         - application/xml
3727       responses:
3728         "default":
3729           description: Response codes found in [response codes](https://wiki.onap.org/).
3730       parameters:
3731         - name: cloud-owner
3732           in: path
3733           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3734           required: true
3735           type: string
3736           example: __CLOUD-OWNER__
3737         - name: cloud-region-id
3738           in: path
3739           description: Identifier used by the vendor for the region. Second part of composite key
3740           required: true
3741           type: string
3742           example: __CLOUD-REGION-ID__
3743         - name: tenant-id
3744           in: path
3745           description: Unique id relative to the cloud-region.
3746           required: true
3747           type: string
3748           example: __TENANT-ID__
3749         - name: vserver-id
3750           in: path
3751           description: Unique identifier for this vserver relative to its tenant
3752           required: true
3753           type: string
3754           example: __VSERVER-ID__
3755         - name: interface-name
3756           in: path
3757           description: Name given to the interface
3758           required: true
3759           type: string
3760           example: __INTERFACE-NAME__
3761         - name: l3-interface-ipv4-address
3762           in: path
3763           description: IP address
3764           required: true
3765           type: string
3766           example: __L3-INTERFACE-IPV4-ADDRESS__
3767         - name: body
3768           in: body
3769           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
3770           required: true
3771           schema:
3772             $ref: "#/definitions/l3-interface-ipv4-address-list"
3773     patch:
3774       tags:
3775         - CloudInfrastructure
3776       summary: update an existing l3-interface-ipv4-address-list
3777       description: |
3778         Update an existing l3-interface-ipv4-address-list
3779         #
3780         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
3781         The PUT operation will entirely replace an existing object.
3782         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
3783         #
3784         Other differences between PUT and PATCH are:
3785         #
3786         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
3787         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
3788         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
3789       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3790       consumes:
3791         - application/json
3792         - application/xml
3793       produces:
3794         - application/json
3795         - application/xml
3796       responses:
3797         "default":
3798           description: Response codes found in [response codes](https://wiki.onap.org/).
3799       parameters:
3800         - name: cloud-owner
3801           in: path
3802           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3803           required: true
3804           type: string
3805           example: __CLOUD-OWNER__
3806         - name: cloud-region-id
3807           in: path
3808           description: Identifier used by the vendor for the region. Second part of composite key
3809           required: true
3810           type: string
3811           example: __CLOUD-REGION-ID__
3812         - name: tenant-id
3813           in: path
3814           description: Unique id relative to the cloud-region.
3815           required: true
3816           type: string
3817           example: __TENANT-ID__
3818         - name: vserver-id
3819           in: path
3820           description: Unique identifier for this vserver relative to its tenant
3821           required: true
3822           type: string
3823           example: __VSERVER-ID__
3824         - name: interface-name
3825           in: path
3826           description: Name given to the interface
3827           required: true
3828           type: string
3829           example: __INTERFACE-NAME__
3830         - name: l3-interface-ipv4-address
3831           in: path
3832           description: IP address
3833           required: true
3834           type: string
3835           example: __L3-INTERFACE-IPV4-ADDRESS__
3836         - name: body
3837           in: body
3838           description: l3-interface-ipv4-address-list object that needs to be created or updated.
3839           required: true
3840           schema:
3841             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
3842     delete:
3843       tags:
3844         - CloudInfrastructure
3845       summary: delete an existing l3-interface-ipv4-address-list
3846       description: delete an existing l3-interface-ipv4-address-list
3847       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList
3848       consumes:
3849         - application/json
3850         - application/xml
3851       produces:
3852         - application/json
3853         - application/xml
3854       responses:
3855         "default":
3856           description: Response codes found in [response codes](https://wiki.onap.org/).
3857       parameters:
3858         - name: cloud-owner
3859           in: path
3860           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3861           required: true
3862           type: string
3863           example: __CLOUD-OWNER__
3864         - name: cloud-region-id
3865           in: path
3866           description: Identifier used by the vendor for the region. Second part of composite key
3867           required: true
3868           type: string
3869           example: __CLOUD-REGION-ID__
3870         - name: tenant-id
3871           in: path
3872           description: Unique id relative to the cloud-region.
3873           required: true
3874           type: string
3875           example: __TENANT-ID__
3876         - name: vserver-id
3877           in: path
3878           description: Unique identifier for this vserver relative to its tenant
3879           required: true
3880           type: string
3881           example: __VSERVER-ID__
3882         - name: interface-name
3883           in: path
3884           description: Name given to the interface
3885           required: true
3886           type: string
3887           example: __INTERFACE-NAME__
3888         - name: l3-interface-ipv4-address
3889           in: path
3890           description: IP address
3891           required: true
3892           type: string
3893           example: __L3-INTERFACE-IPV4-ADDRESS__
3894         - name: resource-version
3895           in: query
3896           description: resource-version for concurrency
3897           required: true
3898           type: string
3899   /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:
3900     put:
3901       tags:
3902         - CloudInfrastructure
3903       summary: see node definition for valid relationships
3904       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3905       consumes:
3906         - application/json
3907         - application/xml
3908       produces:
3909         - application/json
3910         - application/xml
3911       responses:
3912         "default":
3913           description: Response codes found in [response codes](https://wiki.onap.org/).
3914       parameters:
3915         - name: cloud-owner
3916           in: path
3917           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3918           required: true
3919           type: string
3920           example: __CLOUD-OWNER__
3921         - name: cloud-region-id
3922           in: path
3923           description: Identifier used by the vendor for the region. Second part of composite key
3924           required: true
3925           type: string
3926           example: __CLOUD-REGION-ID__
3927         - name: tenant-id
3928           in: path
3929           description: Unique id relative to the cloud-region.
3930           required: true
3931           type: string
3932           example: __TENANT-ID__
3933         - name: vserver-id
3934           in: path
3935           description: Unique identifier for this vserver relative to its tenant
3936           required: true
3937           type: string
3938           example: __VSERVER-ID__
3939         - name: interface-name
3940           in: path
3941           description: Name given to the interface
3942           required: true
3943           type: string
3944           example: __INTERFACE-NAME__
3945         - name: l3-interface-ipv6-address
3946           in: path
3947           description: IP address
3948           required: true
3949           type: string
3950           example: __L3-INTERFACE-IPV6-ADDRESS__
3951         - name: body
3952           in: body
3953           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
3954           required: true
3955           schema:
3956             $ref: "#/definitions/relationship"
3957     delete:
3958       tags:
3959         - CloudInfrastructure
3960       summary: delete an existing relationship
3961       description: delete an existing relationship
3962       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
3963       consumes:
3964         - application/json
3965         - application/xml
3966       produces:
3967         - application/json
3968         - application/xml
3969       responses:
3970         "default":
3971           description: Response codes found in [response codes](https://wiki.onap.org/).
3972       parameters:
3973         - name: cloud-owner
3974           in: path
3975           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
3976           required: true
3977           type: string
3978           example: __CLOUD-OWNER__
3979         - name: cloud-region-id
3980           in: path
3981           description: Identifier used by the vendor for the region. Second part of composite key
3982           required: true
3983           type: string
3984           example: __CLOUD-REGION-ID__
3985         - name: tenant-id
3986           in: path
3987           description: Unique id relative to the cloud-region.
3988           required: true
3989           type: string
3990           example: __TENANT-ID__
3991         - name: vserver-id
3992           in: path
3993           description: Unique identifier for this vserver relative to its tenant
3994           required: true
3995           type: string
3996           example: __VSERVER-ID__
3997         - name: interface-name
3998           in: path
3999           description: Name given to the interface
4000           required: true
4001           type: string
4002           example: __INTERFACE-NAME__
4003         - name: l3-interface-ipv6-address
4004           in: path
4005           description: IP address
4006           required: true
4007           type: string
4008           example: __L3-INTERFACE-IPV6-ADDRESS__
4009   /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}:
4010     get:
4011       tags:
4012         - CloudInfrastructure
4013       summary: returns l3-interface-ipv6-address-list
4014       description: returns l3-interface-ipv6-address-list
4015       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4016       produces:
4017         - application/json
4018         - application/xml
4019       responses:
4020         "200":
4021           description: successful operation
4022           schema:
4023               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
4024         "default":
4025           description: Response codes found in [response codes](https://wiki.onap.org/).
4026       parameters:
4027         - name: cloud-owner
4028           in: path
4029           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4030           required: true
4031           type: string
4032           example: __CLOUD-OWNER__
4033         - name: cloud-region-id
4034           in: path
4035           description: Identifier used by the vendor for the region. Second part of composite key
4036           required: true
4037           type: string
4038           example: __CLOUD-REGION-ID__
4039         - name: tenant-id
4040           in: path
4041           description: Unique id relative to the cloud-region.
4042           required: true
4043           type: string
4044           example: __TENANT-ID__
4045         - name: vserver-id
4046           in: path
4047           description: Unique identifier for this vserver relative to its tenant
4048           required: true
4049           type: string
4050           example: __VSERVER-ID__
4051         - name: interface-name
4052           in: path
4053           description: Name given to the interface
4054           required: true
4055           type: string
4056           example: __INTERFACE-NAME__
4057         - name: l3-interface-ipv6-address
4058           in: path
4059           description: IP address
4060           required: true
4061           type: string
4062           example: __L3-INTERFACE-IPV6-ADDRESS__
4063         - name: cloud-type
4064           in: query
4065           description: Type of the cloud (e.g., openstack)
4066           required: false
4067           type: string
4068         - name: owner-defined-type
4069           in: query
4070           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4071           required: false
4072           type: string
4073         - name: tenant-name
4074           in: query
4075           description: Readable name of tenant
4076           required: false
4077           type: string
4078         - name: tenant-context
4079           in: query
4080           description: This field will store the tenant context.
4081           required: false
4082           type: string
4083         - name: vserver-name
4084           in: query
4085           description: Name of vserver
4086           required: false
4087           type: string
4088         - name: vserver-name2
4089           in: query
4090           description: Alternative name of vserver
4091           required: false
4092           type: string
4093         - name: prov-status
4094           in: query
4095           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4096           required: false
4097           type: string
4098         - name: in-maint
4099           in: query
4100           required: false
4101           type: boolean
4102         - name: is-closed-loop-disabled
4103           in: query
4104           required: false
4105           type: boolean
4106         - name: interface-id
4107           in: query
4108           description: ID of interface
4109           required: false
4110           type: string
4111         - name: macaddr
4112           in: query
4113           description: MAC address for the interface
4114           required: false
4115           type: string
4116         - name: network-name
4117           in: query
4118           description: Name of the network
4119           required: false
4120           type: string
4121         - name: vlan-id-inner
4122           in: query
4123           description: Inner VLAN tag
4124           required: false
4125           type: integer
4126           format: int64
4127         - name: neutron-network-id
4128           in: query
4129           description: Neutron network id of the interface that address belongs to
4130           required: false
4131           type: string
4132         - name: neutron-subnet-id
4133           in: query
4134           description: Neutron id of subnet that address belongs to
4135           required: false
4136           type: string
4137     put:
4138       tags:
4139         - CloudInfrastructure
4140       summary: create or update an existing l3-interface-ipv6-address-list
4141       description: |
4142         Create or update an existing l3-interface-ipv6-address-list.
4143         #
4144         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4145       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4146       consumes:
4147         - application/json
4148         - application/xml
4149       produces:
4150         - application/json
4151         - application/xml
4152       responses:
4153         "default":
4154           description: Response codes found in [response codes](https://wiki.onap.org/).
4155       parameters:
4156         - name: cloud-owner
4157           in: path
4158           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4159           required: true
4160           type: string
4161           example: __CLOUD-OWNER__
4162         - name: cloud-region-id
4163           in: path
4164           description: Identifier used by the vendor for the region. Second part of composite key
4165           required: true
4166           type: string
4167           example: __CLOUD-REGION-ID__
4168         - name: tenant-id
4169           in: path
4170           description: Unique id relative to the cloud-region.
4171           required: true
4172           type: string
4173           example: __TENANT-ID__
4174         - name: vserver-id
4175           in: path
4176           description: Unique identifier for this vserver relative to its tenant
4177           required: true
4178           type: string
4179           example: __VSERVER-ID__
4180         - name: interface-name
4181           in: path
4182           description: Name given to the interface
4183           required: true
4184           type: string
4185           example: __INTERFACE-NAME__
4186         - name: l3-interface-ipv6-address
4187           in: path
4188           description: IP address
4189           required: true
4190           type: string
4191           example: __L3-INTERFACE-IPV6-ADDRESS__
4192         - name: body
4193           in: body
4194           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
4195           required: true
4196           schema:
4197             $ref: "#/definitions/l3-interface-ipv6-address-list"
4198     patch:
4199       tags:
4200         - CloudInfrastructure
4201       summary: update an existing l3-interface-ipv6-address-list
4202       description: |
4203         Update an existing l3-interface-ipv6-address-list
4204         #
4205         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4206         The PUT operation will entirely replace an existing object.
4207         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4208         #
4209         Other differences between PUT and PATCH are:
4210         #
4211         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4212         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4213         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4214       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4215       consumes:
4216         - application/json
4217         - application/xml
4218       produces:
4219         - application/json
4220         - application/xml
4221       responses:
4222         "default":
4223           description: Response codes found in [response codes](https://wiki.onap.org/).
4224       parameters:
4225         - name: cloud-owner
4226           in: path
4227           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4228           required: true
4229           type: string
4230           example: __CLOUD-OWNER__
4231         - name: cloud-region-id
4232           in: path
4233           description: Identifier used by the vendor for the region. Second part of composite key
4234           required: true
4235           type: string
4236           example: __CLOUD-REGION-ID__
4237         - name: tenant-id
4238           in: path
4239           description: Unique id relative to the cloud-region.
4240           required: true
4241           type: string
4242           example: __TENANT-ID__
4243         - name: vserver-id
4244           in: path
4245           description: Unique identifier for this vserver relative to its tenant
4246           required: true
4247           type: string
4248           example: __VSERVER-ID__
4249         - name: interface-name
4250           in: path
4251           description: Name given to the interface
4252           required: true
4253           type: string
4254           example: __INTERFACE-NAME__
4255         - name: l3-interface-ipv6-address
4256           in: path
4257           description: IP address
4258           required: true
4259           type: string
4260           example: __L3-INTERFACE-IPV6-ADDRESS__
4261         - name: body
4262           in: body
4263           description: l3-interface-ipv6-address-list object that needs to be created or updated.
4264           required: true
4265           schema:
4266             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
4267     delete:
4268       tags:
4269         - CloudInfrastructure
4270       summary: delete an existing l3-interface-ipv6-address-list
4271       description: delete an existing l3-interface-ipv6-address-list
4272       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList
4273       consumes:
4274         - application/json
4275         - application/xml
4276       produces:
4277         - application/json
4278         - application/xml
4279       responses:
4280         "default":
4281           description: Response codes found in [response codes](https://wiki.onap.org/).
4282       parameters:
4283         - name: cloud-owner
4284           in: path
4285           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4286           required: true
4287           type: string
4288           example: __CLOUD-OWNER__
4289         - name: cloud-region-id
4290           in: path
4291           description: Identifier used by the vendor for the region. Second part of composite key
4292           required: true
4293           type: string
4294           example: __CLOUD-REGION-ID__
4295         - name: tenant-id
4296           in: path
4297           description: Unique id relative to the cloud-region.
4298           required: true
4299           type: string
4300           example: __TENANT-ID__
4301         - name: vserver-id
4302           in: path
4303           description: Unique identifier for this vserver relative to its tenant
4304           required: true
4305           type: string
4306           example: __VSERVER-ID__
4307         - name: interface-name
4308           in: path
4309           description: Name given to the interface
4310           required: true
4311           type: string
4312           example: __INTERFACE-NAME__
4313         - name: l3-interface-ipv6-address
4314           in: path
4315           description: IP address
4316           required: true
4317           type: string
4318           example: __L3-INTERFACE-IPV6-ADDRESS__
4319         - name: resource-version
4320           in: query
4321           description: resource-version for concurrency
4322           required: true
4323           type: string
4324   /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}:
4325     get:
4326       tags:
4327         - CloudInfrastructure
4328       summary: returns l-interface
4329       description: returns l-interface
4330       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4331       produces:
4332         - application/json
4333         - application/xml
4334       responses:
4335         "200":
4336           description: successful operation
4337           schema:
4338               $ref: "#/getDefinitions/l-interface"
4339         "default":
4340           description: Response codes found in [response codes](https://wiki.onap.org/).
4341       parameters:
4342         - name: cloud-owner
4343           in: path
4344           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4345           required: true
4346           type: string
4347           example: __CLOUD-OWNER__
4348         - name: cloud-region-id
4349           in: path
4350           description: Identifier used by the vendor for the region. Second part of composite key
4351           required: true
4352           type: string
4353           example: __CLOUD-REGION-ID__
4354         - name: tenant-id
4355           in: path
4356           description: Unique id relative to the cloud-region.
4357           required: true
4358           type: string
4359           example: __TENANT-ID__
4360         - name: vserver-id
4361           in: path
4362           description: Unique identifier for this vserver relative to its tenant
4363           required: true
4364           type: string
4365           example: __VSERVER-ID__
4366         - name: interface-name
4367           in: path
4368           description: Name given to the interface
4369           required: true
4370           type: string
4371           example: __INTERFACE-NAME__
4372         - name: cloud-type
4373           in: query
4374           description: Type of the cloud (e.g., openstack)
4375           required: false
4376           type: string
4377         - name: owner-defined-type
4378           in: query
4379           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4380           required: false
4381           type: string
4382         - name: tenant-name
4383           in: query
4384           description: Readable name of tenant
4385           required: false
4386           type: string
4387         - name: tenant-context
4388           in: query
4389           description: This field will store the tenant context.
4390           required: false
4391           type: string
4392         - name: vserver-name
4393           in: query
4394           description: Name of vserver
4395           required: false
4396           type: string
4397         - name: vserver-name2
4398           in: query
4399           description: Alternative name of vserver
4400           required: false
4401           type: string
4402         - name: prov-status
4403           in: query
4404           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4405           required: false
4406           type: string
4407         - name: in-maint
4408           in: query
4409           required: false
4410           type: boolean
4411         - name: is-closed-loop-disabled
4412           in: query
4413           required: false
4414           type: boolean
4415         - name: interface-id
4416           in: query
4417           description: ID of interface
4418           required: false
4419           type: string
4420         - name: macaddr
4421           in: query
4422           description: MAC address for the interface
4423           required: false
4424           type: string
4425         - name: network-name
4426           in: query
4427           description: Name of the network
4428           required: false
4429           type: string
4430     put:
4431       tags:
4432         - CloudInfrastructure
4433       summary: create or update an existing l-interface
4434       description: |
4435         Create or update an existing l-interface.
4436         #
4437         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4438       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4439       consumes:
4440         - application/json
4441         - application/xml
4442       produces:
4443         - application/json
4444         - application/xml
4445       responses:
4446         "default":
4447           description: Response codes found in [response codes](https://wiki.onap.org/).
4448       parameters:
4449         - name: cloud-owner
4450           in: path
4451           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4452           required: true
4453           type: string
4454           example: __CLOUD-OWNER__
4455         - name: cloud-region-id
4456           in: path
4457           description: Identifier used by the vendor for the region. Second part of composite key
4458           required: true
4459           type: string
4460           example: __CLOUD-REGION-ID__
4461         - name: tenant-id
4462           in: path
4463           description: Unique id relative to the cloud-region.
4464           required: true
4465           type: string
4466           example: __TENANT-ID__
4467         - name: vserver-id
4468           in: path
4469           description: Unique identifier for this vserver relative to its tenant
4470           required: true
4471           type: string
4472           example: __VSERVER-ID__
4473         - name: interface-name
4474           in: path
4475           description: Name given to the interface
4476           required: true
4477           type: string
4478           example: __INTERFACE-NAME__
4479         - name: body
4480           in: body
4481           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)
4482           required: true
4483           schema:
4484             $ref: "#/definitions/l-interface"
4485     patch:
4486       tags:
4487         - CloudInfrastructure
4488       summary: update an existing l-interface
4489       description: |
4490         Update an existing l-interface
4491         #
4492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4493         The PUT operation will entirely replace an existing object.
4494         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4495         #
4496         Other differences between PUT and PATCH are:
4497         #
4498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4501       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4502       consumes:
4503         - application/json
4504         - application/xml
4505       produces:
4506         - application/json
4507         - application/xml
4508       responses:
4509         "default":
4510           description: Response codes found in [response codes](https://wiki.onap.org/).
4511       parameters:
4512         - name: cloud-owner
4513           in: path
4514           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4515           required: true
4516           type: string
4517           example: __CLOUD-OWNER__
4518         - name: cloud-region-id
4519           in: path
4520           description: Identifier used by the vendor for the region. Second part of composite key
4521           required: true
4522           type: string
4523           example: __CLOUD-REGION-ID__
4524         - name: tenant-id
4525           in: path
4526           description: Unique id relative to the cloud-region.
4527           required: true
4528           type: string
4529           example: __TENANT-ID__
4530         - name: vserver-id
4531           in: path
4532           description: Unique identifier for this vserver relative to its tenant
4533           required: true
4534           type: string
4535           example: __VSERVER-ID__
4536         - name: interface-name
4537           in: path
4538           description: Name given to the interface
4539           required: true
4540           type: string
4541           example: __INTERFACE-NAME__
4542         - name: body
4543           in: body
4544           description: l-interface object that needs to be created or updated.
4545           required: true
4546           schema:
4547             $ref: "#/patchDefinitions/l-interface"
4548     delete:
4549       tags:
4550         - CloudInfrastructure
4551       summary: delete an existing l-interface
4552       description: delete an existing l-interface
4553       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface
4554       consumes:
4555         - application/json
4556         - application/xml
4557       produces:
4558         - application/json
4559         - application/xml
4560       responses:
4561         "default":
4562           description: Response codes found in [response codes](https://wiki.onap.org/).
4563       parameters:
4564         - name: cloud-owner
4565           in: path
4566           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4567           required: true
4568           type: string
4569           example: __CLOUD-OWNER__
4570         - name: cloud-region-id
4571           in: path
4572           description: Identifier used by the vendor for the region. Second part of composite key
4573           required: true
4574           type: string
4575           example: __CLOUD-REGION-ID__
4576         - name: tenant-id
4577           in: path
4578           description: Unique id relative to the cloud-region.
4579           required: true
4580           type: string
4581           example: __TENANT-ID__
4582         - name: vserver-id
4583           in: path
4584           description: Unique identifier for this vserver relative to its tenant
4585           required: true
4586           type: string
4587           example: __VSERVER-ID__
4588         - name: interface-name
4589           in: path
4590           description: Name given to the interface
4591           required: true
4592           type: string
4593           example: __INTERFACE-NAME__
4594         - name: resource-version
4595           in: query
4596           description: resource-version for concurrency
4597           required: true
4598           type: string
4599   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces:
4600     get:
4601       tags:
4602         - CloudInfrastructure
4603       summary: returns l-interfaces
4604       description: returns l-interfaces
4605       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfaces
4606       produces:
4607         - application/json
4608         - application/xml
4609       responses:
4610         "200":
4611           description: successful operation
4612           schema:
4613               $ref: "#/getDefinitions/l-interfaces"
4614         "default":
4615           description: Response codes found in [response codes](https://wiki.onap.org/).
4616       parameters:
4617         - name: cloud-owner
4618           in: path
4619           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4620           required: true
4621           type: string
4622           example: __CLOUD-OWNER__
4623         - name: cloud-region-id
4624           in: path
4625           description: Identifier used by the vendor for the region. Second part of composite key
4626           required: true
4627           type: string
4628           example: __CLOUD-REGION-ID__
4629         - name: tenant-id
4630           in: path
4631           description: Unique id relative to the cloud-region.
4632           required: true
4633           type: string
4634           example: __TENANT-ID__
4635         - name: vserver-id
4636           in: path
4637           description: Unique identifier for this vserver relative to its tenant
4638           required: true
4639           type: string
4640           example: __VSERVER-ID__
4641         - name: cloud-type
4642           in: query
4643           description: Type of the cloud (e.g., openstack)
4644           required: false
4645           type: string
4646         - name: owner-defined-type
4647           in: query
4648           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4649           required: false
4650           type: string
4651         - name: tenant-name
4652           in: query
4653           description: Readable name of tenant
4654           required: false
4655           type: string
4656         - name: tenant-context
4657           in: query
4658           description: This field will store the tenant context.
4659           required: false
4660           type: string
4661         - name: vserver-name
4662           in: query
4663           description: Name of vserver
4664           required: false
4665           type: string
4666         - name: vserver-name2
4667           in: query
4668           description: Alternative name of vserver
4669           required: false
4670           type: string
4671         - name: prov-status
4672           in: query
4673           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4674           required: false
4675           type: string
4676         - name: in-maint
4677           in: query
4678           required: false
4679           type: boolean
4680         - name: is-closed-loop-disabled
4681           in: query
4682           required: false
4683           type: boolean
4684   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}:
4685     get:
4686       tags:
4687         - CloudInfrastructure
4688       summary: returns vserver
4689       description: returns vserver
4690       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4691       produces:
4692         - application/json
4693         - application/xml
4694       responses:
4695         "200":
4696           description: successful operation
4697           schema:
4698               $ref: "#/getDefinitions/vserver"
4699         "default":
4700           description: Response codes found in [response codes](https://wiki.onap.org/).
4701       parameters:
4702         - name: cloud-owner
4703           in: path
4704           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4705           required: true
4706           type: string
4707           example: __CLOUD-OWNER__
4708         - name: cloud-region-id
4709           in: path
4710           description: Identifier used by the vendor for the region. Second part of composite key
4711           required: true
4712           type: string
4713           example: __CLOUD-REGION-ID__
4714         - name: tenant-id
4715           in: path
4716           description: Unique id relative to the cloud-region.
4717           required: true
4718           type: string
4719           example: __TENANT-ID__
4720         - name: vserver-id
4721           in: path
4722           description: Unique identifier for this vserver relative to its tenant
4723           required: true
4724           type: string
4725           example: __VSERVER-ID__
4726         - name: cloud-type
4727           in: query
4728           description: Type of the cloud (e.g., openstack)
4729           required: false
4730           type: string
4731         - name: owner-defined-type
4732           in: query
4733           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4734           required: false
4735           type: string
4736         - name: tenant-name
4737           in: query
4738           description: Readable name of tenant
4739           required: false
4740           type: string
4741         - name: tenant-context
4742           in: query
4743           description: This field will store the tenant context.
4744           required: false
4745           type: string
4746         - name: vserver-name
4747           in: query
4748           description: Name of vserver
4749           required: false
4750           type: string
4751         - name: vserver-name2
4752           in: query
4753           description: Alternative name of vserver
4754           required: false
4755           type: string
4756         - name: prov-status
4757           in: query
4758           description: Trigger for operational monitoring of this resource by Service Assurance systems.
4759           required: false
4760           type: string
4761         - name: in-maint
4762           in: query
4763           required: false
4764           type: boolean
4765         - name: is-closed-loop-disabled
4766           in: query
4767           required: false
4768           type: boolean
4769     put:
4770       tags:
4771         - CloudInfrastructure
4772       summary: create or update an existing vserver
4773       description: |
4774         Create or update an existing vserver.
4775         #
4776         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
4777       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4778       consumes:
4779         - application/json
4780         - application/xml
4781       produces:
4782         - application/json
4783         - application/xml
4784       responses:
4785         "default":
4786           description: Response codes found in [response codes](https://wiki.onap.org/).
4787       parameters:
4788         - name: cloud-owner
4789           in: path
4790           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4791           required: true
4792           type: string
4793           example: __CLOUD-OWNER__
4794         - name: cloud-region-id
4795           in: path
4796           description: Identifier used by the vendor for the region. Second part of composite key
4797           required: true
4798           type: string
4799           example: __CLOUD-REGION-ID__
4800         - name: tenant-id
4801           in: path
4802           description: Unique id relative to the cloud-region.
4803           required: true
4804           type: string
4805           example: __TENANT-ID__
4806         - name: vserver-id
4807           in: path
4808           description: Unique identifier for this vserver relative to its tenant
4809           required: true
4810           type: string
4811           example: __VSERVER-ID__
4812         - name: body
4813           in: body
4814           description: vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)
4815           required: true
4816           schema:
4817             $ref: "#/definitions/vserver"
4818     patch:
4819       tags:
4820         - CloudInfrastructure
4821       summary: update an existing vserver
4822       description: |
4823         Update an existing vserver
4824         #
4825         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
4826         The PUT operation will entirely replace an existing object.
4827         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
4828         #
4829         Other differences between PUT and PATCH are:
4830         #
4831         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
4832         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
4833         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
4834       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4835       consumes:
4836         - application/json
4837         - application/xml
4838       produces:
4839         - application/json
4840         - application/xml
4841       responses:
4842         "default":
4843           description: Response codes found in [response codes](https://wiki.onap.org/).
4844       parameters:
4845         - name: cloud-owner
4846           in: path
4847           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4848           required: true
4849           type: string
4850           example: __CLOUD-OWNER__
4851         - name: cloud-region-id
4852           in: path
4853           description: Identifier used by the vendor for the region. Second part of composite key
4854           required: true
4855           type: string
4856           example: __CLOUD-REGION-ID__
4857         - name: tenant-id
4858           in: path
4859           description: Unique id relative to the cloud-region.
4860           required: true
4861           type: string
4862           example: __TENANT-ID__
4863         - name: vserver-id
4864           in: path
4865           description: Unique identifier for this vserver relative to its tenant
4866           required: true
4867           type: string
4868           example: __VSERVER-ID__
4869         - name: body
4870           in: body
4871           description: vserver object that needs to be created or updated.
4872           required: true
4873           schema:
4874             $ref: "#/patchDefinitions/vserver"
4875     delete:
4876       tags:
4877         - CloudInfrastructure
4878       summary: delete an existing vserver
4879       description: delete an existing vserver
4880       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver
4881       consumes:
4882         - application/json
4883         - application/xml
4884       produces:
4885         - application/json
4886         - application/xml
4887       responses:
4888         "default":
4889           description: Response codes found in [response codes](https://wiki.onap.org/).
4890       parameters:
4891         - name: cloud-owner
4892           in: path
4893           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4894           required: true
4895           type: string
4896           example: __CLOUD-OWNER__
4897         - name: cloud-region-id
4898           in: path
4899           description: Identifier used by the vendor for the region. Second part of composite key
4900           required: true
4901           type: string
4902           example: __CLOUD-REGION-ID__
4903         - name: tenant-id
4904           in: path
4905           description: Unique id relative to the cloud-region.
4906           required: true
4907           type: string
4908           example: __TENANT-ID__
4909         - name: vserver-id
4910           in: path
4911           description: Unique identifier for this vserver relative to its tenant
4912           required: true
4913           type: string
4914           example: __VSERVER-ID__
4915         - name: resource-version
4916           in: query
4917           description: resource-version for concurrency
4918           required: true
4919           type: string
4920   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers:
4921     get:
4922       tags:
4923         - CloudInfrastructure
4924       summary: returns vservers
4925       description: returns vservers
4926       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenantVservers
4927       produces:
4928         - application/json
4929         - application/xml
4930       responses:
4931         "200":
4932           description: successful operation
4933           schema:
4934               $ref: "#/getDefinitions/vservers"
4935         "default":
4936           description: Response codes found in [response codes](https://wiki.onap.org/).
4937       parameters:
4938         - name: cloud-owner
4939           in: path
4940           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4941           required: true
4942           type: string
4943           example: __CLOUD-OWNER__
4944         - name: cloud-region-id
4945           in: path
4946           description: Identifier used by the vendor for the region. Second part of composite key
4947           required: true
4948           type: string
4949           example: __CLOUD-REGION-ID__
4950         - name: tenant-id
4951           in: path
4952           description: Unique id relative to the cloud-region.
4953           required: true
4954           type: string
4955           example: __TENANT-ID__
4956         - name: cloud-type
4957           in: query
4958           description: Type of the cloud (e.g., openstack)
4959           required: false
4960           type: string
4961         - name: owner-defined-type
4962           in: query
4963           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
4964           required: false
4965           type: string
4966         - name: tenant-name
4967           in: query
4968           description: Readable name of tenant
4969           required: false
4970           type: string
4971         - name: tenant-context
4972           in: query
4973           description: This field will store the tenant context.
4974           required: false
4975           type: string
4976   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship:
4977     put:
4978       tags:
4979         - CloudInfrastructure
4980       summary: see node definition for valid relationships
4981       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
4982       consumes:
4983         - application/json
4984         - application/xml
4985       produces:
4986         - application/json
4987         - application/xml
4988       responses:
4989         "default":
4990           description: Response codes found in [response codes](https://wiki.onap.org/).
4991       parameters:
4992         - name: cloud-owner
4993           in: path
4994           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
4995           required: true
4996           type: string
4997           example: __CLOUD-OWNER__
4998         - name: cloud-region-id
4999           in: path
5000           description: Identifier used by the vendor for the region. Second part of composite key
5001           required: true
5002           type: string
5003           example: __CLOUD-REGION-ID__
5004         - name: tenant-id
5005           in: path
5006           description: Unique id relative to the cloud-region.
5007           required: true
5008           type: string
5009           example: __TENANT-ID__
5010         - name: body
5011           in: body
5012           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5013           required: true
5014           schema:
5015             $ref: "#/definitions/relationship"
5016     delete:
5017       tags:
5018         - CloudInfrastructure
5019       summary: delete an existing relationship
5020       description: delete an existing relationship
5021       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenantRelationshipListRelationship
5022       consumes:
5023         - application/json
5024         - application/xml
5025       produces:
5026         - application/json
5027         - application/xml
5028       responses:
5029         "default":
5030           description: Response codes found in [response codes](https://wiki.onap.org/).
5031       parameters:
5032         - name: cloud-owner
5033           in: path
5034           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5035           required: true
5036           type: string
5037           example: __CLOUD-OWNER__
5038         - name: cloud-region-id
5039           in: path
5040           description: Identifier used by the vendor for the region. Second part of composite key
5041           required: true
5042           type: string
5043           example: __CLOUD-REGION-ID__
5044         - name: tenant-id
5045           in: path
5046           description: Unique id relative to the cloud-region.
5047           required: true
5048           type: string
5049           example: __TENANT-ID__
5050   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}:
5051     get:
5052       tags:
5053         - CloudInfrastructure
5054       summary: returns tenant
5055       description: returns tenant
5056       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5057       produces:
5058         - application/json
5059         - application/xml
5060       responses:
5061         "200":
5062           description: successful operation
5063           schema:
5064               $ref: "#/getDefinitions/tenant"
5065         "default":
5066           description: Response codes found in [response codes](https://wiki.onap.org/).
5067       parameters:
5068         - name: cloud-owner
5069           in: path
5070           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5071           required: true
5072           type: string
5073           example: __CLOUD-OWNER__
5074         - name: cloud-region-id
5075           in: path
5076           description: Identifier used by the vendor for the region. Second part of composite key
5077           required: true
5078           type: string
5079           example: __CLOUD-REGION-ID__
5080         - name: tenant-id
5081           in: path
5082           description: Unique id relative to the cloud-region.
5083           required: true
5084           type: string
5085           example: __TENANT-ID__
5086         - name: cloud-type
5087           in: query
5088           description: Type of the cloud (e.g., openstack)
5089           required: false
5090           type: string
5091         - name: owner-defined-type
5092           in: query
5093           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5094           required: false
5095           type: string
5096         - name: tenant-name
5097           in: query
5098           description: Readable name of tenant
5099           required: false
5100           type: string
5101         - name: tenant-context
5102           in: query
5103           description: This field will store the tenant context.
5104           required: false
5105           type: string
5106     put:
5107       tags:
5108         - CloudInfrastructure
5109       summary: create or update an existing tenant
5110       description: |
5111         Create or update an existing tenant.
5112         #
5113         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5114       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5115       consumes:
5116         - application/json
5117         - application/xml
5118       produces:
5119         - application/json
5120         - application/xml
5121       responses:
5122         "default":
5123           description: Response codes found in [response codes](https://wiki.onap.org/).
5124       parameters:
5125         - name: cloud-owner
5126           in: path
5127           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5128           required: true
5129           type: string
5130           example: __CLOUD-OWNER__
5131         - name: cloud-region-id
5132           in: path
5133           description: Identifier used by the vendor for the region. Second part of composite key
5134           required: true
5135           type: string
5136           example: __CLOUD-REGION-ID__
5137         - name: tenant-id
5138           in: path
5139           description: Unique id relative to the cloud-region.
5140           required: true
5141           type: string
5142           example: __TENANT-ID__
5143         - name: body
5144           in: body
5145           description: tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)
5146           required: true
5147           schema:
5148             $ref: "#/definitions/tenant"
5149     patch:
5150       tags:
5151         - CloudInfrastructure
5152       summary: update an existing tenant
5153       description: |
5154         Update an existing tenant
5155         #
5156         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5157         The PUT operation will entirely replace an existing object.
5158         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5159         #
5160         Other differences between PUT and PATCH are:
5161         #
5162         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5163         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5164         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5165       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5166       consumes:
5167         - application/json
5168         - application/xml
5169       produces:
5170         - application/json
5171         - application/xml
5172       responses:
5173         "default":
5174           description: Response codes found in [response codes](https://wiki.onap.org/).
5175       parameters:
5176         - name: cloud-owner
5177           in: path
5178           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5179           required: true
5180           type: string
5181           example: __CLOUD-OWNER__
5182         - name: cloud-region-id
5183           in: path
5184           description: Identifier used by the vendor for the region. Second part of composite key
5185           required: true
5186           type: string
5187           example: __CLOUD-REGION-ID__
5188         - name: tenant-id
5189           in: path
5190           description: Unique id relative to the cloud-region.
5191           required: true
5192           type: string
5193           example: __TENANT-ID__
5194         - name: body
5195           in: body
5196           description: tenant object that needs to be created or updated.
5197           required: true
5198           schema:
5199             $ref: "#/patchDefinitions/tenant"
5200     delete:
5201       tags:
5202         - CloudInfrastructure
5203       summary: delete an existing tenant
5204       description: delete an existing tenant
5205       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionTenantsTenant
5206       consumes:
5207         - application/json
5208         - application/xml
5209       produces:
5210         - application/json
5211         - application/xml
5212       responses:
5213         "default":
5214           description: Response codes found in [response codes](https://wiki.onap.org/).
5215       parameters:
5216         - name: cloud-owner
5217           in: path
5218           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5219           required: true
5220           type: string
5221           example: __CLOUD-OWNER__
5222         - name: cloud-region-id
5223           in: path
5224           description: Identifier used by the vendor for the region. Second part of composite key
5225           required: true
5226           type: string
5227           example: __CLOUD-REGION-ID__
5228         - name: tenant-id
5229           in: path
5230           description: Unique id relative to the cloud-region.
5231           required: true
5232           type: string
5233           example: __TENANT-ID__
5234         - name: resource-version
5235           in: query
5236           description: resource-version for concurrency
5237           required: true
5238           type: string
5239   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants:
5240     get:
5241       tags:
5242         - CloudInfrastructure
5243       summary: returns tenants
5244       description: returns tenants
5245       operationId: getCloudInfrastructureCloudRegionsCloudRegionTenants
5246       produces:
5247         - application/json
5248         - application/xml
5249       responses:
5250         "200":
5251           description: successful operation
5252           schema:
5253               $ref: "#/getDefinitions/tenants"
5254         "default":
5255           description: Response codes found in [response codes](https://wiki.onap.org/).
5256       parameters:
5257         - name: cloud-owner
5258           in: path
5259           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5260           required: true
5261           type: string
5262           example: __CLOUD-OWNER__
5263         - name: cloud-region-id
5264           in: path
5265           description: Identifier used by the vendor for the region. Second part of composite key
5266           required: true
5267           type: string
5268           example: __CLOUD-REGION-ID__
5269         - name: cloud-type
5270           in: query
5271           description: Type of the cloud (e.g., openstack)
5272           required: false
5273           type: string
5274         - name: owner-defined-type
5275           in: query
5276           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5277           required: false
5278           type: string
5279   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship:
5280     put:
5281       tags:
5282         - CloudInfrastructure
5283       summary: see node definition for valid relationships
5284       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5285       consumes:
5286         - application/json
5287         - application/xml
5288       produces:
5289         - application/json
5290         - application/xml
5291       responses:
5292         "default":
5293           description: Response codes found in [response codes](https://wiki.onap.org/).
5294       parameters:
5295         - name: cloud-owner
5296           in: path
5297           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5298           required: true
5299           type: string
5300           example: __CLOUD-OWNER__
5301         - name: cloud-region-id
5302           in: path
5303           description: Identifier used by the vendor for the region. Second part of composite key
5304           required: true
5305           type: string
5306           example: __CLOUD-REGION-ID__
5307         - name: flavor-id
5308           in: path
5309           description: Flavor id, expected to be unique across cloud-region.
5310           required: true
5311           type: string
5312           example: __FLAVOR-ID__
5313         - name: body
5314           in: body
5315           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5316           required: true
5317           schema:
5318             $ref: "#/definitions/relationship"
5319     delete:
5320       tags:
5321         - CloudInfrastructure
5322       summary: delete an existing relationship
5323       description: delete an existing relationship
5324       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorRelationshipListRelationship
5325       consumes:
5326         - application/json
5327         - application/xml
5328       produces:
5329         - application/json
5330         - application/xml
5331       responses:
5332         "default":
5333           description: Response codes found in [response codes](https://wiki.onap.org/).
5334       parameters:
5335         - name: cloud-owner
5336           in: path
5337           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5338           required: true
5339           type: string
5340           example: __CLOUD-OWNER__
5341         - name: cloud-region-id
5342           in: path
5343           description: Identifier used by the vendor for the region. Second part of composite key
5344           required: true
5345           type: string
5346           example: __CLOUD-REGION-ID__
5347         - name: flavor-id
5348           in: path
5349           description: Flavor id, expected to be unique across cloud-region.
5350           required: true
5351           type: string
5352           example: __FLAVOR-ID__
5353   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}:
5354     get:
5355       tags:
5356         - CloudInfrastructure
5357       summary: returns flavor
5358       description: returns flavor
5359       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5360       produces:
5361         - application/json
5362         - application/xml
5363       responses:
5364         "200":
5365           description: successful operation
5366           schema:
5367               $ref: "#/getDefinitions/flavor"
5368         "default":
5369           description: Response codes found in [response codes](https://wiki.onap.org/).
5370       parameters:
5371         - name: cloud-owner
5372           in: path
5373           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5374           required: true
5375           type: string
5376           example: __CLOUD-OWNER__
5377         - name: cloud-region-id
5378           in: path
5379           description: Identifier used by the vendor for the region. Second part of composite key
5380           required: true
5381           type: string
5382           example: __CLOUD-REGION-ID__
5383         - name: flavor-id
5384           in: path
5385           description: Flavor id, expected to be unique across cloud-region.
5386           required: true
5387           type: string
5388           example: __FLAVOR-ID__
5389         - name: cloud-type
5390           in: query
5391           description: Type of the cloud (e.g., openstack)
5392           required: false
5393           type: string
5394         - name: owner-defined-type
5395           in: query
5396           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5397           required: false
5398           type: string
5399         - name: flavor-name
5400           in: query
5401           description: Flavor name
5402           required: false
5403           type: string
5404     put:
5405       tags:
5406         - CloudInfrastructure
5407       summary: create or update an existing flavor
5408       description: |
5409         Create or update an existing flavor.
5410         #
5411         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5412       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5413       consumes:
5414         - application/json
5415         - application/xml
5416       produces:
5417         - application/json
5418         - application/xml
5419       responses:
5420         "default":
5421           description: Response codes found in [response codes](https://wiki.onap.org/).
5422       parameters:
5423         - name: cloud-owner
5424           in: path
5425           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5426           required: true
5427           type: string
5428           example: __CLOUD-OWNER__
5429         - name: cloud-region-id
5430           in: path
5431           description: Identifier used by the vendor for the region. Second part of composite key
5432           required: true
5433           type: string
5434           example: __CLOUD-REGION-ID__
5435         - name: flavor-id
5436           in: path
5437           description: Flavor id, expected to be unique across cloud-region.
5438           required: true
5439           type: string
5440           example: __FLAVOR-ID__
5441         - name: body
5442           in: body
5443           description: flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)
5444           required: true
5445           schema:
5446             $ref: "#/definitions/flavor"
5447     patch:
5448       tags:
5449         - CloudInfrastructure
5450       summary: update an existing flavor
5451       description: |
5452         Update an existing flavor
5453         #
5454         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5455         The PUT operation will entirely replace an existing object.
5456         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5457         #
5458         Other differences between PUT and PATCH are:
5459         #
5460         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5461         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5462         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5463       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5464       consumes:
5465         - application/json
5466         - application/xml
5467       produces:
5468         - application/json
5469         - application/xml
5470       responses:
5471         "default":
5472           description: Response codes found in [response codes](https://wiki.onap.org/).
5473       parameters:
5474         - name: cloud-owner
5475           in: path
5476           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5477           required: true
5478           type: string
5479           example: __CLOUD-OWNER__
5480         - name: cloud-region-id
5481           in: path
5482           description: Identifier used by the vendor for the region. Second part of composite key
5483           required: true
5484           type: string
5485           example: __CLOUD-REGION-ID__
5486         - name: flavor-id
5487           in: path
5488           description: Flavor id, expected to be unique across cloud-region.
5489           required: true
5490           type: string
5491           example: __FLAVOR-ID__
5492         - name: body
5493           in: body
5494           description: flavor object that needs to be created or updated.
5495           required: true
5496           schema:
5497             $ref: "#/patchDefinitions/flavor"
5498     delete:
5499       tags:
5500         - CloudInfrastructure
5501       summary: delete an existing flavor
5502       description: delete an existing flavor
5503       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor
5504       consumes:
5505         - application/json
5506         - application/xml
5507       produces:
5508         - application/json
5509         - application/xml
5510       responses:
5511         "default":
5512           description: Response codes found in [response codes](https://wiki.onap.org/).
5513       parameters:
5514         - name: cloud-owner
5515           in: path
5516           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5517           required: true
5518           type: string
5519           example: __CLOUD-OWNER__
5520         - name: cloud-region-id
5521           in: path
5522           description: Identifier used by the vendor for the region. Second part of composite key
5523           required: true
5524           type: string
5525           example: __CLOUD-REGION-ID__
5526         - name: flavor-id
5527           in: path
5528           description: Flavor id, expected to be unique across cloud-region.
5529           required: true
5530           type: string
5531           example: __FLAVOR-ID__
5532         - name: resource-version
5533           in: query
5534           description: resource-version for concurrency
5535           required: true
5536           type: string
5537   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors:
5538     get:
5539       tags:
5540         - CloudInfrastructure
5541       summary: returns flavors
5542       description: returns flavors
5543       operationId: getCloudInfrastructureCloudRegionsCloudRegionFlavors
5544       produces:
5545         - application/json
5546         - application/xml
5547       responses:
5548         "200":
5549           description: successful operation
5550           schema:
5551               $ref: "#/getDefinitions/flavors"
5552         "default":
5553           description: Response codes found in [response codes](https://wiki.onap.org/).
5554       parameters:
5555         - name: cloud-owner
5556           in: path
5557           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5558           required: true
5559           type: string
5560           example: __CLOUD-OWNER__
5561         - name: cloud-region-id
5562           in: path
5563           description: Identifier used by the vendor for the region. Second part of composite key
5564           required: true
5565           type: string
5566           example: __CLOUD-REGION-ID__
5567         - name: cloud-type
5568           in: query
5569           description: Type of the cloud (e.g., openstack)
5570           required: false
5571           type: string
5572         - name: owner-defined-type
5573           in: query
5574           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5575           required: false
5576           type: string
5577   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship:
5578     put:
5579       tags:
5580         - CloudInfrastructure
5581       summary: see node definition for valid relationships
5582       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5583       consumes:
5584         - application/json
5585         - application/xml
5586       produces:
5587         - application/json
5588         - application/xml
5589       responses:
5590         "default":
5591           description: Response codes found in [response codes](https://wiki.onap.org/).
5592       parameters:
5593         - name: cloud-owner
5594           in: path
5595           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5596           required: true
5597           type: string
5598           example: __CLOUD-OWNER__
5599         - name: cloud-region-id
5600           in: path
5601           description: Identifier used by the vendor for the region. Second part of composite key
5602           required: true
5603           type: string
5604           example: __CLOUD-REGION-ID__
5605         - name: group-id
5606           in: path
5607           description: Group id, expected to be unique across cloud-region.
5608           required: true
5609           type: string
5610           example: __GROUP-ID__
5611         - name: body
5612           in: body
5613           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5614           required: true
5615           schema:
5616             $ref: "#/definitions/relationship"
5617     delete:
5618       tags:
5619         - CloudInfrastructure
5620       summary: delete an existing relationship
5621       description: delete an existing relationship
5622       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignmentRelationshipListRelationship
5623       consumes:
5624         - application/json
5625         - application/xml
5626       produces:
5627         - application/json
5628         - application/xml
5629       responses:
5630         "default":
5631           description: Response codes found in [response codes](https://wiki.onap.org/).
5632       parameters:
5633         - name: cloud-owner
5634           in: path
5635           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5636           required: true
5637           type: string
5638           example: __CLOUD-OWNER__
5639         - name: cloud-region-id
5640           in: path
5641           description: Identifier used by the vendor for the region. Second part of composite key
5642           required: true
5643           type: string
5644           example: __CLOUD-REGION-ID__
5645         - name: group-id
5646           in: path
5647           description: Group id, expected to be unique across cloud-region.
5648           required: true
5649           type: string
5650           example: __GROUP-ID__
5651   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}:
5652     get:
5653       tags:
5654         - CloudInfrastructure
5655       summary: returns group-assignment
5656       description: returns group-assignment
5657       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5658       produces:
5659         - application/json
5660         - application/xml
5661       responses:
5662         "200":
5663           description: successful operation
5664           schema:
5665               $ref: "#/getDefinitions/group-assignment"
5666         "default":
5667           description: Response codes found in [response codes](https://wiki.onap.org/).
5668       parameters:
5669         - name: cloud-owner
5670           in: path
5671           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5672           required: true
5673           type: string
5674           example: __CLOUD-OWNER__
5675         - name: cloud-region-id
5676           in: path
5677           description: Identifier used by the vendor for the region. Second part of composite key
5678           required: true
5679           type: string
5680           example: __CLOUD-REGION-ID__
5681         - name: group-id
5682           in: path
5683           description: Group id, expected to be unique across cloud-region.
5684           required: true
5685           type: string
5686           example: __GROUP-ID__
5687         - name: cloud-type
5688           in: query
5689           description: Type of the cloud (e.g., openstack)
5690           required: false
5691           type: string
5692         - name: owner-defined-type
5693           in: query
5694           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5695           required: false
5696           type: string
5697         - name: group-type
5698           in: query
5699           description: Group type - the type of group this instance refers to
5700           required: false
5701           type: string
5702         - name: group-name
5703           in: query
5704           description: Group name - name assigned to the group
5705           required: false
5706           type: string
5707     put:
5708       tags:
5709         - CloudInfrastructure
5710       summary: create or update an existing group-assignment
5711       description: |
5712         Create or update an existing group-assignment.
5713         #
5714         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
5715       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5716       consumes:
5717         - application/json
5718         - application/xml
5719       produces:
5720         - application/json
5721         - application/xml
5722       responses:
5723         "default":
5724           description: Response codes found in [response codes](https://wiki.onap.org/).
5725       parameters:
5726         - name: cloud-owner
5727           in: path
5728           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5729           required: true
5730           type: string
5731           example: __CLOUD-OWNER__
5732         - name: cloud-region-id
5733           in: path
5734           description: Identifier used by the vendor for the region. Second part of composite key
5735           required: true
5736           type: string
5737           example: __CLOUD-REGION-ID__
5738         - name: group-id
5739           in: path
5740           description: Group id, expected to be unique across cloud-region.
5741           required: true
5742           type: string
5743           example: __GROUP-ID__
5744         - name: body
5745           in: body
5746           description: group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)
5747           required: true
5748           schema:
5749             $ref: "#/definitions/group-assignment"
5750     patch:
5751       tags:
5752         - CloudInfrastructure
5753       summary: update an existing group-assignment
5754       description: |
5755         Update an existing group-assignment
5756         #
5757         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
5758         The PUT operation will entirely replace an existing object.
5759         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
5760         #
5761         Other differences between PUT and PATCH are:
5762         #
5763         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
5764         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
5765         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
5766       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5767       consumes:
5768         - application/json
5769         - application/xml
5770       produces:
5771         - application/json
5772         - application/xml
5773       responses:
5774         "default":
5775           description: Response codes found in [response codes](https://wiki.onap.org/).
5776       parameters:
5777         - name: cloud-owner
5778           in: path
5779           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5780           required: true
5781           type: string
5782           example: __CLOUD-OWNER__
5783         - name: cloud-region-id
5784           in: path
5785           description: Identifier used by the vendor for the region. Second part of composite key
5786           required: true
5787           type: string
5788           example: __CLOUD-REGION-ID__
5789         - name: group-id
5790           in: path
5791           description: Group id, expected to be unique across cloud-region.
5792           required: true
5793           type: string
5794           example: __GROUP-ID__
5795         - name: body
5796           in: body
5797           description: group-assignment object that needs to be created or updated.
5798           required: true
5799           schema:
5800             $ref: "#/patchDefinitions/group-assignment"
5801     delete:
5802       tags:
5803         - CloudInfrastructure
5804       summary: delete an existing group-assignment
5805       description: delete an existing group-assignment
5806       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment
5807       consumes:
5808         - application/json
5809         - application/xml
5810       produces:
5811         - application/json
5812         - application/xml
5813       responses:
5814         "default":
5815           description: Response codes found in [response codes](https://wiki.onap.org/).
5816       parameters:
5817         - name: cloud-owner
5818           in: path
5819           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5820           required: true
5821           type: string
5822           example: __CLOUD-OWNER__
5823         - name: cloud-region-id
5824           in: path
5825           description: Identifier used by the vendor for the region. Second part of composite key
5826           required: true
5827           type: string
5828           example: __CLOUD-REGION-ID__
5829         - name: group-id
5830           in: path
5831           description: Group id, expected to be unique across cloud-region.
5832           required: true
5833           type: string
5834           example: __GROUP-ID__
5835         - name: resource-version
5836           in: query
5837           description: resource-version for concurrency
5838           required: true
5839           type: string
5840   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments:
5841     get:
5842       tags:
5843         - CloudInfrastructure
5844       summary: returns group-assignments
5845       description: returns group-assignments
5846       operationId: getCloudInfrastructureCloudRegionsCloudRegionGroupAssignments
5847       produces:
5848         - application/json
5849         - application/xml
5850       responses:
5851         "200":
5852           description: successful operation
5853           schema:
5854               $ref: "#/getDefinitions/group-assignments"
5855         "default":
5856           description: Response codes found in [response codes](https://wiki.onap.org/).
5857       parameters:
5858         - name: cloud-owner
5859           in: path
5860           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5861           required: true
5862           type: string
5863           example: __CLOUD-OWNER__
5864         - name: cloud-region-id
5865           in: path
5866           description: Identifier used by the vendor for the region. Second part of composite key
5867           required: true
5868           type: string
5869           example: __CLOUD-REGION-ID__
5870         - name: cloud-type
5871           in: query
5872           description: Type of the cloud (e.g., openstack)
5873           required: false
5874           type: string
5875         - name: owner-defined-type
5876           in: query
5877           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5878           required: false
5879           type: string
5880   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship:
5881     put:
5882       tags:
5883         - CloudInfrastructure
5884       summary: see node definition for valid relationships
5885       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5886       consumes:
5887         - application/json
5888         - application/xml
5889       produces:
5890         - application/json
5891         - application/xml
5892       responses:
5893         "default":
5894           description: Response codes found in [response codes](https://wiki.onap.org/).
5895       parameters:
5896         - name: cloud-owner
5897           in: path
5898           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5899           required: true
5900           type: string
5901           example: __CLOUD-OWNER__
5902         - name: cloud-region-id
5903           in: path
5904           description: Identifier used by the vendor for the region. Second part of composite key
5905           required: true
5906           type: string
5907           example: __CLOUD-REGION-ID__
5908         - name: snapshot-id
5909           in: path
5910           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5911           required: true
5912           type: string
5913           example: __SNAPSHOT-ID__
5914         - name: body
5915           in: body
5916           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
5917           required: true
5918           schema:
5919             $ref: "#/definitions/relationship"
5920     delete:
5921       tags:
5922         - CloudInfrastructure
5923       summary: delete an existing relationship
5924       description: delete an existing relationship
5925       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshotRelationshipListRelationship
5926       consumes:
5927         - application/json
5928         - application/xml
5929       produces:
5930         - application/json
5931         - application/xml
5932       responses:
5933         "default":
5934           description: Response codes found in [response codes](https://wiki.onap.org/).
5935       parameters:
5936         - name: cloud-owner
5937           in: path
5938           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5939           required: true
5940           type: string
5941           example: __CLOUD-OWNER__
5942         - name: cloud-region-id
5943           in: path
5944           description: Identifier used by the vendor for the region. Second part of composite key
5945           required: true
5946           type: string
5947           example: __CLOUD-REGION-ID__
5948         - name: snapshot-id
5949           in: path
5950           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5951           required: true
5952           type: string
5953           example: __SNAPSHOT-ID__
5954   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}:
5955     get:
5956       tags:
5957         - CloudInfrastructure
5958       summary: returns snapshot
5959       description: returns snapshot
5960       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
5961       produces:
5962         - application/json
5963         - application/xml
5964       responses:
5965         "200":
5966           description: successful operation
5967           schema:
5968               $ref: "#/getDefinitions/snapshot"
5969         "default":
5970           description: Response codes found in [response codes](https://wiki.onap.org/).
5971       parameters:
5972         - name: cloud-owner
5973           in: path
5974           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
5975           required: true
5976           type: string
5977           example: __CLOUD-OWNER__
5978         - name: cloud-region-id
5979           in: path
5980           description: Identifier used by the vendor for the region. Second part of composite key
5981           required: true
5982           type: string
5983           example: __CLOUD-REGION-ID__
5984         - name: snapshot-id
5985           in: path
5986           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
5987           required: true
5988           type: string
5989           example: __SNAPSHOT-ID__
5990         - name: cloud-type
5991           in: query
5992           description: Type of the cloud (e.g., openstack)
5993           required: false
5994           type: string
5995         - name: owner-defined-type
5996           in: query
5997           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
5998           required: false
5999           type: string
6000         - name: snapshot-name
6001           in: query
6002           description: Snapshot name
6003           required: false
6004           type: string
6005         - name: application
6006           in: query
6007           description: The application that the image instantiates.
6008           required: false
6009           type: string
6010         - name: application-vendor
6011           in: query
6012           description: The vendor of the application.
6013           required: false
6014           type: string
6015         - name: application-version
6016           in: query
6017           description: The version of the application.
6018           required: false
6019           type: string
6020         - name: prev-snapshot-id
6021           in: query
6022           description: This field contains the UUID of the previous snapshot (if any).
6023           required: false
6024           type: string
6025     put:
6026       tags:
6027         - CloudInfrastructure
6028       summary: create or update an existing snapshot
6029       description: |
6030         Create or update an existing snapshot.
6031         #
6032         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6033       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6034       consumes:
6035         - application/json
6036         - application/xml
6037       produces:
6038         - application/json
6039         - application/xml
6040       responses:
6041         "default":
6042           description: Response codes found in [response codes](https://wiki.onap.org/).
6043       parameters:
6044         - name: cloud-owner
6045           in: path
6046           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6047           required: true
6048           type: string
6049           example: __CLOUD-OWNER__
6050         - name: cloud-region-id
6051           in: path
6052           description: Identifier used by the vendor for the region. Second part of composite key
6053           required: true
6054           type: string
6055           example: __CLOUD-REGION-ID__
6056         - name: snapshot-id
6057           in: path
6058           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6059           required: true
6060           type: string
6061           example: __SNAPSHOT-ID__
6062         - name: body
6063           in: body
6064           description: snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)
6065           required: true
6066           schema:
6067             $ref: "#/definitions/snapshot"
6068     patch:
6069       tags:
6070         - CloudInfrastructure
6071       summary: update an existing snapshot
6072       description: |
6073         Update an existing snapshot
6074         #
6075         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6076         The PUT operation will entirely replace an existing object.
6077         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6078         #
6079         Other differences between PUT and PATCH are:
6080         #
6081         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6082         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6083         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6084       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6085       consumes:
6086         - application/json
6087         - application/xml
6088       produces:
6089         - application/json
6090         - application/xml
6091       responses:
6092         "default":
6093           description: Response codes found in [response codes](https://wiki.onap.org/).
6094       parameters:
6095         - name: cloud-owner
6096           in: path
6097           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6098           required: true
6099           type: string
6100           example: __CLOUD-OWNER__
6101         - name: cloud-region-id
6102           in: path
6103           description: Identifier used by the vendor for the region. Second part of composite key
6104           required: true
6105           type: string
6106           example: __CLOUD-REGION-ID__
6107         - name: snapshot-id
6108           in: path
6109           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6110           required: true
6111           type: string
6112           example: __SNAPSHOT-ID__
6113         - name: body
6114           in: body
6115           description: snapshot object that needs to be created or updated.
6116           required: true
6117           schema:
6118             $ref: "#/patchDefinitions/snapshot"
6119     delete:
6120       tags:
6121         - CloudInfrastructure
6122       summary: delete an existing snapshot
6123       description: delete an existing snapshot
6124       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot
6125       consumes:
6126         - application/json
6127         - application/xml
6128       produces:
6129         - application/json
6130         - application/xml
6131       responses:
6132         "default":
6133           description: Response codes found in [response codes](https://wiki.onap.org/).
6134       parameters:
6135         - name: cloud-owner
6136           in: path
6137           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6138           required: true
6139           type: string
6140           example: __CLOUD-OWNER__
6141         - name: cloud-region-id
6142           in: path
6143           description: Identifier used by the vendor for the region. Second part of composite key
6144           required: true
6145           type: string
6146           example: __CLOUD-REGION-ID__
6147         - name: snapshot-id
6148           in: path
6149           description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
6150           required: true
6151           type: string
6152           example: __SNAPSHOT-ID__
6153         - name: resource-version
6154           in: query
6155           description: resource-version for concurrency
6156           required: true
6157           type: string
6158   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots:
6159     get:
6160       tags:
6161         - CloudInfrastructure
6162       summary: returns snapshots
6163       description: returns snapshots
6164       operationId: getCloudInfrastructureCloudRegionsCloudRegionSnapshots
6165       produces:
6166         - application/json
6167         - application/xml
6168       responses:
6169         "200":
6170           description: successful operation
6171           schema:
6172               $ref: "#/getDefinitions/snapshots"
6173         "default":
6174           description: Response codes found in [response codes](https://wiki.onap.org/).
6175       parameters:
6176         - name: cloud-owner
6177           in: path
6178           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6179           required: true
6180           type: string
6181           example: __CLOUD-OWNER__
6182         - name: cloud-region-id
6183           in: path
6184           description: Identifier used by the vendor for the region. Second part of composite key
6185           required: true
6186           type: string
6187           example: __CLOUD-REGION-ID__
6188         - name: cloud-type
6189           in: query
6190           description: Type of the cloud (e.g., openstack)
6191           required: false
6192           type: string
6193         - name: owner-defined-type
6194           in: query
6195           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6196           required: false
6197           type: string
6198   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship:
6199     put:
6200       tags:
6201         - CloudInfrastructure
6202       summary: see node definition for valid relationships
6203       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6204       consumes:
6205         - application/json
6206         - application/xml
6207       produces:
6208         - application/json
6209         - application/xml
6210       responses:
6211         "default":
6212           description: Response codes found in [response codes](https://wiki.onap.org/).
6213       parameters:
6214         - name: cloud-owner
6215           in: path
6216           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6217           required: true
6218           type: string
6219           example: __CLOUD-OWNER__
6220         - name: cloud-region-id
6221           in: path
6222           description: Identifier used by the vendor for the region. Second part of composite key
6223           required: true
6224           type: string
6225           example: __CLOUD-REGION-ID__
6226         - name: image-id
6227           in: path
6228           description: Image id, expected to be unique across cloud region
6229           required: true
6230           type: string
6231           example: __IMAGE-ID__
6232         - name: body
6233           in: body
6234           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6235           required: true
6236           schema:
6237             $ref: "#/definitions/relationship"
6238     delete:
6239       tags:
6240         - CloudInfrastructure
6241       summary: delete an existing relationship
6242       description: delete an existing relationship
6243       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageRelationshipListRelationship
6244       consumes:
6245         - application/json
6246         - application/xml
6247       produces:
6248         - application/json
6249         - application/xml
6250       responses:
6251         "default":
6252           description: Response codes found in [response codes](https://wiki.onap.org/).
6253       parameters:
6254         - name: cloud-owner
6255           in: path
6256           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6257           required: true
6258           type: string
6259           example: __CLOUD-OWNER__
6260         - name: cloud-region-id
6261           in: path
6262           description: Identifier used by the vendor for the region. Second part of composite key
6263           required: true
6264           type: string
6265           example: __CLOUD-REGION-ID__
6266         - name: image-id
6267           in: path
6268           description: Image id, expected to be unique across cloud region
6269           required: true
6270           type: string
6271           example: __IMAGE-ID__
6272   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}:
6273     get:
6274       tags:
6275         - CloudInfrastructure
6276       summary: returns metadatum
6277       description: returns metadatum
6278       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6279       produces:
6280         - application/json
6281         - application/xml
6282       responses:
6283         "200":
6284           description: successful operation
6285           schema:
6286               $ref: "#/getDefinitions/metadatum"
6287         "default":
6288           description: Response codes found in [response codes](https://wiki.onap.org/).
6289       parameters:
6290         - name: cloud-owner
6291           in: path
6292           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6293           required: true
6294           type: string
6295           example: __CLOUD-OWNER__
6296         - name: cloud-region-id
6297           in: path
6298           description: Identifier used by the vendor for the region. Second part of composite key
6299           required: true
6300           type: string
6301           example: __CLOUD-REGION-ID__
6302         - name: image-id
6303           in: path
6304           description: Image id, expected to be unique across cloud region
6305           required: true
6306           type: string
6307           example: __IMAGE-ID__
6308         - name: metaname
6309           in: path
6310           required: true
6311           type: string
6312           example: __METANAME__
6313         - name: cloud-type
6314           in: query
6315           description: Type of the cloud (e.g., openstack)
6316           required: false
6317           type: string
6318         - name: owner-defined-type
6319           in: query
6320           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6321           required: false
6322           type: string
6323         - name: image-name
6324           in: query
6325           description: Image name
6326           required: false
6327           type: string
6328         - name: application
6329           in: query
6330           description: The application that the image instantiates.
6331           required: false
6332           type: string
6333         - name: application-vendor
6334           in: query
6335           description: The vendor of the application.
6336           required: false
6337           type: string
6338         - name: application-version
6339           in: query
6340           description: The version of the application.
6341           required: false
6342           type: string
6343     put:
6344       tags:
6345         - CloudInfrastructure
6346       summary: create or update an existing metadatum
6347       description: |
6348         Create or update an existing metadatum.
6349         #
6350         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6351       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6352       consumes:
6353         - application/json
6354         - application/xml
6355       produces:
6356         - application/json
6357         - application/xml
6358       responses:
6359         "default":
6360           description: Response codes found in [response codes](https://wiki.onap.org/).
6361       parameters:
6362         - name: cloud-owner
6363           in: path
6364           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6365           required: true
6366           type: string
6367           example: __CLOUD-OWNER__
6368         - name: cloud-region-id
6369           in: path
6370           description: Identifier used by the vendor for the region. Second part of composite key
6371           required: true
6372           type: string
6373           example: __CLOUD-REGION-ID__
6374         - name: image-id
6375           in: path
6376           description: Image id, expected to be unique across cloud region
6377           required: true
6378           type: string
6379           example: __IMAGE-ID__
6380         - name: metaname
6381           in: path
6382           required: true
6383           type: string
6384           example: __METANAME__
6385         - name: body
6386           in: body
6387           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)
6388           required: true
6389           schema:
6390             $ref: "#/definitions/metadatum"
6391     patch:
6392       tags:
6393         - CloudInfrastructure
6394       summary: update an existing metadatum
6395       description: |
6396         Update an existing metadatum
6397         #
6398         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6399         The PUT operation will entirely replace an existing object.
6400         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6401         #
6402         Other differences between PUT and PATCH are:
6403         #
6404         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6405         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6406         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6407       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6408       consumes:
6409         - application/json
6410         - application/xml
6411       produces:
6412         - application/json
6413         - application/xml
6414       responses:
6415         "default":
6416           description: Response codes found in [response codes](https://wiki.onap.org/).
6417       parameters:
6418         - name: cloud-owner
6419           in: path
6420           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6421           required: true
6422           type: string
6423           example: __CLOUD-OWNER__
6424         - name: cloud-region-id
6425           in: path
6426           description: Identifier used by the vendor for the region. Second part of composite key
6427           required: true
6428           type: string
6429           example: __CLOUD-REGION-ID__
6430         - name: image-id
6431           in: path
6432           description: Image id, expected to be unique across cloud region
6433           required: true
6434           type: string
6435           example: __IMAGE-ID__
6436         - name: metaname
6437           in: path
6438           required: true
6439           type: string
6440           example: __METANAME__
6441         - name: body
6442           in: body
6443           description: metadatum object that needs to be created or updated.
6444           required: true
6445           schema:
6446             $ref: "#/patchDefinitions/metadatum"
6447     delete:
6448       tags:
6449         - CloudInfrastructure
6450       summary: delete an existing metadatum
6451       description: delete an existing metadatum
6452       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum
6453       consumes:
6454         - application/json
6455         - application/xml
6456       produces:
6457         - application/json
6458         - application/xml
6459       responses:
6460         "default":
6461           description: Response codes found in [response codes](https://wiki.onap.org/).
6462       parameters:
6463         - name: cloud-owner
6464           in: path
6465           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6466           required: true
6467           type: string
6468           example: __CLOUD-OWNER__
6469         - name: cloud-region-id
6470           in: path
6471           description: Identifier used by the vendor for the region. Second part of composite key
6472           required: true
6473           type: string
6474           example: __CLOUD-REGION-ID__
6475         - name: image-id
6476           in: path
6477           description: Image id, expected to be unique across cloud region
6478           required: true
6479           type: string
6480           example: __IMAGE-ID__
6481         - name: metaname
6482           in: path
6483           required: true
6484           type: string
6485           example: __METANAME__
6486         - name: resource-version
6487           in: query
6488           description: resource-version for concurrency
6489           required: true
6490           type: string
6491   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata:
6492     get:
6493       tags:
6494         - CloudInfrastructure
6495       summary: returns metadata
6496       description: returns metadata
6497       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImageMetadata
6498       produces:
6499         - application/json
6500         - application/xml
6501       responses:
6502         "200":
6503           description: successful operation
6504           schema:
6505               $ref: "#/getDefinitions/metadata"
6506         "default":
6507           description: Response codes found in [response codes](https://wiki.onap.org/).
6508       parameters:
6509         - name: cloud-owner
6510           in: path
6511           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6512           required: true
6513           type: string
6514           example: __CLOUD-OWNER__
6515         - name: cloud-region-id
6516           in: path
6517           description: Identifier used by the vendor for the region. Second part of composite key
6518           required: true
6519           type: string
6520           example: __CLOUD-REGION-ID__
6521         - name: image-id
6522           in: path
6523           description: Image id, expected to be unique across cloud region
6524           required: true
6525           type: string
6526           example: __IMAGE-ID__
6527         - name: cloud-type
6528           in: query
6529           description: Type of the cloud (e.g., openstack)
6530           required: false
6531           type: string
6532         - name: owner-defined-type
6533           in: query
6534           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6535           required: false
6536           type: string
6537         - name: image-name
6538           in: query
6539           description: Image name
6540           required: false
6541           type: string
6542         - name: application
6543           in: query
6544           description: The application that the image instantiates.
6545           required: false
6546           type: string
6547         - name: application-vendor
6548           in: query
6549           description: The vendor of the application.
6550           required: false
6551           type: string
6552         - name: application-version
6553           in: query
6554           description: The version of the application.
6555           required: false
6556           type: string
6557   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}:
6558     get:
6559       tags:
6560         - CloudInfrastructure
6561       summary: returns image
6562       description: returns image
6563       operationId: getCloudInfrastructureCloudRegionsCloudRegionImagesImage
6564       produces:
6565         - application/json
6566         - application/xml
6567       responses:
6568         "200":
6569           description: successful operation
6570           schema:
6571               $ref: "#/getDefinitions/image"
6572         "default":
6573           description: Response codes found in [response codes](https://wiki.onap.org/).
6574       parameters:
6575         - name: cloud-owner
6576           in: path
6577           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6578           required: true
6579           type: string
6580           example: __CLOUD-OWNER__
6581         - name: cloud-region-id
6582           in: path
6583           description: Identifier used by the vendor for the region. Second part of composite key
6584           required: true
6585           type: string
6586           example: __CLOUD-REGION-ID__
6587         - name: image-id
6588           in: path
6589           description: Image id, expected to be unique across cloud region
6590           required: true
6591           type: string
6592           example: __IMAGE-ID__
6593         - name: cloud-type
6594           in: query
6595           description: Type of the cloud (e.g., openstack)
6596           required: false
6597           type: string
6598         - name: owner-defined-type
6599           in: query
6600           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6601           required: false
6602           type: string
6603         - name: image-name
6604           in: query
6605           description: Image name
6606           required: false
6607           type: string
6608         - name: application
6609           in: query
6610           description: The application that the image instantiates.
6611           required: false
6612           type: string
6613         - name: application-vendor
6614           in: query
6615           description: The vendor of the application.
6616           required: false
6617           type: string
6618         - name: application-version
6619           in: query
6620           description: The version of the application.
6621           required: false
6622           type: string
6623     put:
6624       tags:
6625         - CloudInfrastructure
6626       summary: create or update an existing image
6627       description: |
6628         Create or update an existing image.
6629         #
6630         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6631       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6632       consumes:
6633         - application/json
6634         - application/xml
6635       produces:
6636         - application/json
6637         - application/xml
6638       responses:
6639         "default":
6640           description: Response codes found in [response codes](https://wiki.onap.org/).
6641       parameters:
6642         - name: cloud-owner
6643           in: path
6644           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6645           required: true
6646           type: string
6647           example: __CLOUD-OWNER__
6648         - name: cloud-region-id
6649           in: path
6650           description: Identifier used by the vendor for the region. Second part of composite key
6651           required: true
6652           type: string
6653           example: __CLOUD-REGION-ID__
6654         - name: image-id
6655           in: path
6656           description: Image id, expected to be unique across cloud region
6657           required: true
6658           type: string
6659           example: __IMAGE-ID__
6660         - name: body
6661           in: body
6662           description: image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)
6663           required: true
6664           schema:
6665             $ref: "#/definitions/image"
6666     patch:
6667       tags:
6668         - CloudInfrastructure
6669       summary: update an existing image
6670       description: |
6671         Update an existing image
6672         #
6673         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6674         The PUT operation will entirely replace an existing object.
6675         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6676         #
6677         Other differences between PUT and PATCH are:
6678         #
6679         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6680         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6681         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6682       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionImagesImage
6683       consumes:
6684         - application/json
6685         - application/xml
6686       produces:
6687         - application/json
6688         - application/xml
6689       responses:
6690         "default":
6691           description: Response codes found in [response codes](https://wiki.onap.org/).
6692       parameters:
6693         - name: cloud-owner
6694           in: path
6695           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6696           required: true
6697           type: string
6698           example: __CLOUD-OWNER__
6699         - name: cloud-region-id
6700           in: path
6701           description: Identifier used by the vendor for the region. Second part of composite key
6702           required: true
6703           type: string
6704           example: __CLOUD-REGION-ID__
6705         - name: image-id
6706           in: path
6707           description: Image id, expected to be unique across cloud region
6708           required: true
6709           type: string
6710           example: __IMAGE-ID__
6711         - name: body
6712           in: body
6713           description: image object that needs to be created or updated.
6714           required: true
6715           schema:
6716             $ref: "#/patchDefinitions/image"
6717     delete:
6718       tags:
6719         - CloudInfrastructure
6720       summary: delete an existing image
6721       description: delete an existing image
6722       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionImagesImage
6723       consumes:
6724         - application/json
6725         - application/xml
6726       produces:
6727         - application/json
6728         - application/xml
6729       responses:
6730         "default":
6731           description: Response codes found in [response codes](https://wiki.onap.org/).
6732       parameters:
6733         - name: cloud-owner
6734           in: path
6735           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6736           required: true
6737           type: string
6738           example: __CLOUD-OWNER__
6739         - name: cloud-region-id
6740           in: path
6741           description: Identifier used by the vendor for the region. Second part of composite key
6742           required: true
6743           type: string
6744           example: __CLOUD-REGION-ID__
6745         - name: image-id
6746           in: path
6747           description: Image id, expected to be unique across cloud region
6748           required: true
6749           type: string
6750           example: __IMAGE-ID__
6751         - name: resource-version
6752           in: query
6753           description: resource-version for concurrency
6754           required: true
6755           type: string
6756   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images:
6757     get:
6758       tags:
6759         - CloudInfrastructure
6760       summary: returns images
6761       description: returns images
6762       operationId: getCloudInfrastructureCloudRegionsCloudRegionImages
6763       produces:
6764         - application/json
6765         - application/xml
6766       responses:
6767         "200":
6768           description: successful operation
6769           schema:
6770               $ref: "#/getDefinitions/images"
6771         "default":
6772           description: Response codes found in [response codes](https://wiki.onap.org/).
6773       parameters:
6774         - name: cloud-owner
6775           in: path
6776           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6777           required: true
6778           type: string
6779           example: __CLOUD-OWNER__
6780         - name: cloud-region-id
6781           in: path
6782           description: Identifier used by the vendor for the region. Second part of composite key
6783           required: true
6784           type: string
6785           example: __CLOUD-REGION-ID__
6786         - name: cloud-type
6787           in: query
6788           description: Type of the cloud (e.g., openstack)
6789           required: false
6790           type: string
6791         - name: owner-defined-type
6792           in: query
6793           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6794           required: false
6795           type: string
6796   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship:
6797     put:
6798       tags:
6799         - CloudInfrastructure
6800       summary: see node definition for valid relationships
6801       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6802       consumes:
6803         - application/json
6804         - application/xml
6805       produces:
6806         - application/json
6807         - application/xml
6808       responses:
6809         "default":
6810           description: Response codes found in [response codes](https://wiki.onap.org/).
6811       parameters:
6812         - name: cloud-owner
6813           in: path
6814           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6815           required: true
6816           type: string
6817           example: __CLOUD-OWNER__
6818         - name: cloud-region-id
6819           in: path
6820           description: Identifier used by the vendor for the region. Second part of composite key
6821           required: true
6822           type: string
6823           example: __CLOUD-REGION-ID__
6824         - name: switch-name
6825           in: path
6826           description: DVS switch name
6827           required: true
6828           type: string
6829           example: __SWITCH-NAME__
6830         - name: body
6831           in: body
6832           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6833           required: true
6834           schema:
6835             $ref: "#/definitions/relationship"
6836     delete:
6837       tags:
6838         - CloudInfrastructure
6839       summary: delete an existing relationship
6840       description: delete an existing relationship
6841       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitchRelationshipListRelationship
6842       consumes:
6843         - application/json
6844         - application/xml
6845       produces:
6846         - application/json
6847         - application/xml
6848       responses:
6849         "default":
6850           description: Response codes found in [response codes](https://wiki.onap.org/).
6851       parameters:
6852         - name: cloud-owner
6853           in: path
6854           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6855           required: true
6856           type: string
6857           example: __CLOUD-OWNER__
6858         - name: cloud-region-id
6859           in: path
6860           description: Identifier used by the vendor for the region. Second part of composite key
6861           required: true
6862           type: string
6863           example: __CLOUD-REGION-ID__
6864         - name: switch-name
6865           in: path
6866           description: DVS switch name
6867           required: true
6868           type: string
6869           example: __SWITCH-NAME__
6870   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}:
6871     get:
6872       tags:
6873         - CloudInfrastructure
6874       summary: returns dvs-switch
6875       description: returns dvs-switch
6876       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6877       produces:
6878         - application/json
6879         - application/xml
6880       responses:
6881         "200":
6882           description: successful operation
6883           schema:
6884               $ref: "#/getDefinitions/dvs-switch"
6885         "default":
6886           description: Response codes found in [response codes](https://wiki.onap.org/).
6887       parameters:
6888         - name: cloud-owner
6889           in: path
6890           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6891           required: true
6892           type: string
6893           example: __CLOUD-OWNER__
6894         - name: cloud-region-id
6895           in: path
6896           description: Identifier used by the vendor for the region. Second part of composite key
6897           required: true
6898           type: string
6899           example: __CLOUD-REGION-ID__
6900         - name: switch-name
6901           in: path
6902           description: DVS switch name
6903           required: true
6904           type: string
6905           example: __SWITCH-NAME__
6906         - name: cloud-type
6907           in: query
6908           description: Type of the cloud (e.g., openstack)
6909           required: false
6910           type: string
6911         - name: owner-defined-type
6912           in: query
6913           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
6914           required: false
6915           type: string
6916         - name: vcenter-url
6917           in: query
6918           description: URL used to reach the vcenter
6919           required: false
6920           type: string
6921     put:
6922       tags:
6923         - CloudInfrastructure
6924       summary: create or update an existing dvs-switch
6925       description: |
6926         Create or update an existing dvs-switch.
6927         #
6928         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
6929       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6930       consumes:
6931         - application/json
6932         - application/xml
6933       produces:
6934         - application/json
6935         - application/xml
6936       responses:
6937         "default":
6938           description: Response codes found in [response codes](https://wiki.onap.org/).
6939       parameters:
6940         - name: cloud-owner
6941           in: path
6942           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6943           required: true
6944           type: string
6945           example: __CLOUD-OWNER__
6946         - name: cloud-region-id
6947           in: path
6948           description: Identifier used by the vendor for the region. Second part of composite key
6949           required: true
6950           type: string
6951           example: __CLOUD-REGION-ID__
6952         - name: switch-name
6953           in: path
6954           description: DVS switch name
6955           required: true
6956           type: string
6957           example: __SWITCH-NAME__
6958         - name: body
6959           in: body
6960           description: dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)
6961           required: true
6962           schema:
6963             $ref: "#/definitions/dvs-switch"
6964     patch:
6965       tags:
6966         - CloudInfrastructure
6967       summary: update an existing dvs-switch
6968       description: |
6969         Update an existing dvs-switch
6970         #
6971         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
6972         The PUT operation will entirely replace an existing object.
6973         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
6974         #
6975         Other differences between PUT and PATCH are:
6976         #
6977         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
6978         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
6979         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
6980       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
6981       consumes:
6982         - application/json
6983         - application/xml
6984       produces:
6985         - application/json
6986         - application/xml
6987       responses:
6988         "default":
6989           description: Response codes found in [response codes](https://wiki.onap.org/).
6990       parameters:
6991         - name: cloud-owner
6992           in: path
6993           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
6994           required: true
6995           type: string
6996           example: __CLOUD-OWNER__
6997         - name: cloud-region-id
6998           in: path
6999           description: Identifier used by the vendor for the region. Second part of composite key
7000           required: true
7001           type: string
7002           example: __CLOUD-REGION-ID__
7003         - name: switch-name
7004           in: path
7005           description: DVS switch name
7006           required: true
7007           type: string
7008           example: __SWITCH-NAME__
7009         - name: body
7010           in: body
7011           description: dvs-switch object that needs to be created or updated.
7012           required: true
7013           schema:
7014             $ref: "#/patchDefinitions/dvs-switch"
7015     delete:
7016       tags:
7017         - CloudInfrastructure
7018       summary: delete an existing dvs-switch
7019       description: delete an existing dvs-switch
7020       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch
7021       consumes:
7022         - application/json
7023         - application/xml
7024       produces:
7025         - application/json
7026         - application/xml
7027       responses:
7028         "default":
7029           description: Response codes found in [response codes](https://wiki.onap.org/).
7030       parameters:
7031         - name: cloud-owner
7032           in: path
7033           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7034           required: true
7035           type: string
7036           example: __CLOUD-OWNER__
7037         - name: cloud-region-id
7038           in: path
7039           description: Identifier used by the vendor for the region. Second part of composite key
7040           required: true
7041           type: string
7042           example: __CLOUD-REGION-ID__
7043         - name: switch-name
7044           in: path
7045           description: DVS switch name
7046           required: true
7047           type: string
7048           example: __SWITCH-NAME__
7049         - name: resource-version
7050           in: query
7051           description: resource-version for concurrency
7052           required: true
7053           type: string
7054   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches:
7055     get:
7056       tags:
7057         - CloudInfrastructure
7058       summary: returns dvs-switches
7059       description: returns dvs-switches
7060       operationId: getCloudInfrastructureCloudRegionsCloudRegionDvsSwitches
7061       produces:
7062         - application/json
7063         - application/xml
7064       responses:
7065         "200":
7066           description: successful operation
7067           schema:
7068               $ref: "#/getDefinitions/dvs-switches"
7069         "default":
7070           description: Response codes found in [response codes](https://wiki.onap.org/).
7071       parameters:
7072         - name: cloud-owner
7073           in: path
7074           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7075           required: true
7076           type: string
7077           example: __CLOUD-OWNER__
7078         - name: cloud-region-id
7079           in: path
7080           description: Identifier used by the vendor for the region. Second part of composite key
7081           required: true
7082           type: string
7083           example: __CLOUD-REGION-ID__
7084         - name: cloud-type
7085           in: query
7086           description: Type of the cloud (e.g., openstack)
7087           required: false
7088           type: string
7089         - name: owner-defined-type
7090           in: query
7091           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7092           required: false
7093           type: string
7094   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship:
7095     put:
7096       tags:
7097         - CloudInfrastructure
7098       summary: see node definition for valid relationships
7099       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7100       consumes:
7101         - application/json
7102         - application/xml
7103       produces:
7104         - application/json
7105         - application/xml
7106       responses:
7107         "default":
7108           description: Response codes found in [response codes](https://wiki.onap.org/).
7109       parameters:
7110         - name: cloud-owner
7111           in: path
7112           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7113           required: true
7114           type: string
7115           example: __CLOUD-OWNER__
7116         - name: cloud-region-id
7117           in: path
7118           description: Identifier used by the vendor for the region. Second part of composite key
7119           required: true
7120           type: string
7121           example: __CLOUD-REGION-ID__
7122         - name: network-uuid
7123           in: path
7124           description: UUID of the network. Unique across a cloud-region
7125           required: true
7126           type: string
7127           example: __NETWORK-UUID__
7128         - name: body
7129           in: body
7130           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7131           required: true
7132           schema:
7133             $ref: "#/definitions/relationship"
7134     delete:
7135       tags:
7136         - CloudInfrastructure
7137       summary: delete an existing relationship
7138       description: delete an existing relationship
7139       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetworkRelationshipListRelationship
7140       consumes:
7141         - application/json
7142         - application/xml
7143       produces:
7144         - application/json
7145         - application/xml
7146       responses:
7147         "default":
7148           description: Response codes found in [response codes](https://wiki.onap.org/).
7149       parameters:
7150         - name: cloud-owner
7151           in: path
7152           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7153           required: true
7154           type: string
7155           example: __CLOUD-OWNER__
7156         - name: cloud-region-id
7157           in: path
7158           description: Identifier used by the vendor for the region. Second part of composite key
7159           required: true
7160           type: string
7161           example: __CLOUD-REGION-ID__
7162         - name: network-uuid
7163           in: path
7164           description: UUID of the network. Unique across a cloud-region
7165           required: true
7166           type: string
7167           example: __NETWORK-UUID__
7168   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}:
7169     get:
7170       tags:
7171         - CloudInfrastructure
7172       summary: returns oam-network
7173       description: returns oam-network
7174       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7175       produces:
7176         - application/json
7177         - application/xml
7178       responses:
7179         "200":
7180           description: successful operation
7181           schema:
7182               $ref: "#/getDefinitions/oam-network"
7183         "default":
7184           description: Response codes found in [response codes](https://wiki.onap.org/).
7185       parameters:
7186         - name: cloud-owner
7187           in: path
7188           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7189           required: true
7190           type: string
7191           example: __CLOUD-OWNER__
7192         - name: cloud-region-id
7193           in: path
7194           description: Identifier used by the vendor for the region. Second part of composite key
7195           required: true
7196           type: string
7197           example: __CLOUD-REGION-ID__
7198         - name: network-uuid
7199           in: path
7200           description: UUID of the network. Unique across a cloud-region
7201           required: true
7202           type: string
7203           example: __NETWORK-UUID__
7204         - name: cloud-type
7205           in: query
7206           description: Type of the cloud (e.g., openstack)
7207           required: false
7208           type: string
7209         - name: owner-defined-type
7210           in: query
7211           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7212           required: false
7213           type: string
7214         - name: network-name
7215           in: query
7216           description: Name of the network.
7217           required: false
7218           type: string
7219         - name: cvlan-tag
7220           in: query
7221           description: cvlan-id
7222           required: false
7223           type: integer
7224           format: int64
7225     put:
7226       tags:
7227         - CloudInfrastructure
7228       summary: create or update an existing oam-network
7229       description: |
7230         Create or update an existing oam-network.
7231         #
7232         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7233       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7234       consumes:
7235         - application/json
7236         - application/xml
7237       produces:
7238         - application/json
7239         - application/xml
7240       responses:
7241         "default":
7242           description: Response codes found in [response codes](https://wiki.onap.org/).
7243       parameters:
7244         - name: cloud-owner
7245           in: path
7246           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7247           required: true
7248           type: string
7249           example: __CLOUD-OWNER__
7250         - name: cloud-region-id
7251           in: path
7252           description: Identifier used by the vendor for the region. Second part of composite key
7253           required: true
7254           type: string
7255           example: __CLOUD-REGION-ID__
7256         - name: network-uuid
7257           in: path
7258           description: UUID of the network. Unique across a cloud-region
7259           required: true
7260           type: string
7261           example: __NETWORK-UUID__
7262         - name: body
7263           in: body
7264           description: oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)
7265           required: true
7266           schema:
7267             $ref: "#/definitions/oam-network"
7268     patch:
7269       tags:
7270         - CloudInfrastructure
7271       summary: update an existing oam-network
7272       description: |
7273         Update an existing oam-network
7274         #
7275         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7276         The PUT operation will entirely replace an existing object.
7277         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7278         #
7279         Other differences between PUT and PATCH are:
7280         #
7281         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7282         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7283         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7284       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7285       consumes:
7286         - application/json
7287         - application/xml
7288       produces:
7289         - application/json
7290         - application/xml
7291       responses:
7292         "default":
7293           description: Response codes found in [response codes](https://wiki.onap.org/).
7294       parameters:
7295         - name: cloud-owner
7296           in: path
7297           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7298           required: true
7299           type: string
7300           example: __CLOUD-OWNER__
7301         - name: cloud-region-id
7302           in: path
7303           description: Identifier used by the vendor for the region. Second part of composite key
7304           required: true
7305           type: string
7306           example: __CLOUD-REGION-ID__
7307         - name: network-uuid
7308           in: path
7309           description: UUID of the network. Unique across a cloud-region
7310           required: true
7311           type: string
7312           example: __NETWORK-UUID__
7313         - name: body
7314           in: body
7315           description: oam-network object that needs to be created or updated.
7316           required: true
7317           schema:
7318             $ref: "#/patchDefinitions/oam-network"
7319     delete:
7320       tags:
7321         - CloudInfrastructure
7322       summary: delete an existing oam-network
7323       description: delete an existing oam-network
7324       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork
7325       consumes:
7326         - application/json
7327         - application/xml
7328       produces:
7329         - application/json
7330         - application/xml
7331       responses:
7332         "default":
7333           description: Response codes found in [response codes](https://wiki.onap.org/).
7334       parameters:
7335         - name: cloud-owner
7336           in: path
7337           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7338           required: true
7339           type: string
7340           example: __CLOUD-OWNER__
7341         - name: cloud-region-id
7342           in: path
7343           description: Identifier used by the vendor for the region. Second part of composite key
7344           required: true
7345           type: string
7346           example: __CLOUD-REGION-ID__
7347         - name: network-uuid
7348           in: path
7349           description: UUID of the network. Unique across a cloud-region
7350           required: true
7351           type: string
7352           example: __NETWORK-UUID__
7353         - name: resource-version
7354           in: query
7355           description: resource-version for concurrency
7356           required: true
7357           type: string
7358   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks:
7359     get:
7360       tags:
7361         - CloudInfrastructure
7362       summary: returns oam-networks
7363       description: returns oam-networks
7364       operationId: getCloudInfrastructureCloudRegionsCloudRegionOamNetworks
7365       produces:
7366         - application/json
7367         - application/xml
7368       responses:
7369         "200":
7370           description: successful operation
7371           schema:
7372               $ref: "#/getDefinitions/oam-networks"
7373         "default":
7374           description: Response codes found in [response codes](https://wiki.onap.org/).
7375       parameters:
7376         - name: cloud-owner
7377           in: path
7378           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7379           required: true
7380           type: string
7381           example: __CLOUD-OWNER__
7382         - name: cloud-region-id
7383           in: path
7384           description: Identifier used by the vendor for the region. Second part of composite key
7385           required: true
7386           type: string
7387           example: __CLOUD-REGION-ID__
7388         - name: cloud-type
7389           in: query
7390           description: Type of the cloud (e.g., openstack)
7391           required: false
7392           type: string
7393         - name: owner-defined-type
7394           in: query
7395           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7396           required: false
7397           type: string
7398   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship:
7399     put:
7400       tags:
7401         - CloudInfrastructure
7402       summary: see node definition for valid relationships
7403       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7404       consumes:
7405         - application/json
7406         - application/xml
7407       produces:
7408         - application/json
7409         - application/xml
7410       responses:
7411         "default":
7412           description: Response codes found in [response codes](https://wiki.onap.org/).
7413       parameters:
7414         - name: cloud-owner
7415           in: path
7416           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7417           required: true
7418           type: string
7419           example: __CLOUD-OWNER__
7420         - name: cloud-region-id
7421           in: path
7422           description: Identifier used by the vendor for the region. Second part of composite key
7423           required: true
7424           type: string
7425           example: __CLOUD-REGION-ID__
7426         - name: availability-zone-name
7427           in: path
7428           description: Name of the availability zone.  Unique across a cloud region
7429           required: true
7430           type: string
7431           example: __AVAILABILITY-ZONE-NAME__
7432         - name: body
7433           in: body
7434           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7435           required: true
7436           schema:
7437             $ref: "#/definitions/relationship"
7438     delete:
7439       tags:
7440         - CloudInfrastructure
7441       summary: delete an existing relationship
7442       description: delete an existing relationship
7443       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZoneRelationshipListRelationship
7444       consumes:
7445         - application/json
7446         - application/xml
7447       produces:
7448         - application/json
7449         - application/xml
7450       responses:
7451         "default":
7452           description: Response codes found in [response codes](https://wiki.onap.org/).
7453       parameters:
7454         - name: cloud-owner
7455           in: path
7456           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7457           required: true
7458           type: string
7459           example: __CLOUD-OWNER__
7460         - name: cloud-region-id
7461           in: path
7462           description: Identifier used by the vendor for the region. Second part of composite key
7463           required: true
7464           type: string
7465           example: __CLOUD-REGION-ID__
7466         - name: availability-zone-name
7467           in: path
7468           description: Name of the availability zone.  Unique across a cloud region
7469           required: true
7470           type: string
7471           example: __AVAILABILITY-ZONE-NAME__
7472   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}:
7473     get:
7474       tags:
7475         - CloudInfrastructure
7476       summary: returns availability-zone
7477       description: returns availability-zone
7478       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7479       produces:
7480         - application/json
7481         - application/xml
7482       responses:
7483         "200":
7484           description: successful operation
7485           schema:
7486               $ref: "#/getDefinitions/availability-zone"
7487         "default":
7488           description: Response codes found in [response codes](https://wiki.onap.org/).
7489       parameters:
7490         - name: cloud-owner
7491           in: path
7492           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7493           required: true
7494           type: string
7495           example: __CLOUD-OWNER__
7496         - name: cloud-region-id
7497           in: path
7498           description: Identifier used by the vendor for the region. Second part of composite key
7499           required: true
7500           type: string
7501           example: __CLOUD-REGION-ID__
7502         - name: availability-zone-name
7503           in: path
7504           description: Name of the availability zone.  Unique across a cloud region
7505           required: true
7506           type: string
7507           example: __AVAILABILITY-ZONE-NAME__
7508         - name: cloud-type
7509           in: query
7510           description: Type of the cloud (e.g., openstack)
7511           required: false
7512           type: string
7513         - name: owner-defined-type
7514           in: query
7515           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7516           required: false
7517           type: string
7518     put:
7519       tags:
7520         - CloudInfrastructure
7521       summary: create or update an existing availability-zone
7522       description: |
7523         Create or update an existing availability-zone.
7524         #
7525         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7526       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7527       consumes:
7528         - application/json
7529         - application/xml
7530       produces:
7531         - application/json
7532         - application/xml
7533       responses:
7534         "default":
7535           description: Response codes found in [response codes](https://wiki.onap.org/).
7536       parameters:
7537         - name: cloud-owner
7538           in: path
7539           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7540           required: true
7541           type: string
7542           example: __CLOUD-OWNER__
7543         - name: cloud-region-id
7544           in: path
7545           description: Identifier used by the vendor for the region. Second part of composite key
7546           required: true
7547           type: string
7548           example: __CLOUD-REGION-ID__
7549         - name: availability-zone-name
7550           in: path
7551           description: Name of the availability zone.  Unique across a cloud region
7552           required: true
7553           type: string
7554           example: __AVAILABILITY-ZONE-NAME__
7555         - name: body
7556           in: body
7557           description: availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)
7558           required: true
7559           schema:
7560             $ref: "#/definitions/availability-zone"
7561     patch:
7562       tags:
7563         - CloudInfrastructure
7564       summary: update an existing availability-zone
7565       description: |
7566         Update an existing availability-zone
7567         #
7568         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7569         The PUT operation will entirely replace an existing object.
7570         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7571         #
7572         Other differences between PUT and PATCH are:
7573         #
7574         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7575         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7576         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7577       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7578       consumes:
7579         - application/json
7580         - application/xml
7581       produces:
7582         - application/json
7583         - application/xml
7584       responses:
7585         "default":
7586           description: Response codes found in [response codes](https://wiki.onap.org/).
7587       parameters:
7588         - name: cloud-owner
7589           in: path
7590           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7591           required: true
7592           type: string
7593           example: __CLOUD-OWNER__
7594         - name: cloud-region-id
7595           in: path
7596           description: Identifier used by the vendor for the region. Second part of composite key
7597           required: true
7598           type: string
7599           example: __CLOUD-REGION-ID__
7600         - name: availability-zone-name
7601           in: path
7602           description: Name of the availability zone.  Unique across a cloud region
7603           required: true
7604           type: string
7605           example: __AVAILABILITY-ZONE-NAME__
7606         - name: body
7607           in: body
7608           description: availability-zone object that needs to be created or updated.
7609           required: true
7610           schema:
7611             $ref: "#/patchDefinitions/availability-zone"
7612     delete:
7613       tags:
7614         - CloudInfrastructure
7615       summary: delete an existing availability-zone
7616       description: delete an existing availability-zone
7617       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone
7618       consumes:
7619         - application/json
7620         - application/xml
7621       produces:
7622         - application/json
7623         - application/xml
7624       responses:
7625         "default":
7626           description: Response codes found in [response codes](https://wiki.onap.org/).
7627       parameters:
7628         - name: cloud-owner
7629           in: path
7630           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7631           required: true
7632           type: string
7633           example: __CLOUD-OWNER__
7634         - name: cloud-region-id
7635           in: path
7636           description: Identifier used by the vendor for the region. Second part of composite key
7637           required: true
7638           type: string
7639           example: __CLOUD-REGION-ID__
7640         - name: availability-zone-name
7641           in: path
7642           description: Name of the availability zone.  Unique across a cloud region
7643           required: true
7644           type: string
7645           example: __AVAILABILITY-ZONE-NAME__
7646         - name: resource-version
7647           in: query
7648           description: resource-version for concurrency
7649           required: true
7650           type: string
7651   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones:
7652     get:
7653       tags:
7654         - CloudInfrastructure
7655       summary: returns availability-zones
7656       description: returns availability-zones
7657       operationId: getCloudInfrastructureCloudRegionsCloudRegionAvailabilityZones
7658       produces:
7659         - application/json
7660         - application/xml
7661       responses:
7662         "200":
7663           description: successful operation
7664           schema:
7665               $ref: "#/getDefinitions/availability-zones"
7666         "default":
7667           description: Response codes found in [response codes](https://wiki.onap.org/).
7668       parameters:
7669         - name: cloud-owner
7670           in: path
7671           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7672           required: true
7673           type: string
7674           example: __CLOUD-OWNER__
7675         - name: cloud-region-id
7676           in: path
7677           description: Identifier used by the vendor for the region. Second part of composite key
7678           required: true
7679           type: string
7680           example: __CLOUD-REGION-ID__
7681         - name: cloud-type
7682           in: query
7683           description: Type of the cloud (e.g., openstack)
7684           required: false
7685           type: string
7686         - name: owner-defined-type
7687           in: query
7688           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7689           required: false
7690           type: string
7691   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship:
7692     put:
7693       tags:
7694         - CloudInfrastructure
7695       summary: see node definition for valid relationships
7696       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7697       consumes:
7698         - application/json
7699         - application/xml
7700       produces:
7701         - application/json
7702         - application/xml
7703       responses:
7704         "default":
7705           description: Response codes found in [response codes](https://wiki.onap.org/).
7706       parameters:
7707         - name: cloud-owner
7708           in: path
7709           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7710           required: true
7711           type: string
7712           example: __CLOUD-OWNER__
7713         - name: cloud-region-id
7714           in: path
7715           description: Identifier used by the vendor for the region. Second part of composite key
7716           required: true
7717           type: string
7718           example: __CLOUD-REGION-ID__
7719         - name: body
7720           in: body
7721           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
7722           required: true
7723           schema:
7724             $ref: "#/definitions/relationship"
7725     delete:
7726       tags:
7727         - CloudInfrastructure
7728       summary: delete an existing relationship
7729       description: delete an existing relationship
7730       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionRelationshipListRelationship
7731       consumes:
7732         - application/json
7733         - application/xml
7734       produces:
7735         - application/json
7736         - application/xml
7737       responses:
7738         "default":
7739           description: Response codes found in [response codes](https://wiki.onap.org/).
7740       parameters:
7741         - name: cloud-owner
7742           in: path
7743           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7744           required: true
7745           type: string
7746           example: __CLOUD-OWNER__
7747         - name: cloud-region-id
7748           in: path
7749           description: Identifier used by the vendor for the region. Second part of composite key
7750           required: true
7751           type: string
7752           example: __CLOUD-REGION-ID__
7753   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship:
7754     put:
7755       tags:
7756         - CloudInfrastructure
7757       summary: see node definition for valid relationships
7758       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
7759       consumes:
7760         - application/json
7761         - application/xml
7762       produces:
7763         - application/json
7764         - application/xml
7765       responses:
7766         "default":
7767           description: Response codes found in [response codes](https://wiki.onap.org/).
7768       parameters:
7769         - name: cloud-owner
7770           in: path
7771           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7772           required: true
7773           type: string
7774           example: __CLOUD-OWNER__
7775         - name: cloud-region-id
7776           in: path
7777           description: Identifier used by the vendor for the region. Second part of composite key
7778           required: true
7779           type: string
7780           example: __CLOUD-REGION-ID__
7781         - name: esr-system-info-id
7782           in: path
7783           description: Unique ID of esr system info.
7784           required: true
7785           type: string
7786           example: __ESR-SYSTEM-INFO-ID__
7787         - name: body
7788           in: body
7789           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
7790           required: true
7791           schema:
7792             $ref: "#/definitions/relationship"
7793     delete:
7794       tags:
7795         - CloudInfrastructure
7796       summary: delete an existing relationship
7797       description: delete an existing relationship
7798       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfoRelationshipListRelationship
7799       consumes:
7800         - application/json
7801         - application/xml
7802       produces:
7803         - application/json
7804         - application/xml
7805       responses:
7806         "default":
7807           description: Response codes found in [response codes](https://wiki.onap.org/).
7808       parameters:
7809         - name: cloud-owner
7810           in: path
7811           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7812           required: true
7813           type: string
7814           example: __CLOUD-OWNER__
7815         - name: cloud-region-id
7816           in: path
7817           description: Identifier used by the vendor for the region. Second part of composite key
7818           required: true
7819           type: string
7820           example: __CLOUD-REGION-ID__
7821         - name: esr-system-info-id
7822           in: path
7823           description: Unique ID of esr system info.
7824           required: true
7825           type: string
7826           example: __ESR-SYSTEM-INFO-ID__
7827   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}:
7828     get:
7829       tags:
7830         - CloudInfrastructure
7831       summary: returns esr-system-info
7832       description: returns esr-system-info
7833       operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7834       produces:
7835         - application/json
7836         - application/xml
7837       responses:
7838         "200":
7839           description: successful operation
7840           schema:
7841               $ref: "#/getDefinitions/esr-system-info"
7842         "default":
7843           description: Response codes found in [response codes](https://wiki.onap.org/).
7844       parameters:
7845         - name: cloud-owner
7846           in: path
7847           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7848           required: true
7849           type: string
7850           example: __CLOUD-OWNER__
7851         - name: cloud-region-id
7852           in: path
7853           description: Identifier used by the vendor for the region. Second part of composite key
7854           required: true
7855           type: string
7856           example: __CLOUD-REGION-ID__
7857         - name: esr-system-info-id
7858           in: path
7859           description: Unique ID of esr system info.
7860           required: true
7861           type: string
7862           example: __ESR-SYSTEM-INFO-ID__
7863         - name: cloud-type
7864           in: query
7865           description: Type of the cloud (e.g., openstack)
7866           required: false
7867           type: string
7868         - name: owner-defined-type
7869           in: query
7870           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
7871           required: false
7872           type: string
7873         - name: system-name
7874           in: query
7875           description: name of external system.
7876           required: false
7877           type: string
7878         - name: system-type
7879           in: query
7880           description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
7881           required: false
7882           type: string
7883     put:
7884       tags:
7885         - CloudInfrastructure
7886       summary: create or update an existing esr-system-info
7887       description: |
7888         Create or update an existing esr-system-info.
7889         #
7890         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
7891       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7892       consumes:
7893         - application/json
7894         - application/xml
7895       produces:
7896         - application/json
7897         - application/xml
7898       responses:
7899         "default":
7900           description: Response codes found in [response codes](https://wiki.onap.org/).
7901       parameters:
7902         - name: cloud-owner
7903           in: path
7904           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7905           required: true
7906           type: string
7907           example: __CLOUD-OWNER__
7908         - name: cloud-region-id
7909           in: path
7910           description: Identifier used by the vendor for the region. Second part of composite key
7911           required: true
7912           type: string
7913           example: __CLOUD-REGION-ID__
7914         - name: esr-system-info-id
7915           in: path
7916           description: Unique ID of esr system info.
7917           required: true
7918           type: string
7919           example: __ESR-SYSTEM-INFO-ID__
7920         - name: body
7921           in: body
7922           description: esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)
7923           required: true
7924           schema:
7925             $ref: "#/definitions/esr-system-info"
7926     patch:
7927       tags:
7928         - CloudInfrastructure
7929       summary: update an existing esr-system-info
7930       description: |
7931         Update an existing esr-system-info
7932         #
7933         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
7934         The PUT operation will entirely replace an existing object.
7935         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
7936         #
7937         Other differences between PUT and PATCH are:
7938         #
7939         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
7940         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
7941         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
7942       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7943       consumes:
7944         - application/json
7945         - application/xml
7946       produces:
7947         - application/json
7948         - application/xml
7949       responses:
7950         "default":
7951           description: Response codes found in [response codes](https://wiki.onap.org/).
7952       parameters:
7953         - name: cloud-owner
7954           in: path
7955           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7956           required: true
7957           type: string
7958           example: __CLOUD-OWNER__
7959         - name: cloud-region-id
7960           in: path
7961           description: Identifier used by the vendor for the region. Second part of composite key
7962           required: true
7963           type: string
7964           example: __CLOUD-REGION-ID__
7965         - name: esr-system-info-id
7966           in: path
7967           description: Unique ID of esr system info.
7968           required: true
7969           type: string
7970           example: __ESR-SYSTEM-INFO-ID__
7971         - name: body
7972           in: body
7973           description: esr-system-info object that needs to be created or updated.
7974           required: true
7975           schema:
7976             $ref: "#/patchDefinitions/esr-system-info"
7977     delete:
7978       tags:
7979         - CloudInfrastructure
7980       summary: delete an existing esr-system-info
7981       description: delete an existing esr-system-info
7982       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo
7983       consumes:
7984         - application/json
7985         - application/xml
7986       produces:
7987         - application/json
7988         - application/xml
7989       responses:
7990         "default":
7991           description: Response codes found in [response codes](https://wiki.onap.org/).
7992       parameters:
7993         - name: cloud-owner
7994           in: path
7995           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
7996           required: true
7997           type: string
7998           example: __CLOUD-OWNER__
7999         - name: cloud-region-id
8000           in: path
8001           description: Identifier used by the vendor for the region. Second part of composite key
8002           required: true
8003           type: string
8004           example: __CLOUD-REGION-ID__
8005         - name: esr-system-info-id
8006           in: path
8007           description: Unique ID of esr system info.
8008           required: true
8009           type: string
8010           example: __ESR-SYSTEM-INFO-ID__
8011         - name: resource-version
8012           in: query
8013           description: resource-version for concurrency
8014           required: true
8015           type: string
8016   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list:
8017     get:
8018       tags:
8019         - CloudInfrastructure
8020       summary: returns esr-system-info-list
8021       description: returns esr-system-info-list
8022       operationId: getCloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoList
8023       produces:
8024         - application/json
8025         - application/xml
8026       responses:
8027         "200":
8028           description: successful operation
8029           schema:
8030               $ref: "#/getDefinitions/esr-system-info-list"
8031         "default":
8032           description: Response codes found in [response codes](https://wiki.onap.org/).
8033       parameters:
8034         - name: cloud-owner
8035           in: path
8036           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8037           required: true
8038           type: string
8039           example: __CLOUD-OWNER__
8040         - name: cloud-region-id
8041           in: path
8042           description: Identifier used by the vendor for the region. Second part of composite key
8043           required: true
8044           type: string
8045           example: __CLOUD-REGION-ID__
8046         - name: cloud-type
8047           in: query
8048           description: Type of the cloud (e.g., openstack)
8049           required: false
8050           type: string
8051         - name: owner-defined-type
8052           in: query
8053           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8054           required: false
8055           type: string
8056   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship:
8057     put:
8058       tags:
8059         - CloudInfrastructure
8060       summary: see node definition for valid relationships
8061       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8062       consumes:
8063         - application/json
8064         - application/xml
8065       produces:
8066         - application/json
8067         - application/xml
8068       responses:
8069         "default":
8070           description: Response codes found in [response codes](https://wiki.onap.org/).
8071       parameters:
8072         - name: cloud-owner
8073           in: path
8074           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8075           required: true
8076           type: string
8077           example: __CLOUD-OWNER__
8078         - name: cloud-region-id
8079           in: path
8080           description: Identifier used by the vendor for the region. Second part of composite key
8081           required: true
8082           type: string
8083           example: __CLOUD-REGION-ID__
8084         - name: vip-ipv4-address
8085           in: path
8086           description: IP address
8087           required: true
8088           type: string
8089           example: __VIP-IPV4-ADDRESS__
8090         - name: body
8091           in: body
8092           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8093           required: true
8094           schema:
8095             $ref: "#/definitions/relationship"
8096     delete:
8097       tags:
8098         - CloudInfrastructure
8099       summary: delete an existing relationship
8100       description: delete an existing relationship
8101       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressListRelationshipListRelationship
8102       consumes:
8103         - application/json
8104         - application/xml
8105       produces:
8106         - application/json
8107         - application/xml
8108       responses:
8109         "default":
8110           description: Response codes found in [response codes](https://wiki.onap.org/).
8111       parameters:
8112         - name: cloud-owner
8113           in: path
8114           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8115           required: true
8116           type: string
8117           example: __CLOUD-OWNER__
8118         - name: cloud-region-id
8119           in: path
8120           description: Identifier used by the vendor for the region. Second part of composite key
8121           required: true
8122           type: string
8123           example: __CLOUD-REGION-ID__
8124         - name: vip-ipv4-address
8125           in: path
8126           description: IP address
8127           required: true
8128           type: string
8129           example: __VIP-IPV4-ADDRESS__
8130   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}:
8131     get:
8132       tags:
8133         - CloudInfrastructure
8134       summary: returns vip-ipv4-address-list
8135       description: returns vip-ipv4-address-list
8136       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8137       produces:
8138         - application/json
8139         - application/xml
8140       responses:
8141         "200":
8142           description: successful operation
8143           schema:
8144               $ref: "#/getDefinitions/vip-ipv4-address-list"
8145         "default":
8146           description: Response codes found in [response codes](https://wiki.onap.org/).
8147       parameters:
8148         - name: cloud-owner
8149           in: path
8150           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8151           required: true
8152           type: string
8153           example: __CLOUD-OWNER__
8154         - name: cloud-region-id
8155           in: path
8156           description: Identifier used by the vendor for the region. Second part of composite key
8157           required: true
8158           type: string
8159           example: __CLOUD-REGION-ID__
8160         - name: vip-ipv4-address
8161           in: path
8162           description: IP address
8163           required: true
8164           type: string
8165           example: __VIP-IPV4-ADDRESS__
8166         - name: cloud-type
8167           in: query
8168           description: Type of the cloud (e.g., openstack)
8169           required: false
8170           type: string
8171         - name: owner-defined-type
8172           in: query
8173           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8174           required: false
8175           type: string
8176         - name: vlan-id-inner
8177           in: query
8178           description: Inner VLAN tag
8179           required: false
8180           type: integer
8181           format: int64
8182         - name: neutron-network-id
8183           in: query
8184           description: Neutron network id of the interface that address belongs to
8185           required: false
8186           type: string
8187         - name: neutron-subnet-id
8188           in: query
8189           description: Neutron id of subnet that address belongs to
8190           required: false
8191           type: string
8192     put:
8193       tags:
8194         - CloudInfrastructure
8195       summary: create or update an existing vip-ipv4-address-list
8196       description: |
8197         Create or update an existing vip-ipv4-address-list.
8198         #
8199         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8200       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8201       consumes:
8202         - application/json
8203         - application/xml
8204       produces:
8205         - application/json
8206         - application/xml
8207       responses:
8208         "default":
8209           description: Response codes found in [response codes](https://wiki.onap.org/).
8210       parameters:
8211         - name: cloud-owner
8212           in: path
8213           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8214           required: true
8215           type: string
8216           example: __CLOUD-OWNER__
8217         - name: cloud-region-id
8218           in: path
8219           description: Identifier used by the vendor for the region. Second part of composite key
8220           required: true
8221           type: string
8222           example: __CLOUD-REGION-ID__
8223         - name: vip-ipv4-address
8224           in: path
8225           description: IP address
8226           required: true
8227           type: string
8228           example: __VIP-IPV4-ADDRESS__
8229         - name: body
8230           in: body
8231           description: vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)
8232           required: true
8233           schema:
8234             $ref: "#/definitions/vip-ipv4-address-list"
8235     patch:
8236       tags:
8237         - CloudInfrastructure
8238       summary: update an existing vip-ipv4-address-list
8239       description: |
8240         Update an existing vip-ipv4-address-list
8241         #
8242         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8243         The PUT operation will entirely replace an existing object.
8244         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8245         #
8246         Other differences between PUT and PATCH are:
8247         #
8248         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8249         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8250         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8251       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8252       consumes:
8253         - application/json
8254         - application/xml
8255       produces:
8256         - application/json
8257         - application/xml
8258       responses:
8259         "default":
8260           description: Response codes found in [response codes](https://wiki.onap.org/).
8261       parameters:
8262         - name: cloud-owner
8263           in: path
8264           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8265           required: true
8266           type: string
8267           example: __CLOUD-OWNER__
8268         - name: cloud-region-id
8269           in: path
8270           description: Identifier used by the vendor for the region. Second part of composite key
8271           required: true
8272           type: string
8273           example: __CLOUD-REGION-ID__
8274         - name: vip-ipv4-address
8275           in: path
8276           description: IP address
8277           required: true
8278           type: string
8279           example: __VIP-IPV4-ADDRESS__
8280         - name: body
8281           in: body
8282           description: vip-ipv4-address-list object that needs to be created or updated.
8283           required: true
8284           schema:
8285             $ref: "#/patchDefinitions/vip-ipv4-address-list"
8286     delete:
8287       tags:
8288         - CloudInfrastructure
8289       summary: delete an existing vip-ipv4-address-list
8290       description: delete an existing vip-ipv4-address-list
8291       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList
8292       consumes:
8293         - application/json
8294         - application/xml
8295       produces:
8296         - application/json
8297         - application/xml
8298       responses:
8299         "default":
8300           description: Response codes found in [response codes](https://wiki.onap.org/).
8301       parameters:
8302         - name: cloud-owner
8303           in: path
8304           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8305           required: true
8306           type: string
8307           example: __CLOUD-OWNER__
8308         - name: cloud-region-id
8309           in: path
8310           description: Identifier used by the vendor for the region. Second part of composite key
8311           required: true
8312           type: string
8313           example: __CLOUD-REGION-ID__
8314         - name: vip-ipv4-address
8315           in: path
8316           description: IP address
8317           required: true
8318           type: string
8319           example: __VIP-IPV4-ADDRESS__
8320         - name: resource-version
8321           in: query
8322           description: resource-version for concurrency
8323           required: true
8324           type: string
8325   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship:
8326     put:
8327       tags:
8328         - CloudInfrastructure
8329       summary: see node definition for valid relationships
8330       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8331       consumes:
8332         - application/json
8333         - application/xml
8334       produces:
8335         - application/json
8336         - application/xml
8337       responses:
8338         "default":
8339           description: Response codes found in [response codes](https://wiki.onap.org/).
8340       parameters:
8341         - name: cloud-owner
8342           in: path
8343           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8344           required: true
8345           type: string
8346           example: __CLOUD-OWNER__
8347         - name: cloud-region-id
8348           in: path
8349           description: Identifier used by the vendor for the region. Second part of composite key
8350           required: true
8351           type: string
8352           example: __CLOUD-REGION-ID__
8353         - name: vip-ipv6-address
8354           in: path
8355           description: IP address
8356           required: true
8357           type: string
8358           example: __VIP-IPV6-ADDRESS__
8359         - name: body
8360           in: body
8361           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8362           required: true
8363           schema:
8364             $ref: "#/definitions/relationship"
8365     delete:
8366       tags:
8367         - CloudInfrastructure
8368       summary: delete an existing relationship
8369       description: delete an existing relationship
8370       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressListRelationshipListRelationship
8371       consumes:
8372         - application/json
8373         - application/xml
8374       produces:
8375         - application/json
8376         - application/xml
8377       responses:
8378         "default":
8379           description: Response codes found in [response codes](https://wiki.onap.org/).
8380       parameters:
8381         - name: cloud-owner
8382           in: path
8383           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8384           required: true
8385           type: string
8386           example: __CLOUD-OWNER__
8387         - name: cloud-region-id
8388           in: path
8389           description: Identifier used by the vendor for the region. Second part of composite key
8390           required: true
8391           type: string
8392           example: __CLOUD-REGION-ID__
8393         - name: vip-ipv6-address
8394           in: path
8395           description: IP address
8396           required: true
8397           type: string
8398           example: __VIP-IPV6-ADDRESS__
8399   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}:
8400     get:
8401       tags:
8402         - CloudInfrastructure
8403       summary: returns vip-ipv6-address-list
8404       description: returns vip-ipv6-address-list
8405       operationId: getCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8406       produces:
8407         - application/json
8408         - application/xml
8409       responses:
8410         "200":
8411           description: successful operation
8412           schema:
8413               $ref: "#/getDefinitions/vip-ipv6-address-list"
8414         "default":
8415           description: Response codes found in [response codes](https://wiki.onap.org/).
8416       parameters:
8417         - name: cloud-owner
8418           in: path
8419           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8420           required: true
8421           type: string
8422           example: __CLOUD-OWNER__
8423         - name: cloud-region-id
8424           in: path
8425           description: Identifier used by the vendor for the region. Second part of composite key
8426           required: true
8427           type: string
8428           example: __CLOUD-REGION-ID__
8429         - name: vip-ipv6-address
8430           in: path
8431           description: IP address
8432           required: true
8433           type: string
8434           example: __VIP-IPV6-ADDRESS__
8435         - name: cloud-type
8436           in: query
8437           description: Type of the cloud (e.g., openstack)
8438           required: false
8439           type: string
8440         - name: owner-defined-type
8441           in: query
8442           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8443           required: false
8444           type: string
8445         - name: vlan-id-inner
8446           in: query
8447           description: Inner VLAN tag
8448           required: false
8449           type: integer
8450           format: int64
8451         - name: neutron-network-id
8452           in: query
8453           description: Neutron network id of the interface that address belongs to
8454           required: false
8455           type: string
8456         - name: neutron-subnet-id
8457           in: query
8458           description: Neutron id of subnet that address belongs to
8459           required: false
8460           type: string
8461     put:
8462       tags:
8463         - CloudInfrastructure
8464       summary: create or update an existing vip-ipv6-address-list
8465       description: |
8466         Create or update an existing vip-ipv6-address-list.
8467         #
8468         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8469       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8470       consumes:
8471         - application/json
8472         - application/xml
8473       produces:
8474         - application/json
8475         - application/xml
8476       responses:
8477         "default":
8478           description: Response codes found in [response codes](https://wiki.onap.org/).
8479       parameters:
8480         - name: cloud-owner
8481           in: path
8482           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8483           required: true
8484           type: string
8485           example: __CLOUD-OWNER__
8486         - name: cloud-region-id
8487           in: path
8488           description: Identifier used by the vendor for the region. Second part of composite key
8489           required: true
8490           type: string
8491           example: __CLOUD-REGION-ID__
8492         - name: vip-ipv6-address
8493           in: path
8494           description: IP address
8495           required: true
8496           type: string
8497           example: __VIP-IPV6-ADDRESS__
8498         - name: body
8499           in: body
8500           description: vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)
8501           required: true
8502           schema:
8503             $ref: "#/definitions/vip-ipv6-address-list"
8504     patch:
8505       tags:
8506         - CloudInfrastructure
8507       summary: update an existing vip-ipv6-address-list
8508       description: |
8509         Update an existing vip-ipv6-address-list
8510         #
8511         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8512         The PUT operation will entirely replace an existing object.
8513         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8514         #
8515         Other differences between PUT and PATCH are:
8516         #
8517         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8518         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8519         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8520       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8521       consumes:
8522         - application/json
8523         - application/xml
8524       produces:
8525         - application/json
8526         - application/xml
8527       responses:
8528         "default":
8529           description: Response codes found in [response codes](https://wiki.onap.org/).
8530       parameters:
8531         - name: cloud-owner
8532           in: path
8533           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8534           required: true
8535           type: string
8536           example: __CLOUD-OWNER__
8537         - name: cloud-region-id
8538           in: path
8539           description: Identifier used by the vendor for the region. Second part of composite key
8540           required: true
8541           type: string
8542           example: __CLOUD-REGION-ID__
8543         - name: vip-ipv6-address
8544           in: path
8545           description: IP address
8546           required: true
8547           type: string
8548           example: __VIP-IPV6-ADDRESS__
8549         - name: body
8550           in: body
8551           description: vip-ipv6-address-list object that needs to be created or updated.
8552           required: true
8553           schema:
8554             $ref: "#/patchDefinitions/vip-ipv6-address-list"
8555     delete:
8556       tags:
8557         - CloudInfrastructure
8558       summary: delete an existing vip-ipv6-address-list
8559       description: delete an existing vip-ipv6-address-list
8560       operationId: deleteCloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList
8561       consumes:
8562         - application/json
8563         - application/xml
8564       produces:
8565         - application/json
8566         - application/xml
8567       responses:
8568         "default":
8569           description: Response codes found in [response codes](https://wiki.onap.org/).
8570       parameters:
8571         - name: cloud-owner
8572           in: path
8573           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8574           required: true
8575           type: string
8576           example: __CLOUD-OWNER__
8577         - name: cloud-region-id
8578           in: path
8579           description: Identifier used by the vendor for the region. Second part of composite key
8580           required: true
8581           type: string
8582           example: __CLOUD-REGION-ID__
8583         - name: vip-ipv6-address
8584           in: path
8585           description: IP address
8586           required: true
8587           type: string
8588           example: __VIP-IPV6-ADDRESS__
8589         - name: resource-version
8590           in: query
8591           description: resource-version for concurrency
8592           required: true
8593           type: string
8594   /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}:
8595     get:
8596       tags:
8597         - CloudInfrastructure
8598       summary: returns cloud-region
8599       description: returns cloud-region
8600       operationId: getCloudInfrastructureCloudRegionsCloudRegion
8601       produces:
8602         - application/json
8603         - application/xml
8604       responses:
8605         "200":
8606           description: successful operation
8607           schema:
8608               $ref: "#/getDefinitions/cloud-region"
8609         "default":
8610           description: Response codes found in [response codes](https://wiki.onap.org/).
8611       parameters:
8612         - name: cloud-owner
8613           in: path
8614           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8615           required: true
8616           type: string
8617           example: __CLOUD-OWNER__
8618         - name: cloud-region-id
8619           in: path
8620           description: Identifier used by the vendor for the region. Second part of composite key
8621           required: true
8622           type: string
8623           example: __CLOUD-REGION-ID__
8624         - name: cloud-type
8625           in: query
8626           description: Type of the cloud (e.g., openstack)
8627           required: false
8628           type: string
8629         - name: owner-defined-type
8630           in: query
8631           description: Cloud-owner defined type indicator (e.g., dcp, lcp)
8632           required: false
8633           type: string
8634     put:
8635       tags:
8636         - CloudInfrastructure
8637       summary: create or update an existing cloud-region
8638       description: |
8639         Create or update an existing cloud-region.
8640         #
8641         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8642       operationId: createOrUpdateCloudInfrastructureCloudRegionsCloudRegion
8643       consumes:
8644         - application/json
8645         - application/xml
8646       produces:
8647         - application/json
8648         - application/xml
8649       responses:
8650         "default":
8651           description: Response codes found in [response codes](https://wiki.onap.org/).
8652       parameters:
8653         - name: cloud-owner
8654           in: path
8655           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8656           required: true
8657           type: string
8658           example: __CLOUD-OWNER__
8659         - name: cloud-region-id
8660           in: path
8661           description: Identifier used by the vendor for the region. Second part of composite key
8662           required: true
8663           type: string
8664           example: __CLOUD-REGION-ID__
8665         - name: body
8666           in: body
8667           description: cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)
8668           required: true
8669           schema:
8670             $ref: "#/definitions/cloud-region"
8671     patch:
8672       tags:
8673         - CloudInfrastructure
8674       summary: update an existing cloud-region
8675       description: |
8676         Update an existing cloud-region
8677         #
8678         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8679         The PUT operation will entirely replace an existing object.
8680         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8681         #
8682         Other differences between PUT and PATCH are:
8683         #
8684         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8685         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8686         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8687       operationId: UpdateCloudInfrastructureCloudRegionsCloudRegion
8688       consumes:
8689         - application/json
8690         - application/xml
8691       produces:
8692         - application/json
8693         - application/xml
8694       responses:
8695         "default":
8696           description: Response codes found in [response codes](https://wiki.onap.org/).
8697       parameters:
8698         - name: cloud-owner
8699           in: path
8700           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8701           required: true
8702           type: string
8703           example: __CLOUD-OWNER__
8704         - name: cloud-region-id
8705           in: path
8706           description: Identifier used by the vendor for the region. Second part of composite key
8707           required: true
8708           type: string
8709           example: __CLOUD-REGION-ID__
8710         - name: body
8711           in: body
8712           description: cloud-region object that needs to be created or updated.
8713           required: true
8714           schema:
8715             $ref: "#/patchDefinitions/cloud-region"
8716     delete:
8717       tags:
8718         - CloudInfrastructure
8719       summary: delete an existing cloud-region
8720       description: delete an existing cloud-region
8721       operationId: deleteCloudInfrastructureCloudRegionsCloudRegion
8722       consumes:
8723         - application/json
8724         - application/xml
8725       produces:
8726         - application/json
8727         - application/xml
8728       responses:
8729         "default":
8730           description: Response codes found in [response codes](https://wiki.onap.org/).
8731       parameters:
8732         - name: cloud-owner
8733           in: path
8734           description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
8735           required: true
8736           type: string
8737           example: __CLOUD-OWNER__
8738         - name: cloud-region-id
8739           in: path
8740           description: Identifier used by the vendor for the region. Second part of composite key
8741           required: true
8742           type: string
8743           example: __CLOUD-REGION-ID__
8744         - name: resource-version
8745           in: query
8746           description: resource-version for concurrency
8747           required: true
8748           type: string
8749   /cloud-infrastructure/cloud-regions:
8750     get:
8751       tags:
8752         - CloudInfrastructure
8753       summary: returns cloud-regions
8754       description: returns cloud-regions
8755       operationId: getCloudInfrastructureCloudRegions
8756       produces:
8757         - application/json
8758         - application/xml
8759       responses:
8760         "200":
8761           description: successful operation
8762           schema:
8763               $ref: "#/getDefinitions/cloud-regions"
8764         "default":
8765           description: Response codes found in [response codes](https://wiki.onap.org/).
8766   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship:
8767     put:
8768       tags:
8769         - CloudInfrastructure
8770       summary: see node definition for valid relationships
8771       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8772       consumes:
8773         - application/json
8774         - application/xml
8775       produces:
8776         - application/json
8777         - application/xml
8778       responses:
8779         "default":
8780           description: Response codes found in [response codes](https://wiki.onap.org/).
8781       parameters:
8782         - name: nm-profile-name
8783           in: path
8784           description: Unique name of network profile.
8785           required: true
8786           type: string
8787           example: __NM-PROFILE-NAME__
8788         - name: body
8789           in: body
8790           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8791           required: true
8792           schema:
8793             $ref: "#/definitions/relationship"
8794     delete:
8795       tags:
8796         - CloudInfrastructure
8797       summary: delete an existing relationship
8798       description: delete an existing relationship
8799       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfileRelationshipListRelationship
8800       consumes:
8801         - application/json
8802         - application/xml
8803       produces:
8804         - application/json
8805         - application/xml
8806       responses:
8807         "default":
8808           description: Response codes found in [response codes](https://wiki.onap.org/).
8809       parameters:
8810         - name: nm-profile-name
8811           in: path
8812           description: Unique name of network profile.
8813           required: true
8814           type: string
8815           example: __NM-PROFILE-NAME__
8816   /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}:
8817     get:
8818       tags:
8819         - CloudInfrastructure
8820       summary: returns network-profile
8821       description: returns network-profile
8822       operationId: getCloudInfrastructureNetworkProfilesNetworkProfile
8823       produces:
8824         - application/json
8825         - application/xml
8826       responses:
8827         "200":
8828           description: successful operation
8829           schema:
8830               $ref: "#/getDefinitions/network-profile"
8831         "default":
8832           description: Response codes found in [response codes](https://wiki.onap.org/).
8833       parameters:
8834         - name: nm-profile-name
8835           in: path
8836           description: Unique name of network profile.
8837           required: true
8838           type: string
8839           example: __NM-PROFILE-NAME__
8840     put:
8841       tags:
8842         - CloudInfrastructure
8843       summary: create or update an existing network-profile
8844       description: |
8845         Create or update an existing network-profile.
8846         #
8847         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
8848       operationId: createOrUpdateCloudInfrastructureNetworkProfilesNetworkProfile
8849       consumes:
8850         - application/json
8851         - application/xml
8852       produces:
8853         - application/json
8854         - application/xml
8855       responses:
8856         "default":
8857           description: Response codes found in [response codes](https://wiki.onap.org/).
8858       parameters:
8859         - name: nm-profile-name
8860           in: path
8861           description: Unique name of network profile.
8862           required: true
8863           type: string
8864           example: __NM-PROFILE-NAME__
8865         - name: body
8866           in: body
8867           description: network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)
8868           required: true
8869           schema:
8870             $ref: "#/definitions/network-profile"
8871     patch:
8872       tags:
8873         - CloudInfrastructure
8874       summary: update an existing network-profile
8875       description: |
8876         Update an existing network-profile
8877         #
8878         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
8879         The PUT operation will entirely replace an existing object.
8880         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
8881         #
8882         Other differences between PUT and PATCH are:
8883         #
8884         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
8885         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
8886         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
8887       operationId: UpdateCloudInfrastructureNetworkProfilesNetworkProfile
8888       consumes:
8889         - application/json
8890         - application/xml
8891       produces:
8892         - application/json
8893         - application/xml
8894       responses:
8895         "default":
8896           description: Response codes found in [response codes](https://wiki.onap.org/).
8897       parameters:
8898         - name: nm-profile-name
8899           in: path
8900           description: Unique name of network profile.
8901           required: true
8902           type: string
8903           example: __NM-PROFILE-NAME__
8904         - name: body
8905           in: body
8906           description: network-profile object that needs to be created or updated.
8907           required: true
8908           schema:
8909             $ref: "#/patchDefinitions/network-profile"
8910     delete:
8911       tags:
8912         - CloudInfrastructure
8913       summary: delete an existing network-profile
8914       description: delete an existing network-profile
8915       operationId: deleteCloudInfrastructureNetworkProfilesNetworkProfile
8916       consumes:
8917         - application/json
8918         - application/xml
8919       produces:
8920         - application/json
8921         - application/xml
8922       responses:
8923         "default":
8924           description: Response codes found in [response codes](https://wiki.onap.org/).
8925       parameters:
8926         - name: nm-profile-name
8927           in: path
8928           description: Unique name of network profile.
8929           required: true
8930           type: string
8931           example: __NM-PROFILE-NAME__
8932         - name: resource-version
8933           in: query
8934           description: resource-version for concurrency
8935           required: true
8936           type: string
8937   /cloud-infrastructure/network-profiles:
8938     get:
8939       tags:
8940         - CloudInfrastructure
8941       summary: returns network-profiles
8942       description: returns network-profiles
8943       operationId: getCloudInfrastructureNetworkProfiles
8944       produces:
8945         - application/json
8946         - application/xml
8947       responses:
8948         "200":
8949           description: successful operation
8950           schema:
8951               $ref: "#/getDefinitions/network-profiles"
8952         "default":
8953           description: Response codes found in [response codes](https://wiki.onap.org/).
8954   /cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship:
8955     put:
8956       tags:
8957         - CloudInfrastructure
8958       summary: see node definition for valid relationships
8959       operationId: createOrUpdateCloudInfrastructurePserversPserverRelationshipListRelationship
8960       consumes:
8961         - application/json
8962         - application/xml
8963       produces:
8964         - application/json
8965         - application/xml
8966       responses:
8967         "default":
8968           description: Response codes found in [response codes](https://wiki.onap.org/).
8969       parameters:
8970         - name: hostname
8971           in: path
8972           description: Value from executing hostname on the compute node.
8973           required: true
8974           type: string
8975           example: __HOSTNAME__
8976         - name: body
8977           in: body
8978           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
8979           required: true
8980           schema:
8981             $ref: "#/definitions/relationship"
8982     delete:
8983       tags:
8984         - CloudInfrastructure
8985       summary: delete an existing relationship
8986       description: delete an existing relationship
8987       operationId: deleteCloudInfrastructurePserversPserverRelationshipListRelationship
8988       consumes:
8989         - application/json
8990         - application/xml
8991       produces:
8992         - application/json
8993         - application/xml
8994       responses:
8995         "default":
8996           description: Response codes found in [response codes](https://wiki.onap.org/).
8997       parameters:
8998         - name: hostname
8999           in: path
9000           description: Value from executing hostname on the compute node.
9001           required: true
9002           type: string
9003           example: __HOSTNAME__
9004   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
9005     put:
9006       tags:
9007         - CloudInfrastructure
9008       summary: see node definition for valid relationships
9009       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9010       consumes:
9011         - application/json
9012         - application/xml
9013       produces:
9014         - application/json
9015         - application/xml
9016       responses:
9017         "default":
9018           description: Response codes found in [response codes](https://wiki.onap.org/).
9019       parameters:
9020         - name: hostname
9021           in: path
9022           description: Value from executing hostname on the compute node.
9023           required: true
9024           type: string
9025           example: __HOSTNAME__
9026         - name: interface-name
9027           in: path
9028           description: Name that identifies the physical interface
9029           required: true
9030           type: string
9031           example: __INTERFACE-NAME__
9032         - name: body
9033           in: body
9034           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
9035           required: true
9036           schema:
9037             $ref: "#/definitions/relationship"
9038     delete:
9039       tags:
9040         - CloudInfrastructure
9041       summary: delete an existing relationship
9042       description: delete an existing relationship
9043       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceRelationshipListRelationship
9044       consumes:
9045         - application/json
9046         - application/xml
9047       produces:
9048         - application/json
9049         - application/xml
9050       responses:
9051         "default":
9052           description: Response codes found in [response codes](https://wiki.onap.org/).
9053       parameters:
9054         - name: hostname
9055           in: path
9056           description: Value from executing hostname on the compute node.
9057           required: true
9058           type: string
9059           example: __HOSTNAME__
9060         - name: interface-name
9061           in: path
9062           description: Name that identifies the physical interface
9063           required: true
9064           type: string
9065           example: __INTERFACE-NAME__
9066   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
9067     put:
9068       tags:
9069         - CloudInfrastructure
9070       summary: see node definition for valid relationships
9071       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9072       consumes:
9073         - application/json
9074         - application/xml
9075       produces:
9076         - application/json
9077         - application/xml
9078       responses:
9079         "default":
9080           description: Response codes found in [response codes](https://wiki.onap.org/).
9081       parameters:
9082         - name: hostname
9083           in: path
9084           description: Value from executing hostname on the compute node.
9085           required: true
9086           type: string
9087           example: __HOSTNAME__
9088         - name: interface-name
9089           in: path
9090           description: Name that identifies the physical interface
9091           required: true
9092           type: string
9093           example: __INTERFACE-NAME__
9094         - name: pf-pci-id
9095           in: path
9096           description: Identifier for the sriov-pf
9097           required: true
9098           type: string
9099           example: __PF-PCI-ID__
9100         - name: body
9101           in: body
9102           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9103           required: true
9104           schema:
9105             $ref: "#/definitions/relationship"
9106     delete:
9107       tags:
9108         - CloudInfrastructure
9109       summary: delete an existing relationship
9110       description: delete an existing relationship
9111       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
9112       consumes:
9113         - application/json
9114         - application/xml
9115       produces:
9116         - application/json
9117         - application/xml
9118       responses:
9119         "default":
9120           description: Response codes found in [response codes](https://wiki.onap.org/).
9121       parameters:
9122         - name: hostname
9123           in: path
9124           description: Value from executing hostname on the compute node.
9125           required: true
9126           type: string
9127           example: __HOSTNAME__
9128         - name: interface-name
9129           in: path
9130           description: Name that identifies the physical interface
9131           required: true
9132           type: string
9133           example: __INTERFACE-NAME__
9134         - name: pf-pci-id
9135           in: path
9136           description: Identifier for the sriov-pf
9137           required: true
9138           type: string
9139           example: __PF-PCI-ID__
9140   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
9141     get:
9142       tags:
9143         - CloudInfrastructure
9144       summary: returns sriov-pf
9145       description: returns sriov-pf
9146       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9147       produces:
9148         - application/json
9149         - application/xml
9150       responses:
9151         "200":
9152           description: successful operation
9153           schema:
9154               $ref: "#/getDefinitions/sriov-pf"
9155         "default":
9156           description: Response codes found in [response codes](https://wiki.onap.org/).
9157       parameters:
9158         - name: hostname
9159           in: path
9160           description: Value from executing hostname on the compute node.
9161           required: true
9162           type: string
9163           example: __HOSTNAME__
9164         - name: interface-name
9165           in: path
9166           description: Name that identifies the physical interface
9167           required: true
9168           type: string
9169           example: __INTERFACE-NAME__
9170         - name: pf-pci-id
9171           in: path
9172           description: Identifier for the sriov-pf
9173           required: true
9174           type: string
9175           example: __PF-PCI-ID__
9176         - name: inv-status
9177           in: query
9178           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9179           required: false
9180           type: string
9181         - name: pserver-id
9182           in: query
9183           description: ID of Pserver
9184           required: false
9185           type: string
9186         - name: in-maint
9187           in: query
9188           required: false
9189           type: boolean
9190         - name: pserver-name2
9191           in: query
9192           description: alternative pserver name
9193           required: false
9194           type: string
9195         - name: prov-status
9196           in: query
9197           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9198           required: false
9199           type: string
9200     put:
9201       tags:
9202         - CloudInfrastructure
9203       summary: create or update an existing sriov-pf
9204       description: |
9205         Create or update an existing sriov-pf.
9206         #
9207         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9208       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9209       consumes:
9210         - application/json
9211         - application/xml
9212       produces:
9213         - application/json
9214         - application/xml
9215       responses:
9216         "default":
9217           description: Response codes found in [response codes](https://wiki.onap.org/).
9218       parameters:
9219         - name: hostname
9220           in: path
9221           description: Value from executing hostname on the compute node.
9222           required: true
9223           type: string
9224           example: __HOSTNAME__
9225         - name: interface-name
9226           in: path
9227           description: Name that identifies the physical interface
9228           required: true
9229           type: string
9230           example: __INTERFACE-NAME__
9231         - name: pf-pci-id
9232           in: path
9233           description: Identifier for the sriov-pf
9234           required: true
9235           type: string
9236           example: __PF-PCI-ID__
9237         - name: body
9238           in: body
9239           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)
9240           required: true
9241           schema:
9242             $ref: "#/definitions/sriov-pf"
9243     patch:
9244       tags:
9245         - CloudInfrastructure
9246       summary: update an existing sriov-pf
9247       description: |
9248         Update an existing sriov-pf
9249         #
9250         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9251         The PUT operation will entirely replace an existing object.
9252         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9253         #
9254         Other differences between PUT and PATCH are:
9255         #
9256         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9257         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9258         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9259       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9260       consumes:
9261         - application/json
9262         - application/xml
9263       produces:
9264         - application/json
9265         - application/xml
9266       responses:
9267         "default":
9268           description: Response codes found in [response codes](https://wiki.onap.org/).
9269       parameters:
9270         - name: hostname
9271           in: path
9272           description: Value from executing hostname on the compute node.
9273           required: true
9274           type: string
9275           example: __HOSTNAME__
9276         - name: interface-name
9277           in: path
9278           description: Name that identifies the physical interface
9279           required: true
9280           type: string
9281           example: __INTERFACE-NAME__
9282         - name: pf-pci-id
9283           in: path
9284           description: Identifier for the sriov-pf
9285           required: true
9286           type: string
9287           example: __PF-PCI-ID__
9288         - name: body
9289           in: body
9290           description: sriov-pf object that needs to be created or updated.
9291           required: true
9292           schema:
9293             $ref: "#/patchDefinitions/sriov-pf"
9294     delete:
9295       tags:
9296         - CloudInfrastructure
9297       summary: delete an existing sriov-pf
9298       description: delete an existing sriov-pf
9299       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf
9300       consumes:
9301         - application/json
9302         - application/xml
9303       produces:
9304         - application/json
9305         - application/xml
9306       responses:
9307         "default":
9308           description: Response codes found in [response codes](https://wiki.onap.org/).
9309       parameters:
9310         - name: hostname
9311           in: path
9312           description: Value from executing hostname on the compute node.
9313           required: true
9314           type: string
9315           example: __HOSTNAME__
9316         - name: interface-name
9317           in: path
9318           description: Name that identifies the physical interface
9319           required: true
9320           type: string
9321           example: __INTERFACE-NAME__
9322         - name: pf-pci-id
9323           in: path
9324           description: Identifier for the sriov-pf
9325           required: true
9326           type: string
9327           example: __PF-PCI-ID__
9328         - name: resource-version
9329           in: query
9330           description: resource-version for concurrency
9331           required: true
9332           type: string
9333   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
9334     get:
9335       tags:
9336         - CloudInfrastructure
9337       summary: returns sriov-pfs
9338       description: returns sriov-pfs
9339       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfs
9340       produces:
9341         - application/json
9342         - application/xml
9343       responses:
9344         "200":
9345           description: successful operation
9346           schema:
9347               $ref: "#/getDefinitions/sriov-pfs"
9348         "default":
9349           description: Response codes found in [response codes](https://wiki.onap.org/).
9350       parameters:
9351         - name: hostname
9352           in: path
9353           description: Value from executing hostname on the compute node.
9354           required: true
9355           type: string
9356           example: __HOSTNAME__
9357         - name: interface-name
9358           in: path
9359           description: Name that identifies the physical interface
9360           required: true
9361           type: string
9362           example: __INTERFACE-NAME__
9363         - name: inv-status
9364           in: query
9365           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9366           required: false
9367           type: string
9368         - name: pserver-id
9369           in: query
9370           description: ID of Pserver
9371           required: false
9372           type: string
9373         - name: in-maint
9374           in: query
9375           required: false
9376           type: boolean
9377         - name: pserver-name2
9378           in: query
9379           description: alternative pserver name
9380           required: false
9381           type: string
9382         - name: prov-status
9383           in: query
9384           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9385           required: false
9386           type: string
9387   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
9388     put:
9389       tags:
9390         - CloudInfrastructure
9391       summary: see node definition for valid relationships
9392       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9393       consumes:
9394         - application/json
9395         - application/xml
9396       produces:
9397         - application/json
9398         - application/xml
9399       responses:
9400         "default":
9401           description: Response codes found in [response codes](https://wiki.onap.org/).
9402       parameters:
9403         - name: hostname
9404           in: path
9405           description: Value from executing hostname on the compute node.
9406           required: true
9407           type: string
9408           example: __HOSTNAME__
9409         - name: interface-name
9410           in: path
9411           description: Name that identifies the physical interface
9412           required: true
9413           type: string
9414           example: __INTERFACE-NAME__
9415         - name: interface-name
9416           in: path
9417           description: Name given to the interface
9418           required: true
9419           type: string
9420           example: __INTERFACE-NAME__
9421         - name: vlan-interface
9422           in: path
9423           description: String that identifies the interface
9424           required: true
9425           type: string
9426           example: __VLAN-INTERFACE__
9427         - name: body
9428           in: body
9429           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
9430           required: true
9431           schema:
9432             $ref: "#/definitions/relationship"
9433     delete:
9434       tags:
9435         - CloudInfrastructure
9436       summary: delete an existing relationship
9437       description: delete an existing relationship
9438       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
9439       consumes:
9440         - application/json
9441         - application/xml
9442       produces:
9443         - application/json
9444         - application/xml
9445       responses:
9446         "default":
9447           description: Response codes found in [response codes](https://wiki.onap.org/).
9448       parameters:
9449         - name: hostname
9450           in: path
9451           description: Value from executing hostname on the compute node.
9452           required: true
9453           type: string
9454           example: __HOSTNAME__
9455         - name: interface-name
9456           in: path
9457           description: Name that identifies the physical interface
9458           required: true
9459           type: string
9460           example: __INTERFACE-NAME__
9461         - name: interface-name
9462           in: path
9463           description: Name given to the interface
9464           required: true
9465           type: string
9466           example: __INTERFACE-NAME__
9467         - name: vlan-interface
9468           in: path
9469           description: String that identifies the interface
9470           required: true
9471           type: string
9472           example: __VLAN-INTERFACE__
9473   /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:
9474     put:
9475       tags:
9476         - CloudInfrastructure
9477       summary: see node definition for valid relationships
9478       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9479       consumes:
9480         - application/json
9481         - application/xml
9482       produces:
9483         - application/json
9484         - application/xml
9485       responses:
9486         "default":
9487           description: Response codes found in [response codes](https://wiki.onap.org/).
9488       parameters:
9489         - name: hostname
9490           in: path
9491           description: Value from executing hostname on the compute node.
9492           required: true
9493           type: string
9494           example: __HOSTNAME__
9495         - name: interface-name
9496           in: path
9497           description: Name that identifies the physical interface
9498           required: true
9499           type: string
9500           example: __INTERFACE-NAME__
9501         - name: interface-name
9502           in: path
9503           description: Name given to the interface
9504           required: true
9505           type: string
9506           example: __INTERFACE-NAME__
9507         - name: vlan-interface
9508           in: path
9509           description: String that identifies the interface
9510           required: true
9511           type: string
9512           example: __VLAN-INTERFACE__
9513         - name: l3-interface-ipv4-address
9514           in: path
9515           description: IP address
9516           required: true
9517           type: string
9518           example: __L3-INTERFACE-IPV4-ADDRESS__
9519         - name: body
9520           in: body
9521           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9522           required: true
9523           schema:
9524             $ref: "#/definitions/relationship"
9525     delete:
9526       tags:
9527         - CloudInfrastructure
9528       summary: delete an existing relationship
9529       description: delete an existing relationship
9530       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
9531       consumes:
9532         - application/json
9533         - application/xml
9534       produces:
9535         - application/json
9536         - application/xml
9537       responses:
9538         "default":
9539           description: Response codes found in [response codes](https://wiki.onap.org/).
9540       parameters:
9541         - name: hostname
9542           in: path
9543           description: Value from executing hostname on the compute node.
9544           required: true
9545           type: string
9546           example: __HOSTNAME__
9547         - name: interface-name
9548           in: path
9549           description: Name that identifies the physical interface
9550           required: true
9551           type: string
9552           example: __INTERFACE-NAME__
9553         - name: interface-name
9554           in: path
9555           description: Name given to the interface
9556           required: true
9557           type: string
9558           example: __INTERFACE-NAME__
9559         - name: vlan-interface
9560           in: path
9561           description: String that identifies the interface
9562           required: true
9563           type: string
9564           example: __VLAN-INTERFACE__
9565         - name: l3-interface-ipv4-address
9566           in: path
9567           description: IP address
9568           required: true
9569           type: string
9570           example: __L3-INTERFACE-IPV4-ADDRESS__
9571   /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}:
9572     get:
9573       tags:
9574         - CloudInfrastructure
9575       summary: returns l3-interface-ipv4-address-list
9576       description: returns l3-interface-ipv4-address-list
9577       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9578       produces:
9579         - application/json
9580         - application/xml
9581       responses:
9582         "200":
9583           description: successful operation
9584           schema:
9585               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
9586         "default":
9587           description: Response codes found in [response codes](https://wiki.onap.org/).
9588       parameters:
9589         - name: hostname
9590           in: path
9591           description: Value from executing hostname on the compute node.
9592           required: true
9593           type: string
9594           example: __HOSTNAME__
9595         - name: interface-name
9596           in: path
9597           description: Name that identifies the physical interface
9598           required: true
9599           type: string
9600           example: __INTERFACE-NAME__
9601         - name: interface-name
9602           in: path
9603           description: Name given to the interface
9604           required: true
9605           type: string
9606           example: __INTERFACE-NAME__
9607         - name: vlan-interface
9608           in: path
9609           description: String that identifies the interface
9610           required: true
9611           type: string
9612           example: __VLAN-INTERFACE__
9613         - name: l3-interface-ipv4-address
9614           in: path
9615           description: IP address
9616           required: true
9617           type: string
9618           example: __L3-INTERFACE-IPV4-ADDRESS__
9619         - name: inv-status
9620           in: query
9621           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
9622           required: false
9623           type: string
9624         - name: pserver-id
9625           in: query
9626           description: ID of Pserver
9627           required: false
9628           type: string
9629         - name: in-maint
9630           in: query
9631           required: false
9632           type: boolean
9633         - name: pserver-name2
9634           in: query
9635           description: alternative pserver name
9636           required: false
9637           type: string
9638         - name: prov-status
9639           in: query
9640           description: Trigger for operational monitoring of this resource by Service Assurance systems.
9641           required: false
9642           type: string
9643         - name: interface-id
9644           in: query
9645           description: ID of interface
9646           required: false
9647           type: string
9648         - name: macaddr
9649           in: query
9650           description: MAC address for the interface
9651           required: false
9652           type: string
9653         - name: network-name
9654           in: query
9655           description: Name of the network
9656           required: false
9657           type: string
9658         - name: vlan-id-inner
9659           in: query
9660           description: Inner VLAN tag
9661           required: false
9662           type: integer
9663           format: int64
9664         - name: vpn-key
9665           in: query
9666           description: This indicates the customers VPN ID associated with this vlan
9667           required: false
9668           type: string
9669         - name: vlan-id-inner
9670           in: query
9671           description: Inner VLAN tag
9672           required: false
9673           type: integer
9674           format: int64
9675         - name: neutron-network-id
9676           in: query
9677           description: Neutron network id of the interface that address belongs to
9678           required: false
9679           type: string
9680         - name: neutron-subnet-id
9681           in: query
9682           description: Neutron id of subnet that address belongs to
9683           required: false
9684           type: string
9685     put:
9686       tags:
9687         - CloudInfrastructure
9688       summary: create or update an existing l3-interface-ipv4-address-list
9689       description: |
9690         Create or update an existing l3-interface-ipv4-address-list.
9691         #
9692         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
9693       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9694       consumes:
9695         - application/json
9696         - application/xml
9697       produces:
9698         - application/json
9699         - application/xml
9700       responses:
9701         "default":
9702           description: Response codes found in [response codes](https://wiki.onap.org/).
9703       parameters:
9704         - name: hostname
9705           in: path
9706           description: Value from executing hostname on the compute node.
9707           required: true
9708           type: string
9709           example: __HOSTNAME__
9710         - name: interface-name
9711           in: path
9712           description: Name that identifies the physical interface
9713           required: true
9714           type: string
9715           example: __INTERFACE-NAME__
9716         - name: interface-name
9717           in: path
9718           description: Name given to the interface
9719           required: true
9720           type: string
9721           example: __INTERFACE-NAME__
9722         - name: vlan-interface
9723           in: path
9724           description: String that identifies the interface
9725           required: true
9726           type: string
9727           example: __VLAN-INTERFACE__
9728         - name: l3-interface-ipv4-address
9729           in: path
9730           description: IP address
9731           required: true
9732           type: string
9733           example: __L3-INTERFACE-IPV4-ADDRESS__
9734         - name: body
9735           in: body
9736           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
9737           required: true
9738           schema:
9739             $ref: "#/definitions/l3-interface-ipv4-address-list"
9740     patch:
9741       tags:
9742         - CloudInfrastructure
9743       summary: update an existing l3-interface-ipv4-address-list
9744       description: |
9745         Update an existing l3-interface-ipv4-address-list
9746         #
9747         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
9748         The PUT operation will entirely replace an existing object.
9749         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
9750         #
9751         Other differences between PUT and PATCH are:
9752         #
9753         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
9754         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
9755         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
9756       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
9757       consumes:
9758         - application/json
9759         - application/xml
9760       produces:
9761         - application/json
9762         - application/xml
9763       responses:
9764         "default":
9765           description: Response codes found in [response codes](https://wiki.onap.org/).
9766       parameters:
9767         - name: hostname
9768           in: path
9769           description: Value from executing hostname on the compute node.
9770           required: true
9771           type: string
9772           example: __HOSTNAME__
9773         - name: interface-name
9774           in: path
9775           description: Name that identifies the physical interface
9776           required: true
9777           type: string
9778           example: __INTERFACE-NAME__
9779         - name: interface-name
9780           in: path
9781           description: Name given to the interface
9782           required: true
9783           type: string
9784           example: __INTERFACE-NAME__
9785         - name: vlan-interface
9786           in: path
9787           description: String that identifies the interface
9788           required: true
9789           type: string
9790           example: __VLAN-INTERFACE__
9791         - name: l3-interface-ipv4-address
9792           in: path
9793           description: IP address
9794           required: true
9795           type: string
9796           example: __L3-INTERFACE-IPV4-ADDRESS__
9797         - name: body
9798           in: body
9799           description: l3-interface-ipv4-address-list object that needs to be created or updated.
9800           required: true
9801           schema:
9802             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
9803     delete:
9804       tags:
9805         - CloudInfrastructure
9806       summary: delete an existing l3-interface-ipv4-address-list
9807       description: delete an existing l3-interface-ipv4-address-list
9808       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
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: vlan-interface
9838           in: path
9839           description: String that identifies the interface
9840           required: true
9841           type: string
9842           example: __VLAN-INTERFACE__
9843         - name: l3-interface-ipv4-address
9844           in: path
9845           description: IP address
9846           required: true
9847           type: string
9848           example: __L3-INTERFACE-IPV4-ADDRESS__
9849         - name: resource-version
9850           in: query
9851           description: resource-version for concurrency
9852           required: true
9853           type: string
9854   /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:
9855     put:
9856       tags:
9857         - CloudInfrastructure
9858       summary: see node definition for valid relationships
9859       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9860       consumes:
9861         - application/json
9862         - application/xml
9863       produces:
9864         - application/json
9865         - application/xml
9866       responses:
9867         "default":
9868           description: Response codes found in [response codes](https://wiki.onap.org/).
9869       parameters:
9870         - name: hostname
9871           in: path
9872           description: Value from executing hostname on the compute node.
9873           required: true
9874           type: string
9875           example: __HOSTNAME__
9876         - name: interface-name
9877           in: path
9878           description: Name that identifies the physical interface
9879           required: true
9880           type: string
9881           example: __INTERFACE-NAME__
9882         - name: interface-name
9883           in: path
9884           description: Name given to the interface
9885           required: true
9886           type: string
9887           example: __INTERFACE-NAME__
9888         - name: vlan-interface
9889           in: path
9890           description: String that identifies the interface
9891           required: true
9892           type: string
9893           example: __VLAN-INTERFACE__
9894         - name: l3-interface-ipv6-address
9895           in: path
9896           description: IP address
9897           required: true
9898           type: string
9899           example: __L3-INTERFACE-IPV6-ADDRESS__
9900         - name: body
9901           in: body
9902           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
9903           required: true
9904           schema:
9905             $ref: "#/definitions/relationship"
9906     delete:
9907       tags:
9908         - CloudInfrastructure
9909       summary: delete an existing relationship
9910       description: delete an existing relationship
9911       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
9912       consumes:
9913         - application/json
9914         - application/xml
9915       produces:
9916         - application/json
9917         - application/xml
9918       responses:
9919         "default":
9920           description: Response codes found in [response codes](https://wiki.onap.org/).
9921       parameters:
9922         - name: hostname
9923           in: path
9924           description: Value from executing hostname on the compute node.
9925           required: true
9926           type: string
9927           example: __HOSTNAME__
9928         - name: interface-name
9929           in: path
9930           description: Name that identifies the physical interface
9931           required: true
9932           type: string
9933           example: __INTERFACE-NAME__
9934         - name: interface-name
9935           in: path
9936           description: Name given to the interface
9937           required: true
9938           type: string
9939           example: __INTERFACE-NAME__
9940         - name: vlan-interface
9941           in: path
9942           description: String that identifies the interface
9943           required: true
9944           type: string
9945           example: __VLAN-INTERFACE__
9946         - name: l3-interface-ipv6-address
9947           in: path
9948           description: IP address
9949           required: true
9950           type: string
9951           example: __L3-INTERFACE-IPV6-ADDRESS__
9952   /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}:
9953     get:
9954       tags:
9955         - CloudInfrastructure
9956       summary: returns l3-interface-ipv6-address-list
9957       description: returns l3-interface-ipv6-address-list
9958       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
9959       produces:
9960         - application/json
9961         - application/xml
9962       responses:
9963         "200":
9964           description: successful operation
9965           schema:
9966               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
9967         "default":
9968           description: Response codes found in [response codes](https://wiki.onap.org/).
9969       parameters:
9970         - name: hostname
9971           in: path
9972           description: Value from executing hostname on the compute node.
9973           required: true
9974           type: string
9975           example: __HOSTNAME__
9976         - name: interface-name
9977           in: path
9978           description: Name that identifies the physical interface
9979           required: true
9980           type: string
9981           example: __INTERFACE-NAME__
9982         - name: interface-name
9983           in: path
9984           description: Name given to the interface
9985           required: true
9986           type: string
9987           example: __INTERFACE-NAME__
9988         - name: vlan-interface
9989           in: path
9990           description: String that identifies the interface
9991           required: true
9992           type: string
9993           example: __VLAN-INTERFACE__
9994         - name: l3-interface-ipv6-address
9995           in: path
9996           description: IP address
9997           required: true
9998           type: string
9999           example: __L3-INTERFACE-IPV6-ADDRESS__
10000         - name: inv-status
10001           in: query
10002           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10003           required: false
10004           type: string
10005         - name: pserver-id
10006           in: query
10007           description: ID of Pserver
10008           required: false
10009           type: string
10010         - name: in-maint
10011           in: query
10012           required: false
10013           type: boolean
10014         - name: pserver-name2
10015           in: query
10016           description: alternative pserver name
10017           required: false
10018           type: string
10019         - name: prov-status
10020           in: query
10021           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10022           required: false
10023           type: string
10024         - name: interface-id
10025           in: query
10026           description: ID of interface
10027           required: false
10028           type: string
10029         - name: macaddr
10030           in: query
10031           description: MAC address for the interface
10032           required: false
10033           type: string
10034         - name: network-name
10035           in: query
10036           description: Name of the network
10037           required: false
10038           type: string
10039         - name: vlan-id-inner
10040           in: query
10041           description: Inner VLAN tag
10042           required: false
10043           type: integer
10044           format: int64
10045         - name: vpn-key
10046           in: query
10047           description: This indicates the customers VPN ID associated with this vlan
10048           required: false
10049           type: string
10050         - name: vlan-id-inner
10051           in: query
10052           description: Inner VLAN tag
10053           required: false
10054           type: integer
10055           format: int64
10056         - name: neutron-network-id
10057           in: query
10058           description: Neutron network id of the interface that address belongs to
10059           required: false
10060           type: string
10061         - name: neutron-subnet-id
10062           in: query
10063           description: Neutron id of subnet that address belongs to
10064           required: false
10065           type: string
10066     put:
10067       tags:
10068         - CloudInfrastructure
10069       summary: create or update an existing l3-interface-ipv6-address-list
10070       description: |
10071         Create or update an existing l3-interface-ipv6-address-list.
10072         #
10073         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10074       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10075       consumes:
10076         - application/json
10077         - application/xml
10078       produces:
10079         - application/json
10080         - application/xml
10081       responses:
10082         "default":
10083           description: Response codes found in [response codes](https://wiki.onap.org/).
10084       parameters:
10085         - name: hostname
10086           in: path
10087           description: Value from executing hostname on the compute node.
10088           required: true
10089           type: string
10090           example: __HOSTNAME__
10091         - name: interface-name
10092           in: path
10093           description: Name that identifies the physical interface
10094           required: true
10095           type: string
10096           example: __INTERFACE-NAME__
10097         - name: interface-name
10098           in: path
10099           description: Name given to the interface
10100           required: true
10101           type: string
10102           example: __INTERFACE-NAME__
10103         - name: vlan-interface
10104           in: path
10105           description: String that identifies the interface
10106           required: true
10107           type: string
10108           example: __VLAN-INTERFACE__
10109         - name: l3-interface-ipv6-address
10110           in: path
10111           description: IP address
10112           required: true
10113           type: string
10114           example: __L3-INTERFACE-IPV6-ADDRESS__
10115         - name: body
10116           in: body
10117           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
10118           required: true
10119           schema:
10120             $ref: "#/definitions/l3-interface-ipv6-address-list"
10121     patch:
10122       tags:
10123         - CloudInfrastructure
10124       summary: update an existing l3-interface-ipv6-address-list
10125       description: |
10126         Update an existing l3-interface-ipv6-address-list
10127         #
10128         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10129         The PUT operation will entirely replace an existing object.
10130         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10131         #
10132         Other differences between PUT and PATCH are:
10133         #
10134         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10135         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10136         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10137       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10138       consumes:
10139         - application/json
10140         - application/xml
10141       produces:
10142         - application/json
10143         - application/xml
10144       responses:
10145         "default":
10146           description: Response codes found in [response codes](https://wiki.onap.org/).
10147       parameters:
10148         - name: hostname
10149           in: path
10150           description: Value from executing hostname on the compute node.
10151           required: true
10152           type: string
10153           example: __HOSTNAME__
10154         - name: interface-name
10155           in: path
10156           description: Name that identifies the physical interface
10157           required: true
10158           type: string
10159           example: __INTERFACE-NAME__
10160         - name: interface-name
10161           in: path
10162           description: Name given to the interface
10163           required: true
10164           type: string
10165           example: __INTERFACE-NAME__
10166         - name: vlan-interface
10167           in: path
10168           description: String that identifies the interface
10169           required: true
10170           type: string
10171           example: __VLAN-INTERFACE__
10172         - name: l3-interface-ipv6-address
10173           in: path
10174           description: IP address
10175           required: true
10176           type: string
10177           example: __L3-INTERFACE-IPV6-ADDRESS__
10178         - name: body
10179           in: body
10180           description: l3-interface-ipv6-address-list object that needs to be created or updated.
10181           required: true
10182           schema:
10183             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
10184     delete:
10185       tags:
10186         - CloudInfrastructure
10187       summary: delete an existing l3-interface-ipv6-address-list
10188       description: delete an existing l3-interface-ipv6-address-list
10189       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
10190       consumes:
10191         - application/json
10192         - application/xml
10193       produces:
10194         - application/json
10195         - application/xml
10196       responses:
10197         "default":
10198           description: Response codes found in [response codes](https://wiki.onap.org/).
10199       parameters:
10200         - name: hostname
10201           in: path
10202           description: Value from executing hostname on the compute node.
10203           required: true
10204           type: string
10205           example: __HOSTNAME__
10206         - name: interface-name
10207           in: path
10208           description: Name that identifies the physical interface
10209           required: true
10210           type: string
10211           example: __INTERFACE-NAME__
10212         - name: interface-name
10213           in: path
10214           description: Name given to the interface
10215           required: true
10216           type: string
10217           example: __INTERFACE-NAME__
10218         - name: vlan-interface
10219           in: path
10220           description: String that identifies the interface
10221           required: true
10222           type: string
10223           example: __VLAN-INTERFACE__
10224         - name: l3-interface-ipv6-address
10225           in: path
10226           description: IP address
10227           required: true
10228           type: string
10229           example: __L3-INTERFACE-IPV6-ADDRESS__
10230         - name: resource-version
10231           in: query
10232           description: resource-version for concurrency
10233           required: true
10234           type: string
10235   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
10236     get:
10237       tags:
10238         - CloudInfrastructure
10239       summary: returns vlan
10240       description: returns vlan
10241       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10242       produces:
10243         - application/json
10244         - application/xml
10245       responses:
10246         "200":
10247           description: successful operation
10248           schema:
10249               $ref: "#/getDefinitions/vlan"
10250         "default":
10251           description: Response codes found in [response codes](https://wiki.onap.org/).
10252       parameters:
10253         - name: hostname
10254           in: path
10255           description: Value from executing hostname on the compute node.
10256           required: true
10257           type: string
10258           example: __HOSTNAME__
10259         - name: interface-name
10260           in: path
10261           description: Name that identifies the physical interface
10262           required: true
10263           type: string
10264           example: __INTERFACE-NAME__
10265         - name: interface-name
10266           in: path
10267           description: Name given to the interface
10268           required: true
10269           type: string
10270           example: __INTERFACE-NAME__
10271         - name: vlan-interface
10272           in: path
10273           description: String that identifies the interface
10274           required: true
10275           type: string
10276           example: __VLAN-INTERFACE__
10277         - name: inv-status
10278           in: query
10279           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10280           required: false
10281           type: string
10282         - name: pserver-id
10283           in: query
10284           description: ID of Pserver
10285           required: false
10286           type: string
10287         - name: in-maint
10288           in: query
10289           required: false
10290           type: boolean
10291         - name: pserver-name2
10292           in: query
10293           description: alternative pserver name
10294           required: false
10295           type: string
10296         - name: prov-status
10297           in: query
10298           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10299           required: false
10300           type: string
10301         - name: interface-id
10302           in: query
10303           description: ID of interface
10304           required: false
10305           type: string
10306         - name: macaddr
10307           in: query
10308           description: MAC address for the interface
10309           required: false
10310           type: string
10311         - name: network-name
10312           in: query
10313           description: Name of the network
10314           required: false
10315           type: string
10316         - name: vlan-id-inner
10317           in: query
10318           description: Inner VLAN tag
10319           required: false
10320           type: integer
10321           format: int64
10322         - name: vpn-key
10323           in: query
10324           description: This indicates the customers VPN ID associated with this vlan
10325           required: false
10326           type: string
10327     put:
10328       tags:
10329         - CloudInfrastructure
10330       summary: create or update an existing vlan
10331       description: |
10332         Create or update an existing vlan.
10333         #
10334         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10335       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10336       consumes:
10337         - application/json
10338         - application/xml
10339       produces:
10340         - application/json
10341         - application/xml
10342       responses:
10343         "default":
10344           description: Response codes found in [response codes](https://wiki.onap.org/).
10345       parameters:
10346         - name: hostname
10347           in: path
10348           description: Value from executing hostname on the compute node.
10349           required: true
10350           type: string
10351           example: __HOSTNAME__
10352         - name: interface-name
10353           in: path
10354           description: Name that identifies the physical interface
10355           required: true
10356           type: string
10357           example: __INTERFACE-NAME__
10358         - name: interface-name
10359           in: path
10360           description: Name given to the interface
10361           required: true
10362           type: string
10363           example: __INTERFACE-NAME__
10364         - name: vlan-interface
10365           in: path
10366           description: String that identifies the interface
10367           required: true
10368           type: string
10369           example: __VLAN-INTERFACE__
10370         - name: body
10371           in: body
10372           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
10373           required: true
10374           schema:
10375             $ref: "#/definitions/vlan"
10376     patch:
10377       tags:
10378         - CloudInfrastructure
10379       summary: update an existing vlan
10380       description: |
10381         Update an existing vlan
10382         #
10383         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10384         The PUT operation will entirely replace an existing object.
10385         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10386         #
10387         Other differences between PUT and PATCH are:
10388         #
10389         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10390         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10391         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10392       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10393       consumes:
10394         - application/json
10395         - application/xml
10396       produces:
10397         - application/json
10398         - application/xml
10399       responses:
10400         "default":
10401           description: Response codes found in [response codes](https://wiki.onap.org/).
10402       parameters:
10403         - name: hostname
10404           in: path
10405           description: Value from executing hostname on the compute node.
10406           required: true
10407           type: string
10408           example: __HOSTNAME__
10409         - name: interface-name
10410           in: path
10411           description: Name that identifies the physical interface
10412           required: true
10413           type: string
10414           example: __INTERFACE-NAME__
10415         - name: interface-name
10416           in: path
10417           description: Name given to the interface
10418           required: true
10419           type: string
10420           example: __INTERFACE-NAME__
10421         - name: vlan-interface
10422           in: path
10423           description: String that identifies the interface
10424           required: true
10425           type: string
10426           example: __VLAN-INTERFACE__
10427         - name: body
10428           in: body
10429           description: vlan object that needs to be created or updated.
10430           required: true
10431           schema:
10432             $ref: "#/patchDefinitions/vlan"
10433     delete:
10434       tags:
10435         - CloudInfrastructure
10436       summary: delete an existing vlan
10437       description: delete an existing vlan
10438       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
10439       consumes:
10440         - application/json
10441         - application/xml
10442       produces:
10443         - application/json
10444         - application/xml
10445       responses:
10446         "default":
10447           description: Response codes found in [response codes](https://wiki.onap.org/).
10448       parameters:
10449         - name: hostname
10450           in: path
10451           description: Value from executing hostname on the compute node.
10452           required: true
10453           type: string
10454           example: __HOSTNAME__
10455         - name: interface-name
10456           in: path
10457           description: Name that identifies the physical interface
10458           required: true
10459           type: string
10460           example: __INTERFACE-NAME__
10461         - name: interface-name
10462           in: path
10463           description: Name given to the interface
10464           required: true
10465           type: string
10466           example: __INTERFACE-NAME__
10467         - name: vlan-interface
10468           in: path
10469           description: String that identifies the interface
10470           required: true
10471           type: string
10472           example: __VLAN-INTERFACE__
10473         - name: resource-version
10474           in: query
10475           description: resource-version for concurrency
10476           required: true
10477           type: string
10478   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
10479     get:
10480       tags:
10481         - CloudInfrastructure
10482       summary: returns vlans
10483       description: returns vlans
10484       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlans
10485       produces:
10486         - application/json
10487         - application/xml
10488       responses:
10489         "200":
10490           description: successful operation
10491           schema:
10492               $ref: "#/getDefinitions/vlans"
10493         "default":
10494           description: Response codes found in [response codes](https://wiki.onap.org/).
10495       parameters:
10496         - name: hostname
10497           in: path
10498           description: Value from executing hostname on the compute node.
10499           required: true
10500           type: string
10501           example: __HOSTNAME__
10502         - name: interface-name
10503           in: path
10504           description: Name that identifies the physical interface
10505           required: true
10506           type: string
10507           example: __INTERFACE-NAME__
10508         - name: interface-name
10509           in: path
10510           description: Name given to the interface
10511           required: true
10512           type: string
10513           example: __INTERFACE-NAME__
10514         - name: inv-status
10515           in: query
10516           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10517           required: false
10518           type: string
10519         - name: pserver-id
10520           in: query
10521           description: ID of Pserver
10522           required: false
10523           type: string
10524         - name: in-maint
10525           in: query
10526           required: false
10527           type: boolean
10528         - name: pserver-name2
10529           in: query
10530           description: alternative pserver name
10531           required: false
10532           type: string
10533         - name: prov-status
10534           in: query
10535           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10536           required: false
10537           type: string
10538         - name: interface-id
10539           in: query
10540           description: ID of interface
10541           required: false
10542           type: string
10543         - name: macaddr
10544           in: query
10545           description: MAC address for the interface
10546           required: false
10547           type: string
10548         - name: network-name
10549           in: query
10550           description: Name of the network
10551           required: false
10552           type: string
10553   /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:
10554     put:
10555       tags:
10556         - CloudInfrastructure
10557       summary: see node definition for valid relationships
10558       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10559       consumes:
10560         - application/json
10561         - application/xml
10562       produces:
10563         - application/json
10564         - application/xml
10565       responses:
10566         "default":
10567           description: Response codes found in [response codes](https://wiki.onap.org/).
10568       parameters:
10569         - name: hostname
10570           in: path
10571           description: Value from executing hostname on the compute node.
10572           required: true
10573           type: string
10574           example: __HOSTNAME__
10575         - name: interface-name
10576           in: path
10577           description: Name that identifies the physical interface
10578           required: true
10579           type: string
10580           example: __INTERFACE-NAME__
10581         - name: interface-name
10582           in: path
10583           description: Name given to the interface
10584           required: true
10585           type: string
10586           example: __INTERFACE-NAME__
10587         - name: pci-id
10588           in: path
10589           description: PCI ID used to identify the sriov-vf
10590           required: true
10591           type: string
10592           example: __PCI-ID__
10593         - name: body
10594           in: body
10595           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10596           required: true
10597           schema:
10598             $ref: "#/definitions/relationship"
10599     delete:
10600       tags:
10601         - CloudInfrastructure
10602       summary: delete an existing relationship
10603       description: delete an existing relationship
10604       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
10605       consumes:
10606         - application/json
10607         - application/xml
10608       produces:
10609         - application/json
10610         - application/xml
10611       responses:
10612         "default":
10613           description: Response codes found in [response codes](https://wiki.onap.org/).
10614       parameters:
10615         - name: hostname
10616           in: path
10617           description: Value from executing hostname on the compute node.
10618           required: true
10619           type: string
10620           example: __HOSTNAME__
10621         - name: interface-name
10622           in: path
10623           description: Name that identifies the physical interface
10624           required: true
10625           type: string
10626           example: __INTERFACE-NAME__
10627         - name: interface-name
10628           in: path
10629           description: Name given to the interface
10630           required: true
10631           type: string
10632           example: __INTERFACE-NAME__
10633         - name: pci-id
10634           in: path
10635           description: PCI ID used to identify the sriov-vf
10636           required: true
10637           type: string
10638           example: __PCI-ID__
10639   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
10640     get:
10641       tags:
10642         - CloudInfrastructure
10643       summary: returns sriov-vf
10644       description: returns sriov-vf
10645       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10646       produces:
10647         - application/json
10648         - application/xml
10649       responses:
10650         "200":
10651           description: successful operation
10652           schema:
10653               $ref: "#/getDefinitions/sriov-vf"
10654         "default":
10655           description: Response codes found in [response codes](https://wiki.onap.org/).
10656       parameters:
10657         - name: hostname
10658           in: path
10659           description: Value from executing hostname on the compute node.
10660           required: true
10661           type: string
10662           example: __HOSTNAME__
10663         - name: interface-name
10664           in: path
10665           description: Name that identifies the physical interface
10666           required: true
10667           type: string
10668           example: __INTERFACE-NAME__
10669         - name: interface-name
10670           in: path
10671           description: Name given to the interface
10672           required: true
10673           type: string
10674           example: __INTERFACE-NAME__
10675         - name: pci-id
10676           in: path
10677           description: PCI ID used to identify the sriov-vf
10678           required: true
10679           type: string
10680           example: __PCI-ID__
10681         - name: inv-status
10682           in: query
10683           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10684           required: false
10685           type: string
10686         - name: pserver-id
10687           in: query
10688           description: ID of Pserver
10689           required: false
10690           type: string
10691         - name: in-maint
10692           in: query
10693           required: false
10694           type: boolean
10695         - name: pserver-name2
10696           in: query
10697           description: alternative pserver name
10698           required: false
10699           type: string
10700         - name: prov-status
10701           in: query
10702           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10703           required: false
10704           type: string
10705         - name: interface-id
10706           in: query
10707           description: ID of interface
10708           required: false
10709           type: string
10710         - name: macaddr
10711           in: query
10712           description: MAC address for the interface
10713           required: false
10714           type: string
10715         - name: network-name
10716           in: query
10717           description: Name of the network
10718           required: false
10719           type: string
10720         - name: vf-vlan-filter
10721           in: query
10722           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
10723           required: false
10724           type: string
10725         - name: vf-mac-filter
10726           in: query
10727           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
10728           required: false
10729           type: string
10730         - name: vf-vlan-strip
10731           in: query
10732           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
10733           required: false
10734           type: boolean
10735         - name: neutron-network-id
10736           in: query
10737           description: Neutron network id of the interface
10738           required: false
10739           type: string
10740     put:
10741       tags:
10742         - CloudInfrastructure
10743       summary: create or update an existing sriov-vf
10744       description: |
10745         Create or update an existing sriov-vf.
10746         #
10747         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
10748       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10749       consumes:
10750         - application/json
10751         - application/xml
10752       produces:
10753         - application/json
10754         - application/xml
10755       responses:
10756         "default":
10757           description: Response codes found in [response codes](https://wiki.onap.org/).
10758       parameters:
10759         - name: hostname
10760           in: path
10761           description: Value from executing hostname on the compute node.
10762           required: true
10763           type: string
10764           example: __HOSTNAME__
10765         - name: interface-name
10766           in: path
10767           description: Name that identifies the physical interface
10768           required: true
10769           type: string
10770           example: __INTERFACE-NAME__
10771         - name: interface-name
10772           in: path
10773           description: Name given to the interface
10774           required: true
10775           type: string
10776           example: __INTERFACE-NAME__
10777         - name: pci-id
10778           in: path
10779           description: PCI ID used to identify the sriov-vf
10780           required: true
10781           type: string
10782           example: __PCI-ID__
10783         - name: body
10784           in: body
10785           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
10786           required: true
10787           schema:
10788             $ref: "#/definitions/sriov-vf"
10789     patch:
10790       tags:
10791         - CloudInfrastructure
10792       summary: update an existing sriov-vf
10793       description: |
10794         Update an existing sriov-vf
10795         #
10796         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
10797         The PUT operation will entirely replace an existing object.
10798         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
10799         #
10800         Other differences between PUT and PATCH are:
10801         #
10802         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
10803         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
10804         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
10805       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10806       consumes:
10807         - application/json
10808         - application/xml
10809       produces:
10810         - application/json
10811         - application/xml
10812       responses:
10813         "default":
10814           description: Response codes found in [response codes](https://wiki.onap.org/).
10815       parameters:
10816         - name: hostname
10817           in: path
10818           description: Value from executing hostname on the compute node.
10819           required: true
10820           type: string
10821           example: __HOSTNAME__
10822         - name: interface-name
10823           in: path
10824           description: Name that identifies the physical interface
10825           required: true
10826           type: string
10827           example: __INTERFACE-NAME__
10828         - name: interface-name
10829           in: path
10830           description: Name given to the interface
10831           required: true
10832           type: string
10833           example: __INTERFACE-NAME__
10834         - name: pci-id
10835           in: path
10836           description: PCI ID used to identify the sriov-vf
10837           required: true
10838           type: string
10839           example: __PCI-ID__
10840         - name: body
10841           in: body
10842           description: sriov-vf object that needs to be created or updated.
10843           required: true
10844           schema:
10845             $ref: "#/patchDefinitions/sriov-vf"
10846     delete:
10847       tags:
10848         - CloudInfrastructure
10849       summary: delete an existing sriov-vf
10850       description: delete an existing sriov-vf
10851       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
10852       consumes:
10853         - application/json
10854         - application/xml
10855       produces:
10856         - application/json
10857         - application/xml
10858       responses:
10859         "default":
10860           description: Response codes found in [response codes](https://wiki.onap.org/).
10861       parameters:
10862         - name: hostname
10863           in: path
10864           description: Value from executing hostname on the compute node.
10865           required: true
10866           type: string
10867           example: __HOSTNAME__
10868         - name: interface-name
10869           in: path
10870           description: Name that identifies the physical interface
10871           required: true
10872           type: string
10873           example: __INTERFACE-NAME__
10874         - name: interface-name
10875           in: path
10876           description: Name given to the interface
10877           required: true
10878           type: string
10879           example: __INTERFACE-NAME__
10880         - name: pci-id
10881           in: path
10882           description: PCI ID used to identify the sriov-vf
10883           required: true
10884           type: string
10885           example: __PCI-ID__
10886         - name: resource-version
10887           in: query
10888           description: resource-version for concurrency
10889           required: true
10890           type: string
10891   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
10892     get:
10893       tags:
10894         - CloudInfrastructure
10895       summary: returns sriov-vfs
10896       description: returns sriov-vfs
10897       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
10898       produces:
10899         - application/json
10900         - application/xml
10901       responses:
10902         "200":
10903           description: successful operation
10904           schema:
10905               $ref: "#/getDefinitions/sriov-vfs"
10906         "default":
10907           description: Response codes found in [response codes](https://wiki.onap.org/).
10908       parameters:
10909         - name: hostname
10910           in: path
10911           description: Value from executing hostname on the compute node.
10912           required: true
10913           type: string
10914           example: __HOSTNAME__
10915         - name: interface-name
10916           in: path
10917           description: Name that identifies the physical interface
10918           required: true
10919           type: string
10920           example: __INTERFACE-NAME__
10921         - name: interface-name
10922           in: path
10923           description: Name given to the interface
10924           required: true
10925           type: string
10926           example: __INTERFACE-NAME__
10927         - name: inv-status
10928           in: query
10929           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
10930           required: false
10931           type: string
10932         - name: pserver-id
10933           in: query
10934           description: ID of Pserver
10935           required: false
10936           type: string
10937         - name: in-maint
10938           in: query
10939           required: false
10940           type: boolean
10941         - name: pserver-name2
10942           in: query
10943           description: alternative pserver name
10944           required: false
10945           type: string
10946         - name: prov-status
10947           in: query
10948           description: Trigger for operational monitoring of this resource by Service Assurance systems.
10949           required: false
10950           type: string
10951         - name: interface-id
10952           in: query
10953           description: ID of interface
10954           required: false
10955           type: string
10956         - name: macaddr
10957           in: query
10958           description: MAC address for the interface
10959           required: false
10960           type: string
10961         - name: network-name
10962           in: query
10963           description: Name of the network
10964           required: false
10965           type: string
10966   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
10967     put:
10968       tags:
10969         - CloudInfrastructure
10970       summary: see node definition for valid relationships
10971       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
10972       consumes:
10973         - application/json
10974         - application/xml
10975       produces:
10976         - application/json
10977         - application/xml
10978       responses:
10979         "default":
10980           description: Response codes found in [response codes](https://wiki.onap.org/).
10981       parameters:
10982         - name: hostname
10983           in: path
10984           description: Value from executing hostname on the compute node.
10985           required: true
10986           type: string
10987           example: __HOSTNAME__
10988         - name: interface-name
10989           in: path
10990           description: Name that identifies the physical interface
10991           required: true
10992           type: string
10993           example: __INTERFACE-NAME__
10994         - name: interface-name
10995           in: path
10996           description: Name given to the interface
10997           required: true
10998           type: string
10999           example: __INTERFACE-NAME__
11000         - name: body
11001           in: body
11002           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11003           required: true
11004           schema:
11005             $ref: "#/definitions/relationship"
11006     delete:
11007       tags:
11008         - CloudInfrastructure
11009       summary: delete an existing relationship
11010       description: delete an existing relationship
11011       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
11012       consumes:
11013         - application/json
11014         - application/xml
11015       produces:
11016         - application/json
11017         - application/xml
11018       responses:
11019         "default":
11020           description: Response codes found in [response codes](https://wiki.onap.org/).
11021       parameters:
11022         - name: hostname
11023           in: path
11024           description: Value from executing hostname on the compute node.
11025           required: true
11026           type: string
11027           example: __HOSTNAME__
11028         - name: interface-name
11029           in: path
11030           description: Name that identifies the physical interface
11031           required: true
11032           type: string
11033           example: __INTERFACE-NAME__
11034         - name: interface-name
11035           in: path
11036           description: Name given to the interface
11037           required: true
11038           type: string
11039           example: __INTERFACE-NAME__
11040   /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:
11041     put:
11042       tags:
11043         - CloudInfrastructure
11044       summary: see node definition for valid relationships
11045       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11046       consumes:
11047         - application/json
11048         - application/xml
11049       produces:
11050         - application/json
11051         - application/xml
11052       responses:
11053         "default":
11054           description: Response codes found in [response codes](https://wiki.onap.org/).
11055       parameters:
11056         - name: hostname
11057           in: path
11058           description: Value from executing hostname on the compute node.
11059           required: true
11060           type: string
11061           example: __HOSTNAME__
11062         - name: interface-name
11063           in: path
11064           description: Name that identifies the physical interface
11065           required: true
11066           type: string
11067           example: __INTERFACE-NAME__
11068         - name: interface-name
11069           in: path
11070           description: Name given to the interface
11071           required: true
11072           type: string
11073           example: __INTERFACE-NAME__
11074         - name: l3-interface-ipv4-address
11075           in: path
11076           description: IP address
11077           required: true
11078           type: string
11079           example: __L3-INTERFACE-IPV4-ADDRESS__
11080         - name: body
11081           in: body
11082           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11083           required: true
11084           schema:
11085             $ref: "#/definitions/relationship"
11086     delete:
11087       tags:
11088         - CloudInfrastructure
11089       summary: delete an existing relationship
11090       description: delete an existing relationship
11091       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
11092       consumes:
11093         - application/json
11094         - application/xml
11095       produces:
11096         - application/json
11097         - application/xml
11098       responses:
11099         "default":
11100           description: Response codes found in [response codes](https://wiki.onap.org/).
11101       parameters:
11102         - name: hostname
11103           in: path
11104           description: Value from executing hostname on the compute node.
11105           required: true
11106           type: string
11107           example: __HOSTNAME__
11108         - name: interface-name
11109           in: path
11110           description: Name that identifies the physical interface
11111           required: true
11112           type: string
11113           example: __INTERFACE-NAME__
11114         - name: interface-name
11115           in: path
11116           description: Name given to the interface
11117           required: true
11118           type: string
11119           example: __INTERFACE-NAME__
11120         - name: l3-interface-ipv4-address
11121           in: path
11122           description: IP address
11123           required: true
11124           type: string
11125           example: __L3-INTERFACE-IPV4-ADDRESS__
11126   /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}:
11127     get:
11128       tags:
11129         - CloudInfrastructure
11130       summary: returns l3-interface-ipv4-address-list
11131       description: returns l3-interface-ipv4-address-list
11132       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11133       produces:
11134         - application/json
11135         - application/xml
11136       responses:
11137         "200":
11138           description: successful operation
11139           schema:
11140               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
11141         "default":
11142           description: Response codes found in [response codes](https://wiki.onap.org/).
11143       parameters:
11144         - name: hostname
11145           in: path
11146           description: Value from executing hostname on the compute node.
11147           required: true
11148           type: string
11149           example: __HOSTNAME__
11150         - name: interface-name
11151           in: path
11152           description: Name that identifies the physical interface
11153           required: true
11154           type: string
11155           example: __INTERFACE-NAME__
11156         - name: interface-name
11157           in: path
11158           description: Name given to the interface
11159           required: true
11160           type: string
11161           example: __INTERFACE-NAME__
11162         - name: l3-interface-ipv4-address
11163           in: path
11164           description: IP address
11165           required: true
11166           type: string
11167           example: __L3-INTERFACE-IPV4-ADDRESS__
11168         - name: inv-status
11169           in: query
11170           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11171           required: false
11172           type: string
11173         - name: pserver-id
11174           in: query
11175           description: ID of Pserver
11176           required: false
11177           type: string
11178         - name: in-maint
11179           in: query
11180           required: false
11181           type: boolean
11182         - name: pserver-name2
11183           in: query
11184           description: alternative pserver name
11185           required: false
11186           type: string
11187         - name: prov-status
11188           in: query
11189           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11190           required: false
11191           type: string
11192         - name: interface-id
11193           in: query
11194           description: ID of interface
11195           required: false
11196           type: string
11197         - name: macaddr
11198           in: query
11199           description: MAC address for the interface
11200           required: false
11201           type: string
11202         - name: network-name
11203           in: query
11204           description: Name of the network
11205           required: false
11206           type: string
11207         - name: vlan-id-inner
11208           in: query
11209           description: Inner VLAN tag
11210           required: false
11211           type: integer
11212           format: int64
11213         - name: neutron-network-id
11214           in: query
11215           description: Neutron network id of the interface that address belongs to
11216           required: false
11217           type: string
11218         - name: neutron-subnet-id
11219           in: query
11220           description: Neutron id of subnet that address belongs to
11221           required: false
11222           type: string
11223     put:
11224       tags:
11225         - CloudInfrastructure
11226       summary: create or update an existing l3-interface-ipv4-address-list
11227       description: |
11228         Create or update an existing l3-interface-ipv4-address-list.
11229         #
11230         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11231       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11232       consumes:
11233         - application/json
11234         - application/xml
11235       produces:
11236         - application/json
11237         - application/xml
11238       responses:
11239         "default":
11240           description: Response codes found in [response codes](https://wiki.onap.org/).
11241       parameters:
11242         - name: hostname
11243           in: path
11244           description: Value from executing hostname on the compute node.
11245           required: true
11246           type: string
11247           example: __HOSTNAME__
11248         - name: interface-name
11249           in: path
11250           description: Name that identifies the physical interface
11251           required: true
11252           type: string
11253           example: __INTERFACE-NAME__
11254         - name: interface-name
11255           in: path
11256           description: Name given to the interface
11257           required: true
11258           type: string
11259           example: __INTERFACE-NAME__
11260         - name: l3-interface-ipv4-address
11261           in: path
11262           description: IP address
11263           required: true
11264           type: string
11265           example: __L3-INTERFACE-IPV4-ADDRESS__
11266         - name: body
11267           in: body
11268           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
11269           required: true
11270           schema:
11271             $ref: "#/definitions/l3-interface-ipv4-address-list"
11272     patch:
11273       tags:
11274         - CloudInfrastructure
11275       summary: update an existing l3-interface-ipv4-address-list
11276       description: |
11277         Update an existing l3-interface-ipv4-address-list
11278         #
11279         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11280         The PUT operation will entirely replace an existing object.
11281         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11282         #
11283         Other differences between PUT and PATCH are:
11284         #
11285         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11286         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11287         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11288       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11289       consumes:
11290         - application/json
11291         - application/xml
11292       produces:
11293         - application/json
11294         - application/xml
11295       responses:
11296         "default":
11297           description: Response codes found in [response codes](https://wiki.onap.org/).
11298       parameters:
11299         - name: hostname
11300           in: path
11301           description: Value from executing hostname on the compute node.
11302           required: true
11303           type: string
11304           example: __HOSTNAME__
11305         - name: interface-name
11306           in: path
11307           description: Name that identifies the physical interface
11308           required: true
11309           type: string
11310           example: __INTERFACE-NAME__
11311         - name: interface-name
11312           in: path
11313           description: Name given to the interface
11314           required: true
11315           type: string
11316           example: __INTERFACE-NAME__
11317         - name: l3-interface-ipv4-address
11318           in: path
11319           description: IP address
11320           required: true
11321           type: string
11322           example: __L3-INTERFACE-IPV4-ADDRESS__
11323         - name: body
11324           in: body
11325           description: l3-interface-ipv4-address-list object that needs to be created or updated.
11326           required: true
11327           schema:
11328             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
11329     delete:
11330       tags:
11331         - CloudInfrastructure
11332       summary: delete an existing l3-interface-ipv4-address-list
11333       description: delete an existing l3-interface-ipv4-address-list
11334       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
11335       consumes:
11336         - application/json
11337         - application/xml
11338       produces:
11339         - application/json
11340         - application/xml
11341       responses:
11342         "default":
11343           description: Response codes found in [response codes](https://wiki.onap.org/).
11344       parameters:
11345         - name: hostname
11346           in: path
11347           description: Value from executing hostname on the compute node.
11348           required: true
11349           type: string
11350           example: __HOSTNAME__
11351         - name: interface-name
11352           in: path
11353           description: Name that identifies the physical interface
11354           required: true
11355           type: string
11356           example: __INTERFACE-NAME__
11357         - name: interface-name
11358           in: path
11359           description: Name given to the interface
11360           required: true
11361           type: string
11362           example: __INTERFACE-NAME__
11363         - name: l3-interface-ipv4-address
11364           in: path
11365           description: IP address
11366           required: true
11367           type: string
11368           example: __L3-INTERFACE-IPV4-ADDRESS__
11369         - name: resource-version
11370           in: query
11371           description: resource-version for concurrency
11372           required: true
11373           type: string
11374   /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:
11375     put:
11376       tags:
11377         - CloudInfrastructure
11378       summary: see node definition for valid relationships
11379       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11380       consumes:
11381         - application/json
11382         - application/xml
11383       produces:
11384         - application/json
11385         - application/xml
11386       responses:
11387         "default":
11388           description: Response codes found in [response codes](https://wiki.onap.org/).
11389       parameters:
11390         - name: hostname
11391           in: path
11392           description: Value from executing hostname on the compute node.
11393           required: true
11394           type: string
11395           example: __HOSTNAME__
11396         - name: interface-name
11397           in: path
11398           description: Name that identifies the physical interface
11399           required: true
11400           type: string
11401           example: __INTERFACE-NAME__
11402         - name: interface-name
11403           in: path
11404           description: Name given to the interface
11405           required: true
11406           type: string
11407           example: __INTERFACE-NAME__
11408         - name: l3-interface-ipv6-address
11409           in: path
11410           description: IP address
11411           required: true
11412           type: string
11413           example: __L3-INTERFACE-IPV6-ADDRESS__
11414         - name: body
11415           in: body
11416           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11417           required: true
11418           schema:
11419             $ref: "#/definitions/relationship"
11420     delete:
11421       tags:
11422         - CloudInfrastructure
11423       summary: delete an existing relationship
11424       description: delete an existing relationship
11425       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
11426       consumes:
11427         - application/json
11428         - application/xml
11429       produces:
11430         - application/json
11431         - application/xml
11432       responses:
11433         "default":
11434           description: Response codes found in [response codes](https://wiki.onap.org/).
11435       parameters:
11436         - name: hostname
11437           in: path
11438           description: Value from executing hostname on the compute node.
11439           required: true
11440           type: string
11441           example: __HOSTNAME__
11442         - name: interface-name
11443           in: path
11444           description: Name that identifies the physical interface
11445           required: true
11446           type: string
11447           example: __INTERFACE-NAME__
11448         - name: interface-name
11449           in: path
11450           description: Name given to the interface
11451           required: true
11452           type: string
11453           example: __INTERFACE-NAME__
11454         - name: l3-interface-ipv6-address
11455           in: path
11456           description: IP address
11457           required: true
11458           type: string
11459           example: __L3-INTERFACE-IPV6-ADDRESS__
11460   /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}:
11461     get:
11462       tags:
11463         - CloudInfrastructure
11464       summary: returns l3-interface-ipv6-address-list
11465       description: returns l3-interface-ipv6-address-list
11466       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11467       produces:
11468         - application/json
11469         - application/xml
11470       responses:
11471         "200":
11472           description: successful operation
11473           schema:
11474               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
11475         "default":
11476           description: Response codes found in [response codes](https://wiki.onap.org/).
11477       parameters:
11478         - name: hostname
11479           in: path
11480           description: Value from executing hostname on the compute node.
11481           required: true
11482           type: string
11483           example: __HOSTNAME__
11484         - name: interface-name
11485           in: path
11486           description: Name that identifies the physical interface
11487           required: true
11488           type: string
11489           example: __INTERFACE-NAME__
11490         - name: interface-name
11491           in: path
11492           description: Name given to the interface
11493           required: true
11494           type: string
11495           example: __INTERFACE-NAME__
11496         - name: l3-interface-ipv6-address
11497           in: path
11498           description: IP address
11499           required: true
11500           type: string
11501           example: __L3-INTERFACE-IPV6-ADDRESS__
11502         - name: inv-status
11503           in: query
11504           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11505           required: false
11506           type: string
11507         - name: pserver-id
11508           in: query
11509           description: ID of Pserver
11510           required: false
11511           type: string
11512         - name: in-maint
11513           in: query
11514           required: false
11515           type: boolean
11516         - name: pserver-name2
11517           in: query
11518           description: alternative pserver name
11519           required: false
11520           type: string
11521         - name: prov-status
11522           in: query
11523           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11524           required: false
11525           type: string
11526         - name: interface-id
11527           in: query
11528           description: ID of interface
11529           required: false
11530           type: string
11531         - name: macaddr
11532           in: query
11533           description: MAC address for the interface
11534           required: false
11535           type: string
11536         - name: network-name
11537           in: query
11538           description: Name of the network
11539           required: false
11540           type: string
11541         - name: vlan-id-inner
11542           in: query
11543           description: Inner VLAN tag
11544           required: false
11545           type: integer
11546           format: int64
11547         - name: neutron-network-id
11548           in: query
11549           description: Neutron network id of the interface that address belongs to
11550           required: false
11551           type: string
11552         - name: neutron-subnet-id
11553           in: query
11554           description: Neutron id of subnet that address belongs to
11555           required: false
11556           type: string
11557     put:
11558       tags:
11559         - CloudInfrastructure
11560       summary: create or update an existing l3-interface-ipv6-address-list
11561       description: |
11562         Create or update an existing l3-interface-ipv6-address-list.
11563         #
11564         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11565       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11566       consumes:
11567         - application/json
11568         - application/xml
11569       produces:
11570         - application/json
11571         - application/xml
11572       responses:
11573         "default":
11574           description: Response codes found in [response codes](https://wiki.onap.org/).
11575       parameters:
11576         - name: hostname
11577           in: path
11578           description: Value from executing hostname on the compute node.
11579           required: true
11580           type: string
11581           example: __HOSTNAME__
11582         - name: interface-name
11583           in: path
11584           description: Name that identifies the physical interface
11585           required: true
11586           type: string
11587           example: __INTERFACE-NAME__
11588         - name: interface-name
11589           in: path
11590           description: Name given to the interface
11591           required: true
11592           type: string
11593           example: __INTERFACE-NAME__
11594         - name: l3-interface-ipv6-address
11595           in: path
11596           description: IP address
11597           required: true
11598           type: string
11599           example: __L3-INTERFACE-IPV6-ADDRESS__
11600         - name: body
11601           in: body
11602           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
11603           required: true
11604           schema:
11605             $ref: "#/definitions/l3-interface-ipv6-address-list"
11606     patch:
11607       tags:
11608         - CloudInfrastructure
11609       summary: update an existing l3-interface-ipv6-address-list
11610       description: |
11611         Update an existing l3-interface-ipv6-address-list
11612         #
11613         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11614         The PUT operation will entirely replace an existing object.
11615         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11616         #
11617         Other differences between PUT and PATCH are:
11618         #
11619         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11620         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11621         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11622       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11623       consumes:
11624         - application/json
11625         - application/xml
11626       produces:
11627         - application/json
11628         - application/xml
11629       responses:
11630         "default":
11631           description: Response codes found in [response codes](https://wiki.onap.org/).
11632       parameters:
11633         - name: hostname
11634           in: path
11635           description: Value from executing hostname on the compute node.
11636           required: true
11637           type: string
11638           example: __HOSTNAME__
11639         - name: interface-name
11640           in: path
11641           description: Name that identifies the physical interface
11642           required: true
11643           type: string
11644           example: __INTERFACE-NAME__
11645         - name: interface-name
11646           in: path
11647           description: Name given to the interface
11648           required: true
11649           type: string
11650           example: __INTERFACE-NAME__
11651         - name: l3-interface-ipv6-address
11652           in: path
11653           description: IP address
11654           required: true
11655           type: string
11656           example: __L3-INTERFACE-IPV6-ADDRESS__
11657         - name: body
11658           in: body
11659           description: l3-interface-ipv6-address-list object that needs to be created or updated.
11660           required: true
11661           schema:
11662             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
11663     delete:
11664       tags:
11665         - CloudInfrastructure
11666       summary: delete an existing l3-interface-ipv6-address-list
11667       description: delete an existing l3-interface-ipv6-address-list
11668       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
11669       consumes:
11670         - application/json
11671         - application/xml
11672       produces:
11673         - application/json
11674         - application/xml
11675       responses:
11676         "default":
11677           description: Response codes found in [response codes](https://wiki.onap.org/).
11678       parameters:
11679         - name: hostname
11680           in: path
11681           description: Value from executing hostname on the compute node.
11682           required: true
11683           type: string
11684           example: __HOSTNAME__
11685         - name: interface-name
11686           in: path
11687           description: Name that identifies the physical interface
11688           required: true
11689           type: string
11690           example: __INTERFACE-NAME__
11691         - name: interface-name
11692           in: path
11693           description: Name given to the interface
11694           required: true
11695           type: string
11696           example: __INTERFACE-NAME__
11697         - name: l3-interface-ipv6-address
11698           in: path
11699           description: IP address
11700           required: true
11701           type: string
11702           example: __L3-INTERFACE-IPV6-ADDRESS__
11703         - name: resource-version
11704           in: query
11705           description: resource-version for concurrency
11706           required: true
11707           type: string
11708   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
11709     get:
11710       tags:
11711         - CloudInfrastructure
11712       summary: returns l-interface
11713       description: returns l-interface
11714       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11715       produces:
11716         - application/json
11717         - application/xml
11718       responses:
11719         "200":
11720           description: successful operation
11721           schema:
11722               $ref: "#/getDefinitions/l-interface"
11723         "default":
11724           description: Response codes found in [response codes](https://wiki.onap.org/).
11725       parameters:
11726         - name: hostname
11727           in: path
11728           description: Value from executing hostname on the compute node.
11729           required: true
11730           type: string
11731           example: __HOSTNAME__
11732         - name: interface-name
11733           in: path
11734           description: Name that identifies the physical interface
11735           required: true
11736           type: string
11737           example: __INTERFACE-NAME__
11738         - name: interface-name
11739           in: path
11740           description: Name given to the interface
11741           required: true
11742           type: string
11743           example: __INTERFACE-NAME__
11744         - name: inv-status
11745           in: query
11746           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11747           required: false
11748           type: string
11749         - name: pserver-id
11750           in: query
11751           description: ID of Pserver
11752           required: false
11753           type: string
11754         - name: in-maint
11755           in: query
11756           required: false
11757           type: boolean
11758         - name: pserver-name2
11759           in: query
11760           description: alternative pserver name
11761           required: false
11762           type: string
11763         - name: prov-status
11764           in: query
11765           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11766           required: false
11767           type: string
11768         - name: interface-id
11769           in: query
11770           description: ID of interface
11771           required: false
11772           type: string
11773         - name: macaddr
11774           in: query
11775           description: MAC address for the interface
11776           required: false
11777           type: string
11778         - name: network-name
11779           in: query
11780           description: Name of the network
11781           required: false
11782           type: string
11783     put:
11784       tags:
11785         - CloudInfrastructure
11786       summary: create or update an existing l-interface
11787       description: |
11788         Create or update an existing l-interface.
11789         #
11790         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
11791       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11792       consumes:
11793         - application/json
11794         - application/xml
11795       produces:
11796         - application/json
11797         - application/xml
11798       responses:
11799         "default":
11800           description: Response codes found in [response codes](https://wiki.onap.org/).
11801       parameters:
11802         - name: hostname
11803           in: path
11804           description: Value from executing hostname on the compute node.
11805           required: true
11806           type: string
11807           example: __HOSTNAME__
11808         - name: interface-name
11809           in: path
11810           description: Name that identifies the physical interface
11811           required: true
11812           type: string
11813           example: __INTERFACE-NAME__
11814         - name: interface-name
11815           in: path
11816           description: Name given to the interface
11817           required: true
11818           type: string
11819           example: __INTERFACE-NAME__
11820         - name: body
11821           in: body
11822           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)
11823           required: true
11824           schema:
11825             $ref: "#/definitions/l-interface"
11826     patch:
11827       tags:
11828         - CloudInfrastructure
11829       summary: update an existing l-interface
11830       description: |
11831         Update an existing l-interface
11832         #
11833         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
11834         The PUT operation will entirely replace an existing object.
11835         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
11836         #
11837         Other differences between PUT and PATCH are:
11838         #
11839         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
11840         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
11841         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
11842       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11843       consumes:
11844         - application/json
11845         - application/xml
11846       produces:
11847         - application/json
11848         - application/xml
11849       responses:
11850         "default":
11851           description: Response codes found in [response codes](https://wiki.onap.org/).
11852       parameters:
11853         - name: hostname
11854           in: path
11855           description: Value from executing hostname on the compute node.
11856           required: true
11857           type: string
11858           example: __HOSTNAME__
11859         - name: interface-name
11860           in: path
11861           description: Name that identifies the physical interface
11862           required: true
11863           type: string
11864           example: __INTERFACE-NAME__
11865         - name: interface-name
11866           in: path
11867           description: Name given to the interface
11868           required: true
11869           type: string
11870           example: __INTERFACE-NAME__
11871         - name: body
11872           in: body
11873           description: l-interface object that needs to be created or updated.
11874           required: true
11875           schema:
11876             $ref: "#/patchDefinitions/l-interface"
11877     delete:
11878       tags:
11879         - CloudInfrastructure
11880       summary: delete an existing l-interface
11881       description: delete an existing l-interface
11882       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface
11883       consumes:
11884         - application/json
11885         - application/xml
11886       produces:
11887         - application/json
11888         - application/xml
11889       responses:
11890         "default":
11891           description: Response codes found in [response codes](https://wiki.onap.org/).
11892       parameters:
11893         - name: hostname
11894           in: path
11895           description: Value from executing hostname on the compute node.
11896           required: true
11897           type: string
11898           example: __HOSTNAME__
11899         - name: interface-name
11900           in: path
11901           description: Name that identifies the physical interface
11902           required: true
11903           type: string
11904           example: __INTERFACE-NAME__
11905         - name: interface-name
11906           in: path
11907           description: Name given to the interface
11908           required: true
11909           type: string
11910           example: __INTERFACE-NAME__
11911         - name: resource-version
11912           in: query
11913           description: resource-version for concurrency
11914           required: true
11915           type: string
11916   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces:
11917     get:
11918       tags:
11919         - CloudInfrastructure
11920       summary: returns l-interfaces
11921       description: returns l-interfaces
11922       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfaces
11923       produces:
11924         - application/json
11925         - application/xml
11926       responses:
11927         "200":
11928           description: successful operation
11929           schema:
11930               $ref: "#/getDefinitions/l-interfaces"
11931         "default":
11932           description: Response codes found in [response codes](https://wiki.onap.org/).
11933       parameters:
11934         - name: hostname
11935           in: path
11936           description: Value from executing hostname on the compute node.
11937           required: true
11938           type: string
11939           example: __HOSTNAME__
11940         - name: interface-name
11941           in: path
11942           description: Name that identifies the physical interface
11943           required: true
11944           type: string
11945           example: __INTERFACE-NAME__
11946         - name: inv-status
11947           in: query
11948           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
11949           required: false
11950           type: string
11951         - name: pserver-id
11952           in: query
11953           description: ID of Pserver
11954           required: false
11955           type: string
11956         - name: in-maint
11957           in: query
11958           required: false
11959           type: boolean
11960         - name: pserver-name2
11961           in: query
11962           description: alternative pserver name
11963           required: false
11964           type: string
11965         - name: prov-status
11966           in: query
11967           description: Trigger for operational monitoring of this resource by Service Assurance systems.
11968           required: false
11969           type: string
11970   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}:
11971     get:
11972       tags:
11973         - CloudInfrastructure
11974       summary: returns p-interface
11975       description: returns p-interface
11976       operationId: getCloudInfrastructurePserversPserverPInterfacesPInterface
11977       produces:
11978         - application/json
11979         - application/xml
11980       responses:
11981         "200":
11982           description: successful operation
11983           schema:
11984               $ref: "#/getDefinitions/p-interface"
11985         "default":
11986           description: Response codes found in [response codes](https://wiki.onap.org/).
11987       parameters:
11988         - name: hostname
11989           in: path
11990           description: Value from executing hostname on the compute node.
11991           required: true
11992           type: string
11993           example: __HOSTNAME__
11994         - name: interface-name
11995           in: path
11996           description: Name that identifies the physical interface
11997           required: true
11998           type: string
11999           example: __INTERFACE-NAME__
12000         - name: inv-status
12001           in: query
12002           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12003           required: false
12004           type: string
12005         - name: pserver-id
12006           in: query
12007           description: ID of Pserver
12008           required: false
12009           type: string
12010         - name: in-maint
12011           in: query
12012           required: false
12013           type: boolean
12014         - name: pserver-name2
12015           in: query
12016           description: alternative pserver name
12017           required: false
12018           type: string
12019         - name: prov-status
12020           in: query
12021           description: Trigger for operational monitoring of this resource by Service Assurance systems.
12022           required: false
12023           type: string
12024     put:
12025       tags:
12026         - CloudInfrastructure
12027       summary: create or update an existing p-interface
12028       description: |
12029         Create or update an existing p-interface.
12030         #
12031         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12032       operationId: createOrUpdateCloudInfrastructurePserversPserverPInterfacesPInterface
12033       consumes:
12034         - application/json
12035         - application/xml
12036       produces:
12037         - application/json
12038         - application/xml
12039       responses:
12040         "default":
12041           description: Response codes found in [response codes](https://wiki.onap.org/).
12042       parameters:
12043         - name: hostname
12044           in: path
12045           description: Value from executing hostname on the compute node.
12046           required: true
12047           type: string
12048           example: __HOSTNAME__
12049         - name: interface-name
12050           in: path
12051           description: Name that identifies the physical interface
12052           required: true
12053           type: string
12054           example: __INTERFACE-NAME__
12055         - name: body
12056           in: body
12057           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)
12058           required: true
12059           schema:
12060             $ref: "#/definitions/p-interface"
12061     patch:
12062       tags:
12063         - CloudInfrastructure
12064       summary: update an existing p-interface
12065       description: |
12066         Update an existing p-interface
12067         #
12068         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12069         The PUT operation will entirely replace an existing object.
12070         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12071         #
12072         Other differences between PUT and PATCH are:
12073         #
12074         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12075         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12076         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12077       operationId: UpdateCloudInfrastructurePserversPserverPInterfacesPInterface
12078       consumes:
12079         - application/json
12080         - application/xml
12081       produces:
12082         - application/json
12083         - application/xml
12084       responses:
12085         "default":
12086           description: Response codes found in [response codes](https://wiki.onap.org/).
12087       parameters:
12088         - name: hostname
12089           in: path
12090           description: Value from executing hostname on the compute node.
12091           required: true
12092           type: string
12093           example: __HOSTNAME__
12094         - name: interface-name
12095           in: path
12096           description: Name that identifies the physical interface
12097           required: true
12098           type: string
12099           example: __INTERFACE-NAME__
12100         - name: body
12101           in: body
12102           description: p-interface object that needs to be created or updated.
12103           required: true
12104           schema:
12105             $ref: "#/patchDefinitions/p-interface"
12106     delete:
12107       tags:
12108         - CloudInfrastructure
12109       summary: delete an existing p-interface
12110       description: delete an existing p-interface
12111       operationId: deleteCloudInfrastructurePserversPserverPInterfacesPInterface
12112       consumes:
12113         - application/json
12114         - application/xml
12115       produces:
12116         - application/json
12117         - application/xml
12118       responses:
12119         "default":
12120           description: Response codes found in [response codes](https://wiki.onap.org/).
12121       parameters:
12122         - name: hostname
12123           in: path
12124           description: Value from executing hostname on the compute node.
12125           required: true
12126           type: string
12127           example: __HOSTNAME__
12128         - name: interface-name
12129           in: path
12130           description: Name that identifies the physical interface
12131           required: true
12132           type: string
12133           example: __INTERFACE-NAME__
12134         - name: resource-version
12135           in: query
12136           description: resource-version for concurrency
12137           required: true
12138           type: string
12139   /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces:
12140     get:
12141       tags:
12142         - CloudInfrastructure
12143       summary: returns p-interfaces
12144       description: returns p-interfaces
12145       operationId: getCloudInfrastructurePserversPserverPInterfaces
12146       produces:
12147         - application/json
12148         - application/xml
12149       responses:
12150         "200":
12151           description: successful operation
12152           schema:
12153               $ref: "#/getDefinitions/p-interfaces"
12154         "default":
12155           description: Response codes found in [response codes](https://wiki.onap.org/).
12156       parameters:
12157         - name: hostname
12158           in: path
12159           description: Value from executing hostname on the compute node.
12160           required: true
12161           type: string
12162           example: __HOSTNAME__
12163         - name: inv-status
12164           in: query
12165           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12166           required: false
12167           type: string
12168         - name: pserver-id
12169           in: query
12170           description: ID of Pserver
12171           required: false
12172           type: string
12173         - name: in-maint
12174           in: query
12175           required: false
12176           type: boolean
12177         - name: pserver-name2
12178           in: query
12179           description: alternative pserver name
12180           required: false
12181           type: string
12182   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
12183     put:
12184       tags:
12185         - CloudInfrastructure
12186       summary: see node definition for valid relationships
12187       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
12188       consumes:
12189         - application/json
12190         - application/xml
12191       produces:
12192         - application/json
12193         - application/xml
12194       responses:
12195         "default":
12196           description: Response codes found in [response codes](https://wiki.onap.org/).
12197       parameters:
12198         - name: hostname
12199           in: path
12200           description: Value from executing hostname on the compute node.
12201           required: true
12202           type: string
12203           example: __HOSTNAME__
12204         - name: interface-name
12205           in: path
12206           description: Name that identifies the link aggregate interface
12207           required: true
12208           type: string
12209           example: __INTERFACE-NAME__
12210         - name: body
12211           in: body
12212           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
12213           required: true
12214           schema:
12215             $ref: "#/definitions/relationship"
12216     delete:
12217       tags:
12218         - CloudInfrastructure
12219       summary: delete an existing relationship
12220       description: delete an existing relationship
12221       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceRelationshipListRelationship
12222       consumes:
12223         - application/json
12224         - application/xml
12225       produces:
12226         - application/json
12227         - application/xml
12228       responses:
12229         "default":
12230           description: Response codes found in [response codes](https://wiki.onap.org/).
12231       parameters:
12232         - name: hostname
12233           in: path
12234           description: Value from executing hostname on the compute node.
12235           required: true
12236           type: string
12237           example: __HOSTNAME__
12238         - name: interface-name
12239           in: path
12240           description: Name that identifies the link aggregate interface
12241           required: true
12242           type: string
12243           example: __INTERFACE-NAME__
12244   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
12245     put:
12246       tags:
12247         - CloudInfrastructure
12248       summary: see node definition for valid relationships
12249       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12250       consumes:
12251         - application/json
12252         - application/xml
12253       produces:
12254         - application/json
12255         - application/xml
12256       responses:
12257         "default":
12258           description: Response codes found in [response codes](https://wiki.onap.org/).
12259       parameters:
12260         - name: hostname
12261           in: path
12262           description: Value from executing hostname on the compute node.
12263           required: true
12264           type: string
12265           example: __HOSTNAME__
12266         - name: interface-name
12267           in: path
12268           description: Name that identifies the link aggregate interface
12269           required: true
12270           type: string
12271           example: __INTERFACE-NAME__
12272         - name: interface-name
12273           in: path
12274           description: Name given to the interface
12275           required: true
12276           type: string
12277           example: __INTERFACE-NAME__
12278         - name: vlan-interface
12279           in: path
12280           description: String that identifies the interface
12281           required: true
12282           type: string
12283           example: __VLAN-INTERFACE__
12284         - name: body
12285           in: body
12286           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
12287           required: true
12288           schema:
12289             $ref: "#/definitions/relationship"
12290     delete:
12291       tags:
12292         - CloudInfrastructure
12293       summary: delete an existing relationship
12294       description: delete an existing relationship
12295       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
12296       consumes:
12297         - application/json
12298         - application/xml
12299       produces:
12300         - application/json
12301         - application/xml
12302       responses:
12303         "default":
12304           description: Response codes found in [response codes](https://wiki.onap.org/).
12305       parameters:
12306         - name: hostname
12307           in: path
12308           description: Value from executing hostname on the compute node.
12309           required: true
12310           type: string
12311           example: __HOSTNAME__
12312         - name: interface-name
12313           in: path
12314           description: Name that identifies the link aggregate interface
12315           required: true
12316           type: string
12317           example: __INTERFACE-NAME__
12318         - name: interface-name
12319           in: path
12320           description: Name given to the interface
12321           required: true
12322           type: string
12323           example: __INTERFACE-NAME__
12324         - name: vlan-interface
12325           in: path
12326           description: String that identifies the interface
12327           required: true
12328           type: string
12329           example: __VLAN-INTERFACE__
12330   /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:
12331     put:
12332       tags:
12333         - CloudInfrastructure
12334       summary: see node definition for valid relationships
12335       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12336       consumes:
12337         - application/json
12338         - application/xml
12339       produces:
12340         - application/json
12341         - application/xml
12342       responses:
12343         "default":
12344           description: Response codes found in [response codes](https://wiki.onap.org/).
12345       parameters:
12346         - name: hostname
12347           in: path
12348           description: Value from executing hostname on the compute node.
12349           required: true
12350           type: string
12351           example: __HOSTNAME__
12352         - name: interface-name
12353           in: path
12354           description: Name that identifies the link aggregate interface
12355           required: true
12356           type: string
12357           example: __INTERFACE-NAME__
12358         - name: interface-name
12359           in: path
12360           description: Name given to the interface
12361           required: true
12362           type: string
12363           example: __INTERFACE-NAME__
12364         - name: vlan-interface
12365           in: path
12366           description: String that identifies the interface
12367           required: true
12368           type: string
12369           example: __VLAN-INTERFACE__
12370         - name: l3-interface-ipv4-address
12371           in: path
12372           description: IP address
12373           required: true
12374           type: string
12375           example: __L3-INTERFACE-IPV4-ADDRESS__
12376         - name: body
12377           in: body
12378           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12379           required: true
12380           schema:
12381             $ref: "#/definitions/relationship"
12382     delete:
12383       tags:
12384         - CloudInfrastructure
12385       summary: delete an existing relationship
12386       description: delete an existing relationship
12387       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
12388       consumes:
12389         - application/json
12390         - application/xml
12391       produces:
12392         - application/json
12393         - application/xml
12394       responses:
12395         "default":
12396           description: Response codes found in [response codes](https://wiki.onap.org/).
12397       parameters:
12398         - name: hostname
12399           in: path
12400           description: Value from executing hostname on the compute node.
12401           required: true
12402           type: string
12403           example: __HOSTNAME__
12404         - name: interface-name
12405           in: path
12406           description: Name that identifies the link aggregate interface
12407           required: true
12408           type: string
12409           example: __INTERFACE-NAME__
12410         - name: interface-name
12411           in: path
12412           description: Name given to the interface
12413           required: true
12414           type: string
12415           example: __INTERFACE-NAME__
12416         - name: vlan-interface
12417           in: path
12418           description: String that identifies the interface
12419           required: true
12420           type: string
12421           example: __VLAN-INTERFACE__
12422         - name: l3-interface-ipv4-address
12423           in: path
12424           description: IP address
12425           required: true
12426           type: string
12427           example: __L3-INTERFACE-IPV4-ADDRESS__
12428   /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}:
12429     get:
12430       tags:
12431         - CloudInfrastructure
12432       summary: returns l3-interface-ipv4-address-list
12433       description: returns l3-interface-ipv4-address-list
12434       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12435       produces:
12436         - application/json
12437         - application/xml
12438       responses:
12439         "200":
12440           description: successful operation
12441           schema:
12442               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
12443         "default":
12444           description: Response codes found in [response codes](https://wiki.onap.org/).
12445       parameters:
12446         - name: hostname
12447           in: path
12448           description: Value from executing hostname on the compute node.
12449           required: true
12450           type: string
12451           example: __HOSTNAME__
12452         - name: interface-name
12453           in: path
12454           description: Name that identifies the link aggregate interface
12455           required: true
12456           type: string
12457           example: __INTERFACE-NAME__
12458         - name: interface-name
12459           in: path
12460           description: Name given to the interface
12461           required: true
12462           type: string
12463           example: __INTERFACE-NAME__
12464         - name: vlan-interface
12465           in: path
12466           description: String that identifies the interface
12467           required: true
12468           type: string
12469           example: __VLAN-INTERFACE__
12470         - name: l3-interface-ipv4-address
12471           in: path
12472           description: IP address
12473           required: true
12474           type: string
12475           example: __L3-INTERFACE-IPV4-ADDRESS__
12476         - name: inv-status
12477           in: query
12478           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12479           required: false
12480           type: string
12481         - name: pserver-id
12482           in: query
12483           description: ID of Pserver
12484           required: false
12485           type: string
12486         - name: in-maint
12487           in: query
12488           required: false
12489           type: boolean
12490         - name: pserver-name2
12491           in: query
12492           description: alternative pserver name
12493           required: false
12494           type: string
12495         - name: interface-id
12496           in: query
12497           description: ID of interface
12498           required: false
12499           type: string
12500         - name: interface-role
12501           in: query
12502           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12503           required: false
12504           type: string
12505         - name: interface-id
12506           in: query
12507           description: ID of interface
12508           required: false
12509           type: string
12510         - name: macaddr
12511           in: query
12512           description: MAC address for the interface
12513           required: false
12514           type: string
12515         - name: network-name
12516           in: query
12517           description: Name of the network
12518           required: false
12519           type: string
12520         - name: vlan-id-inner
12521           in: query
12522           description: Inner VLAN tag
12523           required: false
12524           type: integer
12525           format: int64
12526         - name: vpn-key
12527           in: query
12528           description: This indicates the customers VPN ID associated with this vlan
12529           required: false
12530           type: string
12531         - name: vlan-id-inner
12532           in: query
12533           description: Inner VLAN tag
12534           required: false
12535           type: integer
12536           format: int64
12537         - name: neutron-network-id
12538           in: query
12539           description: Neutron network id of the interface that address belongs to
12540           required: false
12541           type: string
12542         - name: neutron-subnet-id
12543           in: query
12544           description: Neutron id of subnet that address belongs to
12545           required: false
12546           type: string
12547     put:
12548       tags:
12549         - CloudInfrastructure
12550       summary: create or update an existing l3-interface-ipv4-address-list
12551       description: |
12552         Create or update an existing l3-interface-ipv4-address-list.
12553         #
12554         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12555       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12556       consumes:
12557         - application/json
12558         - application/xml
12559       produces:
12560         - application/json
12561         - application/xml
12562       responses:
12563         "default":
12564           description: Response codes found in [response codes](https://wiki.onap.org/).
12565       parameters:
12566         - name: hostname
12567           in: path
12568           description: Value from executing hostname on the compute node.
12569           required: true
12570           type: string
12571           example: __HOSTNAME__
12572         - name: interface-name
12573           in: path
12574           description: Name that identifies the link aggregate interface
12575           required: true
12576           type: string
12577           example: __INTERFACE-NAME__
12578         - name: interface-name
12579           in: path
12580           description: Name given to the interface
12581           required: true
12582           type: string
12583           example: __INTERFACE-NAME__
12584         - name: vlan-interface
12585           in: path
12586           description: String that identifies the interface
12587           required: true
12588           type: string
12589           example: __VLAN-INTERFACE__
12590         - name: l3-interface-ipv4-address
12591           in: path
12592           description: IP address
12593           required: true
12594           type: string
12595           example: __L3-INTERFACE-IPV4-ADDRESS__
12596         - name: body
12597           in: body
12598           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
12599           required: true
12600           schema:
12601             $ref: "#/definitions/l3-interface-ipv4-address-list"
12602     patch:
12603       tags:
12604         - CloudInfrastructure
12605       summary: update an existing l3-interface-ipv4-address-list
12606       description: |
12607         Update an existing l3-interface-ipv4-address-list
12608         #
12609         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12610         The PUT operation will entirely replace an existing object.
12611         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12612         #
12613         Other differences between PUT and PATCH are:
12614         #
12615         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
12616         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
12617         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
12618       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12619       consumes:
12620         - application/json
12621         - application/xml
12622       produces:
12623         - application/json
12624         - application/xml
12625       responses:
12626         "default":
12627           description: Response codes found in [response codes](https://wiki.onap.org/).
12628       parameters:
12629         - name: hostname
12630           in: path
12631           description: Value from executing hostname on the compute node.
12632           required: true
12633           type: string
12634           example: __HOSTNAME__
12635         - name: interface-name
12636           in: path
12637           description: Name that identifies the link aggregate interface
12638           required: true
12639           type: string
12640           example: __INTERFACE-NAME__
12641         - name: interface-name
12642           in: path
12643           description: Name given to the interface
12644           required: true
12645           type: string
12646           example: __INTERFACE-NAME__
12647         - name: vlan-interface
12648           in: path
12649           description: String that identifies the interface
12650           required: true
12651           type: string
12652           example: __VLAN-INTERFACE__
12653         - name: l3-interface-ipv4-address
12654           in: path
12655           description: IP address
12656           required: true
12657           type: string
12658           example: __L3-INTERFACE-IPV4-ADDRESS__
12659         - name: body
12660           in: body
12661           description: l3-interface-ipv4-address-list object that needs to be created or updated.
12662           required: true
12663           schema:
12664             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
12665     delete:
12666       tags:
12667         - CloudInfrastructure
12668       summary: delete an existing l3-interface-ipv4-address-list
12669       description: delete an existing l3-interface-ipv4-address-list
12670       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
12671       consumes:
12672         - application/json
12673         - application/xml
12674       produces:
12675         - application/json
12676         - application/xml
12677       responses:
12678         "default":
12679           description: Response codes found in [response codes](https://wiki.onap.org/).
12680       parameters:
12681         - name: hostname
12682           in: path
12683           description: Value from executing hostname on the compute node.
12684           required: true
12685           type: string
12686           example: __HOSTNAME__
12687         - name: interface-name
12688           in: path
12689           description: Name that identifies the link aggregate interface
12690           required: true
12691           type: string
12692           example: __INTERFACE-NAME__
12693         - name: interface-name
12694           in: path
12695           description: Name given to the interface
12696           required: true
12697           type: string
12698           example: __INTERFACE-NAME__
12699         - name: vlan-interface
12700           in: path
12701           description: String that identifies the interface
12702           required: true
12703           type: string
12704           example: __VLAN-INTERFACE__
12705         - name: l3-interface-ipv4-address
12706           in: path
12707           description: IP address
12708           required: true
12709           type: string
12710           example: __L3-INTERFACE-IPV4-ADDRESS__
12711         - name: resource-version
12712           in: query
12713           description: resource-version for concurrency
12714           required: true
12715           type: string
12716   /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:
12717     put:
12718       tags:
12719         - CloudInfrastructure
12720       summary: see node definition for valid relationships
12721       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12722       consumes:
12723         - application/json
12724         - application/xml
12725       produces:
12726         - application/json
12727         - application/xml
12728       responses:
12729         "default":
12730           description: Response codes found in [response codes](https://wiki.onap.org/).
12731       parameters:
12732         - name: hostname
12733           in: path
12734           description: Value from executing hostname on the compute node.
12735           required: true
12736           type: string
12737           example: __HOSTNAME__
12738         - name: interface-name
12739           in: path
12740           description: Name that identifies the link aggregate interface
12741           required: true
12742           type: string
12743           example: __INTERFACE-NAME__
12744         - name: interface-name
12745           in: path
12746           description: Name given to the interface
12747           required: true
12748           type: string
12749           example: __INTERFACE-NAME__
12750         - name: vlan-interface
12751           in: path
12752           description: String that identifies the interface
12753           required: true
12754           type: string
12755           example: __VLAN-INTERFACE__
12756         - name: l3-interface-ipv6-address
12757           in: path
12758           description: IP address
12759           required: true
12760           type: string
12761           example: __L3-INTERFACE-IPV6-ADDRESS__
12762         - name: body
12763           in: body
12764           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12765           required: true
12766           schema:
12767             $ref: "#/definitions/relationship"
12768     delete:
12769       tags:
12770         - CloudInfrastructure
12771       summary: delete an existing relationship
12772       description: delete an existing relationship
12773       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
12774       consumes:
12775         - application/json
12776         - application/xml
12777       produces:
12778         - application/json
12779         - application/xml
12780       responses:
12781         "default":
12782           description: Response codes found in [response codes](https://wiki.onap.org/).
12783       parameters:
12784         - name: hostname
12785           in: path
12786           description: Value from executing hostname on the compute node.
12787           required: true
12788           type: string
12789           example: __HOSTNAME__
12790         - name: interface-name
12791           in: path
12792           description: Name that identifies the link aggregate interface
12793           required: true
12794           type: string
12795           example: __INTERFACE-NAME__
12796         - name: interface-name
12797           in: path
12798           description: Name given to the interface
12799           required: true
12800           type: string
12801           example: __INTERFACE-NAME__
12802         - name: vlan-interface
12803           in: path
12804           description: String that identifies the interface
12805           required: true
12806           type: string
12807           example: __VLAN-INTERFACE__
12808         - name: l3-interface-ipv6-address
12809           in: path
12810           description: IP address
12811           required: true
12812           type: string
12813           example: __L3-INTERFACE-IPV6-ADDRESS__
12814   /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}:
12815     get:
12816       tags:
12817         - CloudInfrastructure
12818       summary: returns l3-interface-ipv6-address-list
12819       description: returns l3-interface-ipv6-address-list
12820       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12821       produces:
12822         - application/json
12823         - application/xml
12824       responses:
12825         "200":
12826           description: successful operation
12827           schema:
12828               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
12829         "default":
12830           description: Response codes found in [response codes](https://wiki.onap.org/).
12831       parameters:
12832         - name: hostname
12833           in: path
12834           description: Value from executing hostname on the compute node.
12835           required: true
12836           type: string
12837           example: __HOSTNAME__
12838         - name: interface-name
12839           in: path
12840           description: Name that identifies the link aggregate interface
12841           required: true
12842           type: string
12843           example: __INTERFACE-NAME__
12844         - name: interface-name
12845           in: path
12846           description: Name given to the interface
12847           required: true
12848           type: string
12849           example: __INTERFACE-NAME__
12850         - name: vlan-interface
12851           in: path
12852           description: String that identifies the interface
12853           required: true
12854           type: string
12855           example: __VLAN-INTERFACE__
12856         - name: l3-interface-ipv6-address
12857           in: path
12858           description: IP address
12859           required: true
12860           type: string
12861           example: __L3-INTERFACE-IPV6-ADDRESS__
12862         - name: inv-status
12863           in: query
12864           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
12865           required: false
12866           type: string
12867         - name: pserver-id
12868           in: query
12869           description: ID of Pserver
12870           required: false
12871           type: string
12872         - name: in-maint
12873           in: query
12874           required: false
12875           type: boolean
12876         - name: pserver-name2
12877           in: query
12878           description: alternative pserver name
12879           required: false
12880           type: string
12881         - name: interface-id
12882           in: query
12883           description: ID of interface
12884           required: false
12885           type: string
12886         - name: interface-role
12887           in: query
12888           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
12889           required: false
12890           type: string
12891         - name: interface-id
12892           in: query
12893           description: ID of interface
12894           required: false
12895           type: string
12896         - name: macaddr
12897           in: query
12898           description: MAC address for the interface
12899           required: false
12900           type: string
12901         - name: network-name
12902           in: query
12903           description: Name of the network
12904           required: false
12905           type: string
12906         - name: vlan-id-inner
12907           in: query
12908           description: Inner VLAN tag
12909           required: false
12910           type: integer
12911           format: int64
12912         - name: vpn-key
12913           in: query
12914           description: This indicates the customers VPN ID associated with this vlan
12915           required: false
12916           type: string
12917         - name: vlan-id-inner
12918           in: query
12919           description: Inner VLAN tag
12920           required: false
12921           type: integer
12922           format: int64
12923         - name: neutron-network-id
12924           in: query
12925           description: Neutron network id of the interface that address belongs to
12926           required: false
12927           type: string
12928         - name: neutron-subnet-id
12929           in: query
12930           description: Neutron id of subnet that address belongs to
12931           required: false
12932           type: string
12933     put:
12934       tags:
12935         - CloudInfrastructure
12936       summary: create or update an existing l3-interface-ipv6-address-list
12937       description: |
12938         Create or update an existing l3-interface-ipv6-address-list.
12939         #
12940         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
12941       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
12942       consumes:
12943         - application/json
12944         - application/xml
12945       produces:
12946         - application/json
12947         - application/xml
12948       responses:
12949         "default":
12950           description: Response codes found in [response codes](https://wiki.onap.org/).
12951       parameters:
12952         - name: hostname
12953           in: path
12954           description: Value from executing hostname on the compute node.
12955           required: true
12956           type: string
12957           example: __HOSTNAME__
12958         - name: interface-name
12959           in: path
12960           description: Name that identifies the link aggregate interface
12961           required: true
12962           type: string
12963           example: __INTERFACE-NAME__
12964         - name: interface-name
12965           in: path
12966           description: Name given to the interface
12967           required: true
12968           type: string
12969           example: __INTERFACE-NAME__
12970         - name: vlan-interface
12971           in: path
12972           description: String that identifies the interface
12973           required: true
12974           type: string
12975           example: __VLAN-INTERFACE__
12976         - name: l3-interface-ipv6-address
12977           in: path
12978           description: IP address
12979           required: true
12980           type: string
12981           example: __L3-INTERFACE-IPV6-ADDRESS__
12982         - name: body
12983           in: body
12984           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
12985           required: true
12986           schema:
12987             $ref: "#/definitions/l3-interface-ipv6-address-list"
12988     patch:
12989       tags:
12990         - CloudInfrastructure
12991       summary: update an existing l3-interface-ipv6-address-list
12992       description: |
12993         Update an existing l3-interface-ipv6-address-list
12994         #
12995         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
12996         The PUT operation will entirely replace an existing object.
12997         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
12998         #
12999         Other differences between PUT and PATCH are:
13000         #
13001         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13002         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13003         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13004       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13005       consumes:
13006         - application/json
13007         - application/xml
13008       produces:
13009         - application/json
13010         - application/xml
13011       responses:
13012         "default":
13013           description: Response codes found in [response codes](https://wiki.onap.org/).
13014       parameters:
13015         - name: hostname
13016           in: path
13017           description: Value from executing hostname on the compute node.
13018           required: true
13019           type: string
13020           example: __HOSTNAME__
13021         - name: interface-name
13022           in: path
13023           description: Name that identifies the link aggregate interface
13024           required: true
13025           type: string
13026           example: __INTERFACE-NAME__
13027         - name: interface-name
13028           in: path
13029           description: Name given to the interface
13030           required: true
13031           type: string
13032           example: __INTERFACE-NAME__
13033         - name: vlan-interface
13034           in: path
13035           description: String that identifies the interface
13036           required: true
13037           type: string
13038           example: __VLAN-INTERFACE__
13039         - name: l3-interface-ipv6-address
13040           in: path
13041           description: IP address
13042           required: true
13043           type: string
13044           example: __L3-INTERFACE-IPV6-ADDRESS__
13045         - name: body
13046           in: body
13047           description: l3-interface-ipv6-address-list object that needs to be created or updated.
13048           required: true
13049           schema:
13050             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
13051     delete:
13052       tags:
13053         - CloudInfrastructure
13054       summary: delete an existing l3-interface-ipv6-address-list
13055       description: delete an existing l3-interface-ipv6-address-list
13056       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
13057       consumes:
13058         - application/json
13059         - application/xml
13060       produces:
13061         - application/json
13062         - application/xml
13063       responses:
13064         "default":
13065           description: Response codes found in [response codes](https://wiki.onap.org/).
13066       parameters:
13067         - name: hostname
13068           in: path
13069           description: Value from executing hostname on the compute node.
13070           required: true
13071           type: string
13072           example: __HOSTNAME__
13073         - name: interface-name
13074           in: path
13075           description: Name that identifies the link aggregate interface
13076           required: true
13077           type: string
13078           example: __INTERFACE-NAME__
13079         - name: interface-name
13080           in: path
13081           description: Name given to the interface
13082           required: true
13083           type: string
13084           example: __INTERFACE-NAME__
13085         - name: vlan-interface
13086           in: path
13087           description: String that identifies the interface
13088           required: true
13089           type: string
13090           example: __VLAN-INTERFACE__
13091         - name: l3-interface-ipv6-address
13092           in: path
13093           description: IP address
13094           required: true
13095           type: string
13096           example: __L3-INTERFACE-IPV6-ADDRESS__
13097         - name: resource-version
13098           in: query
13099           description: resource-version for concurrency
13100           required: true
13101           type: string
13102   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
13103     get:
13104       tags:
13105         - CloudInfrastructure
13106       summary: returns vlan
13107       description: returns vlan
13108       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13109       produces:
13110         - application/json
13111         - application/xml
13112       responses:
13113         "200":
13114           description: successful operation
13115           schema:
13116               $ref: "#/getDefinitions/vlan"
13117         "default":
13118           description: Response codes found in [response codes](https://wiki.onap.org/).
13119       parameters:
13120         - name: hostname
13121           in: path
13122           description: Value from executing hostname on the compute node.
13123           required: true
13124           type: string
13125           example: __HOSTNAME__
13126         - name: interface-name
13127           in: path
13128           description: Name that identifies the link aggregate interface
13129           required: true
13130           type: string
13131           example: __INTERFACE-NAME__
13132         - name: interface-name
13133           in: path
13134           description: Name given to the interface
13135           required: true
13136           type: string
13137           example: __INTERFACE-NAME__
13138         - name: vlan-interface
13139           in: path
13140           description: String that identifies the interface
13141           required: true
13142           type: string
13143           example: __VLAN-INTERFACE__
13144         - name: inv-status
13145           in: query
13146           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13147           required: false
13148           type: string
13149         - name: pserver-id
13150           in: query
13151           description: ID of Pserver
13152           required: false
13153           type: string
13154         - name: in-maint
13155           in: query
13156           required: false
13157           type: boolean
13158         - name: pserver-name2
13159           in: query
13160           description: alternative pserver name
13161           required: false
13162           type: string
13163         - name: interface-id
13164           in: query
13165           description: ID of interface
13166           required: false
13167           type: string
13168         - name: interface-role
13169           in: query
13170           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13171           required: false
13172           type: string
13173         - name: interface-id
13174           in: query
13175           description: ID of interface
13176           required: false
13177           type: string
13178         - name: macaddr
13179           in: query
13180           description: MAC address for the interface
13181           required: false
13182           type: string
13183         - name: network-name
13184           in: query
13185           description: Name of the network
13186           required: false
13187           type: string
13188         - name: vlan-id-inner
13189           in: query
13190           description: Inner VLAN tag
13191           required: false
13192           type: integer
13193           format: int64
13194         - name: vpn-key
13195           in: query
13196           description: This indicates the customers VPN ID associated with this vlan
13197           required: false
13198           type: string
13199     put:
13200       tags:
13201         - CloudInfrastructure
13202       summary: create or update an existing vlan
13203       description: |
13204         Create or update an existing vlan.
13205         #
13206         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13207       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13208       consumes:
13209         - application/json
13210         - application/xml
13211       produces:
13212         - application/json
13213         - application/xml
13214       responses:
13215         "default":
13216           description: Response codes found in [response codes](https://wiki.onap.org/).
13217       parameters:
13218         - name: hostname
13219           in: path
13220           description: Value from executing hostname on the compute node.
13221           required: true
13222           type: string
13223           example: __HOSTNAME__
13224         - name: interface-name
13225           in: path
13226           description: Name that identifies the link aggregate interface
13227           required: true
13228           type: string
13229           example: __INTERFACE-NAME__
13230         - name: interface-name
13231           in: path
13232           description: Name given to the interface
13233           required: true
13234           type: string
13235           example: __INTERFACE-NAME__
13236         - name: vlan-interface
13237           in: path
13238           description: String that identifies the interface
13239           required: true
13240           type: string
13241           example: __VLAN-INTERFACE__
13242         - name: body
13243           in: body
13244           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
13245           required: true
13246           schema:
13247             $ref: "#/definitions/vlan"
13248     patch:
13249       tags:
13250         - CloudInfrastructure
13251       summary: update an existing vlan
13252       description: |
13253         Update an existing vlan
13254         #
13255         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13256         The PUT operation will entirely replace an existing object.
13257         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13258         #
13259         Other differences between PUT and PATCH are:
13260         #
13261         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13262         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13263         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13264       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13265       consumes:
13266         - application/json
13267         - application/xml
13268       produces:
13269         - application/json
13270         - application/xml
13271       responses:
13272         "default":
13273           description: Response codes found in [response codes](https://wiki.onap.org/).
13274       parameters:
13275         - name: hostname
13276           in: path
13277           description: Value from executing hostname on the compute node.
13278           required: true
13279           type: string
13280           example: __HOSTNAME__
13281         - name: interface-name
13282           in: path
13283           description: Name that identifies the link aggregate interface
13284           required: true
13285           type: string
13286           example: __INTERFACE-NAME__
13287         - name: interface-name
13288           in: path
13289           description: Name given to the interface
13290           required: true
13291           type: string
13292           example: __INTERFACE-NAME__
13293         - name: vlan-interface
13294           in: path
13295           description: String that identifies the interface
13296           required: true
13297           type: string
13298           example: __VLAN-INTERFACE__
13299         - name: body
13300           in: body
13301           description: vlan object that needs to be created or updated.
13302           required: true
13303           schema:
13304             $ref: "#/patchDefinitions/vlan"
13305     delete:
13306       tags:
13307         - CloudInfrastructure
13308       summary: delete an existing vlan
13309       description: delete an existing vlan
13310       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
13311       consumes:
13312         - application/json
13313         - application/xml
13314       produces:
13315         - application/json
13316         - application/xml
13317       responses:
13318         "default":
13319           description: Response codes found in [response codes](https://wiki.onap.org/).
13320       parameters:
13321         - name: hostname
13322           in: path
13323           description: Value from executing hostname on the compute node.
13324           required: true
13325           type: string
13326           example: __HOSTNAME__
13327         - name: interface-name
13328           in: path
13329           description: Name that identifies the link aggregate interface
13330           required: true
13331           type: string
13332           example: __INTERFACE-NAME__
13333         - name: interface-name
13334           in: path
13335           description: Name given to the interface
13336           required: true
13337           type: string
13338           example: __INTERFACE-NAME__
13339         - name: vlan-interface
13340           in: path
13341           description: String that identifies the interface
13342           required: true
13343           type: string
13344           example: __VLAN-INTERFACE__
13345         - name: resource-version
13346           in: query
13347           description: resource-version for concurrency
13348           required: true
13349           type: string
13350   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
13351     get:
13352       tags:
13353         - CloudInfrastructure
13354       summary: returns vlans
13355       description: returns vlans
13356       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
13357       produces:
13358         - application/json
13359         - application/xml
13360       responses:
13361         "200":
13362           description: successful operation
13363           schema:
13364               $ref: "#/getDefinitions/vlans"
13365         "default":
13366           description: Response codes found in [response codes](https://wiki.onap.org/).
13367       parameters:
13368         - name: hostname
13369           in: path
13370           description: Value from executing hostname on the compute node.
13371           required: true
13372           type: string
13373           example: __HOSTNAME__
13374         - name: interface-name
13375           in: path
13376           description: Name that identifies the link aggregate interface
13377           required: true
13378           type: string
13379           example: __INTERFACE-NAME__
13380         - name: interface-name
13381           in: path
13382           description: Name given to the interface
13383           required: true
13384           type: string
13385           example: __INTERFACE-NAME__
13386         - name: inv-status
13387           in: query
13388           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13389           required: false
13390           type: string
13391         - name: pserver-id
13392           in: query
13393           description: ID of Pserver
13394           required: false
13395           type: string
13396         - name: in-maint
13397           in: query
13398           required: false
13399           type: boolean
13400         - name: pserver-name2
13401           in: query
13402           description: alternative pserver name
13403           required: false
13404           type: string
13405         - name: interface-id
13406           in: query
13407           description: ID of interface
13408           required: false
13409           type: string
13410         - name: interface-role
13411           in: query
13412           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13413           required: false
13414           type: string
13415         - name: interface-id
13416           in: query
13417           description: ID of interface
13418           required: false
13419           type: string
13420         - name: macaddr
13421           in: query
13422           description: MAC address for the interface
13423           required: false
13424           type: string
13425         - name: network-name
13426           in: query
13427           description: Name of the network
13428           required: false
13429           type: string
13430   /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:
13431     put:
13432       tags:
13433         - CloudInfrastructure
13434       summary: see node definition for valid relationships
13435       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
13436       consumes:
13437         - application/json
13438         - application/xml
13439       produces:
13440         - application/json
13441         - application/xml
13442       responses:
13443         "default":
13444           description: Response codes found in [response codes](https://wiki.onap.org/).
13445       parameters:
13446         - name: hostname
13447           in: path
13448           description: Value from executing hostname on the compute node.
13449           required: true
13450           type: string
13451           example: __HOSTNAME__
13452         - name: interface-name
13453           in: path
13454           description: Name that identifies the link aggregate interface
13455           required: true
13456           type: string
13457           example: __INTERFACE-NAME__
13458         - name: interface-name
13459           in: path
13460           description: Name given to the interface
13461           required: true
13462           type: string
13463           example: __INTERFACE-NAME__
13464         - name: pci-id
13465           in: path
13466           description: PCI ID used to identify the sriov-vf
13467           required: true
13468           type: string
13469           example: __PCI-ID__
13470         - name: body
13471           in: body
13472           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13473           required: true
13474           schema:
13475             $ref: "#/definitions/relationship"
13476     delete:
13477       tags:
13478         - CloudInfrastructure
13479       summary: delete an existing relationship
13480       description: delete an existing relationship
13481       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
13482       consumes:
13483         - application/json
13484         - application/xml
13485       produces:
13486         - application/json
13487         - application/xml
13488       responses:
13489         "default":
13490           description: Response codes found in [response codes](https://wiki.onap.org/).
13491       parameters:
13492         - name: hostname
13493           in: path
13494           description: Value from executing hostname on the compute node.
13495           required: true
13496           type: string
13497           example: __HOSTNAME__
13498         - name: interface-name
13499           in: path
13500           description: Name that identifies the link aggregate interface
13501           required: true
13502           type: string
13503           example: __INTERFACE-NAME__
13504         - name: interface-name
13505           in: path
13506           description: Name given to the interface
13507           required: true
13508           type: string
13509           example: __INTERFACE-NAME__
13510         - name: pci-id
13511           in: path
13512           description: PCI ID used to identify the sriov-vf
13513           required: true
13514           type: string
13515           example: __PCI-ID__
13516   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
13517     get:
13518       tags:
13519         - CloudInfrastructure
13520       summary: returns sriov-vf
13521       description: returns sriov-vf
13522       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13523       produces:
13524         - application/json
13525         - application/xml
13526       responses:
13527         "200":
13528           description: successful operation
13529           schema:
13530               $ref: "#/getDefinitions/sriov-vf"
13531         "default":
13532           description: Response codes found in [response codes](https://wiki.onap.org/).
13533       parameters:
13534         - name: hostname
13535           in: path
13536           description: Value from executing hostname on the compute node.
13537           required: true
13538           type: string
13539           example: __HOSTNAME__
13540         - name: interface-name
13541           in: path
13542           description: Name that identifies the link aggregate interface
13543           required: true
13544           type: string
13545           example: __INTERFACE-NAME__
13546         - name: interface-name
13547           in: path
13548           description: Name given to the interface
13549           required: true
13550           type: string
13551           example: __INTERFACE-NAME__
13552         - name: pci-id
13553           in: path
13554           description: PCI ID used to identify the sriov-vf
13555           required: true
13556           type: string
13557           example: __PCI-ID__
13558         - name: inv-status
13559           in: query
13560           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13561           required: false
13562           type: string
13563         - name: pserver-id
13564           in: query
13565           description: ID of Pserver
13566           required: false
13567           type: string
13568         - name: in-maint
13569           in: query
13570           required: false
13571           type: boolean
13572         - name: pserver-name2
13573           in: query
13574           description: alternative pserver name
13575           required: false
13576           type: string
13577         - name: interface-id
13578           in: query
13579           description: ID of interface
13580           required: false
13581           type: string
13582         - name: interface-role
13583           in: query
13584           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13585           required: false
13586           type: string
13587         - name: interface-id
13588           in: query
13589           description: ID of interface
13590           required: false
13591           type: string
13592         - name: macaddr
13593           in: query
13594           description: MAC address for the interface
13595           required: false
13596           type: string
13597         - name: network-name
13598           in: query
13599           description: Name of the network
13600           required: false
13601           type: string
13602         - name: vf-vlan-filter
13603           in: query
13604           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
13605           required: false
13606           type: string
13607         - name: vf-mac-filter
13608           in: query
13609           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
13610           required: false
13611           type: string
13612         - name: vf-vlan-strip
13613           in: query
13614           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
13615           required: false
13616           type: boolean
13617         - name: neutron-network-id
13618           in: query
13619           description: Neutron network id of the interface
13620           required: false
13621           type: string
13622     put:
13623       tags:
13624         - CloudInfrastructure
13625       summary: create or update an existing sriov-vf
13626       description: |
13627         Create or update an existing sriov-vf.
13628         #
13629         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
13630       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13631       consumes:
13632         - application/json
13633         - application/xml
13634       produces:
13635         - application/json
13636         - application/xml
13637       responses:
13638         "default":
13639           description: Response codes found in [response codes](https://wiki.onap.org/).
13640       parameters:
13641         - name: hostname
13642           in: path
13643           description: Value from executing hostname on the compute node.
13644           required: true
13645           type: string
13646           example: __HOSTNAME__
13647         - name: interface-name
13648           in: path
13649           description: Name that identifies the link aggregate interface
13650           required: true
13651           type: string
13652           example: __INTERFACE-NAME__
13653         - name: interface-name
13654           in: path
13655           description: Name given to the interface
13656           required: true
13657           type: string
13658           example: __INTERFACE-NAME__
13659         - name: pci-id
13660           in: path
13661           description: PCI ID used to identify the sriov-vf
13662           required: true
13663           type: string
13664           example: __PCI-ID__
13665         - name: body
13666           in: body
13667           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
13668           required: true
13669           schema:
13670             $ref: "#/definitions/sriov-vf"
13671     patch:
13672       tags:
13673         - CloudInfrastructure
13674       summary: update an existing sriov-vf
13675       description: |
13676         Update an existing sriov-vf
13677         #
13678         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
13679         The PUT operation will entirely replace an existing object.
13680         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
13681         #
13682         Other differences between PUT and PATCH are:
13683         #
13684         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
13685         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
13686         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
13687       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13688       consumes:
13689         - application/json
13690         - application/xml
13691       produces:
13692         - application/json
13693         - application/xml
13694       responses:
13695         "default":
13696           description: Response codes found in [response codes](https://wiki.onap.org/).
13697       parameters:
13698         - name: hostname
13699           in: path
13700           description: Value from executing hostname on the compute node.
13701           required: true
13702           type: string
13703           example: __HOSTNAME__
13704         - name: interface-name
13705           in: path
13706           description: Name that identifies the link aggregate interface
13707           required: true
13708           type: string
13709           example: __INTERFACE-NAME__
13710         - name: interface-name
13711           in: path
13712           description: Name given to the interface
13713           required: true
13714           type: string
13715           example: __INTERFACE-NAME__
13716         - name: pci-id
13717           in: path
13718           description: PCI ID used to identify the sriov-vf
13719           required: true
13720           type: string
13721           example: __PCI-ID__
13722         - name: body
13723           in: body
13724           description: sriov-vf object that needs to be created or updated.
13725           required: true
13726           schema:
13727             $ref: "#/patchDefinitions/sriov-vf"
13728     delete:
13729       tags:
13730         - CloudInfrastructure
13731       summary: delete an existing sriov-vf
13732       description: delete an existing sriov-vf
13733       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
13734       consumes:
13735         - application/json
13736         - application/xml
13737       produces:
13738         - application/json
13739         - application/xml
13740       responses:
13741         "default":
13742           description: Response codes found in [response codes](https://wiki.onap.org/).
13743       parameters:
13744         - name: hostname
13745           in: path
13746           description: Value from executing hostname on the compute node.
13747           required: true
13748           type: string
13749           example: __HOSTNAME__
13750         - name: interface-name
13751           in: path
13752           description: Name that identifies the link aggregate interface
13753           required: true
13754           type: string
13755           example: __INTERFACE-NAME__
13756         - name: interface-name
13757           in: path
13758           description: Name given to the interface
13759           required: true
13760           type: string
13761           example: __INTERFACE-NAME__
13762         - name: pci-id
13763           in: path
13764           description: PCI ID used to identify the sriov-vf
13765           required: true
13766           type: string
13767           example: __PCI-ID__
13768         - name: resource-version
13769           in: query
13770           description: resource-version for concurrency
13771           required: true
13772           type: string
13773   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
13774     get:
13775       tags:
13776         - CloudInfrastructure
13777       summary: returns sriov-vfs
13778       description: returns sriov-vfs
13779       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
13780       produces:
13781         - application/json
13782         - application/xml
13783       responses:
13784         "200":
13785           description: successful operation
13786           schema:
13787               $ref: "#/getDefinitions/sriov-vfs"
13788         "default":
13789           description: Response codes found in [response codes](https://wiki.onap.org/).
13790       parameters:
13791         - name: hostname
13792           in: path
13793           description: Value from executing hostname on the compute node.
13794           required: true
13795           type: string
13796           example: __HOSTNAME__
13797         - name: interface-name
13798           in: path
13799           description: Name that identifies the link aggregate interface
13800           required: true
13801           type: string
13802           example: __INTERFACE-NAME__
13803         - name: interface-name
13804           in: path
13805           description: Name given to the interface
13806           required: true
13807           type: string
13808           example: __INTERFACE-NAME__
13809         - name: inv-status
13810           in: query
13811           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
13812           required: false
13813           type: string
13814         - name: pserver-id
13815           in: query
13816           description: ID of Pserver
13817           required: false
13818           type: string
13819         - name: in-maint
13820           in: query
13821           required: false
13822           type: boolean
13823         - name: pserver-name2
13824           in: query
13825           description: alternative pserver name
13826           required: false
13827           type: string
13828         - name: interface-id
13829           in: query
13830           description: ID of interface
13831           required: false
13832           type: string
13833         - name: interface-role
13834           in: query
13835           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
13836           required: false
13837           type: string
13838         - name: interface-id
13839           in: query
13840           description: ID of interface
13841           required: false
13842           type: string
13843         - name: macaddr
13844           in: query
13845           description: MAC address for the interface
13846           required: false
13847           type: string
13848         - name: network-name
13849           in: query
13850           description: Name of the network
13851           required: false
13852           type: string
13853   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
13854     put:
13855       tags:
13856         - CloudInfrastructure
13857       summary: see node definition for valid relationships
13858       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13859       consumes:
13860         - application/json
13861         - application/xml
13862       produces:
13863         - application/json
13864         - application/xml
13865       responses:
13866         "default":
13867           description: Response codes found in [response codes](https://wiki.onap.org/).
13868       parameters:
13869         - name: hostname
13870           in: path
13871           description: Value from executing hostname on the compute node.
13872           required: true
13873           type: string
13874           example: __HOSTNAME__
13875         - name: interface-name
13876           in: path
13877           description: Name that identifies the link aggregate interface
13878           required: true
13879           type: string
13880           example: __INTERFACE-NAME__
13881         - name: interface-name
13882           in: path
13883           description: Name given to the interface
13884           required: true
13885           type: string
13886           example: __INTERFACE-NAME__
13887         - name: body
13888           in: body
13889           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
13890           required: true
13891           schema:
13892             $ref: "#/definitions/relationship"
13893     delete:
13894       tags:
13895         - CloudInfrastructure
13896       summary: delete an existing relationship
13897       description: delete an existing relationship
13898       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
13899       consumes:
13900         - application/json
13901         - application/xml
13902       produces:
13903         - application/json
13904         - application/xml
13905       responses:
13906         "default":
13907           description: Response codes found in [response codes](https://wiki.onap.org/).
13908       parameters:
13909         - name: hostname
13910           in: path
13911           description: Value from executing hostname on the compute node.
13912           required: true
13913           type: string
13914           example: __HOSTNAME__
13915         - name: interface-name
13916           in: path
13917           description: Name that identifies the link aggregate interface
13918           required: true
13919           type: string
13920           example: __INTERFACE-NAME__
13921         - name: interface-name
13922           in: path
13923           description: Name given to the interface
13924           required: true
13925           type: string
13926           example: __INTERFACE-NAME__
13927   /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:
13928     put:
13929       tags:
13930         - CloudInfrastructure
13931       summary: see node definition for valid relationships
13932       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13933       consumes:
13934         - application/json
13935         - application/xml
13936       produces:
13937         - application/json
13938         - application/xml
13939       responses:
13940         "default":
13941           description: Response codes found in [response codes](https://wiki.onap.org/).
13942       parameters:
13943         - name: hostname
13944           in: path
13945           description: Value from executing hostname on the compute node.
13946           required: true
13947           type: string
13948           example: __HOSTNAME__
13949         - name: interface-name
13950           in: path
13951           description: Name that identifies the link aggregate interface
13952           required: true
13953           type: string
13954           example: __INTERFACE-NAME__
13955         - name: interface-name
13956           in: path
13957           description: Name given to the interface
13958           required: true
13959           type: string
13960           example: __INTERFACE-NAME__
13961         - name: l3-interface-ipv4-address
13962           in: path
13963           description: IP address
13964           required: true
13965           type: string
13966           example: __L3-INTERFACE-IPV4-ADDRESS__
13967         - name: body
13968           in: body
13969           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
13970           required: true
13971           schema:
13972             $ref: "#/definitions/relationship"
13973     delete:
13974       tags:
13975         - CloudInfrastructure
13976       summary: delete an existing relationship
13977       description: delete an existing relationship
13978       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
13979       consumes:
13980         - application/json
13981         - application/xml
13982       produces:
13983         - application/json
13984         - application/xml
13985       responses:
13986         "default":
13987           description: Response codes found in [response codes](https://wiki.onap.org/).
13988       parameters:
13989         - name: hostname
13990           in: path
13991           description: Value from executing hostname on the compute node.
13992           required: true
13993           type: string
13994           example: __HOSTNAME__
13995         - name: interface-name
13996           in: path
13997           description: Name that identifies the link aggregate interface
13998           required: true
13999           type: string
14000           example: __INTERFACE-NAME__
14001         - name: interface-name
14002           in: path
14003           description: Name given to the interface
14004           required: true
14005           type: string
14006           example: __INTERFACE-NAME__
14007         - name: l3-interface-ipv4-address
14008           in: path
14009           description: IP address
14010           required: true
14011           type: string
14012           example: __L3-INTERFACE-IPV4-ADDRESS__
14013   /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}:
14014     get:
14015       tags:
14016         - CloudInfrastructure
14017       summary: returns l3-interface-ipv4-address-list
14018       description: returns l3-interface-ipv4-address-list
14019       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14020       produces:
14021         - application/json
14022         - application/xml
14023       responses:
14024         "200":
14025           description: successful operation
14026           schema:
14027               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
14028         "default":
14029           description: Response codes found in [response codes](https://wiki.onap.org/).
14030       parameters:
14031         - name: hostname
14032           in: path
14033           description: Value from executing hostname on the compute node.
14034           required: true
14035           type: string
14036           example: __HOSTNAME__
14037         - name: interface-name
14038           in: path
14039           description: Name that identifies the link aggregate interface
14040           required: true
14041           type: string
14042           example: __INTERFACE-NAME__
14043         - name: interface-name
14044           in: path
14045           description: Name given to the interface
14046           required: true
14047           type: string
14048           example: __INTERFACE-NAME__
14049         - name: l3-interface-ipv4-address
14050           in: path
14051           description: IP address
14052           required: true
14053           type: string
14054           example: __L3-INTERFACE-IPV4-ADDRESS__
14055         - name: inv-status
14056           in: query
14057           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14058           required: false
14059           type: string
14060         - name: pserver-id
14061           in: query
14062           description: ID of Pserver
14063           required: false
14064           type: string
14065         - name: in-maint
14066           in: query
14067           required: false
14068           type: boolean
14069         - name: pserver-name2
14070           in: query
14071           description: alternative pserver name
14072           required: false
14073           type: string
14074         - name: interface-id
14075           in: query
14076           description: ID of interface
14077           required: false
14078           type: string
14079         - name: interface-role
14080           in: query
14081           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14082           required: false
14083           type: string
14084         - name: interface-id
14085           in: query
14086           description: ID of interface
14087           required: false
14088           type: string
14089         - name: macaddr
14090           in: query
14091           description: MAC address for the interface
14092           required: false
14093           type: string
14094         - name: network-name
14095           in: query
14096           description: Name of the network
14097           required: false
14098           type: string
14099         - name: vlan-id-inner
14100           in: query
14101           description: Inner VLAN tag
14102           required: false
14103           type: integer
14104           format: int64
14105         - name: neutron-network-id
14106           in: query
14107           description: Neutron network id of the interface that address belongs to
14108           required: false
14109           type: string
14110         - name: neutron-subnet-id
14111           in: query
14112           description: Neutron id of subnet that address belongs to
14113           required: false
14114           type: string
14115     put:
14116       tags:
14117         - CloudInfrastructure
14118       summary: create or update an existing l3-interface-ipv4-address-list
14119       description: |
14120         Create or update an existing l3-interface-ipv4-address-list.
14121         #
14122         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14123       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14124       consumes:
14125         - application/json
14126         - application/xml
14127       produces:
14128         - application/json
14129         - application/xml
14130       responses:
14131         "default":
14132           description: Response codes found in [response codes](https://wiki.onap.org/).
14133       parameters:
14134         - name: hostname
14135           in: path
14136           description: Value from executing hostname on the compute node.
14137           required: true
14138           type: string
14139           example: __HOSTNAME__
14140         - name: interface-name
14141           in: path
14142           description: Name that identifies the link aggregate interface
14143           required: true
14144           type: string
14145           example: __INTERFACE-NAME__
14146         - name: interface-name
14147           in: path
14148           description: Name given to the interface
14149           required: true
14150           type: string
14151           example: __INTERFACE-NAME__
14152         - name: l3-interface-ipv4-address
14153           in: path
14154           description: IP address
14155           required: true
14156           type: string
14157           example: __L3-INTERFACE-IPV4-ADDRESS__
14158         - name: body
14159           in: body
14160           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
14161           required: true
14162           schema:
14163             $ref: "#/definitions/l3-interface-ipv4-address-list"
14164     patch:
14165       tags:
14166         - CloudInfrastructure
14167       summary: update an existing l3-interface-ipv4-address-list
14168       description: |
14169         Update an existing l3-interface-ipv4-address-list
14170         #
14171         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14172         The PUT operation will entirely replace an existing object.
14173         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14174         #
14175         Other differences between PUT and PATCH are:
14176         #
14177         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14178         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14179         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14180       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14181       consumes:
14182         - application/json
14183         - application/xml
14184       produces:
14185         - application/json
14186         - application/xml
14187       responses:
14188         "default":
14189           description: Response codes found in [response codes](https://wiki.onap.org/).
14190       parameters:
14191         - name: hostname
14192           in: path
14193           description: Value from executing hostname on the compute node.
14194           required: true
14195           type: string
14196           example: __HOSTNAME__
14197         - name: interface-name
14198           in: path
14199           description: Name that identifies the link aggregate interface
14200           required: true
14201           type: string
14202           example: __INTERFACE-NAME__
14203         - name: interface-name
14204           in: path
14205           description: Name given to the interface
14206           required: true
14207           type: string
14208           example: __INTERFACE-NAME__
14209         - name: l3-interface-ipv4-address
14210           in: path
14211           description: IP address
14212           required: true
14213           type: string
14214           example: __L3-INTERFACE-IPV4-ADDRESS__
14215         - name: body
14216           in: body
14217           description: l3-interface-ipv4-address-list object that needs to be created or updated.
14218           required: true
14219           schema:
14220             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
14221     delete:
14222       tags:
14223         - CloudInfrastructure
14224       summary: delete an existing l3-interface-ipv4-address-list
14225       description: delete an existing l3-interface-ipv4-address-list
14226       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
14227       consumes:
14228         - application/json
14229         - application/xml
14230       produces:
14231         - application/json
14232         - application/xml
14233       responses:
14234         "default":
14235           description: Response codes found in [response codes](https://wiki.onap.org/).
14236       parameters:
14237         - name: hostname
14238           in: path
14239           description: Value from executing hostname on the compute node.
14240           required: true
14241           type: string
14242           example: __HOSTNAME__
14243         - name: interface-name
14244           in: path
14245           description: Name that identifies the link aggregate interface
14246           required: true
14247           type: string
14248           example: __INTERFACE-NAME__
14249         - name: interface-name
14250           in: path
14251           description: Name given to the interface
14252           required: true
14253           type: string
14254           example: __INTERFACE-NAME__
14255         - name: l3-interface-ipv4-address
14256           in: path
14257           description: IP address
14258           required: true
14259           type: string
14260           example: __L3-INTERFACE-IPV4-ADDRESS__
14261         - name: resource-version
14262           in: query
14263           description: resource-version for concurrency
14264           required: true
14265           type: string
14266   /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:
14267     put:
14268       tags:
14269         - CloudInfrastructure
14270       summary: see node definition for valid relationships
14271       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14272       consumes:
14273         - application/json
14274         - application/xml
14275       produces:
14276         - application/json
14277         - application/xml
14278       responses:
14279         "default":
14280           description: Response codes found in [response codes](https://wiki.onap.org/).
14281       parameters:
14282         - name: hostname
14283           in: path
14284           description: Value from executing hostname on the compute node.
14285           required: true
14286           type: string
14287           example: __HOSTNAME__
14288         - name: interface-name
14289           in: path
14290           description: Name that identifies the link aggregate interface
14291           required: true
14292           type: string
14293           example: __INTERFACE-NAME__
14294         - name: interface-name
14295           in: path
14296           description: Name given to the interface
14297           required: true
14298           type: string
14299           example: __INTERFACE-NAME__
14300         - name: l3-interface-ipv6-address
14301           in: path
14302           description: IP address
14303           required: true
14304           type: string
14305           example: __L3-INTERFACE-IPV6-ADDRESS__
14306         - name: body
14307           in: body
14308           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14309           required: true
14310           schema:
14311             $ref: "#/definitions/relationship"
14312     delete:
14313       tags:
14314         - CloudInfrastructure
14315       summary: delete an existing relationship
14316       description: delete an existing relationship
14317       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
14318       consumes:
14319         - application/json
14320         - application/xml
14321       produces:
14322         - application/json
14323         - application/xml
14324       responses:
14325         "default":
14326           description: Response codes found in [response codes](https://wiki.onap.org/).
14327       parameters:
14328         - name: hostname
14329           in: path
14330           description: Value from executing hostname on the compute node.
14331           required: true
14332           type: string
14333           example: __HOSTNAME__
14334         - name: interface-name
14335           in: path
14336           description: Name that identifies the link aggregate interface
14337           required: true
14338           type: string
14339           example: __INTERFACE-NAME__
14340         - name: interface-name
14341           in: path
14342           description: Name given to the interface
14343           required: true
14344           type: string
14345           example: __INTERFACE-NAME__
14346         - name: l3-interface-ipv6-address
14347           in: path
14348           description: IP address
14349           required: true
14350           type: string
14351           example: __L3-INTERFACE-IPV6-ADDRESS__
14352   /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}:
14353     get:
14354       tags:
14355         - CloudInfrastructure
14356       summary: returns l3-interface-ipv6-address-list
14357       description: returns l3-interface-ipv6-address-list
14358       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14359       produces:
14360         - application/json
14361         - application/xml
14362       responses:
14363         "200":
14364           description: successful operation
14365           schema:
14366               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
14367         "default":
14368           description: Response codes found in [response codes](https://wiki.onap.org/).
14369       parameters:
14370         - name: hostname
14371           in: path
14372           description: Value from executing hostname on the compute node.
14373           required: true
14374           type: string
14375           example: __HOSTNAME__
14376         - name: interface-name
14377           in: path
14378           description: Name that identifies the link aggregate interface
14379           required: true
14380           type: string
14381           example: __INTERFACE-NAME__
14382         - name: interface-name
14383           in: path
14384           description: Name given to the interface
14385           required: true
14386           type: string
14387           example: __INTERFACE-NAME__
14388         - name: l3-interface-ipv6-address
14389           in: path
14390           description: IP address
14391           required: true
14392           type: string
14393           example: __L3-INTERFACE-IPV6-ADDRESS__
14394         - name: inv-status
14395           in: query
14396           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14397           required: false
14398           type: string
14399         - name: pserver-id
14400           in: query
14401           description: ID of Pserver
14402           required: false
14403           type: string
14404         - name: in-maint
14405           in: query
14406           required: false
14407           type: boolean
14408         - name: pserver-name2
14409           in: query
14410           description: alternative pserver name
14411           required: false
14412           type: string
14413         - name: interface-id
14414           in: query
14415           description: ID of interface
14416           required: false
14417           type: string
14418         - name: interface-role
14419           in: query
14420           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14421           required: false
14422           type: string
14423         - name: interface-id
14424           in: query
14425           description: ID of interface
14426           required: false
14427           type: string
14428         - name: macaddr
14429           in: query
14430           description: MAC address for the interface
14431           required: false
14432           type: string
14433         - name: network-name
14434           in: query
14435           description: Name of the network
14436           required: false
14437           type: string
14438         - name: vlan-id-inner
14439           in: query
14440           description: Inner VLAN tag
14441           required: false
14442           type: integer
14443           format: int64
14444         - name: neutron-network-id
14445           in: query
14446           description: Neutron network id of the interface that address belongs to
14447           required: false
14448           type: string
14449         - name: neutron-subnet-id
14450           in: query
14451           description: Neutron id of subnet that address belongs to
14452           required: false
14453           type: string
14454     put:
14455       tags:
14456         - CloudInfrastructure
14457       summary: create or update an existing l3-interface-ipv6-address-list
14458       description: |
14459         Create or update an existing l3-interface-ipv6-address-list.
14460         #
14461         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14462       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14463       consumes:
14464         - application/json
14465         - application/xml
14466       produces:
14467         - application/json
14468         - application/xml
14469       responses:
14470         "default":
14471           description: Response codes found in [response codes](https://wiki.onap.org/).
14472       parameters:
14473         - name: hostname
14474           in: path
14475           description: Value from executing hostname on the compute node.
14476           required: true
14477           type: string
14478           example: __HOSTNAME__
14479         - name: interface-name
14480           in: path
14481           description: Name that identifies the link aggregate interface
14482           required: true
14483           type: string
14484           example: __INTERFACE-NAME__
14485         - name: interface-name
14486           in: path
14487           description: Name given to the interface
14488           required: true
14489           type: string
14490           example: __INTERFACE-NAME__
14491         - name: l3-interface-ipv6-address
14492           in: path
14493           description: IP address
14494           required: true
14495           type: string
14496           example: __L3-INTERFACE-IPV6-ADDRESS__
14497         - name: body
14498           in: body
14499           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
14500           required: true
14501           schema:
14502             $ref: "#/definitions/l3-interface-ipv6-address-list"
14503     patch:
14504       tags:
14505         - CloudInfrastructure
14506       summary: update an existing l3-interface-ipv6-address-list
14507       description: |
14508         Update an existing l3-interface-ipv6-address-list
14509         #
14510         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14511         The PUT operation will entirely replace an existing object.
14512         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14513         #
14514         Other differences between PUT and PATCH are:
14515         #
14516         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14517         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14518         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14519       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14520       consumes:
14521         - application/json
14522         - application/xml
14523       produces:
14524         - application/json
14525         - application/xml
14526       responses:
14527         "default":
14528           description: Response codes found in [response codes](https://wiki.onap.org/).
14529       parameters:
14530         - name: hostname
14531           in: path
14532           description: Value from executing hostname on the compute node.
14533           required: true
14534           type: string
14535           example: __HOSTNAME__
14536         - name: interface-name
14537           in: path
14538           description: Name that identifies the link aggregate interface
14539           required: true
14540           type: string
14541           example: __INTERFACE-NAME__
14542         - name: interface-name
14543           in: path
14544           description: Name given to the interface
14545           required: true
14546           type: string
14547           example: __INTERFACE-NAME__
14548         - name: l3-interface-ipv6-address
14549           in: path
14550           description: IP address
14551           required: true
14552           type: string
14553           example: __L3-INTERFACE-IPV6-ADDRESS__
14554         - name: body
14555           in: body
14556           description: l3-interface-ipv6-address-list object that needs to be created or updated.
14557           required: true
14558           schema:
14559             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
14560     delete:
14561       tags:
14562         - CloudInfrastructure
14563       summary: delete an existing l3-interface-ipv6-address-list
14564       description: delete an existing l3-interface-ipv6-address-list
14565       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
14566       consumes:
14567         - application/json
14568         - application/xml
14569       produces:
14570         - application/json
14571         - application/xml
14572       responses:
14573         "default":
14574           description: Response codes found in [response codes](https://wiki.onap.org/).
14575       parameters:
14576         - name: hostname
14577           in: path
14578           description: Value from executing hostname on the compute node.
14579           required: true
14580           type: string
14581           example: __HOSTNAME__
14582         - name: interface-name
14583           in: path
14584           description: Name that identifies the link aggregate interface
14585           required: true
14586           type: string
14587           example: __INTERFACE-NAME__
14588         - name: interface-name
14589           in: path
14590           description: Name given to the interface
14591           required: true
14592           type: string
14593           example: __INTERFACE-NAME__
14594         - name: l3-interface-ipv6-address
14595           in: path
14596           description: IP address
14597           required: true
14598           type: string
14599           example: __L3-INTERFACE-IPV6-ADDRESS__
14600         - name: resource-version
14601           in: query
14602           description: resource-version for concurrency
14603           required: true
14604           type: string
14605   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
14606     get:
14607       tags:
14608         - CloudInfrastructure
14609       summary: returns l-interface
14610       description: returns l-interface
14611       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14612       produces:
14613         - application/json
14614         - application/xml
14615       responses:
14616         "200":
14617           description: successful operation
14618           schema:
14619               $ref: "#/getDefinitions/l-interface"
14620         "default":
14621           description: Response codes found in [response codes](https://wiki.onap.org/).
14622       parameters:
14623         - name: hostname
14624           in: path
14625           description: Value from executing hostname on the compute node.
14626           required: true
14627           type: string
14628           example: __HOSTNAME__
14629         - name: interface-name
14630           in: path
14631           description: Name that identifies the link aggregate interface
14632           required: true
14633           type: string
14634           example: __INTERFACE-NAME__
14635         - name: interface-name
14636           in: path
14637           description: Name given to the interface
14638           required: true
14639           type: string
14640           example: __INTERFACE-NAME__
14641         - name: inv-status
14642           in: query
14643           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14644           required: false
14645           type: string
14646         - name: pserver-id
14647           in: query
14648           description: ID of Pserver
14649           required: false
14650           type: string
14651         - name: in-maint
14652           in: query
14653           required: false
14654           type: boolean
14655         - name: pserver-name2
14656           in: query
14657           description: alternative pserver name
14658           required: false
14659           type: string
14660         - name: interface-id
14661           in: query
14662           description: ID of interface
14663           required: false
14664           type: string
14665         - name: interface-role
14666           in: query
14667           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14668           required: false
14669           type: string
14670         - name: interface-id
14671           in: query
14672           description: ID of interface
14673           required: false
14674           type: string
14675         - name: macaddr
14676           in: query
14677           description: MAC address for the interface
14678           required: false
14679           type: string
14680         - name: network-name
14681           in: query
14682           description: Name of the network
14683           required: false
14684           type: string
14685     put:
14686       tags:
14687         - CloudInfrastructure
14688       summary: create or update an existing l-interface
14689       description: |
14690         Create or update an existing l-interface.
14691         #
14692         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14693       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14694       consumes:
14695         - application/json
14696         - application/xml
14697       produces:
14698         - application/json
14699         - application/xml
14700       responses:
14701         "default":
14702           description: Response codes found in [response codes](https://wiki.onap.org/).
14703       parameters:
14704         - name: hostname
14705           in: path
14706           description: Value from executing hostname on the compute node.
14707           required: true
14708           type: string
14709           example: __HOSTNAME__
14710         - name: interface-name
14711           in: path
14712           description: Name that identifies the link aggregate interface
14713           required: true
14714           type: string
14715           example: __INTERFACE-NAME__
14716         - name: interface-name
14717           in: path
14718           description: Name given to the interface
14719           required: true
14720           type: string
14721           example: __INTERFACE-NAME__
14722         - name: body
14723           in: body
14724           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)
14725           required: true
14726           schema:
14727             $ref: "#/definitions/l-interface"
14728     patch:
14729       tags:
14730         - CloudInfrastructure
14731       summary: update an existing l-interface
14732       description: |
14733         Update an existing l-interface
14734         #
14735         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14736         The PUT operation will entirely replace an existing object.
14737         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14738         #
14739         Other differences between PUT and PATCH are:
14740         #
14741         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14742         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14743         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14744       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14745       consumes:
14746         - application/json
14747         - application/xml
14748       produces:
14749         - application/json
14750         - application/xml
14751       responses:
14752         "default":
14753           description: Response codes found in [response codes](https://wiki.onap.org/).
14754       parameters:
14755         - name: hostname
14756           in: path
14757           description: Value from executing hostname on the compute node.
14758           required: true
14759           type: string
14760           example: __HOSTNAME__
14761         - name: interface-name
14762           in: path
14763           description: Name that identifies the link aggregate interface
14764           required: true
14765           type: string
14766           example: __INTERFACE-NAME__
14767         - name: interface-name
14768           in: path
14769           description: Name given to the interface
14770           required: true
14771           type: string
14772           example: __INTERFACE-NAME__
14773         - name: body
14774           in: body
14775           description: l-interface object that needs to be created or updated.
14776           required: true
14777           schema:
14778             $ref: "#/patchDefinitions/l-interface"
14779     delete:
14780       tags:
14781         - CloudInfrastructure
14782       summary: delete an existing l-interface
14783       description: delete an existing l-interface
14784       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface
14785       consumes:
14786         - application/json
14787         - application/xml
14788       produces:
14789         - application/json
14790         - application/xml
14791       responses:
14792         "default":
14793           description: Response codes found in [response codes](https://wiki.onap.org/).
14794       parameters:
14795         - name: hostname
14796           in: path
14797           description: Value from executing hostname on the compute node.
14798           required: true
14799           type: string
14800           example: __HOSTNAME__
14801         - name: interface-name
14802           in: path
14803           description: Name that identifies the link aggregate interface
14804           required: true
14805           type: string
14806           example: __INTERFACE-NAME__
14807         - name: interface-name
14808           in: path
14809           description: Name given to the interface
14810           required: true
14811           type: string
14812           example: __INTERFACE-NAME__
14813         - name: resource-version
14814           in: query
14815           description: resource-version for concurrency
14816           required: true
14817           type: string
14818   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
14819     get:
14820       tags:
14821         - CloudInfrastructure
14822       summary: returns l-interfaces
14823       description: returns l-interfaces
14824       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfaces
14825       produces:
14826         - application/json
14827         - application/xml
14828       responses:
14829         "200":
14830           description: successful operation
14831           schema:
14832               $ref: "#/getDefinitions/l-interfaces"
14833         "default":
14834           description: Response codes found in [response codes](https://wiki.onap.org/).
14835       parameters:
14836         - name: hostname
14837           in: path
14838           description: Value from executing hostname on the compute node.
14839           required: true
14840           type: string
14841           example: __HOSTNAME__
14842         - name: interface-name
14843           in: path
14844           description: Name that identifies the link aggregate interface
14845           required: true
14846           type: string
14847           example: __INTERFACE-NAME__
14848         - name: inv-status
14849           in: query
14850           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14851           required: false
14852           type: string
14853         - name: pserver-id
14854           in: query
14855           description: ID of Pserver
14856           required: false
14857           type: string
14858         - name: in-maint
14859           in: query
14860           required: false
14861           type: boolean
14862         - name: pserver-name2
14863           in: query
14864           description: alternative pserver name
14865           required: false
14866           type: string
14867         - name: interface-id
14868           in: query
14869           description: ID of interface
14870           required: false
14871           type: string
14872         - name: interface-role
14873           in: query
14874           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14875           required: false
14876           type: string
14877   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}:
14878     get:
14879       tags:
14880         - CloudInfrastructure
14881       summary: returns lag-interface
14882       description: returns lag-interface
14883       operationId: getCloudInfrastructurePserversPserverLagInterfacesLagInterface
14884       produces:
14885         - application/json
14886         - application/xml
14887       responses:
14888         "200":
14889           description: successful operation
14890           schema:
14891               $ref: "#/getDefinitions/lag-interface"
14892         "default":
14893           description: Response codes found in [response codes](https://wiki.onap.org/).
14894       parameters:
14895         - name: hostname
14896           in: path
14897           description: Value from executing hostname on the compute node.
14898           required: true
14899           type: string
14900           example: __HOSTNAME__
14901         - name: interface-name
14902           in: path
14903           description: Name that identifies the link aggregate interface
14904           required: true
14905           type: string
14906           example: __INTERFACE-NAME__
14907         - name: inv-status
14908           in: query
14909           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
14910           required: false
14911           type: string
14912         - name: pserver-id
14913           in: query
14914           description: ID of Pserver
14915           required: false
14916           type: string
14917         - name: in-maint
14918           in: query
14919           required: false
14920           type: boolean
14921         - name: pserver-name2
14922           in: query
14923           description: alternative pserver name
14924           required: false
14925           type: string
14926         - name: interface-id
14927           in: query
14928           description: ID of interface
14929           required: false
14930           type: string
14931         - name: interface-role
14932           in: query
14933           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
14934           required: false
14935           type: string
14936     put:
14937       tags:
14938         - CloudInfrastructure
14939       summary: create or update an existing lag-interface
14940       description: |
14941         Create or update an existing lag-interface.
14942         #
14943         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
14944       operationId: createOrUpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14945       consumes:
14946         - application/json
14947         - application/xml
14948       produces:
14949         - application/json
14950         - application/xml
14951       responses:
14952         "default":
14953           description: Response codes found in [response codes](https://wiki.onap.org/).
14954       parameters:
14955         - name: hostname
14956           in: path
14957           description: Value from executing hostname on the compute node.
14958           required: true
14959           type: string
14960           example: __HOSTNAME__
14961         - name: interface-name
14962           in: path
14963           description: Name that identifies the link aggregate interface
14964           required: true
14965           type: string
14966           example: __INTERFACE-NAME__
14967         - name: body
14968           in: body
14969           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)
14970           required: true
14971           schema:
14972             $ref: "#/definitions/lag-interface"
14973     patch:
14974       tags:
14975         - CloudInfrastructure
14976       summary: update an existing lag-interface
14977       description: |
14978         Update an existing lag-interface
14979         #
14980         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
14981         The PUT operation will entirely replace an existing object.
14982         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
14983         #
14984         Other differences between PUT and PATCH are:
14985         #
14986         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
14987         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
14988         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
14989       operationId: UpdateCloudInfrastructurePserversPserverLagInterfacesLagInterface
14990       consumes:
14991         - application/json
14992         - application/xml
14993       produces:
14994         - application/json
14995         - application/xml
14996       responses:
14997         "default":
14998           description: Response codes found in [response codes](https://wiki.onap.org/).
14999       parameters:
15000         - name: hostname
15001           in: path
15002           description: Value from executing hostname on the compute node.
15003           required: true
15004           type: string
15005           example: __HOSTNAME__
15006         - name: interface-name
15007           in: path
15008           description: Name that identifies the link aggregate interface
15009           required: true
15010           type: string
15011           example: __INTERFACE-NAME__
15012         - name: body
15013           in: body
15014           description: lag-interface object that needs to be created or updated.
15015           required: true
15016           schema:
15017             $ref: "#/patchDefinitions/lag-interface"
15018     delete:
15019       tags:
15020         - CloudInfrastructure
15021       summary: delete an existing lag-interface
15022       description: delete an existing lag-interface
15023       operationId: deleteCloudInfrastructurePserversPserverLagInterfacesLagInterface
15024       consumes:
15025         - application/json
15026         - application/xml
15027       produces:
15028         - application/json
15029         - application/xml
15030       responses:
15031         "default":
15032           description: Response codes found in [response codes](https://wiki.onap.org/).
15033       parameters:
15034         - name: hostname
15035           in: path
15036           description: Value from executing hostname on the compute node.
15037           required: true
15038           type: string
15039           example: __HOSTNAME__
15040         - name: interface-name
15041           in: path
15042           description: Name that identifies the link aggregate interface
15043           required: true
15044           type: string
15045           example: __INTERFACE-NAME__
15046         - name: resource-version
15047           in: query
15048           description: resource-version for concurrency
15049           required: true
15050           type: string
15051   /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces:
15052     get:
15053       tags:
15054         - CloudInfrastructure
15055       summary: returns lag-interfaces
15056       description: returns lag-interfaces
15057       operationId: getCloudInfrastructurePserversPserverLagInterfaces
15058       produces:
15059         - application/json
15060         - application/xml
15061       responses:
15062         "200":
15063           description: successful operation
15064           schema:
15065               $ref: "#/getDefinitions/lag-interfaces"
15066         "default":
15067           description: Response codes found in [response codes](https://wiki.onap.org/).
15068       parameters:
15069         - name: hostname
15070           in: path
15071           description: Value from executing hostname on the compute node.
15072           required: true
15073           type: string
15074           example: __HOSTNAME__
15075         - name: inv-status
15076           in: query
15077           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15078           required: false
15079           type: string
15080         - name: pserver-id
15081           in: query
15082           description: ID of Pserver
15083           required: false
15084           type: string
15085         - name: in-maint
15086           in: query
15087           required: false
15088           type: boolean
15089         - name: pserver-name2
15090           in: query
15091           description: alternative pserver name
15092           required: false
15093           type: string
15094   /cloud-infrastructure/pservers/pserver/{hostname}:
15095     get:
15096       tags:
15097         - CloudInfrastructure
15098       summary: returns pserver
15099       description: returns pserver
15100       operationId: getCloudInfrastructurePserversPserver
15101       produces:
15102         - application/json
15103         - application/xml
15104       responses:
15105         "200":
15106           description: successful operation
15107           schema:
15108               $ref: "#/getDefinitions/pserver"
15109         "default":
15110           description: Response codes found in [response codes](https://wiki.onap.org/).
15111       parameters:
15112         - name: hostname
15113           in: path
15114           description: Value from executing hostname on the compute node.
15115           required: true
15116           type: string
15117           example: __HOSTNAME__
15118         - name: inv-status
15119           in: query
15120           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
15121           required: false
15122           type: string
15123         - name: pserver-id
15124           in: query
15125           description: ID of Pserver
15126           required: false
15127           type: string
15128         - name: in-maint
15129           in: query
15130           required: false
15131           type: boolean
15132         - name: pserver-name2
15133           in: query
15134           description: alternative pserver name
15135           required: false
15136           type: string
15137     put:
15138       tags:
15139         - CloudInfrastructure
15140       summary: create or update an existing pserver
15141       description: |
15142         Create or update an existing pserver.
15143         #
15144         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15145       operationId: createOrUpdateCloudInfrastructurePserversPserver
15146       consumes:
15147         - application/json
15148         - application/xml
15149       produces:
15150         - application/json
15151         - application/xml
15152       responses:
15153         "default":
15154           description: Response codes found in [response codes](https://wiki.onap.org/).
15155       parameters:
15156         - name: hostname
15157           in: path
15158           description: Value from executing hostname on the compute node.
15159           required: true
15160           type: string
15161           example: __HOSTNAME__
15162         - name: body
15163           in: body
15164           description: pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)
15165           required: true
15166           schema:
15167             $ref: "#/definitions/pserver"
15168     patch:
15169       tags:
15170         - CloudInfrastructure
15171       summary: update an existing pserver
15172       description: |
15173         Update an existing pserver
15174         #
15175         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15176         The PUT operation will entirely replace an existing object.
15177         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15178         #
15179         Other differences between PUT and PATCH are:
15180         #
15181         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15182         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15183         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15184       operationId: UpdateCloudInfrastructurePserversPserver
15185       consumes:
15186         - application/json
15187         - application/xml
15188       produces:
15189         - application/json
15190         - application/xml
15191       responses:
15192         "default":
15193           description: Response codes found in [response codes](https://wiki.onap.org/).
15194       parameters:
15195         - name: hostname
15196           in: path
15197           description: Value from executing hostname on the compute node.
15198           required: true
15199           type: string
15200           example: __HOSTNAME__
15201         - name: body
15202           in: body
15203           description: pserver object that needs to be created or updated.
15204           required: true
15205           schema:
15206             $ref: "#/patchDefinitions/pserver"
15207     delete:
15208       tags:
15209         - CloudInfrastructure
15210       summary: delete an existing pserver
15211       description: delete an existing pserver
15212       operationId: deleteCloudInfrastructurePserversPserver
15213       consumes:
15214         - application/json
15215         - application/xml
15216       produces:
15217         - application/json
15218         - application/xml
15219       responses:
15220         "default":
15221           description: Response codes found in [response codes](https://wiki.onap.org/).
15222       parameters:
15223         - name: hostname
15224           in: path
15225           description: Value from executing hostname on the compute node.
15226           required: true
15227           type: string
15228           example: __HOSTNAME__
15229         - name: resource-version
15230           in: query
15231           description: resource-version for concurrency
15232           required: true
15233           type: string
15234   /cloud-infrastructure/pservers:
15235     get:
15236       tags:
15237         - CloudInfrastructure
15238       summary: returns pservers
15239       description: returns pservers
15240       operationId: getCloudInfrastructurePservers
15241       produces:
15242         - application/json
15243         - application/xml
15244       responses:
15245         "200":
15246           description: successful operation
15247           schema:
15248               $ref: "#/getDefinitions/pservers"
15249         "default":
15250           description: Response codes found in [response codes](https://wiki.onap.org/).
15251   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship:
15252     put:
15253       tags:
15254         - CloudInfrastructure
15255       summary: see node definition for valid relationships
15256       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
15257       consumes:
15258         - application/json
15259         - application/xml
15260       produces:
15261         - application/json
15262         - application/xml
15263       responses:
15264         "default":
15265           description: Response codes found in [response codes](https://wiki.onap.org/).
15266       parameters:
15267         - name: vdc-id
15268           in: path
15269           description: Unique ID of the vdc
15270           required: true
15271           type: string
15272           example: __VDC-ID__
15273         - name: body
15274           in: body
15275           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15276           required: true
15277           schema:
15278             $ref: "#/definitions/relationship"
15279     delete:
15280       tags:
15281         - CloudInfrastructure
15282       summary: delete an existing relationship
15283       description: delete an existing relationship
15284       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenterRelationshipListRelationship
15285       consumes:
15286         - application/json
15287         - application/xml
15288       produces:
15289         - application/json
15290         - application/xml
15291       responses:
15292         "default":
15293           description: Response codes found in [response codes](https://wiki.onap.org/).
15294       parameters:
15295         - name: vdc-id
15296           in: path
15297           description: Unique ID of the vdc
15298           required: true
15299           type: string
15300           example: __VDC-ID__
15301   /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}:
15302     get:
15303       tags:
15304         - CloudInfrastructure
15305       summary: returns virtual-data-center
15306       description: returns virtual-data-center
15307       operationId: getCloudInfrastructureVirtualDataCentersVirtualDataCenter
15308       produces:
15309         - application/json
15310         - application/xml
15311       responses:
15312         "200":
15313           description: successful operation
15314           schema:
15315               $ref: "#/getDefinitions/virtual-data-center"
15316         "default":
15317           description: Response codes found in [response codes](https://wiki.onap.org/).
15318       parameters:
15319         - name: vdc-id
15320           in: path
15321           description: Unique ID of the vdc
15322           required: true
15323           type: string
15324           example: __VDC-ID__
15325         - name: vdc-name
15326           in: query
15327           description: Name of the virtual data center
15328           required: false
15329           type: string
15330     put:
15331       tags:
15332         - CloudInfrastructure
15333       summary: create or update an existing virtual-data-center
15334       description: |
15335         Create or update an existing virtual-data-center.
15336         #
15337         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15338       operationId: createOrUpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15339       consumes:
15340         - application/json
15341         - application/xml
15342       produces:
15343         - application/json
15344         - application/xml
15345       responses:
15346         "default":
15347           description: Response codes found in [response codes](https://wiki.onap.org/).
15348       parameters:
15349         - name: vdc-id
15350           in: path
15351           description: Unique ID of the vdc
15352           required: true
15353           type: string
15354           example: __VDC-ID__
15355         - name: body
15356           in: body
15357           description: virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)
15358           required: true
15359           schema:
15360             $ref: "#/definitions/virtual-data-center"
15361     patch:
15362       tags:
15363         - CloudInfrastructure
15364       summary: update an existing virtual-data-center
15365       description: |
15366         Update an existing virtual-data-center
15367         #
15368         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15369         The PUT operation will entirely replace an existing object.
15370         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15371         #
15372         Other differences between PUT and PATCH are:
15373         #
15374         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15375         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15376         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15377       operationId: UpdateCloudInfrastructureVirtualDataCentersVirtualDataCenter
15378       consumes:
15379         - application/json
15380         - application/xml
15381       produces:
15382         - application/json
15383         - application/xml
15384       responses:
15385         "default":
15386           description: Response codes found in [response codes](https://wiki.onap.org/).
15387       parameters:
15388         - name: vdc-id
15389           in: path
15390           description: Unique ID of the vdc
15391           required: true
15392           type: string
15393           example: __VDC-ID__
15394         - name: body
15395           in: body
15396           description: virtual-data-center object that needs to be created or updated.
15397           required: true
15398           schema:
15399             $ref: "#/patchDefinitions/virtual-data-center"
15400     delete:
15401       tags:
15402         - CloudInfrastructure
15403       summary: delete an existing virtual-data-center
15404       description: delete an existing virtual-data-center
15405       operationId: deleteCloudInfrastructureVirtualDataCentersVirtualDataCenter
15406       consumes:
15407         - application/json
15408         - application/xml
15409       produces:
15410         - application/json
15411         - application/xml
15412       responses:
15413         "default":
15414           description: Response codes found in [response codes](https://wiki.onap.org/).
15415       parameters:
15416         - name: vdc-id
15417           in: path
15418           description: Unique ID of the vdc
15419           required: true
15420           type: string
15421           example: __VDC-ID__
15422         - name: resource-version
15423           in: query
15424           description: resource-version for concurrency
15425           required: true
15426           type: string
15427   /cloud-infrastructure/virtual-data-centers:
15428     get:
15429       tags:
15430         - CloudInfrastructure
15431       summary: returns virtual-data-centers
15432       description: returns virtual-data-centers
15433       operationId: getCloudInfrastructureVirtualDataCenters
15434       produces:
15435         - application/json
15436         - application/xml
15437       responses:
15438         "200":
15439           description: successful operation
15440           schema:
15441               $ref: "#/getDefinitions/virtual-data-centers"
15442         "default":
15443           description: Response codes found in [response codes](https://wiki.onap.org/).
15444   /business/connectors/connector/{resource-instance-id}/relationship-list/relationship:
15445     put:
15446       tags:
15447         - Business
15448       summary: see node definition for valid relationships
15449       operationId: createOrUpdateBusinessConnectorsConnectorRelationshipListRelationship
15450       consumes:
15451         - application/json
15452         - application/xml
15453       produces:
15454         - application/json
15455         - application/xml
15456       responses:
15457         "default":
15458           description: Response codes found in [response codes](https://wiki.onap.org/).
15459       parameters:
15460         - name: resource-instance-id
15461           in: path
15462           description: Unique id of resource instance.
15463           required: true
15464           type: string
15465           example: __RESOURCE-INSTANCE-ID__
15466         - name: body
15467           in: body
15468           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
15469           required: true
15470           schema:
15471             $ref: "#/definitions/relationship"
15472     delete:
15473       tags:
15474         - Business
15475       summary: delete an existing relationship
15476       description: delete an existing relationship
15477       operationId: deleteBusinessConnectorsConnectorRelationshipListRelationship
15478       consumes:
15479         - application/json
15480         - application/xml
15481       produces:
15482         - application/json
15483         - application/xml
15484       responses:
15485         "default":
15486           description: Response codes found in [response codes](https://wiki.onap.org/).
15487       parameters:
15488         - name: resource-instance-id
15489           in: path
15490           description: Unique id of resource instance.
15491           required: true
15492           type: string
15493           example: __RESOURCE-INSTANCE-ID__
15494   /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}:
15495     get:
15496       tags:
15497         - Business
15498       summary: returns metadatum
15499       description: returns metadatum
15500       operationId: getBusinessConnectorsConnectorMetadataMetadatum
15501       produces:
15502         - application/json
15503         - application/xml
15504       responses:
15505         "200":
15506           description: successful operation
15507           schema:
15508               $ref: "#/getDefinitions/metadatum"
15509         "default":
15510           description: Response codes found in [response codes](https://wiki.onap.org/).
15511       parameters:
15512         - name: resource-instance-id
15513           in: path
15514           description: Unique id of resource instance.
15515           required: true
15516           type: string
15517           example: __RESOURCE-INSTANCE-ID__
15518         - name: metaname
15519           in: path
15520           required: true
15521           type: string
15522           example: __METANAME__
15523         - name: model-invariant-id
15524           in: query
15525           description: the ASDC model id for this resource or service model.
15526           required: false
15527           type: string
15528         - name: model-version-id
15529           in: query
15530           description: the ASDC model version for this resource or service model.
15531           required: false
15532           type: string
15533         - name: widget-model-id
15534           in: query
15535           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15536           required: false
15537           type: string
15538         - name: widget-model-version
15539           in: query
15540           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15541           required: false
15542           type: string
15543     put:
15544       tags:
15545         - Business
15546       summary: create or update an existing metadatum
15547       description: |
15548         Create or update an existing metadatum.
15549         #
15550         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15551       operationId: createOrUpdateBusinessConnectorsConnectorMetadataMetadatum
15552       consumes:
15553         - application/json
15554         - application/xml
15555       produces:
15556         - application/json
15557         - application/xml
15558       responses:
15559         "default":
15560           description: Response codes found in [response codes](https://wiki.onap.org/).
15561       parameters:
15562         - name: resource-instance-id
15563           in: path
15564           description: Unique id of resource instance.
15565           required: true
15566           type: string
15567           example: __RESOURCE-INSTANCE-ID__
15568         - name: metaname
15569           in: path
15570           required: true
15571           type: string
15572           example: __METANAME__
15573         - name: body
15574           in: body
15575           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json)
15576           required: true
15577           schema:
15578             $ref: "#/definitions/metadatum"
15579     patch:
15580       tags:
15581         - Business
15582       summary: update an existing metadatum
15583       description: |
15584         Update an existing metadatum
15585         #
15586         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15587         The PUT operation will entirely replace an existing object.
15588         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15589         #
15590         Other differences between PUT and PATCH are:
15591         #
15592         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15593         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15594         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15595       operationId: UpdateBusinessConnectorsConnectorMetadataMetadatum
15596       consumes:
15597         - application/json
15598         - application/xml
15599       produces:
15600         - application/json
15601         - application/xml
15602       responses:
15603         "default":
15604           description: Response codes found in [response codes](https://wiki.onap.org/).
15605       parameters:
15606         - name: resource-instance-id
15607           in: path
15608           description: Unique id of resource instance.
15609           required: true
15610           type: string
15611           example: __RESOURCE-INSTANCE-ID__
15612         - name: metaname
15613           in: path
15614           required: true
15615           type: string
15616           example: __METANAME__
15617         - name: body
15618           in: body
15619           description: metadatum object that needs to be created or updated.
15620           required: true
15621           schema:
15622             $ref: "#/patchDefinitions/metadatum"
15623     delete:
15624       tags:
15625         - Business
15626       summary: delete an existing metadatum
15627       description: delete an existing metadatum
15628       operationId: deleteBusinessConnectorsConnectorMetadataMetadatum
15629       consumes:
15630         - application/json
15631         - application/xml
15632       produces:
15633         - application/json
15634         - application/xml
15635       responses:
15636         "default":
15637           description: Response codes found in [response codes](https://wiki.onap.org/).
15638       parameters:
15639         - name: resource-instance-id
15640           in: path
15641           description: Unique id of resource instance.
15642           required: true
15643           type: string
15644           example: __RESOURCE-INSTANCE-ID__
15645         - name: metaname
15646           in: path
15647           required: true
15648           type: string
15649           example: __METANAME__
15650         - name: resource-version
15651           in: query
15652           description: resource-version for concurrency
15653           required: true
15654           type: string
15655   /business/connectors/connector/{resource-instance-id}/metadata:
15656     get:
15657       tags:
15658         - Business
15659       summary: returns metadata
15660       description: returns metadata
15661       operationId: getBusinessConnectorsConnectorMetadata
15662       produces:
15663         - application/json
15664         - application/xml
15665       responses:
15666         "200":
15667           description: successful operation
15668           schema:
15669               $ref: "#/getDefinitions/metadata"
15670         "default":
15671           description: Response codes found in [response codes](https://wiki.onap.org/).
15672       parameters:
15673         - name: resource-instance-id
15674           in: path
15675           description: Unique id of resource instance.
15676           required: true
15677           type: string
15678           example: __RESOURCE-INSTANCE-ID__
15679         - name: model-invariant-id
15680           in: query
15681           description: the ASDC model id for this resource or service model.
15682           required: false
15683           type: string
15684         - name: model-version-id
15685           in: query
15686           description: the ASDC model version for this resource or service model.
15687           required: false
15688           type: string
15689         - name: widget-model-id
15690           in: query
15691           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15692           required: false
15693           type: string
15694         - name: widget-model-version
15695           in: query
15696           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15697           required: false
15698           type: string
15699   /business/connectors/connector/{resource-instance-id}:
15700     get:
15701       tags:
15702         - Business
15703       summary: returns connector
15704       description: returns connector
15705       operationId: getBusinessConnectorsConnector
15706       produces:
15707         - application/json
15708         - application/xml
15709       responses:
15710         "200":
15711           description: successful operation
15712           schema:
15713               $ref: "#/getDefinitions/connector"
15714         "default":
15715           description: Response codes found in [response codes](https://wiki.onap.org/).
15716       parameters:
15717         - name: resource-instance-id
15718           in: path
15719           description: Unique id of resource instance.
15720           required: true
15721           type: string
15722           example: __RESOURCE-INSTANCE-ID__
15723         - name: model-invariant-id
15724           in: query
15725           description: the ASDC model id for this resource or service model.
15726           required: false
15727           type: string
15728         - name: model-version-id
15729           in: query
15730           description: the ASDC model version for this resource or service model.
15731           required: false
15732           type: string
15733         - name: widget-model-id
15734           in: query
15735           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
15736           required: false
15737           type: string
15738         - name: widget-model-version
15739           in: query
15740           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
15741           required: false
15742           type: string
15743     put:
15744       tags:
15745         - Business
15746       summary: create or update an existing connector
15747       description: |
15748         Create or update an existing connector.
15749         #
15750         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
15751       operationId: createOrUpdateBusinessConnectorsConnector
15752       consumes:
15753         - application/json
15754         - application/xml
15755       produces:
15756         - application/json
15757         - application/xml
15758       responses:
15759         "default":
15760           description: Response codes found in [response codes](https://wiki.onap.org/).
15761       parameters:
15762         - name: resource-instance-id
15763           in: path
15764           description: Unique id of resource instance.
15765           required: true
15766           type: string
15767           example: __RESOURCE-INSTANCE-ID__
15768         - name: body
15769           in: body
15770           description: connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)
15771           required: true
15772           schema:
15773             $ref: "#/definitions/connector"
15774     patch:
15775       tags:
15776         - Business
15777       summary: update an existing connector
15778       description: |
15779         Update an existing connector
15780         #
15781         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
15782         The PUT operation will entirely replace an existing object.
15783         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
15784         #
15785         Other differences between PUT and PATCH are:
15786         #
15787         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
15788         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
15789         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
15790       operationId: UpdateBusinessConnectorsConnector
15791       consumes:
15792         - application/json
15793         - application/xml
15794       produces:
15795         - application/json
15796         - application/xml
15797       responses:
15798         "default":
15799           description: Response codes found in [response codes](https://wiki.onap.org/).
15800       parameters:
15801         - name: resource-instance-id
15802           in: path
15803           description: Unique id of resource instance.
15804           required: true
15805           type: string
15806           example: __RESOURCE-INSTANCE-ID__
15807         - name: body
15808           in: body
15809           description: connector object that needs to be created or updated.
15810           required: true
15811           schema:
15812             $ref: "#/patchDefinitions/connector"
15813     delete:
15814       tags:
15815         - Business
15816       summary: delete an existing connector
15817       description: delete an existing connector
15818       operationId: deleteBusinessConnectorsConnector
15819       consumes:
15820         - application/json
15821         - application/xml
15822       produces:
15823         - application/json
15824         - application/xml
15825       responses:
15826         "default":
15827           description: Response codes found in [response codes](https://wiki.onap.org/).
15828       parameters:
15829         - name: resource-instance-id
15830           in: path
15831           description: Unique id of resource instance.
15832           required: true
15833           type: string
15834           example: __RESOURCE-INSTANCE-ID__
15835         - name: resource-version
15836           in: query
15837           description: resource-version for concurrency
15838           required: true
15839           type: string
15840   /business/connectors:
15841     get:
15842       tags:
15843         - Business
15844       summary: returns connectors
15845       description: returns connectors
15846       operationId: getBusinessConnectors
15847       produces:
15848         - application/json
15849         - application/xml
15850       responses:
15851         "200":
15852           description: successful operation
15853           schema:
15854               $ref: "#/getDefinitions/connectors"
15855         "default":
15856           description: Response codes found in [response codes](https://wiki.onap.org/).
15857   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship:
15858     put:
15859       tags:
15860         - Business
15861       summary: see node definition for valid relationships
15862       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15863       consumes:
15864         - application/json
15865         - application/xml
15866       produces:
15867         - application/json
15868         - application/xml
15869       responses:
15870         "default":
15871           description: Response codes found in [response codes](https://wiki.onap.org/).
15872       parameters:
15873         - name: global-customer-id
15874           in: path
15875           description: Global customer id used across ECOMP to uniquely identify customer.
15876           required: true
15877           type: string
15878           example: __GLOBAL-CUSTOMER-ID__
15879         - name: service-type
15880           in: path
15881           description: Value defined by orchestration to identify this service across ECOMP.
15882           required: true
15883           type: string
15884           example: __SERVICE-TYPE__
15885         - name: service-instance-id
15886           in: path
15887           description: Uniquely identifies this instance of a service
15888           required: true
15889           type: string
15890           example: __SERVICE-INSTANCE-ID__
15891         - name: body
15892           in: body
15893           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
15894           required: true
15895           schema:
15896             $ref: "#/definitions/relationship"
15897     delete:
15898       tags:
15899         - Business
15900       summary: delete an existing relationship
15901       description: delete an existing relationship
15902       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceRelationshipListRelationship
15903       consumes:
15904         - application/json
15905         - application/xml
15906       produces:
15907         - application/json
15908         - application/xml
15909       responses:
15910         "default":
15911           description: Response codes found in [response codes](https://wiki.onap.org/).
15912       parameters:
15913         - name: global-customer-id
15914           in: path
15915           description: Global customer id used across ECOMP to uniquely identify customer.
15916           required: true
15917           type: string
15918           example: __GLOBAL-CUSTOMER-ID__
15919         - name: service-type
15920           in: path
15921           description: Value defined by orchestration to identify this service across ECOMP.
15922           required: true
15923           type: string
15924           example: __SERVICE-TYPE__
15925         - name: service-instance-id
15926           in: path
15927           description: Uniquely identifies this instance of a service
15928           required: true
15929           type: string
15930           example: __SERVICE-INSTANCE-ID__
15931   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}:
15932     get:
15933       tags:
15934         - Business
15935       summary: returns metadatum
15936       description: returns metadatum
15937       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
15938       produces:
15939         - application/json
15940         - application/xml
15941       responses:
15942         "200":
15943           description: successful operation
15944           schema:
15945               $ref: "#/getDefinitions/metadatum"
15946         "default":
15947           description: Response codes found in [response codes](https://wiki.onap.org/).
15948       parameters:
15949         - name: global-customer-id
15950           in: path
15951           description: Global customer id used across ECOMP to uniquely identify customer.
15952           required: true
15953           type: string
15954           example: __GLOBAL-CUSTOMER-ID__
15955         - name: service-type
15956           in: path
15957           description: Value defined by orchestration to identify this service across ECOMP.
15958           required: true
15959           type: string
15960           example: __SERVICE-TYPE__
15961         - name: service-instance-id
15962           in: path
15963           description: Uniquely identifies this instance of a service
15964           required: true
15965           type: string
15966           example: __SERVICE-INSTANCE-ID__
15967         - name: metaname
15968           in: path
15969           required: true
15970           type: string
15971           example: __METANAME__
15972         - name: subscriber-name
15973           in: query
15974           description: Subscriber name, an alternate way to retrieve a customer.
15975           required: false
15976           type: string
15977         - name: subscriber-type
15978           in: query
15979           description: Subscriber type, a way to provide VID with only the INFRA customers.
15980           required: false
15981           type: string
15982         - name: service-instance-name
15983           in: query
15984           description: This field will store a name assigned to the service-instance.
15985           required: false
15986           type: string
15987         - name: environment-context
15988           in: query
15989           description: This field will store the environment context assigned to the service-instance.
15990           required: false
15991           type: string
15992         - name: workload-context
15993           in: query
15994           description: This field will store the workload context assigned to the service-instance.
15995           required: false
15996           type: string
15997         - name: model-invariant-id
15998           in: query
15999           description: the ASDC model id for this resource or service model.
16000           required: false
16001           type: string
16002         - name: model-version-id
16003           in: query
16004           description: the ASDC model version for this resource or service model.
16005           required: false
16006           type: string
16007         - name: widget-model-id
16008           in: query
16009           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16010           required: false
16011           type: string
16012         - name: widget-model-version
16013           in: query
16014           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16015           required: false
16016           type: string
16017         - name: service-instance-location-id
16018           in: query
16019           description: An identifier that customers assign to the location where this service is being used.
16020           required: false
16021           type: string
16022         - name: orchestration-status
16023           in: query
16024           description: Orchestration status of this service.
16025           required: false
16026           type: string
16027     put:
16028       tags:
16029         - Business
16030       summary: create or update an existing metadatum
16031       description: |
16032         Create or update an existing metadatum.
16033         #
16034         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16035       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16036       consumes:
16037         - application/json
16038         - application/xml
16039       produces:
16040         - application/json
16041         - application/xml
16042       responses:
16043         "default":
16044           description: Response codes found in [response codes](https://wiki.onap.org/).
16045       parameters:
16046         - name: global-customer-id
16047           in: path
16048           description: Global customer id used across ECOMP to uniquely identify customer.
16049           required: true
16050           type: string
16051           example: __GLOBAL-CUSTOMER-ID__
16052         - name: service-type
16053           in: path
16054           description: Value defined by orchestration to identify this service across ECOMP.
16055           required: true
16056           type: string
16057           example: __SERVICE-TYPE__
16058         - name: service-instance-id
16059           in: path
16060           description: Uniquely identifies this instance of a service
16061           required: true
16062           type: string
16063           example: __SERVICE-INSTANCE-ID__
16064         - name: metaname
16065           in: path
16066           required: true
16067           type: string
16068           example: __METANAME__
16069         - name: body
16070           in: body
16071           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)
16072           required: true
16073           schema:
16074             $ref: "#/definitions/metadatum"
16075     patch:
16076       tags:
16077         - Business
16078       summary: update an existing metadatum
16079       description: |
16080         Update an existing metadatum
16081         #
16082         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16083         The PUT operation will entirely replace an existing object.
16084         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16085         #
16086         Other differences between PUT and PATCH are:
16087         #
16088         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16089         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16090         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16091       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16092       consumes:
16093         - application/json
16094         - application/xml
16095       produces:
16096         - application/json
16097         - application/xml
16098       responses:
16099         "default":
16100           description: Response codes found in [response codes](https://wiki.onap.org/).
16101       parameters:
16102         - name: global-customer-id
16103           in: path
16104           description: Global customer id used across ECOMP to uniquely identify customer.
16105           required: true
16106           type: string
16107           example: __GLOBAL-CUSTOMER-ID__
16108         - name: service-type
16109           in: path
16110           description: Value defined by orchestration to identify this service across ECOMP.
16111           required: true
16112           type: string
16113           example: __SERVICE-TYPE__
16114         - name: service-instance-id
16115           in: path
16116           description: Uniquely identifies this instance of a service
16117           required: true
16118           type: string
16119           example: __SERVICE-INSTANCE-ID__
16120         - name: metaname
16121           in: path
16122           required: true
16123           type: string
16124           example: __METANAME__
16125         - name: body
16126           in: body
16127           description: metadatum object that needs to be created or updated.
16128           required: true
16129           schema:
16130             $ref: "#/patchDefinitions/metadatum"
16131     delete:
16132       tags:
16133         - Business
16134       summary: delete an existing metadatum
16135       description: delete an existing metadatum
16136       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum
16137       consumes:
16138         - application/json
16139         - application/xml
16140       produces:
16141         - application/json
16142         - application/xml
16143       responses:
16144         "default":
16145           description: Response codes found in [response codes](https://wiki.onap.org/).
16146       parameters:
16147         - name: global-customer-id
16148           in: path
16149           description: Global customer id used across ECOMP to uniquely identify customer.
16150           required: true
16151           type: string
16152           example: __GLOBAL-CUSTOMER-ID__
16153         - name: service-type
16154           in: path
16155           description: Value defined by orchestration to identify this service across ECOMP.
16156           required: true
16157           type: string
16158           example: __SERVICE-TYPE__
16159         - name: service-instance-id
16160           in: path
16161           description: Uniquely identifies this instance of a service
16162           required: true
16163           type: string
16164           example: __SERVICE-INSTANCE-ID__
16165         - name: metaname
16166           in: path
16167           required: true
16168           type: string
16169           example: __METANAME__
16170         - name: resource-version
16171           in: query
16172           description: resource-version for concurrency
16173           required: true
16174           type: string
16175   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata:
16176     get:
16177       tags:
16178         - Business
16179       summary: returns metadata
16180       description: returns metadata
16181       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadata
16182       produces:
16183         - application/json
16184         - application/xml
16185       responses:
16186         "200":
16187           description: successful operation
16188           schema:
16189               $ref: "#/getDefinitions/metadata"
16190         "default":
16191           description: Response codes found in [response codes](https://wiki.onap.org/).
16192       parameters:
16193         - name: global-customer-id
16194           in: path
16195           description: Global customer id used across ECOMP to uniquely identify customer.
16196           required: true
16197           type: string
16198           example: __GLOBAL-CUSTOMER-ID__
16199         - name: service-type
16200           in: path
16201           description: Value defined by orchestration to identify this service across ECOMP.
16202           required: true
16203           type: string
16204           example: __SERVICE-TYPE__
16205         - name: service-instance-id
16206           in: path
16207           description: Uniquely identifies this instance of a service
16208           required: true
16209           type: string
16210           example: __SERVICE-INSTANCE-ID__
16211         - name: subscriber-name
16212           in: query
16213           description: Subscriber name, an alternate way to retrieve a customer.
16214           required: false
16215           type: string
16216         - name: subscriber-type
16217           in: query
16218           description: Subscriber type, a way to provide VID with only the INFRA customers.
16219           required: false
16220           type: string
16221         - name: service-instance-name
16222           in: query
16223           description: This field will store a name assigned to the service-instance.
16224           required: false
16225           type: string
16226         - name: environment-context
16227           in: query
16228           description: This field will store the environment context assigned to the service-instance.
16229           required: false
16230           type: string
16231         - name: workload-context
16232           in: query
16233           description: This field will store the workload context assigned to the service-instance.
16234           required: false
16235           type: string
16236         - name: model-invariant-id
16237           in: query
16238           description: the ASDC model id for this resource or service model.
16239           required: false
16240           type: string
16241         - name: model-version-id
16242           in: query
16243           description: the ASDC model version for this resource or service model.
16244           required: false
16245           type: string
16246         - name: widget-model-id
16247           in: query
16248           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16249           required: false
16250           type: string
16251         - name: widget-model-version
16252           in: query
16253           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16254           required: false
16255           type: string
16256         - name: service-instance-location-id
16257           in: query
16258           description: An identifier that customers assign to the location where this service is being used.
16259           required: false
16260           type: string
16261         - name: orchestration-status
16262           in: query
16263           description: Orchestration status of this service.
16264           required: false
16265           type: string
16266   /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:
16267     put:
16268       tags:
16269         - Business
16270       summary: see node definition for valid relationships
16271       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
16272       consumes:
16273         - application/json
16274         - application/xml
16275       produces:
16276         - application/json
16277         - application/xml
16278       responses:
16279         "default":
16280           description: Response codes found in [response codes](https://wiki.onap.org/).
16281       parameters:
16282         - name: global-customer-id
16283           in: path
16284           description: Global customer id used across ECOMP to uniquely identify customer.
16285           required: true
16286           type: string
16287           example: __GLOBAL-CUSTOMER-ID__
16288         - name: service-type
16289           in: path
16290           description: Value defined by orchestration to identify this service across ECOMP.
16291           required: true
16292           type: string
16293           example: __SERVICE-TYPE__
16294         - name: service-instance-id
16295           in: path
16296           description: Uniquely identifies this instance of a service
16297           required: true
16298           type: string
16299           example: __SERVICE-INSTANCE-ID__
16300         - name: id
16301           in: path
16302           description: Allotted Resource id UUID assigned to this instance.
16303           required: true
16304           type: string
16305           example: __ID__
16306         - name: id
16307           in: path
16308           description: Allotted Resource id UUID assigned to this instance.
16309           required: true
16310           type: string
16311           example: __ID__
16312         - name: body
16313           in: body
16314           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
16315           required: true
16316           schema:
16317             $ref: "#/definitions/relationship"
16318     delete:
16319       tags:
16320         - Business
16321       summary: delete an existing relationship
16322       description: delete an existing relationship
16323       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnectRelationshipListRelationship
16324       consumes:
16325         - application/json
16326         - application/xml
16327       produces:
16328         - application/json
16329         - application/xml
16330       responses:
16331         "default":
16332           description: Response codes found in [response codes](https://wiki.onap.org/).
16333       parameters:
16334         - name: global-customer-id
16335           in: path
16336           description: Global customer id used across ECOMP to uniquely identify customer.
16337           required: true
16338           type: string
16339           example: __GLOBAL-CUSTOMER-ID__
16340         - name: service-type
16341           in: path
16342           description: Value defined by orchestration to identify this service across ECOMP.
16343           required: true
16344           type: string
16345           example: __SERVICE-TYPE__
16346         - name: service-instance-id
16347           in: path
16348           description: Uniquely identifies this instance of a service
16349           required: true
16350           type: string
16351           example: __SERVICE-INSTANCE-ID__
16352         - name: id
16353           in: path
16354           description: Allotted Resource id UUID assigned to this instance.
16355           required: true
16356           type: string
16357           example: __ID__
16358         - name: id
16359           in: path
16360           description: Allotted Resource id UUID assigned to this instance.
16361           required: true
16362           type: string
16363           example: __ID__
16364   /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}:
16365     get:
16366       tags:
16367         - Business
16368       summary: returns tunnel-xconnect
16369       description: returns tunnel-xconnect
16370       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16371       produces:
16372         - application/json
16373         - application/xml
16374       responses:
16375         "200":
16376           description: successful operation
16377           schema:
16378               $ref: "#/getDefinitions/tunnel-xconnect"
16379         "default":
16380           description: Response codes found in [response codes](https://wiki.onap.org/).
16381       parameters:
16382         - name: global-customer-id
16383           in: path
16384           description: Global customer id used across ECOMP to uniquely identify customer.
16385           required: true
16386           type: string
16387           example: __GLOBAL-CUSTOMER-ID__
16388         - name: service-type
16389           in: path
16390           description: Value defined by orchestration to identify this service across ECOMP.
16391           required: true
16392           type: string
16393           example: __SERVICE-TYPE__
16394         - name: service-instance-id
16395           in: path
16396           description: Uniquely identifies this instance of a service
16397           required: true
16398           type: string
16399           example: __SERVICE-INSTANCE-ID__
16400         - name: id
16401           in: path
16402           description: Allotted Resource id UUID assigned to this instance.
16403           required: true
16404           type: string
16405           example: __ID__
16406         - name: id
16407           in: path
16408           description: Allotted Resource id UUID assigned to this instance.
16409           required: true
16410           type: string
16411           example: __ID__
16412         - name: subscriber-name
16413           in: query
16414           description: Subscriber name, an alternate way to retrieve a customer.
16415           required: false
16416           type: string
16417         - name: subscriber-type
16418           in: query
16419           description: Subscriber type, a way to provide VID with only the INFRA customers.
16420           required: false
16421           type: string
16422         - name: service-instance-name
16423           in: query
16424           description: This field will store a name assigned to the service-instance.
16425           required: false
16426           type: string
16427         - name: environment-context
16428           in: query
16429           description: This field will store the environment context assigned to the service-instance.
16430           required: false
16431           type: string
16432         - name: workload-context
16433           in: query
16434           description: This field will store the workload context assigned to the service-instance.
16435           required: false
16436           type: string
16437         - name: model-invariant-id
16438           in: query
16439           description: the ASDC model id for this resource or service model.
16440           required: false
16441           type: string
16442         - name: model-version-id
16443           in: query
16444           description: the ASDC model version for this resource or service model.
16445           required: false
16446           type: string
16447         - name: widget-model-id
16448           in: query
16449           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16450           required: false
16451           type: string
16452         - name: widget-model-version
16453           in: query
16454           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16455           required: false
16456           type: string
16457         - name: service-instance-location-id
16458           in: query
16459           description: An identifier that customers assign to the location where this service is being used.
16460           required: false
16461           type: string
16462         - name: orchestration-status
16463           in: query
16464           description: Orchestration status of this service.
16465           required: false
16466           type: string
16467         - name: model-invariant-id
16468           in: query
16469           description: the ASDC model id for this resource or service model.
16470           required: false
16471           type: string
16472         - name: model-version-id
16473           in: query
16474           description: the ASDC model version for this resource or service model.
16475           required: false
16476           type: string
16477         - name: type
16478           in: query
16479           description: Generic description of the type of allotted resource.
16480           required: false
16481           type: string
16482         - name: role
16483           in: query
16484           description: role in the network that this resource will be providing.
16485           required: false
16486           type: string
16487     put:
16488       tags:
16489         - Business
16490       summary: create or update an existing tunnel-xconnect
16491       description: |
16492         Create or update an existing tunnel-xconnect.
16493         #
16494         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16495       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16496       consumes:
16497         - application/json
16498         - application/xml
16499       produces:
16500         - application/json
16501         - application/xml
16502       responses:
16503         "default":
16504           description: Response codes found in [response codes](https://wiki.onap.org/).
16505       parameters:
16506         - name: global-customer-id
16507           in: path
16508           description: Global customer id used across ECOMP to uniquely identify customer.
16509           required: true
16510           type: string
16511           example: __GLOBAL-CUSTOMER-ID__
16512         - name: service-type
16513           in: path
16514           description: Value defined by orchestration to identify this service across ECOMP.
16515           required: true
16516           type: string
16517           example: __SERVICE-TYPE__
16518         - name: service-instance-id
16519           in: path
16520           description: Uniquely identifies this instance of a service
16521           required: true
16522           type: string
16523           example: __SERVICE-INSTANCE-ID__
16524         - name: id
16525           in: path
16526           description: Allotted Resource id UUID assigned to this instance.
16527           required: true
16528           type: string
16529           example: __ID__
16530         - name: id
16531           in: path
16532           description: Allotted Resource id UUID assigned to this instance.
16533           required: true
16534           type: string
16535           example: __ID__
16536         - name: body
16537           in: body
16538           description: tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)
16539           required: true
16540           schema:
16541             $ref: "#/definitions/tunnel-xconnect"
16542     patch:
16543       tags:
16544         - Business
16545       summary: update an existing tunnel-xconnect
16546       description: |
16547         Update an existing tunnel-xconnect
16548         #
16549         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
16550         The PUT operation will entirely replace an existing object.
16551         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
16552         #
16553         Other differences between PUT and PATCH are:
16554         #
16555         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
16556         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
16557         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
16558       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16559       consumes:
16560         - application/json
16561         - application/xml
16562       produces:
16563         - application/json
16564         - application/xml
16565       responses:
16566         "default":
16567           description: Response codes found in [response codes](https://wiki.onap.org/).
16568       parameters:
16569         - name: global-customer-id
16570           in: path
16571           description: Global customer id used across ECOMP to uniquely identify customer.
16572           required: true
16573           type: string
16574           example: __GLOBAL-CUSTOMER-ID__
16575         - name: service-type
16576           in: path
16577           description: Value defined by orchestration to identify this service across ECOMP.
16578           required: true
16579           type: string
16580           example: __SERVICE-TYPE__
16581         - name: service-instance-id
16582           in: path
16583           description: Uniquely identifies this instance of a service
16584           required: true
16585           type: string
16586           example: __SERVICE-INSTANCE-ID__
16587         - name: id
16588           in: path
16589           description: Allotted Resource id UUID assigned to this instance.
16590           required: true
16591           type: string
16592           example: __ID__
16593         - name: id
16594           in: path
16595           description: Allotted Resource id UUID assigned to this instance.
16596           required: true
16597           type: string
16598           example: __ID__
16599         - name: body
16600           in: body
16601           description: tunnel-xconnect object that needs to be created or updated.
16602           required: true
16603           schema:
16604             $ref: "#/patchDefinitions/tunnel-xconnect"
16605     delete:
16606       tags:
16607         - Business
16608       summary: delete an existing tunnel-xconnect
16609       description: delete an existing tunnel-xconnect
16610       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect
16611       consumes:
16612         - application/json
16613         - application/xml
16614       produces:
16615         - application/json
16616         - application/xml
16617       responses:
16618         "default":
16619           description: Response codes found in [response codes](https://wiki.onap.org/).
16620       parameters:
16621         - name: global-customer-id
16622           in: path
16623           description: Global customer id used across ECOMP to uniquely identify customer.
16624           required: true
16625           type: string
16626           example: __GLOBAL-CUSTOMER-ID__
16627         - name: service-type
16628           in: path
16629           description: Value defined by orchestration to identify this service across ECOMP.
16630           required: true
16631           type: string
16632           example: __SERVICE-TYPE__
16633         - name: service-instance-id
16634           in: path
16635           description: Uniquely identifies this instance of a service
16636           required: true
16637           type: string
16638           example: __SERVICE-INSTANCE-ID__
16639         - name: id
16640           in: path
16641           description: Allotted Resource id UUID assigned to this instance.
16642           required: true
16643           type: string
16644           example: __ID__
16645         - name: id
16646           in: path
16647           description: Allotted Resource id UUID assigned to this instance.
16648           required: true
16649           type: string
16650           example: __ID__
16651         - name: resource-version
16652           in: query
16653           description: resource-version for concurrency
16654           required: true
16655           type: string
16656   /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:
16657     get:
16658       tags:
16659         - Business
16660       summary: returns tunnel-xconnects
16661       description: returns tunnel-xconnects
16662       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnects
16663       produces:
16664         - application/json
16665         - application/xml
16666       responses:
16667         "200":
16668           description: successful operation
16669           schema:
16670               $ref: "#/getDefinitions/tunnel-xconnects"
16671         "default":
16672           description: Response codes found in [response codes](https://wiki.onap.org/).
16673       parameters:
16674         - name: global-customer-id
16675           in: path
16676           description: Global customer id used across ECOMP to uniquely identify customer.
16677           required: true
16678           type: string
16679           example: __GLOBAL-CUSTOMER-ID__
16680         - name: service-type
16681           in: path
16682           description: Value defined by orchestration to identify this service across ECOMP.
16683           required: true
16684           type: string
16685           example: __SERVICE-TYPE__
16686         - name: service-instance-id
16687           in: path
16688           description: Uniquely identifies this instance of a service
16689           required: true
16690           type: string
16691           example: __SERVICE-INSTANCE-ID__
16692         - name: id
16693           in: path
16694           description: Allotted Resource id UUID assigned to this instance.
16695           required: true
16696           type: string
16697           example: __ID__
16698         - name: subscriber-name
16699           in: query
16700           description: Subscriber name, an alternate way to retrieve a customer.
16701           required: false
16702           type: string
16703         - name: subscriber-type
16704           in: query
16705           description: Subscriber type, a way to provide VID with only the INFRA customers.
16706           required: false
16707           type: string
16708         - name: service-instance-name
16709           in: query
16710           description: This field will store a name assigned to the service-instance.
16711           required: false
16712           type: string
16713         - name: environment-context
16714           in: query
16715           description: This field will store the environment context assigned to the service-instance.
16716           required: false
16717           type: string
16718         - name: workload-context
16719           in: query
16720           description: This field will store the workload context assigned to the service-instance.
16721           required: false
16722           type: string
16723         - name: model-invariant-id
16724           in: query
16725           description: the ASDC model id for this resource or service model.
16726           required: false
16727           type: string
16728         - name: model-version-id
16729           in: query
16730           description: the ASDC model version for this resource or service model.
16731           required: false
16732           type: string
16733         - name: widget-model-id
16734           in: query
16735           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16736           required: false
16737           type: string
16738         - name: widget-model-version
16739           in: query
16740           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16741           required: false
16742           type: string
16743         - name: service-instance-location-id
16744           in: query
16745           description: An identifier that customers assign to the location where this service is being used.
16746           required: false
16747           type: string
16748         - name: orchestration-status
16749           in: query
16750           description: Orchestration status of this service.
16751           required: false
16752           type: string
16753         - name: model-invariant-id
16754           in: query
16755           description: the ASDC model id for this resource or service model.
16756           required: false
16757           type: string
16758         - name: model-version-id
16759           in: query
16760           description: the ASDC model version for this resource or service model.
16761           required: false
16762           type: string
16763         - name: type
16764           in: query
16765           description: Generic description of the type of allotted resource.
16766           required: false
16767           type: string
16768         - name: role
16769           in: query
16770           description: role in the network that this resource will be providing.
16771           required: false
16772           type: string
16773   /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:
16774     put:
16775       tags:
16776         - Business
16777       summary: see node definition for valid relationships
16778       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
16779       consumes:
16780         - application/json
16781         - application/xml
16782       produces:
16783         - application/json
16784         - application/xml
16785       responses:
16786         "default":
16787           description: Response codes found in [response codes](https://wiki.onap.org/).
16788       parameters:
16789         - name: global-customer-id
16790           in: path
16791           description: Global customer id used across ECOMP to uniquely identify customer.
16792           required: true
16793           type: string
16794           example: __GLOBAL-CUSTOMER-ID__
16795         - name: service-type
16796           in: path
16797           description: Value defined by orchestration to identify this service across ECOMP.
16798           required: true
16799           type: string
16800           example: __SERVICE-TYPE__
16801         - name: service-instance-id
16802           in: path
16803           description: Uniquely identifies this instance of a service
16804           required: true
16805           type: string
16806           example: __SERVICE-INSTANCE-ID__
16807         - name: id
16808           in: path
16809           description: Allotted Resource id UUID assigned to this instance.
16810           required: true
16811           type: string
16812           example: __ID__
16813         - name: body
16814           in: body
16815           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
16816           required: true
16817           schema:
16818             $ref: "#/definitions/relationship"
16819     delete:
16820       tags:
16821         - Business
16822       summary: delete an existing relationship
16823       description: delete an existing relationship
16824       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceRelationshipListRelationship
16825       consumes:
16826         - application/json
16827         - application/xml
16828       produces:
16829         - application/json
16830         - application/xml
16831       responses:
16832         "default":
16833           description: Response codes found in [response codes](https://wiki.onap.org/).
16834       parameters:
16835         - name: global-customer-id
16836           in: path
16837           description: Global customer id used across ECOMP to uniquely identify customer.
16838           required: true
16839           type: string
16840           example: __GLOBAL-CUSTOMER-ID__
16841         - name: service-type
16842           in: path
16843           description: Value defined by orchestration to identify this service across ECOMP.
16844           required: true
16845           type: string
16846           example: __SERVICE-TYPE__
16847         - name: service-instance-id
16848           in: path
16849           description: Uniquely identifies this instance of a service
16850           required: true
16851           type: string
16852           example: __SERVICE-INSTANCE-ID__
16853         - name: id
16854           in: path
16855           description: Allotted Resource id UUID assigned to this instance.
16856           required: true
16857           type: string
16858           example: __ID__
16859   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}:
16860     get:
16861       tags:
16862         - Business
16863       summary: returns allotted-resource
16864       description: returns allotted-resource
16865       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16866       produces:
16867         - application/json
16868         - application/xml
16869       responses:
16870         "200":
16871           description: successful operation
16872           schema:
16873               $ref: "#/getDefinitions/allotted-resource"
16874         "default":
16875           description: Response codes found in [response codes](https://wiki.onap.org/).
16876       parameters:
16877         - name: global-customer-id
16878           in: path
16879           description: Global customer id used across ECOMP to uniquely identify customer.
16880           required: true
16881           type: string
16882           example: __GLOBAL-CUSTOMER-ID__
16883         - name: service-type
16884           in: path
16885           description: Value defined by orchestration to identify this service across ECOMP.
16886           required: true
16887           type: string
16888           example: __SERVICE-TYPE__
16889         - name: service-instance-id
16890           in: path
16891           description: Uniquely identifies this instance of a service
16892           required: true
16893           type: string
16894           example: __SERVICE-INSTANCE-ID__
16895         - name: id
16896           in: path
16897           description: Allotted Resource id UUID assigned to this instance.
16898           required: true
16899           type: string
16900           example: __ID__
16901         - name: subscriber-name
16902           in: query
16903           description: Subscriber name, an alternate way to retrieve a customer.
16904           required: false
16905           type: string
16906         - name: subscriber-type
16907           in: query
16908           description: Subscriber type, a way to provide VID with only the INFRA customers.
16909           required: false
16910           type: string
16911         - name: service-instance-name
16912           in: query
16913           description: This field will store a name assigned to the service-instance.
16914           required: false
16915           type: string
16916         - name: environment-context
16917           in: query
16918           description: This field will store the environment context assigned to the service-instance.
16919           required: false
16920           type: string
16921         - name: workload-context
16922           in: query
16923           description: This field will store the workload context assigned to the service-instance.
16924           required: false
16925           type: string
16926         - name: model-invariant-id
16927           in: query
16928           description: the ASDC model id for this resource or service model.
16929           required: false
16930           type: string
16931         - name: model-version-id
16932           in: query
16933           description: the ASDC model version for this resource or service model.
16934           required: false
16935           type: string
16936         - name: widget-model-id
16937           in: query
16938           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
16939           required: false
16940           type: string
16941         - name: widget-model-version
16942           in: query
16943           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
16944           required: false
16945           type: string
16946         - name: service-instance-location-id
16947           in: query
16948           description: An identifier that customers assign to the location where this service is being used.
16949           required: false
16950           type: string
16951         - name: orchestration-status
16952           in: query
16953           description: Orchestration status of this service.
16954           required: false
16955           type: string
16956         - name: model-invariant-id
16957           in: query
16958           description: the ASDC model id for this resource or service model.
16959           required: false
16960           type: string
16961         - name: model-version-id
16962           in: query
16963           description: the ASDC model version for this resource or service model.
16964           required: false
16965           type: string
16966         - name: type
16967           in: query
16968           description: Generic description of the type of allotted resource.
16969           required: false
16970           type: string
16971         - name: role
16972           in: query
16973           description: role in the network that this resource will be providing.
16974           required: false
16975           type: string
16976     put:
16977       tags:
16978         - Business
16979       summary: create or update an existing allotted-resource
16980       description: |
16981         Create or update an existing allotted-resource.
16982         #
16983         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
16984       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
16985       consumes:
16986         - application/json
16987         - application/xml
16988       produces:
16989         - application/json
16990         - application/xml
16991       responses:
16992         "default":
16993           description: Response codes found in [response codes](https://wiki.onap.org/).
16994       parameters:
16995         - name: global-customer-id
16996           in: path
16997           description: Global customer id used across ECOMP to uniquely identify customer.
16998           required: true
16999           type: string
17000           example: __GLOBAL-CUSTOMER-ID__
17001         - name: service-type
17002           in: path
17003           description: Value defined by orchestration to identify this service across ECOMP.
17004           required: true
17005           type: string
17006           example: __SERVICE-TYPE__
17007         - name: service-instance-id
17008           in: path
17009           description: Uniquely identifies this instance of a service
17010           required: true
17011           type: string
17012           example: __SERVICE-INSTANCE-ID__
17013         - name: id
17014           in: path
17015           description: Allotted Resource id UUID assigned to this instance.
17016           required: true
17017           type: string
17018           example: __ID__
17019         - name: body
17020           in: body
17021           description: allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)
17022           required: true
17023           schema:
17024             $ref: "#/definitions/allotted-resource"
17025     patch:
17026       tags:
17027         - Business
17028       summary: update an existing allotted-resource
17029       description: |
17030         Update an existing allotted-resource
17031         #
17032         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17033         The PUT operation will entirely replace an existing object.
17034         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17035         #
17036         Other differences between PUT and PATCH are:
17037         #
17038         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17039         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17040         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17041       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17042       consumes:
17043         - application/json
17044         - application/xml
17045       produces:
17046         - application/json
17047         - application/xml
17048       responses:
17049         "default":
17050           description: Response codes found in [response codes](https://wiki.onap.org/).
17051       parameters:
17052         - name: global-customer-id
17053           in: path
17054           description: Global customer id used across ECOMP to uniquely identify customer.
17055           required: true
17056           type: string
17057           example: __GLOBAL-CUSTOMER-ID__
17058         - name: service-type
17059           in: path
17060           description: Value defined by orchestration to identify this service across ECOMP.
17061           required: true
17062           type: string
17063           example: __SERVICE-TYPE__
17064         - name: service-instance-id
17065           in: path
17066           description: Uniquely identifies this instance of a service
17067           required: true
17068           type: string
17069           example: __SERVICE-INSTANCE-ID__
17070         - name: id
17071           in: path
17072           description: Allotted Resource id UUID assigned to this instance.
17073           required: true
17074           type: string
17075           example: __ID__
17076         - name: body
17077           in: body
17078           description: allotted-resource object that needs to be created or updated.
17079           required: true
17080           schema:
17081             $ref: "#/patchDefinitions/allotted-resource"
17082     delete:
17083       tags:
17084         - Business
17085       summary: delete an existing allotted-resource
17086       description: delete an existing allotted-resource
17087       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource
17088       consumes:
17089         - application/json
17090         - application/xml
17091       produces:
17092         - application/json
17093         - application/xml
17094       responses:
17095         "default":
17096           description: Response codes found in [response codes](https://wiki.onap.org/).
17097       parameters:
17098         - name: global-customer-id
17099           in: path
17100           description: Global customer id used across ECOMP to uniquely identify customer.
17101           required: true
17102           type: string
17103           example: __GLOBAL-CUSTOMER-ID__
17104         - name: service-type
17105           in: path
17106           description: Value defined by orchestration to identify this service across ECOMP.
17107           required: true
17108           type: string
17109           example: __SERVICE-TYPE__
17110         - name: service-instance-id
17111           in: path
17112           description: Uniquely identifies this instance of a service
17113           required: true
17114           type: string
17115           example: __SERVICE-INSTANCE-ID__
17116         - name: id
17117           in: path
17118           description: Allotted Resource id UUID assigned to this instance.
17119           required: true
17120           type: string
17121           example: __ID__
17122         - name: resource-version
17123           in: query
17124           description: resource-version for concurrency
17125           required: true
17126           type: string
17127   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources:
17128     get:
17129       tags:
17130         - Business
17131       summary: returns allotted-resources
17132       description: returns allotted-resources
17133       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResources
17134       produces:
17135         - application/json
17136         - application/xml
17137       responses:
17138         "200":
17139           description: successful operation
17140           schema:
17141               $ref: "#/getDefinitions/allotted-resources"
17142         "default":
17143           description: Response codes found in [response codes](https://wiki.onap.org/).
17144       parameters:
17145         - name: global-customer-id
17146           in: path
17147           description: Global customer id used across ECOMP to uniquely identify customer.
17148           required: true
17149           type: string
17150           example: __GLOBAL-CUSTOMER-ID__
17151         - name: service-type
17152           in: path
17153           description: Value defined by orchestration to identify this service across ECOMP.
17154           required: true
17155           type: string
17156           example: __SERVICE-TYPE__
17157         - name: service-instance-id
17158           in: path
17159           description: Uniquely identifies this instance of a service
17160           required: true
17161           type: string
17162           example: __SERVICE-INSTANCE-ID__
17163         - name: subscriber-name
17164           in: query
17165           description: Subscriber name, an alternate way to retrieve a customer.
17166           required: false
17167           type: string
17168         - name: subscriber-type
17169           in: query
17170           description: Subscriber type, a way to provide VID with only the INFRA customers.
17171           required: false
17172           type: string
17173         - name: service-instance-name
17174           in: query
17175           description: This field will store a name assigned to the service-instance.
17176           required: false
17177           type: string
17178         - name: environment-context
17179           in: query
17180           description: This field will store the environment context assigned to the service-instance.
17181           required: false
17182           type: string
17183         - name: workload-context
17184           in: query
17185           description: This field will store the workload context assigned to the service-instance.
17186           required: false
17187           type: string
17188         - name: model-invariant-id
17189           in: query
17190           description: the ASDC model id for this resource or service model.
17191           required: false
17192           type: string
17193         - name: model-version-id
17194           in: query
17195           description: the ASDC model version for this resource or service model.
17196           required: false
17197           type: string
17198         - name: widget-model-id
17199           in: query
17200           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17201           required: false
17202           type: string
17203         - name: widget-model-version
17204           in: query
17205           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17206           required: false
17207           type: string
17208         - name: service-instance-location-id
17209           in: query
17210           description: An identifier that customers assign to the location where this service is being used.
17211           required: false
17212           type: string
17213         - name: orchestration-status
17214           in: query
17215           description: Orchestration status of this service.
17216           required: false
17217           type: string
17218   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}:
17219     get:
17220       tags:
17221         - Business
17222       summary: returns service-instance
17223       description: returns service-instance
17224       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17225       produces:
17226         - application/json
17227         - application/xml
17228       responses:
17229         "200":
17230           description: successful operation
17231           schema:
17232               $ref: "#/getDefinitions/service-instance"
17233         "default":
17234           description: Response codes found in [response codes](https://wiki.onap.org/).
17235       parameters:
17236         - name: global-customer-id
17237           in: path
17238           description: Global customer id used across ECOMP to uniquely identify customer.
17239           required: true
17240           type: string
17241           example: __GLOBAL-CUSTOMER-ID__
17242         - name: service-type
17243           in: path
17244           description: Value defined by orchestration to identify this service across ECOMP.
17245           required: true
17246           type: string
17247           example: __SERVICE-TYPE__
17248         - name: service-instance-id
17249           in: path
17250           description: Uniquely identifies this instance of a service
17251           required: true
17252           type: string
17253           example: __SERVICE-INSTANCE-ID__
17254         - name: subscriber-name
17255           in: query
17256           description: Subscriber name, an alternate way to retrieve a customer.
17257           required: false
17258           type: string
17259         - name: subscriber-type
17260           in: query
17261           description: Subscriber type, a way to provide VID with only the INFRA customers.
17262           required: false
17263           type: string
17264         - name: service-instance-name
17265           in: query
17266           description: This field will store a name assigned to the service-instance.
17267           required: false
17268           type: string
17269         - name: environment-context
17270           in: query
17271           description: This field will store the environment context assigned to the service-instance.
17272           required: false
17273           type: string
17274         - name: workload-context
17275           in: query
17276           description: This field will store the workload context assigned to the service-instance.
17277           required: false
17278           type: string
17279         - name: model-invariant-id
17280           in: query
17281           description: the ASDC model id for this resource or service model.
17282           required: false
17283           type: string
17284         - name: model-version-id
17285           in: query
17286           description: the ASDC model version for this resource or service model.
17287           required: false
17288           type: string
17289         - name: widget-model-id
17290           in: query
17291           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
17292           required: false
17293           type: string
17294         - name: widget-model-version
17295           in: query
17296           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
17297           required: false
17298           type: string
17299         - name: service-instance-location-id
17300           in: query
17301           description: An identifier that customers assign to the location where this service is being used.
17302           required: false
17303           type: string
17304         - name: orchestration-status
17305           in: query
17306           description: Orchestration status of this service.
17307           required: false
17308           type: string
17309     put:
17310       tags:
17311         - Business
17312       summary: create or update an existing service-instance
17313       description: |
17314         Create or update an existing service-instance.
17315         #
17316         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17317       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17318       consumes:
17319         - application/json
17320         - application/xml
17321       produces:
17322         - application/json
17323         - application/xml
17324       responses:
17325         "default":
17326           description: Response codes found in [response codes](https://wiki.onap.org/).
17327       parameters:
17328         - name: global-customer-id
17329           in: path
17330           description: Global customer id used across ECOMP to uniquely identify customer.
17331           required: true
17332           type: string
17333           example: __GLOBAL-CUSTOMER-ID__
17334         - name: service-type
17335           in: path
17336           description: Value defined by orchestration to identify this service across ECOMP.
17337           required: true
17338           type: string
17339           example: __SERVICE-TYPE__
17340         - name: service-instance-id
17341           in: path
17342           description: Uniquely identifies this instance of a service
17343           required: true
17344           type: string
17345           example: __SERVICE-INSTANCE-ID__
17346         - name: body
17347           in: body
17348           description: service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)
17349           required: true
17350           schema:
17351             $ref: "#/definitions/service-instance"
17352     patch:
17353       tags:
17354         - Business
17355       summary: update an existing service-instance
17356       description: |
17357         Update an existing service-instance
17358         #
17359         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17360         The PUT operation will entirely replace an existing object.
17361         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17362         #
17363         Other differences between PUT and PATCH are:
17364         #
17365         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17366         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17367         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17368       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17369       consumes:
17370         - application/json
17371         - application/xml
17372       produces:
17373         - application/json
17374         - application/xml
17375       responses:
17376         "default":
17377           description: Response codes found in [response codes](https://wiki.onap.org/).
17378       parameters:
17379         - name: global-customer-id
17380           in: path
17381           description: Global customer id used across ECOMP to uniquely identify customer.
17382           required: true
17383           type: string
17384           example: __GLOBAL-CUSTOMER-ID__
17385         - name: service-type
17386           in: path
17387           description: Value defined by orchestration to identify this service across ECOMP.
17388           required: true
17389           type: string
17390           example: __SERVICE-TYPE__
17391         - name: service-instance-id
17392           in: path
17393           description: Uniquely identifies this instance of a service
17394           required: true
17395           type: string
17396           example: __SERVICE-INSTANCE-ID__
17397         - name: body
17398           in: body
17399           description: service-instance object that needs to be created or updated.
17400           required: true
17401           schema:
17402             $ref: "#/patchDefinitions/service-instance"
17403     delete:
17404       tags:
17405         - Business
17406       summary: delete an existing service-instance
17407       description: delete an existing service-instance
17408       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance
17409       consumes:
17410         - application/json
17411         - application/xml
17412       produces:
17413         - application/json
17414         - application/xml
17415       responses:
17416         "default":
17417           description: Response codes found in [response codes](https://wiki.onap.org/).
17418       parameters:
17419         - name: global-customer-id
17420           in: path
17421           description: Global customer id used across ECOMP to uniquely identify customer.
17422           required: true
17423           type: string
17424           example: __GLOBAL-CUSTOMER-ID__
17425         - name: service-type
17426           in: path
17427           description: Value defined by orchestration to identify this service across ECOMP.
17428           required: true
17429           type: string
17430           example: __SERVICE-TYPE__
17431         - name: service-instance-id
17432           in: path
17433           description: Uniquely identifies this instance of a service
17434           required: true
17435           type: string
17436           example: __SERVICE-INSTANCE-ID__
17437         - name: resource-version
17438           in: query
17439           description: resource-version for concurrency
17440           required: true
17441           type: string
17442   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances:
17443     get:
17444       tags:
17445         - Business
17446       summary: returns service-instances
17447       description: returns service-instances
17448       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstances
17449       produces:
17450         - application/json
17451         - application/xml
17452       responses:
17453         "200":
17454           description: successful operation
17455           schema:
17456               $ref: "#/getDefinitions/service-instances"
17457         "default":
17458           description: Response codes found in [response codes](https://wiki.onap.org/).
17459       parameters:
17460         - name: global-customer-id
17461           in: path
17462           description: Global customer id used across ECOMP to uniquely identify customer.
17463           required: true
17464           type: string
17465           example: __GLOBAL-CUSTOMER-ID__
17466         - name: service-type
17467           in: path
17468           description: Value defined by orchestration to identify this service across ECOMP.
17469           required: true
17470           type: string
17471           example: __SERVICE-TYPE__
17472         - name: subscriber-name
17473           in: query
17474           description: Subscriber name, an alternate way to retrieve a customer.
17475           required: false
17476           type: string
17477         - name: subscriber-type
17478           in: query
17479           description: Subscriber type, a way to provide VID with only the INFRA customers.
17480           required: false
17481           type: string
17482   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship:
17483     put:
17484       tags:
17485         - Business
17486       summary: see node definition for valid relationships
17487       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
17488       consumes:
17489         - application/json
17490         - application/xml
17491       produces:
17492         - application/json
17493         - application/xml
17494       responses:
17495         "default":
17496           description: Response codes found in [response codes](https://wiki.onap.org/).
17497       parameters:
17498         - name: global-customer-id
17499           in: path
17500           description: Global customer id used across ECOMP to uniquely identify customer.
17501           required: true
17502           type: string
17503           example: __GLOBAL-CUSTOMER-ID__
17504         - name: service-type
17505           in: path
17506           description: Value defined by orchestration to identify this service across ECOMP.
17507           required: true
17508           type: string
17509           example: __SERVICE-TYPE__
17510         - name: body
17511           in: body
17512           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
17513           required: true
17514           schema:
17515             $ref: "#/definitions/relationship"
17516     delete:
17517       tags:
17518         - Business
17519       summary: delete an existing relationship
17520       description: delete an existing relationship
17521       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionRelationshipListRelationship
17522       consumes:
17523         - application/json
17524         - application/xml
17525       produces:
17526         - application/json
17527         - application/xml
17528       responses:
17529         "default":
17530           description: Response codes found in [response codes](https://wiki.onap.org/).
17531       parameters:
17532         - name: global-customer-id
17533           in: path
17534           description: Global customer id used across ECOMP to uniquely identify customer.
17535           required: true
17536           type: string
17537           example: __GLOBAL-CUSTOMER-ID__
17538         - name: service-type
17539           in: path
17540           description: Value defined by orchestration to identify this service across ECOMP.
17541           required: true
17542           type: string
17543           example: __SERVICE-TYPE__
17544   /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}:
17545     get:
17546       tags:
17547         - Business
17548       summary: returns service-subscription
17549       description: returns service-subscription
17550       operationId: getBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17551       produces:
17552         - application/json
17553         - application/xml
17554       responses:
17555         "200":
17556           description: successful operation
17557           schema:
17558               $ref: "#/getDefinitions/service-subscription"
17559         "default":
17560           description: Response codes found in [response codes](https://wiki.onap.org/).
17561       parameters:
17562         - name: global-customer-id
17563           in: path
17564           description: Global customer id used across ECOMP to uniquely identify customer.
17565           required: true
17566           type: string
17567           example: __GLOBAL-CUSTOMER-ID__
17568         - name: service-type
17569           in: path
17570           description: Value defined by orchestration to identify this service across ECOMP.
17571           required: true
17572           type: string
17573           example: __SERVICE-TYPE__
17574         - name: subscriber-name
17575           in: query
17576           description: Subscriber name, an alternate way to retrieve a customer.
17577           required: false
17578           type: string
17579         - name: subscriber-type
17580           in: query
17581           description: Subscriber type, a way to provide VID with only the INFRA customers.
17582           required: false
17583           type: string
17584     put:
17585       tags:
17586         - Business
17587       summary: create or update an existing service-subscription
17588       description: |
17589         Create or update an existing service-subscription.
17590         #
17591         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17592       operationId: createOrUpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17593       consumes:
17594         - application/json
17595         - application/xml
17596       produces:
17597         - application/json
17598         - application/xml
17599       responses:
17600         "default":
17601           description: Response codes found in [response codes](https://wiki.onap.org/).
17602       parameters:
17603         - name: global-customer-id
17604           in: path
17605           description: Global customer id used across ECOMP to uniquely identify customer.
17606           required: true
17607           type: string
17608           example: __GLOBAL-CUSTOMER-ID__
17609         - name: service-type
17610           in: path
17611           description: Value defined by orchestration to identify this service across ECOMP.
17612           required: true
17613           type: string
17614           example: __SERVICE-TYPE__
17615         - name: body
17616           in: body
17617           description: service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)
17618           required: true
17619           schema:
17620             $ref: "#/definitions/service-subscription"
17621     patch:
17622       tags:
17623         - Business
17624       summary: update an existing service-subscription
17625       description: |
17626         Update an existing service-subscription
17627         #
17628         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17629         The PUT operation will entirely replace an existing object.
17630         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17631         #
17632         Other differences between PUT and PATCH are:
17633         #
17634         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17635         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17636         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17637       operationId: UpdateBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17638       consumes:
17639         - application/json
17640         - application/xml
17641       produces:
17642         - application/json
17643         - application/xml
17644       responses:
17645         "default":
17646           description: Response codes found in [response codes](https://wiki.onap.org/).
17647       parameters:
17648         - name: global-customer-id
17649           in: path
17650           description: Global customer id used across ECOMP to uniquely identify customer.
17651           required: true
17652           type: string
17653           example: __GLOBAL-CUSTOMER-ID__
17654         - name: service-type
17655           in: path
17656           description: Value defined by orchestration to identify this service across ECOMP.
17657           required: true
17658           type: string
17659           example: __SERVICE-TYPE__
17660         - name: body
17661           in: body
17662           description: service-subscription object that needs to be created or updated.
17663           required: true
17664           schema:
17665             $ref: "#/patchDefinitions/service-subscription"
17666     delete:
17667       tags:
17668         - Business
17669       summary: delete an existing service-subscription
17670       description: delete an existing service-subscription
17671       operationId: deleteBusinessCustomersCustomerServiceSubscriptionsServiceSubscription
17672       consumes:
17673         - application/json
17674         - application/xml
17675       produces:
17676         - application/json
17677         - application/xml
17678       responses:
17679         "default":
17680           description: Response codes found in [response codes](https://wiki.onap.org/).
17681       parameters:
17682         - name: global-customer-id
17683           in: path
17684           description: Global customer id used across ECOMP to uniquely identify customer.
17685           required: true
17686           type: string
17687           example: __GLOBAL-CUSTOMER-ID__
17688         - name: service-type
17689           in: path
17690           description: Value defined by orchestration to identify this service across ECOMP.
17691           required: true
17692           type: string
17693           example: __SERVICE-TYPE__
17694         - name: resource-version
17695           in: query
17696           description: resource-version for concurrency
17697           required: true
17698           type: string
17699   /business/customers/customer/{global-customer-id}/service-subscriptions:
17700     get:
17701       tags:
17702         - Business
17703       summary: returns service-subscriptions
17704       description: returns service-subscriptions
17705       operationId: getBusinessCustomersCustomerServiceSubscriptions
17706       produces:
17707         - application/json
17708         - application/xml
17709       responses:
17710         "200":
17711           description: successful operation
17712           schema:
17713               $ref: "#/getDefinitions/service-subscriptions"
17714         "default":
17715           description: Response codes found in [response codes](https://wiki.onap.org/).
17716       parameters:
17717         - name: global-customer-id
17718           in: path
17719           description: Global customer id used across ECOMP to uniquely identify customer.
17720           required: true
17721           type: string
17722           example: __GLOBAL-CUSTOMER-ID__
17723         - name: subscriber-name
17724           in: query
17725           description: Subscriber name, an alternate way to retrieve a customer.
17726           required: false
17727           type: string
17728         - name: subscriber-type
17729           in: query
17730           description: Subscriber type, a way to provide VID with only the INFRA customers.
17731           required: false
17732           type: string
17733   /business/customers/customer/{global-customer-id}/relationship-list/relationship:
17734     put:
17735       tags:
17736         - Business
17737       summary: see node definition for valid relationships
17738       operationId: createOrUpdateBusinessCustomersCustomerRelationshipListRelationship
17739       consumes:
17740         - application/json
17741         - application/xml
17742       produces:
17743         - application/json
17744         - application/xml
17745       responses:
17746         "default":
17747           description: Response codes found in [response codes](https://wiki.onap.org/).
17748       parameters:
17749         - name: global-customer-id
17750           in: path
17751           description: Global customer id used across ECOMP to uniquely identify customer.
17752           required: true
17753           type: string
17754           example: __GLOBAL-CUSTOMER-ID__
17755         - name: body
17756           in: body
17757           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
17758           required: true
17759           schema:
17760             $ref: "#/definitions/relationship"
17761     delete:
17762       tags:
17763         - Business
17764       summary: delete an existing relationship
17765       description: delete an existing relationship
17766       operationId: deleteBusinessCustomersCustomerRelationshipListRelationship
17767       consumes:
17768         - application/json
17769         - application/xml
17770       produces:
17771         - application/json
17772         - application/xml
17773       responses:
17774         "default":
17775           description: Response codes found in [response codes](https://wiki.onap.org/).
17776       parameters:
17777         - name: global-customer-id
17778           in: path
17779           description: Global customer id used across ECOMP to uniquely identify customer.
17780           required: true
17781           type: string
17782           example: __GLOBAL-CUSTOMER-ID__
17783   /business/customers/customer/{global-customer-id}:
17784     get:
17785       tags:
17786         - Business
17787       summary: returns customer
17788       description: returns customer
17789       operationId: getBusinessCustomersCustomer
17790       produces:
17791         - application/json
17792         - application/xml
17793       responses:
17794         "200":
17795           description: successful operation
17796           schema:
17797               $ref: "#/getDefinitions/customer"
17798         "default":
17799           description: Response codes found in [response codes](https://wiki.onap.org/).
17800       parameters:
17801         - name: global-customer-id
17802           in: path
17803           description: Global customer id used across ECOMP to uniquely identify customer.
17804           required: true
17805           type: string
17806           example: __GLOBAL-CUSTOMER-ID__
17807         - name: subscriber-name
17808           in: query
17809           description: Subscriber name, an alternate way to retrieve a customer.
17810           required: false
17811           type: string
17812         - name: subscriber-type
17813           in: query
17814           description: Subscriber type, a way to provide VID with only the INFRA customers.
17815           required: false
17816           type: string
17817     put:
17818       tags:
17819         - Business
17820       summary: create or update an existing customer
17821       description: |
17822         Create or update an existing customer.
17823         #
17824         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
17825       operationId: createOrUpdateBusinessCustomersCustomer
17826       consumes:
17827         - application/json
17828         - application/xml
17829       produces:
17830         - application/json
17831         - application/xml
17832       responses:
17833         "default":
17834           description: Response codes found in [response codes](https://wiki.onap.org/).
17835       parameters:
17836         - name: global-customer-id
17837           in: path
17838           description: Global customer id used across ECOMP to uniquely identify customer.
17839           required: true
17840           type: string
17841           example: __GLOBAL-CUSTOMER-ID__
17842         - name: body
17843           in: body
17844           description: customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)
17845           required: true
17846           schema:
17847             $ref: "#/definitions/customer"
17848     patch:
17849       tags:
17850         - Business
17851       summary: update an existing customer
17852       description: |
17853         Update an existing customer
17854         #
17855         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
17856         The PUT operation will entirely replace an existing object.
17857         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
17858         #
17859         Other differences between PUT and PATCH are:
17860         #
17861         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
17862         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
17863         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
17864       operationId: UpdateBusinessCustomersCustomer
17865       consumes:
17866         - application/json
17867         - application/xml
17868       produces:
17869         - application/json
17870         - application/xml
17871       responses:
17872         "default":
17873           description: Response codes found in [response codes](https://wiki.onap.org/).
17874       parameters:
17875         - name: global-customer-id
17876           in: path
17877           description: Global customer id used across ECOMP to uniquely identify customer.
17878           required: true
17879           type: string
17880           example: __GLOBAL-CUSTOMER-ID__
17881         - name: body
17882           in: body
17883           description: customer object that needs to be created or updated.
17884           required: true
17885           schema:
17886             $ref: "#/patchDefinitions/customer"
17887     delete:
17888       tags:
17889         - Business
17890       summary: delete an existing customer
17891       description: delete an existing customer
17892       operationId: deleteBusinessCustomersCustomer
17893       consumes:
17894         - application/json
17895         - application/xml
17896       produces:
17897         - application/json
17898         - application/xml
17899       responses:
17900         "default":
17901           description: Response codes found in [response codes](https://wiki.onap.org/).
17902       parameters:
17903         - name: global-customer-id
17904           in: path
17905           description: Global customer id used across ECOMP to uniquely identify customer.
17906           required: true
17907           type: string
17908           example: __GLOBAL-CUSTOMER-ID__
17909         - name: resource-version
17910           in: query
17911           description: resource-version for concurrency
17912           required: true
17913           type: string
17914   /business/customers:
17915     get:
17916       tags:
17917         - Business
17918       summary: returns customers
17919       description: returns customers
17920       operationId: getBusinessCustomers
17921       produces:
17922         - application/json
17923         - application/xml
17924       responses:
17925         "200":
17926           description: successful operation
17927           schema:
17928               $ref: "#/getDefinitions/customers"
17929         "default":
17930           description: Response codes found in [response codes](https://wiki.onap.org/).
17931   /business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship:
17932     put:
17933       tags:
17934         - Business
17935       summary: see node definition for valid relationships
17936       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
17937       consumes:
17938         - application/json
17939         - application/xml
17940       produces:
17941         - application/json
17942         - application/xml
17943       responses:
17944         "default":
17945           description: Response codes found in [response codes](https://wiki.onap.org/).
17946       parameters:
17947         - name: line-of-business-name
17948           in: path
17949           description: Name of the line-of-business (product)
17950           required: true
17951           type: string
17952           example: __LINE-OF-BUSINESS-NAME__
17953         - name: body
17954           in: body
17955           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
17956           required: true
17957           schema:
17958             $ref: "#/definitions/relationship"
17959     delete:
17960       tags:
17961         - Business
17962       summary: delete an existing relationship
17963       description: delete an existing relationship
17964       operationId: deleteBusinessLinesOfBusinessLineOfBusinessRelationshipListRelationship
17965       consumes:
17966         - application/json
17967         - application/xml
17968       produces:
17969         - application/json
17970         - application/xml
17971       responses:
17972         "default":
17973           description: Response codes found in [response codes](https://wiki.onap.org/).
17974       parameters:
17975         - name: line-of-business-name
17976           in: path
17977           description: Name of the line-of-business (product)
17978           required: true
17979           type: string
17980           example: __LINE-OF-BUSINESS-NAME__
17981   /business/lines-of-business/line-of-business/{line-of-business-name}:
17982     get:
17983       tags:
17984         - Business
17985       summary: returns line-of-business
17986       description: returns line-of-business
17987       operationId: getBusinessLinesOfBusinessLineOfBusiness
17988       produces:
17989         - application/json
17990         - application/xml
17991       responses:
17992         "200":
17993           description: successful operation
17994           schema:
17995               $ref: "#/getDefinitions/line-of-business"
17996         "default":
17997           description: Response codes found in [response codes](https://wiki.onap.org/).
17998       parameters:
17999         - name: line-of-business-name
18000           in: path
18001           description: Name of the line-of-business (product)
18002           required: true
18003           type: string
18004           example: __LINE-OF-BUSINESS-NAME__
18005     put:
18006       tags:
18007         - Business
18008       summary: create or update an existing line-of-business
18009       description: |
18010         Create or update an existing line-of-business.
18011         #
18012         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18013       operationId: createOrUpdateBusinessLinesOfBusinessLineOfBusiness
18014       consumes:
18015         - application/json
18016         - application/xml
18017       produces:
18018         - application/json
18019         - application/xml
18020       responses:
18021         "default":
18022           description: Response codes found in [response codes](https://wiki.onap.org/).
18023       parameters:
18024         - name: line-of-business-name
18025           in: path
18026           description: Name of the line-of-business (product)
18027           required: true
18028           type: string
18029           example: __LINE-OF-BUSINESS-NAME__
18030         - name: body
18031           in: body
18032           description: line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)
18033           required: true
18034           schema:
18035             $ref: "#/definitions/line-of-business"
18036     patch:
18037       tags:
18038         - Business
18039       summary: update an existing line-of-business
18040       description: |
18041         Update an existing line-of-business
18042         #
18043         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18044         The PUT operation will entirely replace an existing object.
18045         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18046         #
18047         Other differences between PUT and PATCH are:
18048         #
18049         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18050         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18051         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18052       operationId: UpdateBusinessLinesOfBusinessLineOfBusiness
18053       consumes:
18054         - application/json
18055         - application/xml
18056       produces:
18057         - application/json
18058         - application/xml
18059       responses:
18060         "default":
18061           description: Response codes found in [response codes](https://wiki.onap.org/).
18062       parameters:
18063         - name: line-of-business-name
18064           in: path
18065           description: Name of the line-of-business (product)
18066           required: true
18067           type: string
18068           example: __LINE-OF-BUSINESS-NAME__
18069         - name: body
18070           in: body
18071           description: line-of-business object that needs to be created or updated.
18072           required: true
18073           schema:
18074             $ref: "#/patchDefinitions/line-of-business"
18075     delete:
18076       tags:
18077         - Business
18078       summary: delete an existing line-of-business
18079       description: delete an existing line-of-business
18080       operationId: deleteBusinessLinesOfBusinessLineOfBusiness
18081       consumes:
18082         - application/json
18083         - application/xml
18084       produces:
18085         - application/json
18086         - application/xml
18087       responses:
18088         "default":
18089           description: Response codes found in [response codes](https://wiki.onap.org/).
18090       parameters:
18091         - name: line-of-business-name
18092           in: path
18093           description: Name of the line-of-business (product)
18094           required: true
18095           type: string
18096           example: __LINE-OF-BUSINESS-NAME__
18097         - name: resource-version
18098           in: query
18099           description: resource-version for concurrency
18100           required: true
18101           type: string
18102   /business/lines-of-business:
18103     get:
18104       tags:
18105         - Business
18106       summary: returns lines-of-business
18107       description: returns lines-of-business
18108       operationId: getBusinessLinesOfBusiness
18109       produces:
18110         - application/json
18111         - application/xml
18112       responses:
18113         "200":
18114           description: successful operation
18115           schema:
18116               $ref: "#/getDefinitions/lines-of-business"
18117         "default":
18118           description: Response codes found in [response codes](https://wiki.onap.org/).
18119   /business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship:
18120     put:
18121       tags:
18122         - Business
18123       summary: see node definition for valid relationships
18124       operationId: createOrUpdateBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18125       consumes:
18126         - application/json
18127         - application/xml
18128       produces:
18129         - application/json
18130         - application/xml
18131       responses:
18132         "default":
18133           description: Response codes found in [response codes](https://wiki.onap.org/).
18134       parameters:
18135         - name: owning-entity-id
18136           in: path
18137           description: UUID of an owning entity
18138           required: true
18139           type: string
18140           example: __OWNING-ENTITY-ID__
18141         - name: body
18142           in: body
18143           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
18144           required: true
18145           schema:
18146             $ref: "#/definitions/relationship"
18147     delete:
18148       tags:
18149         - Business
18150       summary: delete an existing relationship
18151       description: delete an existing relationship
18152       operationId: deleteBusinessOwningEntitiesOwningEntityRelationshipListRelationship
18153       consumes:
18154         - application/json
18155         - application/xml
18156       produces:
18157         - application/json
18158         - application/xml
18159       responses:
18160         "default":
18161           description: Response codes found in [response codes](https://wiki.onap.org/).
18162       parameters:
18163         - name: owning-entity-id
18164           in: path
18165           description: UUID of an owning entity
18166           required: true
18167           type: string
18168           example: __OWNING-ENTITY-ID__
18169   /business/owning-entities/owning-entity/{owning-entity-id}:
18170     get:
18171       tags:
18172         - Business
18173       summary: returns owning-entity
18174       description: returns owning-entity
18175       operationId: getBusinessOwningEntitiesOwningEntity
18176       produces:
18177         - application/json
18178         - application/xml
18179       responses:
18180         "200":
18181           description: successful operation
18182           schema:
18183               $ref: "#/getDefinitions/owning-entity"
18184         "default":
18185           description: Response codes found in [response codes](https://wiki.onap.org/).
18186       parameters:
18187         - name: owning-entity-id
18188           in: path
18189           description: UUID of an owning entity
18190           required: true
18191           type: string
18192           example: __OWNING-ENTITY-ID__
18193     put:
18194       tags:
18195         - Business
18196       summary: create or update an existing owning-entity
18197       description: |
18198         Create or update an existing owning-entity.
18199         #
18200         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18201       operationId: createOrUpdateBusinessOwningEntitiesOwningEntity
18202       consumes:
18203         - application/json
18204         - application/xml
18205       produces:
18206         - application/json
18207         - application/xml
18208       responses:
18209         "default":
18210           description: Response codes found in [response codes](https://wiki.onap.org/).
18211       parameters:
18212         - name: owning-entity-id
18213           in: path
18214           description: UUID of an owning entity
18215           required: true
18216           type: string
18217           example: __OWNING-ENTITY-ID__
18218         - name: body
18219           in: body
18220           description: owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)
18221           required: true
18222           schema:
18223             $ref: "#/definitions/owning-entity"
18224     patch:
18225       tags:
18226         - Business
18227       summary: update an existing owning-entity
18228       description: |
18229         Update an existing owning-entity
18230         #
18231         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18232         The PUT operation will entirely replace an existing object.
18233         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18234         #
18235         Other differences between PUT and PATCH are:
18236         #
18237         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18238         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18239         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18240       operationId: UpdateBusinessOwningEntitiesOwningEntity
18241       consumes:
18242         - application/json
18243         - application/xml
18244       produces:
18245         - application/json
18246         - application/xml
18247       responses:
18248         "default":
18249           description: Response codes found in [response codes](https://wiki.onap.org/).
18250       parameters:
18251         - name: owning-entity-id
18252           in: path
18253           description: UUID of an owning entity
18254           required: true
18255           type: string
18256           example: __OWNING-ENTITY-ID__
18257         - name: body
18258           in: body
18259           description: owning-entity object that needs to be created or updated.
18260           required: true
18261           schema:
18262             $ref: "#/patchDefinitions/owning-entity"
18263     delete:
18264       tags:
18265         - Business
18266       summary: delete an existing owning-entity
18267       description: delete an existing owning-entity
18268       operationId: deleteBusinessOwningEntitiesOwningEntity
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: owning-entity-id
18280           in: path
18281           description: UUID of an owning entity
18282           required: true
18283           type: string
18284           example: __OWNING-ENTITY-ID__
18285         - name: resource-version
18286           in: query
18287           description: resource-version for concurrency
18288           required: true
18289           type: string
18290   /business/owning-entities:
18291     get:
18292       tags:
18293         - Business
18294       summary: returns owning-entities
18295       description: returns owning-entities
18296       operationId: getBusinessOwningEntities
18297       produces:
18298         - application/json
18299         - application/xml
18300       responses:
18301         "200":
18302           description: successful operation
18303           schema:
18304               $ref: "#/getDefinitions/owning-entities"
18305         "default":
18306           description: Response codes found in [response codes](https://wiki.onap.org/).
18307   /business/platforms/platform/{platform-name}/relationship-list/relationship:
18308     put:
18309       tags:
18310         - Business
18311       summary: see node definition for valid relationships
18312       operationId: createOrUpdateBusinessPlatformsPlatformRelationshipListRelationship
18313       consumes:
18314         - application/json
18315         - application/xml
18316       produces:
18317         - application/json
18318         - application/xml
18319       responses:
18320         "default":
18321           description: Response codes found in [response codes](https://wiki.onap.org/).
18322       parameters:
18323         - name: platform-name
18324           in: path
18325           description: Name of the platform
18326           required: true
18327           type: string
18328           example: __PLATFORM-NAME__
18329         - name: body
18330           in: body
18331           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
18332           required: true
18333           schema:
18334             $ref: "#/definitions/relationship"
18335     delete:
18336       tags:
18337         - Business
18338       summary: delete an existing relationship
18339       description: delete an existing relationship
18340       operationId: deleteBusinessPlatformsPlatformRelationshipListRelationship
18341       consumes:
18342         - application/json
18343         - application/xml
18344       produces:
18345         - application/json
18346         - application/xml
18347       responses:
18348         "default":
18349           description: Response codes found in [response codes](https://wiki.onap.org/).
18350       parameters:
18351         - name: platform-name
18352           in: path
18353           description: Name of the platform
18354           required: true
18355           type: string
18356           example: __PLATFORM-NAME__
18357   /business/platforms/platform/{platform-name}:
18358     get:
18359       tags:
18360         - Business
18361       summary: returns platform
18362       description: returns platform
18363       operationId: getBusinessPlatformsPlatform
18364       produces:
18365         - application/json
18366         - application/xml
18367       responses:
18368         "200":
18369           description: successful operation
18370           schema:
18371               $ref: "#/getDefinitions/platform"
18372         "default":
18373           description: Response codes found in [response codes](https://wiki.onap.org/).
18374       parameters:
18375         - name: platform-name
18376           in: path
18377           description: Name of the platform
18378           required: true
18379           type: string
18380           example: __PLATFORM-NAME__
18381     put:
18382       tags:
18383         - Business
18384       summary: create or update an existing platform
18385       description: |
18386         Create or update an existing platform.
18387         #
18388         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18389       operationId: createOrUpdateBusinessPlatformsPlatform
18390       consumes:
18391         - application/json
18392         - application/xml
18393       produces:
18394         - application/json
18395         - application/xml
18396       responses:
18397         "default":
18398           description: Response codes found in [response codes](https://wiki.onap.org/).
18399       parameters:
18400         - name: platform-name
18401           in: path
18402           description: Name of the platform
18403           required: true
18404           type: string
18405           example: __PLATFORM-NAME__
18406         - name: body
18407           in: body
18408           description: platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)
18409           required: true
18410           schema:
18411             $ref: "#/definitions/platform"
18412     patch:
18413       tags:
18414         - Business
18415       summary: update an existing platform
18416       description: |
18417         Update an existing platform
18418         #
18419         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18420         The PUT operation will entirely replace an existing object.
18421         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18422         #
18423         Other differences between PUT and PATCH are:
18424         #
18425         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18426         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18427         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18428       operationId: UpdateBusinessPlatformsPlatform
18429       consumes:
18430         - application/json
18431         - application/xml
18432       produces:
18433         - application/json
18434         - application/xml
18435       responses:
18436         "default":
18437           description: Response codes found in [response codes](https://wiki.onap.org/).
18438       parameters:
18439         - name: platform-name
18440           in: path
18441           description: Name of the platform
18442           required: true
18443           type: string
18444           example: __PLATFORM-NAME__
18445         - name: body
18446           in: body
18447           description: platform object that needs to be created or updated.
18448           required: true
18449           schema:
18450             $ref: "#/patchDefinitions/platform"
18451     delete:
18452       tags:
18453         - Business
18454       summary: delete an existing platform
18455       description: delete an existing platform
18456       operationId: deleteBusinessPlatformsPlatform
18457       consumes:
18458         - application/json
18459         - application/xml
18460       produces:
18461         - application/json
18462         - application/xml
18463       responses:
18464         "default":
18465           description: Response codes found in [response codes](https://wiki.onap.org/).
18466       parameters:
18467         - name: platform-name
18468           in: path
18469           description: Name of the platform
18470           required: true
18471           type: string
18472           example: __PLATFORM-NAME__
18473         - name: resource-version
18474           in: query
18475           description: resource-version for concurrency
18476           required: true
18477           type: string
18478   /business/platforms:
18479     get:
18480       tags:
18481         - Business
18482       summary: returns platforms
18483       description: returns platforms
18484       operationId: getBusinessPlatforms
18485       produces:
18486         - application/json
18487         - application/xml
18488       responses:
18489         "200":
18490           description: successful operation
18491           schema:
18492               $ref: "#/getDefinitions/platforms"
18493         "default":
18494           description: Response codes found in [response codes](https://wiki.onap.org/).
18495   /business/projects/project/{project-name}/relationship-list/relationship:
18496     put:
18497       tags:
18498         - Business
18499       summary: see node definition for valid relationships
18500       operationId: createOrUpdateBusinessProjectsProjectRelationshipListRelationship
18501       consumes:
18502         - application/json
18503         - application/xml
18504       produces:
18505         - application/json
18506         - application/xml
18507       responses:
18508         "default":
18509           description: Response codes found in [response codes](https://wiki.onap.org/).
18510       parameters:
18511         - name: project-name
18512           in: path
18513           description: Name of the project deploying a service
18514           required: true
18515           type: string
18516           example: __PROJECT-NAME__
18517         - name: body
18518           in: body
18519           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
18520           required: true
18521           schema:
18522             $ref: "#/definitions/relationship"
18523     delete:
18524       tags:
18525         - Business
18526       summary: delete an existing relationship
18527       description: delete an existing relationship
18528       operationId: deleteBusinessProjectsProjectRelationshipListRelationship
18529       consumes:
18530         - application/json
18531         - application/xml
18532       produces:
18533         - application/json
18534         - application/xml
18535       responses:
18536         "default":
18537           description: Response codes found in [response codes](https://wiki.onap.org/).
18538       parameters:
18539         - name: project-name
18540           in: path
18541           description: Name of the project deploying a service
18542           required: true
18543           type: string
18544           example: __PROJECT-NAME__
18545   /business/projects/project/{project-name}:
18546     get:
18547       tags:
18548         - Business
18549       summary: returns project
18550       description: returns project
18551       operationId: getBusinessProjectsProject
18552       produces:
18553         - application/json
18554         - application/xml
18555       responses:
18556         "200":
18557           description: successful operation
18558           schema:
18559               $ref: "#/getDefinitions/project"
18560         "default":
18561           description: Response codes found in [response codes](https://wiki.onap.org/).
18562       parameters:
18563         - name: project-name
18564           in: path
18565           description: Name of the project deploying a service
18566           required: true
18567           type: string
18568           example: __PROJECT-NAME__
18569     put:
18570       tags:
18571         - Business
18572       summary: create or update an existing project
18573       description: |
18574         Create or update an existing project.
18575         #
18576         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18577       operationId: createOrUpdateBusinessProjectsProject
18578       consumes:
18579         - application/json
18580         - application/xml
18581       produces:
18582         - application/json
18583         - application/xml
18584       responses:
18585         "default":
18586           description: Response codes found in [response codes](https://wiki.onap.org/).
18587       parameters:
18588         - name: project-name
18589           in: path
18590           description: Name of the project deploying a service
18591           required: true
18592           type: string
18593           example: __PROJECT-NAME__
18594         - name: body
18595           in: body
18596           description: project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)
18597           required: true
18598           schema:
18599             $ref: "#/definitions/project"
18600     patch:
18601       tags:
18602         - Business
18603       summary: update an existing project
18604       description: |
18605         Update an existing project
18606         #
18607         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18608         The PUT operation will entirely replace an existing object.
18609         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18610         #
18611         Other differences between PUT and PATCH are:
18612         #
18613         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18614         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18615         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18616       operationId: UpdateBusinessProjectsProject
18617       consumes:
18618         - application/json
18619         - application/xml
18620       produces:
18621         - application/json
18622         - application/xml
18623       responses:
18624         "default":
18625           description: Response codes found in [response codes](https://wiki.onap.org/).
18626       parameters:
18627         - name: project-name
18628           in: path
18629           description: Name of the project deploying a service
18630           required: true
18631           type: string
18632           example: __PROJECT-NAME__
18633         - name: body
18634           in: body
18635           description: project object that needs to be created or updated.
18636           required: true
18637           schema:
18638             $ref: "#/patchDefinitions/project"
18639     delete:
18640       tags:
18641         - Business
18642       summary: delete an existing project
18643       description: delete an existing project
18644       operationId: deleteBusinessProjectsProject
18645       consumes:
18646         - application/json
18647         - application/xml
18648       produces:
18649         - application/json
18650         - application/xml
18651       responses:
18652         "default":
18653           description: Response codes found in [response codes](https://wiki.onap.org/).
18654       parameters:
18655         - name: project-name
18656           in: path
18657           description: Name of the project deploying a service
18658           required: true
18659           type: string
18660           example: __PROJECT-NAME__
18661         - name: resource-version
18662           in: query
18663           description: resource-version for concurrency
18664           required: true
18665           type: string
18666   /business/projects:
18667     get:
18668       tags:
18669         - Business
18670       summary: returns projects
18671       description: returns projects
18672       operationId: getBusinessProjects
18673       produces:
18674         - application/json
18675         - application/xml
18676       responses:
18677         "200":
18678           description: successful operation
18679           schema:
18680               $ref: "#/getDefinitions/projects"
18681         "default":
18682           description: Response codes found in [response codes](https://wiki.onap.org/).
18683   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship:
18684     put:
18685       tags:
18686         - ServiceDesignAndCreation
18687       summary: see node definition for valid relationships
18688       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
18689       consumes:
18690         - application/json
18691         - application/xml
18692       produces:
18693         - application/json
18694         - application/xml
18695       responses:
18696         "default":
18697           description: Response codes found in [response codes](https://wiki.onap.org/).
18698       parameters:
18699         - name: vnf-image-uuid
18700           in: path
18701           description: Unique ID of this asset
18702           required: true
18703           type: string
18704           example: __VNF-IMAGE-UUID__
18705         - name: body
18706           in: body
18707           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
18708           required: true
18709           schema:
18710             $ref: "#/definitions/relationship"
18711     delete:
18712       tags:
18713         - ServiceDesignAndCreation
18714       summary: delete an existing relationship
18715       description: delete an existing relationship
18716       operationId: deleteServiceDesignAndCreationVnfImagesVnfImageRelationshipListRelationship
18717       consumes:
18718         - application/json
18719         - application/xml
18720       produces:
18721         - application/json
18722         - application/xml
18723       responses:
18724         "default":
18725           description: Response codes found in [response codes](https://wiki.onap.org/).
18726       parameters:
18727         - name: vnf-image-uuid
18728           in: path
18729           description: Unique ID of this asset
18730           required: true
18731           type: string
18732           example: __VNF-IMAGE-UUID__
18733   /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}:
18734     get:
18735       tags:
18736         - ServiceDesignAndCreation
18737       summary: returns vnf-image
18738       description: returns vnf-image
18739       operationId: getServiceDesignAndCreationVnfImagesVnfImage
18740       produces:
18741         - application/json
18742         - application/xml
18743       responses:
18744         "200":
18745           description: successful operation
18746           schema:
18747               $ref: "#/getDefinitions/vnf-image"
18748         "default":
18749           description: Response codes found in [response codes](https://wiki.onap.org/).
18750       parameters:
18751         - name: vnf-image-uuid
18752           in: path
18753           description: Unique ID of this asset
18754           required: true
18755           type: string
18756           example: __VNF-IMAGE-UUID__
18757         - name: application
18758           in: query
18759           description: The application that the image instantiates.
18760           required: false
18761           type: string
18762         - name: application-vendor
18763           in: query
18764           description: The vendor of the application.
18765           required: false
18766           type: string
18767         - name: application-version
18768           in: query
18769           description: The version of the application.
18770           required: false
18771           type: string
18772     put:
18773       tags:
18774         - ServiceDesignAndCreation
18775       summary: create or update an existing vnf-image
18776       description: |
18777         Create or update an existing vnf-image.
18778         #
18779         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18780       operationId: createOrUpdateServiceDesignAndCreationVnfImagesVnfImage
18781       consumes:
18782         - application/json
18783         - application/xml
18784       produces:
18785         - application/json
18786         - application/xml
18787       responses:
18788         "default":
18789           description: Response codes found in [response codes](https://wiki.onap.org/).
18790       parameters:
18791         - name: vnf-image-uuid
18792           in: path
18793           description: Unique ID of this asset
18794           required: true
18795           type: string
18796           example: __VNF-IMAGE-UUID__
18797         - name: body
18798           in: body
18799           description: vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)
18800           required: true
18801           schema:
18802             $ref: "#/definitions/vnf-image"
18803     patch:
18804       tags:
18805         - ServiceDesignAndCreation
18806       summary: update an existing vnf-image
18807       description: |
18808         Update an existing vnf-image
18809         #
18810         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
18811         The PUT operation will entirely replace an existing object.
18812         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
18813         #
18814         Other differences between PUT and PATCH are:
18815         #
18816         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
18817         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
18818         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
18819       operationId: UpdateServiceDesignAndCreationVnfImagesVnfImage
18820       consumes:
18821         - application/json
18822         - application/xml
18823       produces:
18824         - application/json
18825         - application/xml
18826       responses:
18827         "default":
18828           description: Response codes found in [response codes](https://wiki.onap.org/).
18829       parameters:
18830         - name: vnf-image-uuid
18831           in: path
18832           description: Unique ID of this asset
18833           required: true
18834           type: string
18835           example: __VNF-IMAGE-UUID__
18836         - name: body
18837           in: body
18838           description: vnf-image object that needs to be created or updated.
18839           required: true
18840           schema:
18841             $ref: "#/patchDefinitions/vnf-image"
18842     delete:
18843       tags:
18844         - ServiceDesignAndCreation
18845       summary: delete an existing vnf-image
18846       description: delete an existing vnf-image
18847       operationId: deleteServiceDesignAndCreationVnfImagesVnfImage
18848       consumes:
18849         - application/json
18850         - application/xml
18851       produces:
18852         - application/json
18853         - application/xml
18854       responses:
18855         "default":
18856           description: Response codes found in [response codes](https://wiki.onap.org/).
18857       parameters:
18858         - name: vnf-image-uuid
18859           in: path
18860           description: Unique ID of this asset
18861           required: true
18862           type: string
18863           example: __VNF-IMAGE-UUID__
18864         - name: resource-version
18865           in: query
18866           description: resource-version for concurrency
18867           required: true
18868           type: string
18869   /service-design-and-creation/vnf-images:
18870     get:
18871       tags:
18872         - ServiceDesignAndCreation
18873       summary: returns vnf-images
18874       description: returns vnf-images
18875       operationId: getServiceDesignAndCreationVnfImages
18876       produces:
18877         - application/json
18878         - application/xml
18879       responses:
18880         "200":
18881           description: successful operation
18882           schema:
18883               $ref: "#/getDefinitions/vnf-images"
18884         "default":
18885           description: Response codes found in [response codes](https://wiki.onap.org/).
18886   /service-design-and-creation/services/service/{service-id}/relationship-list/relationship:
18887     put:
18888       tags:
18889         - ServiceDesignAndCreation
18890       summary: see node definition for valid relationships
18891       operationId: createOrUpdateServiceDesignAndCreationServicesServiceRelationshipListRelationship
18892       consumes:
18893         - application/json
18894         - application/xml
18895       produces:
18896         - application/json
18897         - application/xml
18898       responses:
18899         "default":
18900           description: Response codes found in [response codes](https://wiki.onap.org/).
18901       parameters:
18902         - name: service-id
18903           in: path
18904           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18905           required: true
18906           type: string
18907           example: __SERVICE-ID__
18908         - name: body
18909           in: body
18910           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
18911           required: true
18912           schema:
18913             $ref: "#/definitions/relationship"
18914     delete:
18915       tags:
18916         - ServiceDesignAndCreation
18917       summary: delete an existing relationship
18918       description: delete an existing relationship
18919       operationId: deleteServiceDesignAndCreationServicesServiceRelationshipListRelationship
18920       consumes:
18921         - application/json
18922         - application/xml
18923       produces:
18924         - application/json
18925         - application/xml
18926       responses:
18927         "default":
18928           description: Response codes found in [response codes](https://wiki.onap.org/).
18929       parameters:
18930         - name: service-id
18931           in: path
18932           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18933           required: true
18934           type: string
18935           example: __SERVICE-ID__
18936   /service-design-and-creation/services/service/{service-id}:
18937     get:
18938       tags:
18939         - ServiceDesignAndCreation
18940       summary: returns service
18941       description: returns service
18942       operationId: getServiceDesignAndCreationServicesService
18943       produces:
18944         - application/json
18945         - application/xml
18946       responses:
18947         "200":
18948           description: successful operation
18949           schema:
18950               $ref: "#/getDefinitions/service"
18951         "default":
18952           description: Response codes found in [response codes](https://wiki.onap.org/).
18953       parameters:
18954         - name: service-id
18955           in: path
18956           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18957           required: true
18958           type: string
18959           example: __SERVICE-ID__
18960         - name: service-description
18961           in: query
18962           description: Description of the service
18963           required: false
18964           type: string
18965     put:
18966       tags:
18967         - ServiceDesignAndCreation
18968       summary: create or update an existing service
18969       description: |
18970         Create or update an existing service.
18971         #
18972         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
18973       operationId: createOrUpdateServiceDesignAndCreationServicesService
18974       consumes:
18975         - application/json
18976         - application/xml
18977       produces:
18978         - application/json
18979         - application/xml
18980       responses:
18981         "default":
18982           description: Response codes found in [response codes](https://wiki.onap.org/).
18983       parameters:
18984         - name: service-id
18985           in: path
18986           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
18987           required: true
18988           type: string
18989           example: __SERVICE-ID__
18990         - name: body
18991           in: body
18992           description: service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)
18993           required: true
18994           schema:
18995             $ref: "#/definitions/service"
18996     patch:
18997       tags:
18998         - ServiceDesignAndCreation
18999       summary: update an existing service
19000       description: |
19001         Update an existing service
19002         #
19003         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19004         The PUT operation will entirely replace an existing object.
19005         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19006         #
19007         Other differences between PUT and PATCH are:
19008         #
19009         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19010         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19011         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19012       operationId: UpdateServiceDesignAndCreationServicesService
19013       consumes:
19014         - application/json
19015         - application/xml
19016       produces:
19017         - application/json
19018         - application/xml
19019       responses:
19020         "default":
19021           description: Response codes found in [response codes](https://wiki.onap.org/).
19022       parameters:
19023         - name: service-id
19024           in: path
19025           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19026           required: true
19027           type: string
19028           example: __SERVICE-ID__
19029         - name: body
19030           in: body
19031           description: service object that needs to be created or updated.
19032           required: true
19033           schema:
19034             $ref: "#/patchDefinitions/service"
19035     delete:
19036       tags:
19037         - ServiceDesignAndCreation
19038       summary: delete an existing service
19039       description: delete an existing service
19040       operationId: deleteServiceDesignAndCreationServicesService
19041       consumes:
19042         - application/json
19043         - application/xml
19044       produces:
19045         - application/json
19046         - application/xml
19047       responses:
19048         "default":
19049           description: Response codes found in [response codes](https://wiki.onap.org/).
19050       parameters:
19051         - name: service-id
19052           in: path
19053           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19054           required: true
19055           type: string
19056           example: __SERVICE-ID__
19057         - name: resource-version
19058           in: query
19059           description: resource-version for concurrency
19060           required: true
19061           type: string
19062   /service-design-and-creation/services:
19063     get:
19064       tags:
19065         - ServiceDesignAndCreation
19066       summary: returns services
19067       description: returns services
19068       operationId: getServiceDesignAndCreationServices
19069       produces:
19070         - application/json
19071         - application/xml
19072       responses:
19073         "200":
19074           description: successful operation
19075           schema:
19076               $ref: "#/getDefinitions/services"
19077         "default":
19078           description: Response codes found in [response codes](https://wiki.onap.org/).
19079   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship:
19080     put:
19081       tags:
19082         - ServiceDesignAndCreation
19083       summary: see node definition for valid relationships
19084       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19085       consumes:
19086         - application/json
19087         - application/xml
19088       produces:
19089         - application/json
19090         - application/xml
19091       responses:
19092         "default":
19093           description: Response codes found in [response codes](https://wiki.onap.org/).
19094       parameters:
19095         - name: service-type
19096           in: path
19097           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19098           required: true
19099           type: string
19100           example: __SERVICE-TYPE__
19101         - name: vnf-type
19102           in: path
19103           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.
19104           required: true
19105           type: string
19106           example: __VNF-TYPE__
19107         - name: body
19108           in: body
19109           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
19110           required: true
19111           schema:
19112             $ref: "#/definitions/relationship"
19113     delete:
19114       tags:
19115         - ServiceDesignAndCreation
19116       summary: delete an existing relationship
19117       description: delete an existing relationship
19118       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapabilityRelationshipListRelationship
19119       consumes:
19120         - application/json
19121         - application/xml
19122       produces:
19123         - application/json
19124         - application/xml
19125       responses:
19126         "default":
19127           description: Response codes found in [response codes](https://wiki.onap.org/).
19128       parameters:
19129         - name: service-type
19130           in: path
19131           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19132           required: true
19133           type: string
19134           example: __SERVICE-TYPE__
19135         - name: vnf-type
19136           in: path
19137           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.
19138           required: true
19139           type: string
19140           example: __VNF-TYPE__
19141   /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}:
19142     get:
19143       tags:
19144         - ServiceDesignAndCreation
19145       summary: returns service-capability
19146       description: returns service-capability
19147       operationId: getServiceDesignAndCreationServiceCapabilitiesServiceCapability
19148       produces:
19149         - application/json
19150         - application/xml
19151       responses:
19152         "200":
19153           description: successful operation
19154           schema:
19155               $ref: "#/getDefinitions/service-capability"
19156         "default":
19157           description: Response codes found in [response codes](https://wiki.onap.org/).
19158       parameters:
19159         - name: service-type
19160           in: path
19161           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19162           required: true
19163           type: string
19164           example: __SERVICE-TYPE__
19165         - name: vnf-type
19166           in: path
19167           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.
19168           required: true
19169           type: string
19170           example: __VNF-TYPE__
19171     put:
19172       tags:
19173         - ServiceDesignAndCreation
19174       summary: create or update an existing service-capability
19175       description: |
19176         Create or update an existing service-capability.
19177         #
19178         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19179       operationId: createOrUpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
19180       consumes:
19181         - application/json
19182         - application/xml
19183       produces:
19184         - application/json
19185         - application/xml
19186       responses:
19187         "default":
19188           description: Response codes found in [response codes](https://wiki.onap.org/).
19189       parameters:
19190         - name: service-type
19191           in: path
19192           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19193           required: true
19194           type: string
19195           example: __SERVICE-TYPE__
19196         - name: vnf-type
19197           in: path
19198           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.
19199           required: true
19200           type: string
19201           example: __VNF-TYPE__
19202         - name: body
19203           in: body
19204           description: service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)
19205           required: true
19206           schema:
19207             $ref: "#/definitions/service-capability"
19208     patch:
19209       tags:
19210         - ServiceDesignAndCreation
19211       summary: update an existing service-capability
19212       description: |
19213         Update an existing service-capability
19214         #
19215         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19216         The PUT operation will entirely replace an existing object.
19217         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19218         #
19219         Other differences between PUT and PATCH are:
19220         #
19221         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19222         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19223         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19224       operationId: UpdateServiceDesignAndCreationServiceCapabilitiesServiceCapability
19225       consumes:
19226         - application/json
19227         - application/xml
19228       produces:
19229         - application/json
19230         - application/xml
19231       responses:
19232         "default":
19233           description: Response codes found in [response codes](https://wiki.onap.org/).
19234       parameters:
19235         - name: service-type
19236           in: path
19237           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19238           required: true
19239           type: string
19240           example: __SERVICE-TYPE__
19241         - name: vnf-type
19242           in: path
19243           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.
19244           required: true
19245           type: string
19246           example: __VNF-TYPE__
19247         - name: body
19248           in: body
19249           description: service-capability object that needs to be created or updated.
19250           required: true
19251           schema:
19252             $ref: "#/patchDefinitions/service-capability"
19253     delete:
19254       tags:
19255         - ServiceDesignAndCreation
19256       summary: delete an existing service-capability
19257       description: delete an existing service-capability
19258       operationId: deleteServiceDesignAndCreationServiceCapabilitiesServiceCapability
19259       consumes:
19260         - application/json
19261         - application/xml
19262       produces:
19263         - application/json
19264         - application/xml
19265       responses:
19266         "default":
19267           description: Response codes found in [response codes](https://wiki.onap.org/).
19268       parameters:
19269         - name: service-type
19270           in: path
19271           description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
19272           required: true
19273           type: string
19274           example: __SERVICE-TYPE__
19275         - name: vnf-type
19276           in: path
19277           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.
19278           required: true
19279           type: string
19280           example: __VNF-TYPE__
19281         - name: resource-version
19282           in: query
19283           description: resource-version for concurrency
19284           required: true
19285           type: string
19286   /service-design-and-creation/service-capabilities:
19287     get:
19288       tags:
19289         - ServiceDesignAndCreation
19290       summary: returns service-capabilities
19291       description: returns service-capabilities
19292       operationId: getServiceDesignAndCreationServiceCapabilities
19293       produces:
19294         - application/json
19295         - application/xml
19296       responses:
19297         "200":
19298           description: successful operation
19299           schema:
19300               $ref: "#/getDefinitions/service-capabilities"
19301         "default":
19302           description: Response codes found in [response codes](https://wiki.onap.org/).
19303   /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:
19304     put:
19305       tags:
19306         - ServiceDesignAndCreation
19307       summary: see node definition for valid relationships
19308       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
19309       consumes:
19310         - application/json
19311         - application/xml
19312       produces:
19313         - application/json
19314         - application/xml
19315       responses:
19316         "default":
19317           description: Response codes found in [response codes](https://wiki.onap.org/).
19318       parameters:
19319         - name: model-invariant-id
19320           in: path
19321           description: Unique identifier corresponding to the main definition of a model in ASDC
19322           required: true
19323           type: string
19324           example: __MODEL-INVARIANT-ID__
19325         - name: model-version-id
19326           in: path
19327           description: Unique identifier corresponding to one version of a model in ASDC
19328           required: true
19329           type: string
19330           example: __MODEL-VERSION-ID__
19331         - name: model-element-uuid
19332           in: path
19333           required: true
19334           type: string
19335           example: __MODEL-ELEMENT-UUID__
19336         - name: model-constraint-uuid
19337           in: path
19338           required: true
19339           type: string
19340           example: __MODEL-CONSTRAINT-UUID__
19341         - name: constrained-element-set-uuid
19342           in: path
19343           required: true
19344           type: string
19345           example: __CONSTRAINED-ELEMENT-SET-UUID__
19346         - name: element-choice-set-uuid
19347           in: path
19348           required: true
19349           type: string
19350           example: __ELEMENT-CHOICE-SET-UUID__
19351         - name: body
19352           in: body
19353           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
19354           required: true
19355           schema:
19356             $ref: "#/definitions/relationship"
19357     delete:
19358       tags:
19359         - ServiceDesignAndCreation
19360       summary: delete an existing relationship
19361       description: delete an existing relationship
19362       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSetRelationshipListRelationship
19363       consumes:
19364         - application/json
19365         - application/xml
19366       produces:
19367         - application/json
19368         - application/xml
19369       responses:
19370         "default":
19371           description: Response codes found in [response codes](https://wiki.onap.org/).
19372       parameters:
19373         - name: model-invariant-id
19374           in: path
19375           description: Unique identifier corresponding to the main definition of a model in ASDC
19376           required: true
19377           type: string
19378           example: __MODEL-INVARIANT-ID__
19379         - name: model-version-id
19380           in: path
19381           description: Unique identifier corresponding to one version of a model in ASDC
19382           required: true
19383           type: string
19384           example: __MODEL-VERSION-ID__
19385         - name: model-element-uuid
19386           in: path
19387           required: true
19388           type: string
19389           example: __MODEL-ELEMENT-UUID__
19390         - name: model-constraint-uuid
19391           in: path
19392           required: true
19393           type: string
19394           example: __MODEL-CONSTRAINT-UUID__
19395         - name: constrained-element-set-uuid
19396           in: path
19397           required: true
19398           type: string
19399           example: __CONSTRAINED-ELEMENT-SET-UUID__
19400         - name: element-choice-set-uuid
19401           in: path
19402           required: true
19403           type: string
19404           example: __ELEMENT-CHOICE-SET-UUID__
19405   /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}:
19406     get:
19407       tags:
19408         - ServiceDesignAndCreation
19409       summary: returns element-choice-set
19410       description: returns element-choice-set
19411       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19412       produces:
19413         - application/json
19414         - application/xml
19415       responses:
19416         "200":
19417           description: successful operation
19418           schema:
19419               $ref: "#/getDefinitions/element-choice-set"
19420         "default":
19421           description: Response codes found in [response codes](https://wiki.onap.org/).
19422       parameters:
19423         - name: model-invariant-id
19424           in: path
19425           description: Unique identifier corresponding to the main definition of a model in ASDC
19426           required: true
19427           type: string
19428           example: __MODEL-INVARIANT-ID__
19429         - name: model-version-id
19430           in: path
19431           description: Unique identifier corresponding to one version of a model in ASDC
19432           required: true
19433           type: string
19434           example: __MODEL-VERSION-ID__
19435         - name: model-element-uuid
19436           in: path
19437           required: true
19438           type: string
19439           example: __MODEL-ELEMENT-UUID__
19440         - name: model-constraint-uuid
19441           in: path
19442           required: true
19443           type: string
19444           example: __MODEL-CONSTRAINT-UUID__
19445         - name: constrained-element-set-uuid
19446           in: path
19447           required: true
19448           type: string
19449           example: __CONSTRAINED-ELEMENT-SET-UUID__
19450         - name: element-choice-set-uuid
19451           in: path
19452           required: true
19453           type: string
19454           example: __ELEMENT-CHOICE-SET-UUID__
19455         - name: model-type
19456           in: query
19457           description: Type of the model, e.g., service, resource, widget, etc.
19458           required: false
19459           type: string
19460         - name: model-name
19461           in: query
19462           description: Name of the model, which can change from version to version.
19463           required: false
19464           type: string
19465         - name: model-version
19466           in: query
19467           description: Version
19468           required: false
19469           type: string
19470     put:
19471       tags:
19472         - ServiceDesignAndCreation
19473       summary: create or update an existing element-choice-set
19474       description: |
19475         Create or update an existing element-choice-set.
19476         #
19477         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19478       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19479       consumes:
19480         - application/json
19481         - application/xml
19482       produces:
19483         - application/json
19484         - application/xml
19485       responses:
19486         "default":
19487           description: Response codes found in [response codes](https://wiki.onap.org/).
19488       parameters:
19489         - name: model-invariant-id
19490           in: path
19491           description: Unique identifier corresponding to the main definition of a model in ASDC
19492           required: true
19493           type: string
19494           example: __MODEL-INVARIANT-ID__
19495         - name: model-version-id
19496           in: path
19497           description: Unique identifier corresponding to one version of a model in ASDC
19498           required: true
19499           type: string
19500           example: __MODEL-VERSION-ID__
19501         - name: model-element-uuid
19502           in: path
19503           required: true
19504           type: string
19505           example: __MODEL-ELEMENT-UUID__
19506         - name: model-constraint-uuid
19507           in: path
19508           required: true
19509           type: string
19510           example: __MODEL-CONSTRAINT-UUID__
19511         - name: constrained-element-set-uuid
19512           in: path
19513           required: true
19514           type: string
19515           example: __CONSTRAINED-ELEMENT-SET-UUID__
19516         - name: element-choice-set-uuid
19517           in: path
19518           required: true
19519           type: string
19520           example: __ELEMENT-CHOICE-SET-UUID__
19521         - name: body
19522           in: body
19523           description: element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)
19524           required: true
19525           schema:
19526             $ref: "#/definitions/element-choice-set"
19527     patch:
19528       tags:
19529         - ServiceDesignAndCreation
19530       summary: update an existing element-choice-set
19531       description: |
19532         Update an existing element-choice-set
19533         #
19534         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19535         The PUT operation will entirely replace an existing object.
19536         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19537         #
19538         Other differences between PUT and PATCH are:
19539         #
19540         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19541         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19542         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19543       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19544       consumes:
19545         - application/json
19546         - application/xml
19547       produces:
19548         - application/json
19549         - application/xml
19550       responses:
19551         "default":
19552           description: Response codes found in [response codes](https://wiki.onap.org/).
19553       parameters:
19554         - name: model-invariant-id
19555           in: path
19556           description: Unique identifier corresponding to the main definition of a model in ASDC
19557           required: true
19558           type: string
19559           example: __MODEL-INVARIANT-ID__
19560         - name: model-version-id
19561           in: path
19562           description: Unique identifier corresponding to one version of a model in ASDC
19563           required: true
19564           type: string
19565           example: __MODEL-VERSION-ID__
19566         - name: model-element-uuid
19567           in: path
19568           required: true
19569           type: string
19570           example: __MODEL-ELEMENT-UUID__
19571         - name: model-constraint-uuid
19572           in: path
19573           required: true
19574           type: string
19575           example: __MODEL-CONSTRAINT-UUID__
19576         - name: constrained-element-set-uuid
19577           in: path
19578           required: true
19579           type: string
19580           example: __CONSTRAINED-ELEMENT-SET-UUID__
19581         - name: element-choice-set-uuid
19582           in: path
19583           required: true
19584           type: string
19585           example: __ELEMENT-CHOICE-SET-UUID__
19586         - name: body
19587           in: body
19588           description: element-choice-set object that needs to be created or updated.
19589           required: true
19590           schema:
19591             $ref: "#/patchDefinitions/element-choice-set"
19592     delete:
19593       tags:
19594         - ServiceDesignAndCreation
19595       summary: delete an existing element-choice-set
19596       description: delete an existing element-choice-set
19597       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet
19598       consumes:
19599         - application/json
19600         - application/xml
19601       produces:
19602         - application/json
19603         - application/xml
19604       responses:
19605         "default":
19606           description: Response codes found in [response codes](https://wiki.onap.org/).
19607       parameters:
19608         - name: model-invariant-id
19609           in: path
19610           description: Unique identifier corresponding to the main definition of a model in ASDC
19611           required: true
19612           type: string
19613           example: __MODEL-INVARIANT-ID__
19614         - name: model-version-id
19615           in: path
19616           description: Unique identifier corresponding to one version of a model in ASDC
19617           required: true
19618           type: string
19619           example: __MODEL-VERSION-ID__
19620         - name: model-element-uuid
19621           in: path
19622           required: true
19623           type: string
19624           example: __MODEL-ELEMENT-UUID__
19625         - name: model-constraint-uuid
19626           in: path
19627           required: true
19628           type: string
19629           example: __MODEL-CONSTRAINT-UUID__
19630         - name: constrained-element-set-uuid
19631           in: path
19632           required: true
19633           type: string
19634           example: __CONSTRAINED-ELEMENT-SET-UUID__
19635         - name: element-choice-set-uuid
19636           in: path
19637           required: true
19638           type: string
19639           example: __ELEMENT-CHOICE-SET-UUID__
19640         - name: resource-version
19641           in: query
19642           description: resource-version for concurrency
19643           required: true
19644           type: string
19645   /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:
19646     get:
19647       tags:
19648         - ServiceDesignAndCreation
19649       summary: returns element-choice-sets
19650       description: returns element-choice-sets
19651       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSets
19652       produces:
19653         - application/json
19654         - application/xml
19655       responses:
19656         "200":
19657           description: successful operation
19658           schema:
19659               $ref: "#/getDefinitions/element-choice-sets"
19660         "default":
19661           description: Response codes found in [response codes](https://wiki.onap.org/).
19662       parameters:
19663         - name: model-invariant-id
19664           in: path
19665           description: Unique identifier corresponding to the main definition of a model in ASDC
19666           required: true
19667           type: string
19668           example: __MODEL-INVARIANT-ID__
19669         - name: model-version-id
19670           in: path
19671           description: Unique identifier corresponding to one version of a model in ASDC
19672           required: true
19673           type: string
19674           example: __MODEL-VERSION-ID__
19675         - name: model-element-uuid
19676           in: path
19677           required: true
19678           type: string
19679           example: __MODEL-ELEMENT-UUID__
19680         - name: model-constraint-uuid
19681           in: path
19682           required: true
19683           type: string
19684           example: __MODEL-CONSTRAINT-UUID__
19685         - name: constrained-element-set-uuid
19686           in: path
19687           required: true
19688           type: string
19689           example: __CONSTRAINED-ELEMENT-SET-UUID__
19690         - name: model-type
19691           in: query
19692           description: Type of the model, e.g., service, resource, widget, etc.
19693           required: false
19694           type: string
19695         - name: model-name
19696           in: query
19697           description: Name of the model, which can change from version to version.
19698           required: false
19699           type: string
19700         - name: model-version
19701           in: query
19702           description: Version
19703           required: false
19704           type: string
19705   /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:
19706     put:
19707       tags:
19708         - ServiceDesignAndCreation
19709       summary: see node definition for valid relationships
19710       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
19711       consumes:
19712         - application/json
19713         - application/xml
19714       produces:
19715         - application/json
19716         - application/xml
19717       responses:
19718         "default":
19719           description: Response codes found in [response codes](https://wiki.onap.org/).
19720       parameters:
19721         - name: model-invariant-id
19722           in: path
19723           description: Unique identifier corresponding to the main definition of a model in ASDC
19724           required: true
19725           type: string
19726           example: __MODEL-INVARIANT-ID__
19727         - name: model-version-id
19728           in: path
19729           description: Unique identifier corresponding to one version of a model in ASDC
19730           required: true
19731           type: string
19732           example: __MODEL-VERSION-ID__
19733         - name: model-element-uuid
19734           in: path
19735           required: true
19736           type: string
19737           example: __MODEL-ELEMENT-UUID__
19738         - name: model-constraint-uuid
19739           in: path
19740           required: true
19741           type: string
19742           example: __MODEL-CONSTRAINT-UUID__
19743         - name: constrained-element-set-uuid
19744           in: path
19745           required: true
19746           type: string
19747           example: __CONSTRAINED-ELEMENT-SET-UUID__
19748         - name: body
19749           in: body
19750           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
19751           required: true
19752           schema:
19753             $ref: "#/definitions/relationship"
19754     delete:
19755       tags:
19756         - ServiceDesignAndCreation
19757       summary: delete an existing relationship
19758       description: delete an existing relationship
19759       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetRelationshipListRelationship
19760       consumes:
19761         - application/json
19762         - application/xml
19763       produces:
19764         - application/json
19765         - application/xml
19766       responses:
19767         "default":
19768           description: Response codes found in [response codes](https://wiki.onap.org/).
19769       parameters:
19770         - name: model-invariant-id
19771           in: path
19772           description: Unique identifier corresponding to the main definition of a model in ASDC
19773           required: true
19774           type: string
19775           example: __MODEL-INVARIANT-ID__
19776         - name: model-version-id
19777           in: path
19778           description: Unique identifier corresponding to one version of a model in ASDC
19779           required: true
19780           type: string
19781           example: __MODEL-VERSION-ID__
19782         - name: model-element-uuid
19783           in: path
19784           required: true
19785           type: string
19786           example: __MODEL-ELEMENT-UUID__
19787         - name: model-constraint-uuid
19788           in: path
19789           required: true
19790           type: string
19791           example: __MODEL-CONSTRAINT-UUID__
19792         - name: constrained-element-set-uuid
19793           in: path
19794           required: true
19795           type: string
19796           example: __CONSTRAINED-ELEMENT-SET-UUID__
19797   /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}:
19798     get:
19799       tags:
19800         - ServiceDesignAndCreation
19801       summary: returns constrained-element-set
19802       description: returns constrained-element-set
19803       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19804       produces:
19805         - application/json
19806         - application/xml
19807       responses:
19808         "200":
19809           description: successful operation
19810           schema:
19811               $ref: "#/getDefinitions/constrained-element-set"
19812         "default":
19813           description: Response codes found in [response codes](https://wiki.onap.org/).
19814       parameters:
19815         - name: model-invariant-id
19816           in: path
19817           description: Unique identifier corresponding to the main definition of a model in ASDC
19818           required: true
19819           type: string
19820           example: __MODEL-INVARIANT-ID__
19821         - name: model-version-id
19822           in: path
19823           description: Unique identifier corresponding to one version of a model in ASDC
19824           required: true
19825           type: string
19826           example: __MODEL-VERSION-ID__
19827         - name: model-element-uuid
19828           in: path
19829           required: true
19830           type: string
19831           example: __MODEL-ELEMENT-UUID__
19832         - name: model-constraint-uuid
19833           in: path
19834           required: true
19835           type: string
19836           example: __MODEL-CONSTRAINT-UUID__
19837         - name: constrained-element-set-uuid
19838           in: path
19839           required: true
19840           type: string
19841           example: __CONSTRAINED-ELEMENT-SET-UUID__
19842         - name: model-type
19843           in: query
19844           description: Type of the model, e.g., service, resource, widget, etc.
19845           required: false
19846           type: string
19847         - name: model-name
19848           in: query
19849           description: Name of the model, which can change from version to version.
19850           required: false
19851           type: string
19852         - name: model-version
19853           in: query
19854           description: Version
19855           required: false
19856           type: string
19857     put:
19858       tags:
19859         - ServiceDesignAndCreation
19860       summary: create or update an existing constrained-element-set
19861       description: |
19862         Create or update an existing constrained-element-set.
19863         #
19864         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
19865       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19866       consumes:
19867         - application/json
19868         - application/xml
19869       produces:
19870         - application/json
19871         - application/xml
19872       responses:
19873         "default":
19874           description: Response codes found in [response codes](https://wiki.onap.org/).
19875       parameters:
19876         - name: model-invariant-id
19877           in: path
19878           description: Unique identifier corresponding to the main definition of a model in ASDC
19879           required: true
19880           type: string
19881           example: __MODEL-INVARIANT-ID__
19882         - name: model-version-id
19883           in: path
19884           description: Unique identifier corresponding to one version of a model in ASDC
19885           required: true
19886           type: string
19887           example: __MODEL-VERSION-ID__
19888         - name: model-element-uuid
19889           in: path
19890           required: true
19891           type: string
19892           example: __MODEL-ELEMENT-UUID__
19893         - name: model-constraint-uuid
19894           in: path
19895           required: true
19896           type: string
19897           example: __MODEL-CONSTRAINT-UUID__
19898         - name: constrained-element-set-uuid
19899           in: path
19900           required: true
19901           type: string
19902           example: __CONSTRAINED-ELEMENT-SET-UUID__
19903         - name: body
19904           in: body
19905           description: constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)
19906           required: true
19907           schema:
19908             $ref: "#/definitions/constrained-element-set"
19909     patch:
19910       tags:
19911         - ServiceDesignAndCreation
19912       summary: update an existing constrained-element-set
19913       description: |
19914         Update an existing constrained-element-set
19915         #
19916         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
19917         The PUT operation will entirely replace an existing object.
19918         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
19919         #
19920         Other differences between PUT and PATCH are:
19921         #
19922         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
19923         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
19924         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
19925       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19926       consumes:
19927         - application/json
19928         - application/xml
19929       produces:
19930         - application/json
19931         - application/xml
19932       responses:
19933         "default":
19934           description: Response codes found in [response codes](https://wiki.onap.org/).
19935       parameters:
19936         - name: model-invariant-id
19937           in: path
19938           description: Unique identifier corresponding to the main definition of a model in ASDC
19939           required: true
19940           type: string
19941           example: __MODEL-INVARIANT-ID__
19942         - name: model-version-id
19943           in: path
19944           description: Unique identifier corresponding to one version of a model in ASDC
19945           required: true
19946           type: string
19947           example: __MODEL-VERSION-ID__
19948         - name: model-element-uuid
19949           in: path
19950           required: true
19951           type: string
19952           example: __MODEL-ELEMENT-UUID__
19953         - name: model-constraint-uuid
19954           in: path
19955           required: true
19956           type: string
19957           example: __MODEL-CONSTRAINT-UUID__
19958         - name: constrained-element-set-uuid
19959           in: path
19960           required: true
19961           type: string
19962           example: __CONSTRAINED-ELEMENT-SET-UUID__
19963         - name: body
19964           in: body
19965           description: constrained-element-set object that needs to be created or updated.
19966           required: true
19967           schema:
19968             $ref: "#/patchDefinitions/constrained-element-set"
19969     delete:
19970       tags:
19971         - ServiceDesignAndCreation
19972       summary: delete an existing constrained-element-set
19973       description: delete an existing constrained-element-set
19974       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet
19975       consumes:
19976         - application/json
19977         - application/xml
19978       produces:
19979         - application/json
19980         - application/xml
19981       responses:
19982         "default":
19983           description: Response codes found in [response codes](https://wiki.onap.org/).
19984       parameters:
19985         - name: model-invariant-id
19986           in: path
19987           description: Unique identifier corresponding to the main definition of a model in ASDC
19988           required: true
19989           type: string
19990           example: __MODEL-INVARIANT-ID__
19991         - name: model-version-id
19992           in: path
19993           description: Unique identifier corresponding to one version of a model in ASDC
19994           required: true
19995           type: string
19996           example: __MODEL-VERSION-ID__
19997         - name: model-element-uuid
19998           in: path
19999           required: true
20000           type: string
20001           example: __MODEL-ELEMENT-UUID__
20002         - name: model-constraint-uuid
20003           in: path
20004           required: true
20005           type: string
20006           example: __MODEL-CONSTRAINT-UUID__
20007         - name: constrained-element-set-uuid
20008           in: path
20009           required: true
20010           type: string
20011           example: __CONSTRAINED-ELEMENT-SET-UUID__
20012         - name: resource-version
20013           in: query
20014           description: resource-version for concurrency
20015           required: true
20016           type: string
20017   /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:
20018     get:
20019       tags:
20020         - ServiceDesignAndCreation
20021       summary: returns constrained-element-sets
20022       description: returns constrained-element-sets
20023       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSets
20024       produces:
20025         - application/json
20026         - application/xml
20027       responses:
20028         "200":
20029           description: successful operation
20030           schema:
20031               $ref: "#/getDefinitions/constrained-element-sets"
20032         "default":
20033           description: Response codes found in [response codes](https://wiki.onap.org/).
20034       parameters:
20035         - name: model-invariant-id
20036           in: path
20037           description: Unique identifier corresponding to the main definition of a model in ASDC
20038           required: true
20039           type: string
20040           example: __MODEL-INVARIANT-ID__
20041         - name: model-version-id
20042           in: path
20043           description: Unique identifier corresponding to one version of a model in ASDC
20044           required: true
20045           type: string
20046           example: __MODEL-VERSION-ID__
20047         - name: model-element-uuid
20048           in: path
20049           required: true
20050           type: string
20051           example: __MODEL-ELEMENT-UUID__
20052         - name: model-constraint-uuid
20053           in: path
20054           required: true
20055           type: string
20056           example: __MODEL-CONSTRAINT-UUID__
20057         - name: model-type
20058           in: query
20059           description: Type of the model, e.g., service, resource, widget, etc.
20060           required: false
20061           type: string
20062         - name: model-name
20063           in: query
20064           description: Name of the model, which can change from version to version.
20065           required: false
20066           type: string
20067         - name: model-version
20068           in: query
20069           description: Version
20070           required: false
20071           type: string
20072   /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}:
20073     get:
20074       tags:
20075         - ServiceDesignAndCreation
20076       summary: returns model-constraint
20077       description: returns model-constraint
20078       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20079       produces:
20080         - application/json
20081         - application/xml
20082       responses:
20083         "200":
20084           description: successful operation
20085           schema:
20086               $ref: "#/getDefinitions/model-constraint"
20087         "default":
20088           description: Response codes found in [response codes](https://wiki.onap.org/).
20089       parameters:
20090         - name: model-invariant-id
20091           in: path
20092           description: Unique identifier corresponding to the main definition of a model in ASDC
20093           required: true
20094           type: string
20095           example: __MODEL-INVARIANT-ID__
20096         - name: model-version-id
20097           in: path
20098           description: Unique identifier corresponding to one version of a model in ASDC
20099           required: true
20100           type: string
20101           example: __MODEL-VERSION-ID__
20102         - name: model-element-uuid
20103           in: path
20104           required: true
20105           type: string
20106           example: __MODEL-ELEMENT-UUID__
20107         - name: model-constraint-uuid
20108           in: path
20109           required: true
20110           type: string
20111           example: __MODEL-CONSTRAINT-UUID__
20112         - name: model-type
20113           in: query
20114           description: Type of the model, e.g., service, resource, widget, etc.
20115           required: false
20116           type: string
20117         - name: model-name
20118           in: query
20119           description: Name of the model, which can change from version to version.
20120           required: false
20121           type: string
20122         - name: model-version
20123           in: query
20124           description: Version
20125           required: false
20126           type: string
20127     put:
20128       tags:
20129         - ServiceDesignAndCreation
20130       summary: create or update an existing model-constraint
20131       description: |
20132         Create or update an existing model-constraint.
20133         #
20134         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20135       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20136       consumes:
20137         - application/json
20138         - application/xml
20139       produces:
20140         - application/json
20141         - application/xml
20142       responses:
20143         "default":
20144           description: Response codes found in [response codes](https://wiki.onap.org/).
20145       parameters:
20146         - name: model-invariant-id
20147           in: path
20148           description: Unique identifier corresponding to the main definition of a model in ASDC
20149           required: true
20150           type: string
20151           example: __MODEL-INVARIANT-ID__
20152         - name: model-version-id
20153           in: path
20154           description: Unique identifier corresponding to one version of a model in ASDC
20155           required: true
20156           type: string
20157           example: __MODEL-VERSION-ID__
20158         - name: model-element-uuid
20159           in: path
20160           required: true
20161           type: string
20162           example: __MODEL-ELEMENT-UUID__
20163         - name: model-constraint-uuid
20164           in: path
20165           required: true
20166           type: string
20167           example: __MODEL-CONSTRAINT-UUID__
20168         - name: body
20169           in: body
20170           description: model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)
20171           required: true
20172           schema:
20173             $ref: "#/definitions/model-constraint"
20174     patch:
20175       tags:
20176         - ServiceDesignAndCreation
20177       summary: update an existing model-constraint
20178       description: |
20179         Update an existing model-constraint
20180         #
20181         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20182         The PUT operation will entirely replace an existing object.
20183         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20184         #
20185         Other differences between PUT and PATCH are:
20186         #
20187         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20188         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20189         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20190       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20191       consumes:
20192         - application/json
20193         - application/xml
20194       produces:
20195         - application/json
20196         - application/xml
20197       responses:
20198         "default":
20199           description: Response codes found in [response codes](https://wiki.onap.org/).
20200       parameters:
20201         - name: model-invariant-id
20202           in: path
20203           description: Unique identifier corresponding to the main definition of a model in ASDC
20204           required: true
20205           type: string
20206           example: __MODEL-INVARIANT-ID__
20207         - name: model-version-id
20208           in: path
20209           description: Unique identifier corresponding to one version of a model in ASDC
20210           required: true
20211           type: string
20212           example: __MODEL-VERSION-ID__
20213         - name: model-element-uuid
20214           in: path
20215           required: true
20216           type: string
20217           example: __MODEL-ELEMENT-UUID__
20218         - name: model-constraint-uuid
20219           in: path
20220           required: true
20221           type: string
20222           example: __MODEL-CONSTRAINT-UUID__
20223         - name: body
20224           in: body
20225           description: model-constraint object that needs to be created or updated.
20226           required: true
20227           schema:
20228             $ref: "#/patchDefinitions/model-constraint"
20229     delete:
20230       tags:
20231         - ServiceDesignAndCreation
20232       summary: delete an existing model-constraint
20233       description: delete an existing model-constraint
20234       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint
20235       consumes:
20236         - application/json
20237         - application/xml
20238       produces:
20239         - application/json
20240         - application/xml
20241       responses:
20242         "default":
20243           description: Response codes found in [response codes](https://wiki.onap.org/).
20244       parameters:
20245         - name: model-invariant-id
20246           in: path
20247           description: Unique identifier corresponding to the main definition of a model in ASDC
20248           required: true
20249           type: string
20250           example: __MODEL-INVARIANT-ID__
20251         - name: model-version-id
20252           in: path
20253           description: Unique identifier corresponding to one version of a model in ASDC
20254           required: true
20255           type: string
20256           example: __MODEL-VERSION-ID__
20257         - name: model-element-uuid
20258           in: path
20259           required: true
20260           type: string
20261           example: __MODEL-ELEMENT-UUID__
20262         - name: model-constraint-uuid
20263           in: path
20264           required: true
20265           type: string
20266           example: __MODEL-CONSTRAINT-UUID__
20267         - name: resource-version
20268           in: query
20269           description: resource-version for concurrency
20270           required: true
20271           type: string
20272   /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:
20273     get:
20274       tags:
20275         - ServiceDesignAndCreation
20276       summary: returns model-constraints
20277       description: returns model-constraints
20278       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraints
20279       produces:
20280         - application/json
20281         - application/xml
20282       responses:
20283         "200":
20284           description: successful operation
20285           schema:
20286               $ref: "#/getDefinitions/model-constraints"
20287         "default":
20288           description: Response codes found in [response codes](https://wiki.onap.org/).
20289       parameters:
20290         - name: model-invariant-id
20291           in: path
20292           description: Unique identifier corresponding to the main definition of a model in ASDC
20293           required: true
20294           type: string
20295           example: __MODEL-INVARIANT-ID__
20296         - name: model-version-id
20297           in: path
20298           description: Unique identifier corresponding to one version of a model in ASDC
20299           required: true
20300           type: string
20301           example: __MODEL-VERSION-ID__
20302         - name: model-element-uuid
20303           in: path
20304           required: true
20305           type: string
20306           example: __MODEL-ELEMENT-UUID__
20307         - name: model-type
20308           in: query
20309           description: Type of the model, e.g., service, resource, widget, etc.
20310           required: false
20311           type: string
20312         - name: model-name
20313           in: query
20314           description: Name of the model, which can change from version to version.
20315           required: false
20316           type: string
20317         - name: model-version
20318           in: query
20319           description: Version
20320           required: false
20321           type: string
20322   /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:
20323     put:
20324       tags:
20325         - ServiceDesignAndCreation
20326       summary: see node definition for valid relationships
20327       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
20328       consumes:
20329         - application/json
20330         - application/xml
20331       produces:
20332         - application/json
20333         - application/xml
20334       responses:
20335         "default":
20336           description: Response codes found in [response codes](https://wiki.onap.org/).
20337       parameters:
20338         - name: model-invariant-id
20339           in: path
20340           description: Unique identifier corresponding to the main definition of a model in ASDC
20341           required: true
20342           type: string
20343           example: __MODEL-INVARIANT-ID__
20344         - name: model-version-id
20345           in: path
20346           description: Unique identifier corresponding to one version of a model in ASDC
20347           required: true
20348           type: string
20349           example: __MODEL-VERSION-ID__
20350         - name: model-element-uuid
20351           in: path
20352           required: true
20353           type: string
20354           example: __MODEL-ELEMENT-UUID__
20355         - name: body
20356           in: body
20357           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
20358           required: true
20359           schema:
20360             $ref: "#/definitions/relationship"
20361     delete:
20362       tags:
20363         - ServiceDesignAndCreation
20364       summary: delete an existing relationship
20365       description: delete an existing relationship
20366       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementRelationshipListRelationship
20367       consumes:
20368         - application/json
20369         - application/xml
20370       produces:
20371         - application/json
20372         - application/xml
20373       responses:
20374         "default":
20375           description: Response codes found in [response codes](https://wiki.onap.org/).
20376       parameters:
20377         - name: model-invariant-id
20378           in: path
20379           description: Unique identifier corresponding to the main definition of a model in ASDC
20380           required: true
20381           type: string
20382           example: __MODEL-INVARIANT-ID__
20383         - name: model-version-id
20384           in: path
20385           description: Unique identifier corresponding to one version of a model in ASDC
20386           required: true
20387           type: string
20388           example: __MODEL-VERSION-ID__
20389         - name: model-element-uuid
20390           in: path
20391           required: true
20392           type: string
20393           example: __MODEL-ELEMENT-UUID__
20394   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}:
20395     get:
20396       tags:
20397         - ServiceDesignAndCreation
20398       summary: returns model-element
20399       description: returns model-element
20400       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20401       produces:
20402         - application/json
20403         - application/xml
20404       responses:
20405         "200":
20406           description: successful operation
20407           schema:
20408               $ref: "#/getDefinitions/model-element"
20409         "default":
20410           description: Response codes found in [response codes](https://wiki.onap.org/).
20411       parameters:
20412         - name: model-invariant-id
20413           in: path
20414           description: Unique identifier corresponding to the main definition of a model in ASDC
20415           required: true
20416           type: string
20417           example: __MODEL-INVARIANT-ID__
20418         - name: model-version-id
20419           in: path
20420           description: Unique identifier corresponding to one version of a model in ASDC
20421           required: true
20422           type: string
20423           example: __MODEL-VERSION-ID__
20424         - name: model-element-uuid
20425           in: path
20426           required: true
20427           type: string
20428           example: __MODEL-ELEMENT-UUID__
20429         - name: model-type
20430           in: query
20431           description: Type of the model, e.g., service, resource, widget, etc.
20432           required: false
20433           type: string
20434         - name: model-name
20435           in: query
20436           description: Name of the model, which can change from version to version.
20437           required: false
20438           type: string
20439         - name: model-version
20440           in: query
20441           description: Version
20442           required: false
20443           type: string
20444     put:
20445       tags:
20446         - ServiceDesignAndCreation
20447       summary: create or update an existing model-element
20448       description: |
20449         Create or update an existing model-element.
20450         #
20451         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20452       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20453       consumes:
20454         - application/json
20455         - application/xml
20456       produces:
20457         - application/json
20458         - application/xml
20459       responses:
20460         "default":
20461           description: Response codes found in [response codes](https://wiki.onap.org/).
20462       parameters:
20463         - name: model-invariant-id
20464           in: path
20465           description: Unique identifier corresponding to the main definition of a model in ASDC
20466           required: true
20467           type: string
20468           example: __MODEL-INVARIANT-ID__
20469         - name: model-version-id
20470           in: path
20471           description: Unique identifier corresponding to one version of a model in ASDC
20472           required: true
20473           type: string
20474           example: __MODEL-VERSION-ID__
20475         - name: model-element-uuid
20476           in: path
20477           required: true
20478           type: string
20479           example: __MODEL-ELEMENT-UUID__
20480         - name: body
20481           in: body
20482           description: model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)
20483           required: true
20484           schema:
20485             $ref: "#/definitions/model-element"
20486     patch:
20487       tags:
20488         - ServiceDesignAndCreation
20489       summary: update an existing model-element
20490       description: |
20491         Update an existing model-element
20492         #
20493         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20494         The PUT operation will entirely replace an existing object.
20495         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20496         #
20497         Other differences between PUT and PATCH are:
20498         #
20499         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20500         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20501         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20502       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20503       consumes:
20504         - application/json
20505         - application/xml
20506       produces:
20507         - application/json
20508         - application/xml
20509       responses:
20510         "default":
20511           description: Response codes found in [response codes](https://wiki.onap.org/).
20512       parameters:
20513         - name: model-invariant-id
20514           in: path
20515           description: Unique identifier corresponding to the main definition of a model in ASDC
20516           required: true
20517           type: string
20518           example: __MODEL-INVARIANT-ID__
20519         - name: model-version-id
20520           in: path
20521           description: Unique identifier corresponding to one version of a model in ASDC
20522           required: true
20523           type: string
20524           example: __MODEL-VERSION-ID__
20525         - name: model-element-uuid
20526           in: path
20527           required: true
20528           type: string
20529           example: __MODEL-ELEMENT-UUID__
20530         - name: body
20531           in: body
20532           description: model-element object that needs to be created or updated.
20533           required: true
20534           schema:
20535             $ref: "#/patchDefinitions/model-element"
20536     delete:
20537       tags:
20538         - ServiceDesignAndCreation
20539       summary: delete an existing model-element
20540       description: delete an existing model-element
20541       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement
20542       consumes:
20543         - application/json
20544         - application/xml
20545       produces:
20546         - application/json
20547         - application/xml
20548       responses:
20549         "default":
20550           description: Response codes found in [response codes](https://wiki.onap.org/).
20551       parameters:
20552         - name: model-invariant-id
20553           in: path
20554           description: Unique identifier corresponding to the main definition of a model in ASDC
20555           required: true
20556           type: string
20557           example: __MODEL-INVARIANT-ID__
20558         - name: model-version-id
20559           in: path
20560           description: Unique identifier corresponding to one version of a model in ASDC
20561           required: true
20562           type: string
20563           example: __MODEL-VERSION-ID__
20564         - name: model-element-uuid
20565           in: path
20566           required: true
20567           type: string
20568           example: __MODEL-ELEMENT-UUID__
20569         - name: resource-version
20570           in: query
20571           description: resource-version for concurrency
20572           required: true
20573           type: string
20574   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements:
20575     get:
20576       tags:
20577         - ServiceDesignAndCreation
20578       summary: returns model-elements
20579       description: returns model-elements
20580       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerModelElements
20581       produces:
20582         - application/json
20583         - application/xml
20584       responses:
20585         "200":
20586           description: successful operation
20587           schema:
20588               $ref: "#/getDefinitions/model-elements"
20589         "default":
20590           description: Response codes found in [response codes](https://wiki.onap.org/).
20591       parameters:
20592         - name: model-invariant-id
20593           in: path
20594           description: Unique identifier corresponding to the main definition of a model in ASDC
20595           required: true
20596           type: string
20597           example: __MODEL-INVARIANT-ID__
20598         - name: model-version-id
20599           in: path
20600           description: Unique identifier corresponding to one version of a model in ASDC
20601           required: true
20602           type: string
20603           example: __MODEL-VERSION-ID__
20604         - name: model-type
20605           in: query
20606           description: Type of the model, e.g., service, resource, widget, etc.
20607           required: false
20608           type: string
20609         - name: model-name
20610           in: query
20611           description: Name of the model, which can change from version to version.
20612           required: false
20613           type: string
20614         - name: model-version
20615           in: query
20616           description: Version
20617           required: false
20618           type: string
20619   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}:
20620     get:
20621       tags:
20622         - ServiceDesignAndCreation
20623       summary: returns metadatum
20624       description: returns metadatum
20625       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20626       produces:
20627         - application/json
20628         - application/xml
20629       responses:
20630         "200":
20631           description: successful operation
20632           schema:
20633               $ref: "#/getDefinitions/metadatum"
20634         "default":
20635           description: Response codes found in [response codes](https://wiki.onap.org/).
20636       parameters:
20637         - name: model-invariant-id
20638           in: path
20639           description: Unique identifier corresponding to the main definition of a model in ASDC
20640           required: true
20641           type: string
20642           example: __MODEL-INVARIANT-ID__
20643         - name: model-version-id
20644           in: path
20645           description: Unique identifier corresponding to one version of a model in ASDC
20646           required: true
20647           type: string
20648           example: __MODEL-VERSION-ID__
20649         - name: metaname
20650           in: path
20651           required: true
20652           type: string
20653           example: __METANAME__
20654         - name: model-type
20655           in: query
20656           description: Type of the model, e.g., service, resource, widget, etc.
20657           required: false
20658           type: string
20659         - name: model-name
20660           in: query
20661           description: Name of the model, which can change from version to version.
20662           required: false
20663           type: string
20664         - name: model-version
20665           in: query
20666           description: Version
20667           required: false
20668           type: string
20669     put:
20670       tags:
20671         - ServiceDesignAndCreation
20672       summary: create or update an existing metadatum
20673       description: |
20674         Create or update an existing metadatum.
20675         #
20676         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20677       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20678       consumes:
20679         - application/json
20680         - application/xml
20681       produces:
20682         - application/json
20683         - application/xml
20684       responses:
20685         "default":
20686           description: Response codes found in [response codes](https://wiki.onap.org/).
20687       parameters:
20688         - name: model-invariant-id
20689           in: path
20690           description: Unique identifier corresponding to the main definition of a model in ASDC
20691           required: true
20692           type: string
20693           example: __MODEL-INVARIANT-ID__
20694         - name: model-version-id
20695           in: path
20696           description: Unique identifier corresponding to one version of a model in ASDC
20697           required: true
20698           type: string
20699           example: __MODEL-VERSION-ID__
20700         - name: metaname
20701           in: path
20702           required: true
20703           type: string
20704           example: __METANAME__
20705         - name: body
20706           in: body
20707           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)
20708           required: true
20709           schema:
20710             $ref: "#/definitions/metadatum"
20711     patch:
20712       tags:
20713         - ServiceDesignAndCreation
20714       summary: update an existing metadatum
20715       description: |
20716         Update an existing metadatum
20717         #
20718         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20719         The PUT operation will entirely replace an existing object.
20720         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20721         #
20722         Other differences between PUT and PATCH are:
20723         #
20724         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
20725         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
20726         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
20727       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20728       consumes:
20729         - application/json
20730         - application/xml
20731       produces:
20732         - application/json
20733         - application/xml
20734       responses:
20735         "default":
20736           description: Response codes found in [response codes](https://wiki.onap.org/).
20737       parameters:
20738         - name: model-invariant-id
20739           in: path
20740           description: Unique identifier corresponding to the main definition of a model in ASDC
20741           required: true
20742           type: string
20743           example: __MODEL-INVARIANT-ID__
20744         - name: model-version-id
20745           in: path
20746           description: Unique identifier corresponding to one version of a model in ASDC
20747           required: true
20748           type: string
20749           example: __MODEL-VERSION-ID__
20750         - name: metaname
20751           in: path
20752           required: true
20753           type: string
20754           example: __METANAME__
20755         - name: body
20756           in: body
20757           description: metadatum object that needs to be created or updated.
20758           required: true
20759           schema:
20760             $ref: "#/patchDefinitions/metadatum"
20761     delete:
20762       tags:
20763         - ServiceDesignAndCreation
20764       summary: delete an existing metadatum
20765       description: delete an existing metadatum
20766       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum
20767       consumes:
20768         - application/json
20769         - application/xml
20770       produces:
20771         - application/json
20772         - application/xml
20773       responses:
20774         "default":
20775           description: Response codes found in [response codes](https://wiki.onap.org/).
20776       parameters:
20777         - name: model-invariant-id
20778           in: path
20779           description: Unique identifier corresponding to the main definition of a model in ASDC
20780           required: true
20781           type: string
20782           example: __MODEL-INVARIANT-ID__
20783         - name: model-version-id
20784           in: path
20785           description: Unique identifier corresponding to one version of a model in ASDC
20786           required: true
20787           type: string
20788           example: __MODEL-VERSION-ID__
20789         - name: metaname
20790           in: path
20791           required: true
20792           type: string
20793           example: __METANAME__
20794         - name: resource-version
20795           in: query
20796           description: resource-version for concurrency
20797           required: true
20798           type: string
20799   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata:
20800     get:
20801       tags:
20802         - ServiceDesignAndCreation
20803       summary: returns metadata
20804       description: returns metadata
20805       operationId: getServiceDesignAndCreationModelsModelModelVersModelVerMetadata
20806       produces:
20807         - application/json
20808         - application/xml
20809       responses:
20810         "200":
20811           description: successful operation
20812           schema:
20813               $ref: "#/getDefinitions/metadata"
20814         "default":
20815           description: Response codes found in [response codes](https://wiki.onap.org/).
20816       parameters:
20817         - name: model-invariant-id
20818           in: path
20819           description: Unique identifier corresponding to the main definition of a model in ASDC
20820           required: true
20821           type: string
20822           example: __MODEL-INVARIANT-ID__
20823         - name: model-version-id
20824           in: path
20825           description: Unique identifier corresponding to one version of a model in ASDC
20826           required: true
20827           type: string
20828           example: __MODEL-VERSION-ID__
20829         - name: model-type
20830           in: query
20831           description: Type of the model, e.g., service, resource, widget, etc.
20832           required: false
20833           type: string
20834         - name: model-name
20835           in: query
20836           description: Name of the model, which can change from version to version.
20837           required: false
20838           type: string
20839         - name: model-version
20840           in: query
20841           description: Version
20842           required: false
20843           type: string
20844   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship:
20845     put:
20846       tags:
20847         - ServiceDesignAndCreation
20848       summary: see node definition for valid relationships
20849       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
20850       consumes:
20851         - application/json
20852         - application/xml
20853       produces:
20854         - application/json
20855         - application/xml
20856       responses:
20857         "default":
20858           description: Response codes found in [response codes](https://wiki.onap.org/).
20859       parameters:
20860         - name: model-invariant-id
20861           in: path
20862           description: Unique identifier corresponding to the main definition of a model in ASDC
20863           required: true
20864           type: string
20865           example: __MODEL-INVARIANT-ID__
20866         - name: model-version-id
20867           in: path
20868           description: Unique identifier corresponding to one version of a model in ASDC
20869           required: true
20870           type: string
20871           example: __MODEL-VERSION-ID__
20872         - name: body
20873           in: body
20874           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
20875           required: true
20876           schema:
20877             $ref: "#/definitions/relationship"
20878     delete:
20879       tags:
20880         - ServiceDesignAndCreation
20881       summary: delete an existing relationship
20882       description: delete an existing relationship
20883       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVerRelationshipListRelationship
20884       consumes:
20885         - application/json
20886         - application/xml
20887       produces:
20888         - application/json
20889         - application/xml
20890       responses:
20891         "default":
20892           description: Response codes found in [response codes](https://wiki.onap.org/).
20893       parameters:
20894         - name: model-invariant-id
20895           in: path
20896           description: Unique identifier corresponding to the main definition of a model in ASDC
20897           required: true
20898           type: string
20899           example: __MODEL-INVARIANT-ID__
20900         - name: model-version-id
20901           in: path
20902           description: Unique identifier corresponding to one version of a model in ASDC
20903           required: true
20904           type: string
20905           example: __MODEL-VERSION-ID__
20906   /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}:
20907     get:
20908       tags:
20909         - ServiceDesignAndCreation
20910       summary: returns model-ver
20911       description: returns model-ver
20912       operationId: getServiceDesignAndCreationModelsModelModelVersModelVer
20913       produces:
20914         - application/json
20915         - application/xml
20916       responses:
20917         "200":
20918           description: successful operation
20919           schema:
20920               $ref: "#/getDefinitions/model-ver"
20921         "default":
20922           description: Response codes found in [response codes](https://wiki.onap.org/).
20923       parameters:
20924         - name: model-invariant-id
20925           in: path
20926           description: Unique identifier corresponding to the main definition of a model in ASDC
20927           required: true
20928           type: string
20929           example: __MODEL-INVARIANT-ID__
20930         - name: model-version-id
20931           in: path
20932           description: Unique identifier corresponding to one version of a model in ASDC
20933           required: true
20934           type: string
20935           example: __MODEL-VERSION-ID__
20936         - name: model-type
20937           in: query
20938           description: Type of the model, e.g., service, resource, widget, etc.
20939           required: false
20940           type: string
20941         - name: model-name
20942           in: query
20943           description: Name of the model, which can change from version to version.
20944           required: false
20945           type: string
20946         - name: model-version
20947           in: query
20948           description: Version
20949           required: false
20950           type: string
20951     put:
20952       tags:
20953         - ServiceDesignAndCreation
20954       summary: create or update an existing model-ver
20955       description: |
20956         Create or update an existing model-ver.
20957         #
20958         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
20959       operationId: createOrUpdateServiceDesignAndCreationModelsModelModelVersModelVer
20960       consumes:
20961         - application/json
20962         - application/xml
20963       produces:
20964         - application/json
20965         - application/xml
20966       responses:
20967         "default":
20968           description: Response codes found in [response codes](https://wiki.onap.org/).
20969       parameters:
20970         - name: model-invariant-id
20971           in: path
20972           description: Unique identifier corresponding to the main definition of a model in ASDC
20973           required: true
20974           type: string
20975           example: __MODEL-INVARIANT-ID__
20976         - name: model-version-id
20977           in: path
20978           description: Unique identifier corresponding to one version of a model in ASDC
20979           required: true
20980           type: string
20981           example: __MODEL-VERSION-ID__
20982         - name: body
20983           in: body
20984           description: model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)
20985           required: true
20986           schema:
20987             $ref: "#/definitions/model-ver"
20988     patch:
20989       tags:
20990         - ServiceDesignAndCreation
20991       summary: update an existing model-ver
20992       description: |
20993         Update an existing model-ver
20994         #
20995         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
20996         The PUT operation will entirely replace an existing object.
20997         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
20998         #
20999         Other differences between PUT and PATCH are:
21000         #
21001         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21002         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21003         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21004       operationId: UpdateServiceDesignAndCreationModelsModelModelVersModelVer
21005       consumes:
21006         - application/json
21007         - application/xml
21008       produces:
21009         - application/json
21010         - application/xml
21011       responses:
21012         "default":
21013           description: Response codes found in [response codes](https://wiki.onap.org/).
21014       parameters:
21015         - name: model-invariant-id
21016           in: path
21017           description: Unique identifier corresponding to the main definition of a model in ASDC
21018           required: true
21019           type: string
21020           example: __MODEL-INVARIANT-ID__
21021         - name: model-version-id
21022           in: path
21023           description: Unique identifier corresponding to one version of a model in ASDC
21024           required: true
21025           type: string
21026           example: __MODEL-VERSION-ID__
21027         - name: body
21028           in: body
21029           description: model-ver object that needs to be created or updated.
21030           required: true
21031           schema:
21032             $ref: "#/patchDefinitions/model-ver"
21033     delete:
21034       tags:
21035         - ServiceDesignAndCreation
21036       summary: delete an existing model-ver
21037       description: delete an existing model-ver
21038       operationId: deleteServiceDesignAndCreationModelsModelModelVersModelVer
21039       consumes:
21040         - application/json
21041         - application/xml
21042       produces:
21043         - application/json
21044         - application/xml
21045       responses:
21046         "default":
21047           description: Response codes found in [response codes](https://wiki.onap.org/).
21048       parameters:
21049         - name: model-invariant-id
21050           in: path
21051           description: Unique identifier corresponding to the main definition of a model in ASDC
21052           required: true
21053           type: string
21054           example: __MODEL-INVARIANT-ID__
21055         - name: model-version-id
21056           in: path
21057           description: Unique identifier corresponding to one version of a model in ASDC
21058           required: true
21059           type: string
21060           example: __MODEL-VERSION-ID__
21061         - name: resource-version
21062           in: query
21063           description: resource-version for concurrency
21064           required: true
21065           type: string
21066   /service-design-and-creation/models/model/{model-invariant-id}/model-vers:
21067     get:
21068       tags:
21069         - ServiceDesignAndCreation
21070       summary: returns model-vers
21071       description: returns model-vers
21072       operationId: getServiceDesignAndCreationModelsModelModelVers
21073       produces:
21074         - application/json
21075         - application/xml
21076       responses:
21077         "200":
21078           description: successful operation
21079           schema:
21080               $ref: "#/getDefinitions/model-vers"
21081         "default":
21082           description: Response codes found in [response codes](https://wiki.onap.org/).
21083       parameters:
21084         - name: model-invariant-id
21085           in: path
21086           description: Unique identifier corresponding to the main definition of a model in ASDC
21087           required: true
21088           type: string
21089           example: __MODEL-INVARIANT-ID__
21090         - name: model-type
21091           in: query
21092           description: Type of the model, e.g., service, resource, widget, etc.
21093           required: false
21094           type: string
21095   /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship:
21096     put:
21097       tags:
21098         - ServiceDesignAndCreation
21099       summary: see node definition for valid relationships
21100       operationId: createOrUpdateServiceDesignAndCreationModelsModelRelationshipListRelationship
21101       consumes:
21102         - application/json
21103         - application/xml
21104       produces:
21105         - application/json
21106         - application/xml
21107       responses:
21108         "default":
21109           description: Response codes found in [response codes](https://wiki.onap.org/).
21110       parameters:
21111         - name: model-invariant-id
21112           in: path
21113           description: Unique identifier corresponding to the main definition of a model in ASDC
21114           required: true
21115           type: string
21116           example: __MODEL-INVARIANT-ID__
21117         - name: body
21118           in: body
21119           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
21120           required: true
21121           schema:
21122             $ref: "#/definitions/relationship"
21123     delete:
21124       tags:
21125         - ServiceDesignAndCreation
21126       summary: delete an existing relationship
21127       description: delete an existing relationship
21128       operationId: deleteServiceDesignAndCreationModelsModelRelationshipListRelationship
21129       consumes:
21130         - application/json
21131         - application/xml
21132       produces:
21133         - application/json
21134         - application/xml
21135       responses:
21136         "default":
21137           description: Response codes found in [response codes](https://wiki.onap.org/).
21138       parameters:
21139         - name: model-invariant-id
21140           in: path
21141           description: Unique identifier corresponding to the main definition of a model in ASDC
21142           required: true
21143           type: string
21144           example: __MODEL-INVARIANT-ID__
21145   /service-design-and-creation/models/model/{model-invariant-id}:
21146     get:
21147       tags:
21148         - ServiceDesignAndCreation
21149       summary: returns model
21150       description: returns model
21151       operationId: getServiceDesignAndCreationModelsModel
21152       produces:
21153         - application/json
21154         - application/xml
21155       responses:
21156         "200":
21157           description: successful operation
21158           schema:
21159               $ref: "#/getDefinitions/model"
21160         "default":
21161           description: Response codes found in [response codes](https://wiki.onap.org/).
21162       parameters:
21163         - name: model-invariant-id
21164           in: path
21165           description: Unique identifier corresponding to the main definition of a model in ASDC
21166           required: true
21167           type: string
21168           example: __MODEL-INVARIANT-ID__
21169         - name: model-type
21170           in: query
21171           description: Type of the model, e.g., service, resource, widget, etc.
21172           required: false
21173           type: string
21174     put:
21175       tags:
21176         - ServiceDesignAndCreation
21177       summary: create or update an existing model
21178       description: |
21179         Create or update an existing model.
21180         #
21181         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21182       operationId: createOrUpdateServiceDesignAndCreationModelsModel
21183       consumes:
21184         - application/json
21185         - application/xml
21186       produces:
21187         - application/json
21188         - application/xml
21189       responses:
21190         "default":
21191           description: Response codes found in [response codes](https://wiki.onap.org/).
21192       parameters:
21193         - name: model-invariant-id
21194           in: path
21195           description: Unique identifier corresponding to the main definition of a model in ASDC
21196           required: true
21197           type: string
21198           example: __MODEL-INVARIANT-ID__
21199         - name: body
21200           in: body
21201           description: model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)
21202           required: true
21203           schema:
21204             $ref: "#/definitions/model"
21205     patch:
21206       tags:
21207         - ServiceDesignAndCreation
21208       summary: update an existing model
21209       description: |
21210         Update an existing model
21211         #
21212         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21213         The PUT operation will entirely replace an existing object.
21214         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21215         #
21216         Other differences between PUT and PATCH are:
21217         #
21218         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21219         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21220         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21221       operationId: UpdateServiceDesignAndCreationModelsModel
21222       consumes:
21223         - application/json
21224         - application/xml
21225       produces:
21226         - application/json
21227         - application/xml
21228       responses:
21229         "default":
21230           description: Response codes found in [response codes](https://wiki.onap.org/).
21231       parameters:
21232         - name: model-invariant-id
21233           in: path
21234           description: Unique identifier corresponding to the main definition of a model in ASDC
21235           required: true
21236           type: string
21237           example: __MODEL-INVARIANT-ID__
21238         - name: body
21239           in: body
21240           description: model object that needs to be created or updated.
21241           required: true
21242           schema:
21243             $ref: "#/patchDefinitions/model"
21244     delete:
21245       tags:
21246         - ServiceDesignAndCreation
21247       summary: delete an existing model
21248       description: delete an existing model
21249       operationId: deleteServiceDesignAndCreationModelsModel
21250       consumes:
21251         - application/json
21252         - application/xml
21253       produces:
21254         - application/json
21255         - application/xml
21256       responses:
21257         "default":
21258           description: Response codes found in [response codes](https://wiki.onap.org/).
21259       parameters:
21260         - name: model-invariant-id
21261           in: path
21262           description: Unique identifier corresponding to the main definition of a model in ASDC
21263           required: true
21264           type: string
21265           example: __MODEL-INVARIANT-ID__
21266         - name: resource-version
21267           in: query
21268           description: resource-version for concurrency
21269           required: true
21270           type: string
21271   /service-design-and-creation/models:
21272     get:
21273       tags:
21274         - ServiceDesignAndCreation
21275       summary: returns models
21276       description: returns models
21277       operationId: getServiceDesignAndCreationModels
21278       produces:
21279         - application/json
21280         - application/xml
21281       responses:
21282         "200":
21283           description: successful operation
21284           schema:
21285               $ref: "#/getDefinitions/models"
21286         "default":
21287           description: Response codes found in [response codes](https://wiki.onap.org/).
21288   /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:
21289     put:
21290       tags:
21291         - ServiceDesignAndCreation
21292       summary: see node definition for valid relationships
21293       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
21294       consumes:
21295         - application/json
21296         - application/xml
21297       produces:
21298         - application/json
21299         - application/xml
21300       responses:
21301         "default":
21302           description: Response codes found in [response codes](https://wiki.onap.org/).
21303       parameters:
21304         - name: named-query-uuid
21305           in: path
21306           required: true
21307           type: string
21308           example: __NAMED-QUERY-UUID__
21309         - name: named-query-element-uuid
21310           in: path
21311           required: true
21312           type: string
21313           example: __NAMED-QUERY-ELEMENT-UUID__
21314         - name: related-lookup-uuid
21315           in: path
21316           required: true
21317           type: string
21318           example: __RELATED-LOOKUP-UUID__
21319         - name: body
21320           in: body
21321           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
21322           required: true
21323           schema:
21324             $ref: "#/definitions/relationship"
21325     delete:
21326       tags:
21327         - ServiceDesignAndCreation
21328       summary: delete an existing relationship
21329       description: delete an existing relationship
21330       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookupRelationshipListRelationship
21331       consumes:
21332         - application/json
21333         - application/xml
21334       produces:
21335         - application/json
21336         - application/xml
21337       responses:
21338         "default":
21339           description: Response codes found in [response codes](https://wiki.onap.org/).
21340       parameters:
21341         - name: named-query-uuid
21342           in: path
21343           required: true
21344           type: string
21345           example: __NAMED-QUERY-UUID__
21346         - name: named-query-element-uuid
21347           in: path
21348           required: true
21349           type: string
21350           example: __NAMED-QUERY-ELEMENT-UUID__
21351         - name: related-lookup-uuid
21352           in: path
21353           required: true
21354           type: string
21355           example: __RELATED-LOOKUP-UUID__
21356   /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}:
21357     get:
21358       tags:
21359         - ServiceDesignAndCreation
21360       summary: returns related-lookup
21361       description: returns related-lookup
21362       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21363       produces:
21364         - application/json
21365         - application/xml
21366       responses:
21367         "200":
21368           description: successful operation
21369           schema:
21370               $ref: "#/getDefinitions/related-lookup"
21371         "default":
21372           description: Response codes found in [response codes](https://wiki.onap.org/).
21373       parameters:
21374         - name: named-query-uuid
21375           in: path
21376           required: true
21377           type: string
21378           example: __NAMED-QUERY-UUID__
21379         - name: named-query-element-uuid
21380           in: path
21381           required: true
21382           type: string
21383           example: __NAMED-QUERY-ELEMENT-UUID__
21384         - name: related-lookup-uuid
21385           in: path
21386           required: true
21387           type: string
21388           example: __RELATED-LOOKUP-UUID__
21389         - name: named-query-name
21390           in: query
21391           required: false
21392           type: string
21393     put:
21394       tags:
21395         - ServiceDesignAndCreation
21396       summary: create or update an existing related-lookup
21397       description: |
21398         Create or update an existing related-lookup.
21399         #
21400         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21401       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21402       consumes:
21403         - application/json
21404         - application/xml
21405       produces:
21406         - application/json
21407         - application/xml
21408       responses:
21409         "default":
21410           description: Response codes found in [response codes](https://wiki.onap.org/).
21411       parameters:
21412         - name: named-query-uuid
21413           in: path
21414           required: true
21415           type: string
21416           example: __NAMED-QUERY-UUID__
21417         - name: named-query-element-uuid
21418           in: path
21419           required: true
21420           type: string
21421           example: __NAMED-QUERY-ELEMENT-UUID__
21422         - name: related-lookup-uuid
21423           in: path
21424           required: true
21425           type: string
21426           example: __RELATED-LOOKUP-UUID__
21427         - name: body
21428           in: body
21429           description: related-lookup object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)
21430           required: true
21431           schema:
21432             $ref: "#/definitions/related-lookup"
21433     patch:
21434       tags:
21435         - ServiceDesignAndCreation
21436       summary: update an existing related-lookup
21437       description: |
21438         Update an existing related-lookup
21439         #
21440         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21441         The PUT operation will entirely replace an existing object.
21442         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21443         #
21444         Other differences between PUT and PATCH are:
21445         #
21446         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21447         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21448         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21449       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21450       consumes:
21451         - application/json
21452         - application/xml
21453       produces:
21454         - application/json
21455         - application/xml
21456       responses:
21457         "default":
21458           description: Response codes found in [response codes](https://wiki.onap.org/).
21459       parameters:
21460         - name: named-query-uuid
21461           in: path
21462           required: true
21463           type: string
21464           example: __NAMED-QUERY-UUID__
21465         - name: named-query-element-uuid
21466           in: path
21467           required: true
21468           type: string
21469           example: __NAMED-QUERY-ELEMENT-UUID__
21470         - name: related-lookup-uuid
21471           in: path
21472           required: true
21473           type: string
21474           example: __RELATED-LOOKUP-UUID__
21475         - name: body
21476           in: body
21477           description: related-lookup object that needs to be created or updated.
21478           required: true
21479           schema:
21480             $ref: "#/patchDefinitions/related-lookup"
21481     delete:
21482       tags:
21483         - ServiceDesignAndCreation
21484       summary: delete an existing related-lookup
21485       description: delete an existing related-lookup
21486       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup
21487       consumes:
21488         - application/json
21489         - application/xml
21490       produces:
21491         - application/json
21492         - application/xml
21493       responses:
21494         "default":
21495           description: Response codes found in [response codes](https://wiki.onap.org/).
21496       parameters:
21497         - name: named-query-uuid
21498           in: path
21499           required: true
21500           type: string
21501           example: __NAMED-QUERY-UUID__
21502         - name: named-query-element-uuid
21503           in: path
21504           required: true
21505           type: string
21506           example: __NAMED-QUERY-ELEMENT-UUID__
21507         - name: related-lookup-uuid
21508           in: path
21509           required: true
21510           type: string
21511           example: __RELATED-LOOKUP-UUID__
21512         - name: resource-version
21513           in: query
21514           description: resource-version for concurrency
21515           required: true
21516           type: string
21517   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups:
21518     get:
21519       tags:
21520         - ServiceDesignAndCreation
21521       summary: returns related-lookups
21522       description: returns related-lookups
21523       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookups
21524       produces:
21525         - application/json
21526         - application/xml
21527       responses:
21528         "200":
21529           description: successful operation
21530           schema:
21531               $ref: "#/getDefinitions/related-lookups"
21532         "default":
21533           description: Response codes found in [response codes](https://wiki.onap.org/).
21534       parameters:
21535         - name: named-query-uuid
21536           in: path
21537           required: true
21538           type: string
21539           example: __NAMED-QUERY-UUID__
21540         - name: named-query-element-uuid
21541           in: path
21542           required: true
21543           type: string
21544           example: __NAMED-QUERY-ELEMENT-UUID__
21545         - name: named-query-name
21546           in: query
21547           required: false
21548           type: string
21549   /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}:
21550     get:
21551       tags:
21552         - ServiceDesignAndCreation
21553       summary: returns property-constraint
21554       description: returns property-constraint
21555       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21556       produces:
21557         - application/json
21558         - application/xml
21559       responses:
21560         "200":
21561           description: successful operation
21562           schema:
21563               $ref: "#/getDefinitions/property-constraint"
21564         "default":
21565           description: Response codes found in [response codes](https://wiki.onap.org/).
21566       parameters:
21567         - name: named-query-uuid
21568           in: path
21569           required: true
21570           type: string
21571           example: __NAMED-QUERY-UUID__
21572         - name: named-query-element-uuid
21573           in: path
21574           required: true
21575           type: string
21576           example: __NAMED-QUERY-ELEMENT-UUID__
21577         - name: property-constraint-uuid
21578           in: path
21579           required: true
21580           type: string
21581           example: __PROPERTY-CONSTRAINT-UUID__
21582         - name: named-query-name
21583           in: query
21584           required: false
21585           type: string
21586     put:
21587       tags:
21588         - ServiceDesignAndCreation
21589       summary: create or update an existing property-constraint
21590       description: |
21591         Create or update an existing property-constraint.
21592         #
21593         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21594       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21595       consumes:
21596         - application/json
21597         - application/xml
21598       produces:
21599         - application/json
21600         - application/xml
21601       responses:
21602         "default":
21603           description: Response codes found in [response codes](https://wiki.onap.org/).
21604       parameters:
21605         - name: named-query-uuid
21606           in: path
21607           required: true
21608           type: string
21609           example: __NAMED-QUERY-UUID__
21610         - name: named-query-element-uuid
21611           in: path
21612           required: true
21613           type: string
21614           example: __NAMED-QUERY-ELEMENT-UUID__
21615         - name: property-constraint-uuid
21616           in: path
21617           required: true
21618           type: string
21619           example: __PROPERTY-CONSTRAINT-UUID__
21620         - name: body
21621           in: body
21622           description: property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)
21623           required: true
21624           schema:
21625             $ref: "#/definitions/property-constraint"
21626     patch:
21627       tags:
21628         - ServiceDesignAndCreation
21629       summary: update an existing property-constraint
21630       description: |
21631         Update an existing property-constraint
21632         #
21633         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21634         The PUT operation will entirely replace an existing object.
21635         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21636         #
21637         Other differences between PUT and PATCH are:
21638         #
21639         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21640         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21641         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21642       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21643       consumes:
21644         - application/json
21645         - application/xml
21646       produces:
21647         - application/json
21648         - application/xml
21649       responses:
21650         "default":
21651           description: Response codes found in [response codes](https://wiki.onap.org/).
21652       parameters:
21653         - name: named-query-uuid
21654           in: path
21655           required: true
21656           type: string
21657           example: __NAMED-QUERY-UUID__
21658         - name: named-query-element-uuid
21659           in: path
21660           required: true
21661           type: string
21662           example: __NAMED-QUERY-ELEMENT-UUID__
21663         - name: property-constraint-uuid
21664           in: path
21665           required: true
21666           type: string
21667           example: __PROPERTY-CONSTRAINT-UUID__
21668         - name: body
21669           in: body
21670           description: property-constraint object that needs to be created or updated.
21671           required: true
21672           schema:
21673             $ref: "#/patchDefinitions/property-constraint"
21674     delete:
21675       tags:
21676         - ServiceDesignAndCreation
21677       summary: delete an existing property-constraint
21678       description: delete an existing property-constraint
21679       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint
21680       consumes:
21681         - application/json
21682         - application/xml
21683       produces:
21684         - application/json
21685         - application/xml
21686       responses:
21687         "default":
21688           description: Response codes found in [response codes](https://wiki.onap.org/).
21689       parameters:
21690         - name: named-query-uuid
21691           in: path
21692           required: true
21693           type: string
21694           example: __NAMED-QUERY-UUID__
21695         - name: named-query-element-uuid
21696           in: path
21697           required: true
21698           type: string
21699           example: __NAMED-QUERY-ELEMENT-UUID__
21700         - name: property-constraint-uuid
21701           in: path
21702           required: true
21703           type: string
21704           example: __PROPERTY-CONSTRAINT-UUID__
21705         - name: resource-version
21706           in: query
21707           description: resource-version for concurrency
21708           required: true
21709           type: string
21710   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints:
21711     get:
21712       tags:
21713         - ServiceDesignAndCreation
21714       summary: returns property-constraints
21715       description: returns property-constraints
21716       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraints
21717       produces:
21718         - application/json
21719         - application/xml
21720       responses:
21721         "200":
21722           description: successful operation
21723           schema:
21724               $ref: "#/getDefinitions/property-constraints"
21725         "default":
21726           description: Response codes found in [response codes](https://wiki.onap.org/).
21727       parameters:
21728         - name: named-query-uuid
21729           in: path
21730           required: true
21731           type: string
21732           example: __NAMED-QUERY-UUID__
21733         - name: named-query-element-uuid
21734           in: path
21735           required: true
21736           type: string
21737           example: __NAMED-QUERY-ELEMENT-UUID__
21738         - name: named-query-name
21739           in: query
21740           required: false
21741           type: string
21742   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship:
21743     put:
21744       tags:
21745         - ServiceDesignAndCreation
21746       summary: see node definition for valid relationships
21747       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
21748       consumes:
21749         - application/json
21750         - application/xml
21751       produces:
21752         - application/json
21753         - application/xml
21754       responses:
21755         "default":
21756           description: Response codes found in [response codes](https://wiki.onap.org/).
21757       parameters:
21758         - name: named-query-uuid
21759           in: path
21760           required: true
21761           type: string
21762           example: __NAMED-QUERY-UUID__
21763         - name: named-query-element-uuid
21764           in: path
21765           required: true
21766           type: string
21767           example: __NAMED-QUERY-ELEMENT-UUID__
21768         - name: body
21769           in: body
21770           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
21771           required: true
21772           schema:
21773             $ref: "#/definitions/relationship"
21774     delete:
21775       tags:
21776         - ServiceDesignAndCreation
21777       summary: delete an existing relationship
21778       description: delete an existing relationship
21779       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelationshipListRelationship
21780       consumes:
21781         - application/json
21782         - application/xml
21783       produces:
21784         - application/json
21785         - application/xml
21786       responses:
21787         "default":
21788           description: Response codes found in [response codes](https://wiki.onap.org/).
21789       parameters:
21790         - name: named-query-uuid
21791           in: path
21792           required: true
21793           type: string
21794           example: __NAMED-QUERY-UUID__
21795         - name: named-query-element-uuid
21796           in: path
21797           required: true
21798           type: string
21799           example: __NAMED-QUERY-ELEMENT-UUID__
21800   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}:
21801     get:
21802       tags:
21803         - ServiceDesignAndCreation
21804       summary: returns named-query-element
21805       description: returns named-query-element
21806       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21807       produces:
21808         - application/json
21809         - application/xml
21810       responses:
21811         "200":
21812           description: successful operation
21813           schema:
21814               $ref: "#/getDefinitions/named-query-element"
21815         "default":
21816           description: Response codes found in [response codes](https://wiki.onap.org/).
21817       parameters:
21818         - name: named-query-uuid
21819           in: path
21820           required: true
21821           type: string
21822           example: __NAMED-QUERY-UUID__
21823         - name: named-query-element-uuid
21824           in: path
21825           required: true
21826           type: string
21827           example: __NAMED-QUERY-ELEMENT-UUID__
21828         - name: named-query-name
21829           in: query
21830           required: false
21831           type: string
21832     put:
21833       tags:
21834         - ServiceDesignAndCreation
21835       summary: create or update an existing named-query-element
21836       description: |
21837         Create or update an existing named-query-element.
21838         #
21839         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
21840       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21841       consumes:
21842         - application/json
21843         - application/xml
21844       produces:
21845         - application/json
21846         - application/xml
21847       responses:
21848         "default":
21849           description: Response codes found in [response codes](https://wiki.onap.org/).
21850       parameters:
21851         - name: named-query-uuid
21852           in: path
21853           required: true
21854           type: string
21855           example: __NAMED-QUERY-UUID__
21856         - name: named-query-element-uuid
21857           in: path
21858           required: true
21859           type: string
21860           example: __NAMED-QUERY-ELEMENT-UUID__
21861         - name: body
21862           in: body
21863           description: named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)
21864           required: true
21865           schema:
21866             $ref: "#/definitions/named-query-element"
21867     patch:
21868       tags:
21869         - ServiceDesignAndCreation
21870       summary: update an existing named-query-element
21871       description: |
21872         Update an existing named-query-element
21873         #
21874         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
21875         The PUT operation will entirely replace an existing object.
21876         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
21877         #
21878         Other differences between PUT and PATCH are:
21879         #
21880         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
21881         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
21882         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
21883       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21884       consumes:
21885         - application/json
21886         - application/xml
21887       produces:
21888         - application/json
21889         - application/xml
21890       responses:
21891         "default":
21892           description: Response codes found in [response codes](https://wiki.onap.org/).
21893       parameters:
21894         - name: named-query-uuid
21895           in: path
21896           required: true
21897           type: string
21898           example: __NAMED-QUERY-UUID__
21899         - name: named-query-element-uuid
21900           in: path
21901           required: true
21902           type: string
21903           example: __NAMED-QUERY-ELEMENT-UUID__
21904         - name: body
21905           in: body
21906           description: named-query-element object that needs to be created or updated.
21907           required: true
21908           schema:
21909             $ref: "#/patchDefinitions/named-query-element"
21910     delete:
21911       tags:
21912         - ServiceDesignAndCreation
21913       summary: delete an existing named-query-element
21914       description: delete an existing named-query-element
21915       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement
21916       consumes:
21917         - application/json
21918         - application/xml
21919       produces:
21920         - application/json
21921         - application/xml
21922       responses:
21923         "default":
21924           description: Response codes found in [response codes](https://wiki.onap.org/).
21925       parameters:
21926         - name: named-query-uuid
21927           in: path
21928           required: true
21929           type: string
21930           example: __NAMED-QUERY-UUID__
21931         - name: named-query-element-uuid
21932           in: path
21933           required: true
21934           type: string
21935           example: __NAMED-QUERY-ELEMENT-UUID__
21936         - name: resource-version
21937           in: query
21938           description: resource-version for concurrency
21939           required: true
21940           type: string
21941   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements:
21942     get:
21943       tags:
21944         - ServiceDesignAndCreation
21945       summary: returns named-query-elements
21946       description: returns named-query-elements
21947       operationId: getServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElements
21948       produces:
21949         - application/json
21950         - application/xml
21951       responses:
21952         "200":
21953           description: successful operation
21954           schema:
21955               $ref: "#/getDefinitions/named-query-elements"
21956         "default":
21957           description: Response codes found in [response codes](https://wiki.onap.org/).
21958       parameters:
21959         - name: named-query-uuid
21960           in: path
21961           required: true
21962           type: string
21963           example: __NAMED-QUERY-UUID__
21964         - name: named-query-name
21965           in: query
21966           required: false
21967           type: string
21968   /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship:
21969     put:
21970       tags:
21971         - ServiceDesignAndCreation
21972       summary: see node definition for valid relationships
21973       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
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: named-query-uuid
21985           in: path
21986           required: true
21987           type: string
21988           example: __NAMED-QUERY-UUID__
21989         - name: body
21990           in: body
21991           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
21992           required: true
21993           schema:
21994             $ref: "#/definitions/relationship"
21995     delete:
21996       tags:
21997         - ServiceDesignAndCreation
21998       summary: delete an existing relationship
21999       description: delete an existing relationship
22000       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQueryRelationshipListRelationship
22001       consumes:
22002         - application/json
22003         - application/xml
22004       produces:
22005         - application/json
22006         - application/xml
22007       responses:
22008         "default":
22009           description: Response codes found in [response codes](https://wiki.onap.org/).
22010       parameters:
22011         - name: named-query-uuid
22012           in: path
22013           required: true
22014           type: string
22015           example: __NAMED-QUERY-UUID__
22016   /service-design-and-creation/named-queries/named-query/{named-query-uuid}:
22017     get:
22018       tags:
22019         - ServiceDesignAndCreation
22020       summary: returns named-query
22021       description: returns named-query
22022       operationId: getServiceDesignAndCreationNamedQueriesNamedQuery
22023       produces:
22024         - application/json
22025         - application/xml
22026       responses:
22027         "200":
22028           description: successful operation
22029           schema:
22030               $ref: "#/getDefinitions/named-query"
22031         "default":
22032           description: Response codes found in [response codes](https://wiki.onap.org/).
22033       parameters:
22034         - name: named-query-uuid
22035           in: path
22036           required: true
22037           type: string
22038           example: __NAMED-QUERY-UUID__
22039         - name: named-query-name
22040           in: query
22041           required: false
22042           type: string
22043     put:
22044       tags:
22045         - ServiceDesignAndCreation
22046       summary: create or update an existing named-query
22047       description: |
22048         Create or update an existing named-query.
22049         #
22050         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22051       operationId: createOrUpdateServiceDesignAndCreationNamedQueriesNamedQuery
22052       consumes:
22053         - application/json
22054         - application/xml
22055       produces:
22056         - application/json
22057         - application/xml
22058       responses:
22059         "default":
22060           description: Response codes found in [response codes](https://wiki.onap.org/).
22061       parameters:
22062         - name: named-query-uuid
22063           in: path
22064           required: true
22065           type: string
22066           example: __NAMED-QUERY-UUID__
22067         - name: body
22068           in: body
22069           description: named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)
22070           required: true
22071           schema:
22072             $ref: "#/definitions/named-query"
22073     patch:
22074       tags:
22075         - ServiceDesignAndCreation
22076       summary: update an existing named-query
22077       description: |
22078         Update an existing named-query
22079         #
22080         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22081         The PUT operation will entirely replace an existing object.
22082         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22083         #
22084         Other differences between PUT and PATCH are:
22085         #
22086         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22087         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22088         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22089       operationId: UpdateServiceDesignAndCreationNamedQueriesNamedQuery
22090       consumes:
22091         - application/json
22092         - application/xml
22093       produces:
22094         - application/json
22095         - application/xml
22096       responses:
22097         "default":
22098           description: Response codes found in [response codes](https://wiki.onap.org/).
22099       parameters:
22100         - name: named-query-uuid
22101           in: path
22102           required: true
22103           type: string
22104           example: __NAMED-QUERY-UUID__
22105         - name: body
22106           in: body
22107           description: named-query object that needs to be created or updated.
22108           required: true
22109           schema:
22110             $ref: "#/patchDefinitions/named-query"
22111     delete:
22112       tags:
22113         - ServiceDesignAndCreation
22114       summary: delete an existing named-query
22115       description: delete an existing named-query
22116       operationId: deleteServiceDesignAndCreationNamedQueriesNamedQuery
22117       consumes:
22118         - application/json
22119         - application/xml
22120       produces:
22121         - application/json
22122         - application/xml
22123       responses:
22124         "default":
22125           description: Response codes found in [response codes](https://wiki.onap.org/).
22126       parameters:
22127         - name: named-query-uuid
22128           in: path
22129           required: true
22130           type: string
22131           example: __NAMED-QUERY-UUID__
22132         - name: resource-version
22133           in: query
22134           description: resource-version for concurrency
22135           required: true
22136           type: string
22137   /service-design-and-creation/named-queries:
22138     get:
22139       tags:
22140         - ServiceDesignAndCreation
22141       summary: returns named-queries
22142       description: returns named-queries
22143       operationId: getServiceDesignAndCreationNamedQueries
22144       produces:
22145         - application/json
22146         - application/xml
22147       responses:
22148         "200":
22149           description: successful operation
22150           schema:
22151               $ref: "#/getDefinitions/named-queries"
22152         "default":
22153           description: Response codes found in [response codes](https://wiki.onap.org/).
22154   /network/logical-links/logical-link/{link-name}/relationship-list/relationship:
22155     put:
22156       tags:
22157         - Network
22158       summary: see node definition for valid relationships
22159       operationId: createOrUpdateNetworkLogicalLinksLogicalLinkRelationshipListRelationship
22160       consumes:
22161         - application/json
22162         - application/xml
22163       produces:
22164         - application/json
22165         - application/xml
22166       responses:
22167         "default":
22168           description: Response codes found in [response codes](https://wiki.onap.org/).
22169       parameters:
22170         - name: link-name
22171           in: path
22172           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22173           required: true
22174           type: string
22175           example: __LINK-NAME__
22176         - name: body
22177           in: body
22178           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
22179           required: true
22180           schema:
22181             $ref: "#/definitions/relationship"
22182     delete:
22183       tags:
22184         - Network
22185       summary: delete an existing relationship
22186       description: delete an existing relationship
22187       operationId: deleteNetworkLogicalLinksLogicalLinkRelationshipListRelationship
22188       consumes:
22189         - application/json
22190         - application/xml
22191       produces:
22192         - application/json
22193         - application/xml
22194       responses:
22195         "default":
22196           description: Response codes found in [response codes](https://wiki.onap.org/).
22197       parameters:
22198         - name: link-name
22199           in: path
22200           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22201           required: true
22202           type: string
22203           example: __LINK-NAME__
22204   /network/logical-links/logical-link/{link-name}:
22205     get:
22206       tags:
22207         - Network
22208       summary: returns logical-link
22209       description: returns logical-link
22210       operationId: getNetworkLogicalLinksLogicalLink
22211       produces:
22212         - application/json
22213         - application/xml
22214       responses:
22215         "200":
22216           description: successful operation
22217           schema:
22218               $ref: "#/getDefinitions/logical-link"
22219         "default":
22220           description: Response codes found in [response codes](https://wiki.onap.org/).
22221       parameters:
22222         - name: link-name
22223           in: path
22224           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22225           required: true
22226           type: string
22227           example: __LINK-NAME__
22228         - name: model-invariant-id
22229           in: query
22230           description: the ASDC model id for this resource or service model.
22231           required: false
22232           type: string
22233         - name: model-version-id
22234           in: query
22235           description: the ASDC model version for this resource or service model.
22236           required: false
22237           type: string
22238         - name: widget-model-id
22239           in: query
22240           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
22241           required: false
22242           type: string
22243         - name: widget-model-version
22244           in: query
22245           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
22246           required: false
22247           type: string
22248         - name: prov-status
22249           in: query
22250           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
22251           required: false
22252           type: string
22253         - name: link-id
22254           in: query
22255           description: UUID of the logical-link, SDNC generates this.
22256           required: false
22257           type: string
22258         - name: circuit-id
22259           in: query
22260           description: Circuit id
22261           required: false
22262           type: string
22263         - name: purpose
22264           in: query
22265           description: Reason for this entity, role it is playing
22266           required: false
22267           type: string
22268     put:
22269       tags:
22270         - Network
22271       summary: create or update an existing logical-link
22272       description: |
22273         Create or update an existing logical-link.
22274         #
22275         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22276       operationId: createOrUpdateNetworkLogicalLinksLogicalLink
22277       consumes:
22278         - application/json
22279         - application/xml
22280       produces:
22281         - application/json
22282         - application/xml
22283       responses:
22284         "default":
22285           description: Response codes found in [response codes](https://wiki.onap.org/).
22286       parameters:
22287         - name: link-name
22288           in: path
22289           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22290           required: true
22291           type: string
22292           example: __LINK-NAME__
22293         - name: body
22294           in: body
22295           description: logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)
22296           required: true
22297           schema:
22298             $ref: "#/definitions/logical-link"
22299     patch:
22300       tags:
22301         - Network
22302       summary: update an existing logical-link
22303       description: |
22304         Update an existing logical-link
22305         #
22306         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22307         The PUT operation will entirely replace an existing object.
22308         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22309         #
22310         Other differences between PUT and PATCH are:
22311         #
22312         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22313         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22314         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22315       operationId: UpdateNetworkLogicalLinksLogicalLink
22316       consumes:
22317         - application/json
22318         - application/xml
22319       produces:
22320         - application/json
22321         - application/xml
22322       responses:
22323         "default":
22324           description: Response codes found in [response codes](https://wiki.onap.org/).
22325       parameters:
22326         - name: link-name
22327           in: path
22328           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22329           required: true
22330           type: string
22331           example: __LINK-NAME__
22332         - name: body
22333           in: body
22334           description: logical-link object that needs to be created or updated.
22335           required: true
22336           schema:
22337             $ref: "#/patchDefinitions/logical-link"
22338     delete:
22339       tags:
22340         - Network
22341       summary: delete an existing logical-link
22342       description: delete an existing logical-link
22343       operationId: deleteNetworkLogicalLinksLogicalLink
22344       consumes:
22345         - application/json
22346         - application/xml
22347       produces:
22348         - application/json
22349         - application/xml
22350       responses:
22351         "default":
22352           description: Response codes found in [response codes](https://wiki.onap.org/).
22353       parameters:
22354         - name: link-name
22355           in: path
22356           description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
22357           required: true
22358           type: string
22359           example: __LINK-NAME__
22360         - name: resource-version
22361           in: query
22362           description: resource-version for concurrency
22363           required: true
22364           type: string
22365   /network/logical-links:
22366     get:
22367       tags:
22368         - Network
22369       summary: returns logical-links
22370       description: returns logical-links
22371       operationId: getNetworkLogicalLinks
22372       produces:
22373         - application/json
22374         - application/xml
22375       responses:
22376         "200":
22377           description: successful operation
22378           schema:
22379               $ref: "#/getDefinitions/logical-links"
22380         "default":
22381           description: Response codes found in [response codes](https://wiki.onap.org/).
22382   /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:
22383     put:
22384       tags:
22385         - Network
22386       summary: see node definition for valid relationships
22387       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
22388       consumes:
22389         - application/json
22390         - application/xml
22391       produces:
22392         - application/json
22393         - application/xml
22394       responses:
22395         "default":
22396           description: Response codes found in [response codes](https://wiki.onap.org/).
22397       parameters:
22398         - name: site-pair-set-id
22399           in: path
22400           description: Unique id of site pair set.
22401           required: true
22402           type: string
22403           example: __SITE-PAIR-SET-ID__
22404         - name: routing-instance-id
22405           in: path
22406           description: Unique id of routing instance
22407           required: true
22408           type: string
22409           example: __ROUTING-INSTANCE-ID__
22410         - name: site-pair-id
22411           in: path
22412           description: unique identifier of probe
22413           required: true
22414           type: string
22415           example: __SITE-PAIR-ID__
22416         - name: cos
22417           in: path
22418           description: unique identifier of probe
22419           required: true
22420           type: string
22421           example: __COS__
22422         - name: body
22423           in: body
22424           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
22425           required: true
22426           schema:
22427             $ref: "#/definitions/relationship"
22428     delete:
22429       tags:
22430         - Network
22431       summary: delete an existing relationship
22432       description: delete an existing relationship
22433       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfServiceRelationshipListRelationship
22434       consumes:
22435         - application/json
22436         - application/xml
22437       produces:
22438         - application/json
22439         - application/xml
22440       responses:
22441         "default":
22442           description: Response codes found in [response codes](https://wiki.onap.org/).
22443       parameters:
22444         - name: site-pair-set-id
22445           in: path
22446           description: Unique id of site pair set.
22447           required: true
22448           type: string
22449           example: __SITE-PAIR-SET-ID__
22450         - name: routing-instance-id
22451           in: path
22452           description: Unique id of routing instance
22453           required: true
22454           type: string
22455           example: __ROUTING-INSTANCE-ID__
22456         - name: site-pair-id
22457           in: path
22458           description: unique identifier of probe
22459           required: true
22460           type: string
22461           example: __SITE-PAIR-ID__
22462         - name: cos
22463           in: path
22464           description: unique identifier of probe
22465           required: true
22466           type: string
22467           example: __COS__
22468   /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}:
22469     get:
22470       tags:
22471         - Network
22472       summary: returns class-of-service
22473       description: returns class-of-service
22474       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22475       produces:
22476         - application/json
22477         - application/xml
22478       responses:
22479         "200":
22480           description: successful operation
22481           schema:
22482               $ref: "#/getDefinitions/class-of-service"
22483         "default":
22484           description: Response codes found in [response codes](https://wiki.onap.org/).
22485       parameters:
22486         - name: site-pair-set-id
22487           in: path
22488           description: Unique id of site pair set.
22489           required: true
22490           type: string
22491           example: __SITE-PAIR-SET-ID__
22492         - name: routing-instance-id
22493           in: path
22494           description: Unique id of routing instance
22495           required: true
22496           type: string
22497           example: __ROUTING-INSTANCE-ID__
22498         - name: site-pair-id
22499           in: path
22500           description: unique identifier of probe
22501           required: true
22502           type: string
22503           example: __SITE-PAIR-ID__
22504         - name: cos
22505           in: path
22506           description: unique identifier of probe
22507           required: true
22508           type: string
22509           example: __COS__
22510     put:
22511       tags:
22512         - Network
22513       summary: create or update an existing class-of-service
22514       description: |
22515         Create or update an existing class-of-service.
22516         #
22517         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22518       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22519       consumes:
22520         - application/json
22521         - application/xml
22522       produces:
22523         - application/json
22524         - application/xml
22525       responses:
22526         "default":
22527           description: Response codes found in [response codes](https://wiki.onap.org/).
22528       parameters:
22529         - name: site-pair-set-id
22530           in: path
22531           description: Unique id of site pair set.
22532           required: true
22533           type: string
22534           example: __SITE-PAIR-SET-ID__
22535         - name: routing-instance-id
22536           in: path
22537           description: Unique id of routing instance
22538           required: true
22539           type: string
22540           example: __ROUTING-INSTANCE-ID__
22541         - name: site-pair-id
22542           in: path
22543           description: unique identifier of probe
22544           required: true
22545           type: string
22546           example: __SITE-PAIR-ID__
22547         - name: cos
22548           in: path
22549           description: unique identifier of probe
22550           required: true
22551           type: string
22552           example: __COS__
22553         - name: body
22554           in: body
22555           description: class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)
22556           required: true
22557           schema:
22558             $ref: "#/definitions/class-of-service"
22559     patch:
22560       tags:
22561         - Network
22562       summary: update an existing class-of-service
22563       description: |
22564         Update an existing class-of-service
22565         #
22566         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22567         The PUT operation will entirely replace an existing object.
22568         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22569         #
22570         Other differences between PUT and PATCH are:
22571         #
22572         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22573         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22574         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22575       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22576       consumes:
22577         - application/json
22578         - application/xml
22579       produces:
22580         - application/json
22581         - application/xml
22582       responses:
22583         "default":
22584           description: Response codes found in [response codes](https://wiki.onap.org/).
22585       parameters:
22586         - name: site-pair-set-id
22587           in: path
22588           description: Unique id of site pair set.
22589           required: true
22590           type: string
22591           example: __SITE-PAIR-SET-ID__
22592         - name: routing-instance-id
22593           in: path
22594           description: Unique id of routing instance
22595           required: true
22596           type: string
22597           example: __ROUTING-INSTANCE-ID__
22598         - name: site-pair-id
22599           in: path
22600           description: unique identifier of probe
22601           required: true
22602           type: string
22603           example: __SITE-PAIR-ID__
22604         - name: cos
22605           in: path
22606           description: unique identifier of probe
22607           required: true
22608           type: string
22609           example: __COS__
22610         - name: body
22611           in: body
22612           description: class-of-service object that needs to be created or updated.
22613           required: true
22614           schema:
22615             $ref: "#/patchDefinitions/class-of-service"
22616     delete:
22617       tags:
22618         - Network
22619       summary: delete an existing class-of-service
22620       description: delete an existing class-of-service
22621       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService
22622       consumes:
22623         - application/json
22624         - application/xml
22625       produces:
22626         - application/json
22627         - application/xml
22628       responses:
22629         "default":
22630           description: Response codes found in [response codes](https://wiki.onap.org/).
22631       parameters:
22632         - name: site-pair-set-id
22633           in: path
22634           description: Unique id of site pair set.
22635           required: true
22636           type: string
22637           example: __SITE-PAIR-SET-ID__
22638         - name: routing-instance-id
22639           in: path
22640           description: Unique id of routing instance
22641           required: true
22642           type: string
22643           example: __ROUTING-INSTANCE-ID__
22644         - name: site-pair-id
22645           in: path
22646           description: unique identifier of probe
22647           required: true
22648           type: string
22649           example: __SITE-PAIR-ID__
22650         - name: cos
22651           in: path
22652           description: unique identifier of probe
22653           required: true
22654           type: string
22655           example: __COS__
22656         - name: resource-version
22657           in: query
22658           description: resource-version for concurrency
22659           required: true
22660           type: string
22661   /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:
22662     get:
22663       tags:
22664         - Network
22665       summary: returns classes-of-service
22666       description: returns classes-of-service
22667       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfService
22668       produces:
22669         - application/json
22670         - application/xml
22671       responses:
22672         "200":
22673           description: successful operation
22674           schema:
22675               $ref: "#/getDefinitions/classes-of-service"
22676         "default":
22677           description: Response codes found in [response codes](https://wiki.onap.org/).
22678       parameters:
22679         - name: site-pair-set-id
22680           in: path
22681           description: Unique id of site pair set.
22682           required: true
22683           type: string
22684           example: __SITE-PAIR-SET-ID__
22685         - name: routing-instance-id
22686           in: path
22687           description: Unique id of routing instance
22688           required: true
22689           type: string
22690           example: __ROUTING-INSTANCE-ID__
22691         - name: site-pair-id
22692           in: path
22693           description: unique identifier of probe
22694           required: true
22695           type: string
22696           example: __SITE-PAIR-ID__
22697   /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:
22698     put:
22699       tags:
22700         - Network
22701       summary: see node definition for valid relationships
22702       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
22703       consumes:
22704         - application/json
22705         - application/xml
22706       produces:
22707         - application/json
22708         - application/xml
22709       responses:
22710         "default":
22711           description: Response codes found in [response codes](https://wiki.onap.org/).
22712       parameters:
22713         - name: site-pair-set-id
22714           in: path
22715           description: Unique id of site pair set.
22716           required: true
22717           type: string
22718           example: __SITE-PAIR-SET-ID__
22719         - name: routing-instance-id
22720           in: path
22721           description: Unique id of routing instance
22722           required: true
22723           type: string
22724           example: __ROUTING-INSTANCE-ID__
22725         - name: site-pair-id
22726           in: path
22727           description: unique identifier of probe
22728           required: true
22729           type: string
22730           example: __SITE-PAIR-ID__
22731         - name: body
22732           in: body
22733           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
22734           required: true
22735           schema:
22736             $ref: "#/definitions/relationship"
22737     delete:
22738       tags:
22739         - Network
22740       summary: delete an existing relationship
22741       description: delete an existing relationship
22742       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairRelationshipListRelationship
22743       consumes:
22744         - application/json
22745         - application/xml
22746       produces:
22747         - application/json
22748         - application/xml
22749       responses:
22750         "default":
22751           description: Response codes found in [response codes](https://wiki.onap.org/).
22752       parameters:
22753         - name: site-pair-set-id
22754           in: path
22755           description: Unique id of site pair set.
22756           required: true
22757           type: string
22758           example: __SITE-PAIR-SET-ID__
22759         - name: routing-instance-id
22760           in: path
22761           description: Unique id of routing instance
22762           required: true
22763           type: string
22764           example: __ROUTING-INSTANCE-ID__
22765         - name: site-pair-id
22766           in: path
22767           description: unique identifier of probe
22768           required: true
22769           type: string
22770           example: __SITE-PAIR-ID__
22771   /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}:
22772     get:
22773       tags:
22774         - Network
22775       summary: returns site-pair
22776       description: returns site-pair
22777       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22778       produces:
22779         - application/json
22780         - application/xml
22781       responses:
22782         "200":
22783           description: successful operation
22784           schema:
22785               $ref: "#/getDefinitions/site-pair"
22786         "default":
22787           description: Response codes found in [response codes](https://wiki.onap.org/).
22788       parameters:
22789         - name: site-pair-set-id
22790           in: path
22791           description: Unique id of site pair set.
22792           required: true
22793           type: string
22794           example: __SITE-PAIR-SET-ID__
22795         - name: routing-instance-id
22796           in: path
22797           description: Unique id of routing instance
22798           required: true
22799           type: string
22800           example: __ROUTING-INSTANCE-ID__
22801         - name: site-pair-id
22802           in: path
22803           description: unique identifier of probe
22804           required: true
22805           type: string
22806           example: __SITE-PAIR-ID__
22807     put:
22808       tags:
22809         - Network
22810       summary: create or update an existing site-pair
22811       description: |
22812         Create or update an existing site-pair.
22813         #
22814         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
22815       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22816       consumes:
22817         - application/json
22818         - application/xml
22819       produces:
22820         - application/json
22821         - application/xml
22822       responses:
22823         "default":
22824           description: Response codes found in [response codes](https://wiki.onap.org/).
22825       parameters:
22826         - name: site-pair-set-id
22827           in: path
22828           description: Unique id of site pair set.
22829           required: true
22830           type: string
22831           example: __SITE-PAIR-SET-ID__
22832         - name: routing-instance-id
22833           in: path
22834           description: Unique id of routing instance
22835           required: true
22836           type: string
22837           example: __ROUTING-INSTANCE-ID__
22838         - name: site-pair-id
22839           in: path
22840           description: unique identifier of probe
22841           required: true
22842           type: string
22843           example: __SITE-PAIR-ID__
22844         - name: body
22845           in: body
22846           description: site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)
22847           required: true
22848           schema:
22849             $ref: "#/definitions/site-pair"
22850     patch:
22851       tags:
22852         - Network
22853       summary: update an existing site-pair
22854       description: |
22855         Update an existing site-pair
22856         #
22857         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
22858         The PUT operation will entirely replace an existing object.
22859         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
22860         #
22861         Other differences between PUT and PATCH are:
22862         #
22863         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
22864         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
22865         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
22866       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22867       consumes:
22868         - application/json
22869         - application/xml
22870       produces:
22871         - application/json
22872         - application/xml
22873       responses:
22874         "default":
22875           description: Response codes found in [response codes](https://wiki.onap.org/).
22876       parameters:
22877         - name: site-pair-set-id
22878           in: path
22879           description: Unique id of site pair set.
22880           required: true
22881           type: string
22882           example: __SITE-PAIR-SET-ID__
22883         - name: routing-instance-id
22884           in: path
22885           description: Unique id of routing instance
22886           required: true
22887           type: string
22888           example: __ROUTING-INSTANCE-ID__
22889         - name: site-pair-id
22890           in: path
22891           description: unique identifier of probe
22892           required: true
22893           type: string
22894           example: __SITE-PAIR-ID__
22895         - name: body
22896           in: body
22897           description: site-pair object that needs to be created or updated.
22898           required: true
22899           schema:
22900             $ref: "#/patchDefinitions/site-pair"
22901     delete:
22902       tags:
22903         - Network
22904       summary: delete an existing site-pair
22905       description: delete an existing site-pair
22906       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair
22907       consumes:
22908         - application/json
22909         - application/xml
22910       produces:
22911         - application/json
22912         - application/xml
22913       responses:
22914         "default":
22915           description: Response codes found in [response codes](https://wiki.onap.org/).
22916       parameters:
22917         - name: site-pair-set-id
22918           in: path
22919           description: Unique id of site pair set.
22920           required: true
22921           type: string
22922           example: __SITE-PAIR-SET-ID__
22923         - name: routing-instance-id
22924           in: path
22925           description: Unique id of routing instance
22926           required: true
22927           type: string
22928           example: __ROUTING-INSTANCE-ID__
22929         - name: site-pair-id
22930           in: path
22931           description: unique identifier of probe
22932           required: true
22933           type: string
22934           example: __SITE-PAIR-ID__
22935         - name: resource-version
22936           in: query
22937           description: resource-version for concurrency
22938           required: true
22939           type: string
22940   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs:
22941     get:
22942       tags:
22943         - Network
22944       summary: returns site-pairs
22945       description: returns site-pairs
22946       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairs
22947       produces:
22948         - application/json
22949         - application/xml
22950       responses:
22951         "200":
22952           description: successful operation
22953           schema:
22954               $ref: "#/getDefinitions/site-pairs"
22955         "default":
22956           description: Response codes found in [response codes](https://wiki.onap.org/).
22957       parameters:
22958         - name: site-pair-set-id
22959           in: path
22960           description: Unique id of site pair set.
22961           required: true
22962           type: string
22963           example: __SITE-PAIR-SET-ID__
22964         - name: routing-instance-id
22965           in: path
22966           description: Unique id of routing instance
22967           required: true
22968           type: string
22969           example: __ROUTING-INSTANCE-ID__
22970   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship:
22971     put:
22972       tags:
22973         - Network
22974       summary: see node definition for valid relationships
22975       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
22976       consumes:
22977         - application/json
22978         - application/xml
22979       produces:
22980         - application/json
22981         - application/xml
22982       responses:
22983         "default":
22984           description: Response codes found in [response codes](https://wiki.onap.org/).
22985       parameters:
22986         - name: site-pair-set-id
22987           in: path
22988           description: Unique id of site pair set.
22989           required: true
22990           type: string
22991           example: __SITE-PAIR-SET-ID__
22992         - name: routing-instance-id
22993           in: path
22994           description: Unique id of routing instance
22995           required: true
22996           type: string
22997           example: __ROUTING-INSTANCE-ID__
22998         - name: body
22999           in: body
23000           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23001           required: true
23002           schema:
23003             $ref: "#/definitions/relationship"
23004     delete:
23005       tags:
23006         - Network
23007       summary: delete an existing relationship
23008       description: delete an existing relationship
23009       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceRelationshipListRelationship
23010       consumes:
23011         - application/json
23012         - application/xml
23013       produces:
23014         - application/json
23015         - application/xml
23016       responses:
23017         "default":
23018           description: Response codes found in [response codes](https://wiki.onap.org/).
23019       parameters:
23020         - name: site-pair-set-id
23021           in: path
23022           description: Unique id of site pair set.
23023           required: true
23024           type: string
23025           example: __SITE-PAIR-SET-ID__
23026         - name: routing-instance-id
23027           in: path
23028           description: Unique id of routing instance
23029           required: true
23030           type: string
23031           example: __ROUTING-INSTANCE-ID__
23032   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}:
23033     get:
23034       tags:
23035         - Network
23036       summary: returns routing-instance
23037       description: returns routing-instance
23038       operationId: getNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23039       produces:
23040         - application/json
23041         - application/xml
23042       responses:
23043         "200":
23044           description: successful operation
23045           schema:
23046               $ref: "#/getDefinitions/routing-instance"
23047         "default":
23048           description: Response codes found in [response codes](https://wiki.onap.org/).
23049       parameters:
23050         - name: site-pair-set-id
23051           in: path
23052           description: Unique id of site pair set.
23053           required: true
23054           type: string
23055           example: __SITE-PAIR-SET-ID__
23056         - name: routing-instance-id
23057           in: path
23058           description: Unique id of routing instance
23059           required: true
23060           type: string
23061           example: __ROUTING-INSTANCE-ID__
23062     put:
23063       tags:
23064         - Network
23065       summary: create or update an existing routing-instance
23066       description: |
23067         Create or update an existing routing-instance.
23068         #
23069         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23070       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23071       consumes:
23072         - application/json
23073         - application/xml
23074       produces:
23075         - application/json
23076         - application/xml
23077       responses:
23078         "default":
23079           description: Response codes found in [response codes](https://wiki.onap.org/).
23080       parameters:
23081         - name: site-pair-set-id
23082           in: path
23083           description: Unique id of site pair set.
23084           required: true
23085           type: string
23086           example: __SITE-PAIR-SET-ID__
23087         - name: routing-instance-id
23088           in: path
23089           description: Unique id of routing instance
23090           required: true
23091           type: string
23092           example: __ROUTING-INSTANCE-ID__
23093         - name: body
23094           in: body
23095           description: routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)
23096           required: true
23097           schema:
23098             $ref: "#/definitions/routing-instance"
23099     patch:
23100       tags:
23101         - Network
23102       summary: update an existing routing-instance
23103       description: |
23104         Update an existing routing-instance
23105         #
23106         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23107         The PUT operation will entirely replace an existing object.
23108         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23109         #
23110         Other differences between PUT and PATCH are:
23111         #
23112         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23113         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23114         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23115       operationId: UpdateNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23116       consumes:
23117         - application/json
23118         - application/xml
23119       produces:
23120         - application/json
23121         - application/xml
23122       responses:
23123         "default":
23124           description: Response codes found in [response codes](https://wiki.onap.org/).
23125       parameters:
23126         - name: site-pair-set-id
23127           in: path
23128           description: Unique id of site pair set.
23129           required: true
23130           type: string
23131           example: __SITE-PAIR-SET-ID__
23132         - name: routing-instance-id
23133           in: path
23134           description: Unique id of routing instance
23135           required: true
23136           type: string
23137           example: __ROUTING-INSTANCE-ID__
23138         - name: body
23139           in: body
23140           description: routing-instance object that needs to be created or updated.
23141           required: true
23142           schema:
23143             $ref: "#/patchDefinitions/routing-instance"
23144     delete:
23145       tags:
23146         - Network
23147       summary: delete an existing routing-instance
23148       description: delete an existing routing-instance
23149       operationId: deleteNetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance
23150       consumes:
23151         - application/json
23152         - application/xml
23153       produces:
23154         - application/json
23155         - application/xml
23156       responses:
23157         "default":
23158           description: Response codes found in [response codes](https://wiki.onap.org/).
23159       parameters:
23160         - name: site-pair-set-id
23161           in: path
23162           description: Unique id of site pair set.
23163           required: true
23164           type: string
23165           example: __SITE-PAIR-SET-ID__
23166         - name: routing-instance-id
23167           in: path
23168           description: Unique id of routing instance
23169           required: true
23170           type: string
23171           example: __ROUTING-INSTANCE-ID__
23172         - name: resource-version
23173           in: query
23174           description: resource-version for concurrency
23175           required: true
23176           type: string
23177   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances:
23178     get:
23179       tags:
23180         - Network
23181       summary: returns routing-instances
23182       description: returns routing-instances
23183       operationId: getNetworkSitePairSetsSitePairSetRoutingInstances
23184       produces:
23185         - application/json
23186         - application/xml
23187       responses:
23188         "200":
23189           description: successful operation
23190           schema:
23191               $ref: "#/getDefinitions/routing-instances"
23192         "default":
23193           description: Response codes found in [response codes](https://wiki.onap.org/).
23194       parameters:
23195         - name: site-pair-set-id
23196           in: path
23197           description: Unique id of site pair set.
23198           required: true
23199           type: string
23200           example: __SITE-PAIR-SET-ID__
23201   /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship:
23202     put:
23203       tags:
23204         - Network
23205       summary: see node definition for valid relationships
23206       operationId: createOrUpdateNetworkSitePairSetsSitePairSetRelationshipListRelationship
23207       consumes:
23208         - application/json
23209         - application/xml
23210       produces:
23211         - application/json
23212         - application/xml
23213       responses:
23214         "default":
23215           description: Response codes found in [response codes](https://wiki.onap.org/).
23216       parameters:
23217         - name: site-pair-set-id
23218           in: path
23219           description: Unique id of site pair set.
23220           required: true
23221           type: string
23222           example: __SITE-PAIR-SET-ID__
23223         - name: body
23224           in: body
23225           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
23226           required: true
23227           schema:
23228             $ref: "#/definitions/relationship"
23229     delete:
23230       tags:
23231         - Network
23232       summary: delete an existing relationship
23233       description: delete an existing relationship
23234       operationId: deleteNetworkSitePairSetsSitePairSetRelationshipListRelationship
23235       consumes:
23236         - application/json
23237         - application/xml
23238       produces:
23239         - application/json
23240         - application/xml
23241       responses:
23242         "default":
23243           description: Response codes found in [response codes](https://wiki.onap.org/).
23244       parameters:
23245         - name: site-pair-set-id
23246           in: path
23247           description: Unique id of site pair set.
23248           required: true
23249           type: string
23250           example: __SITE-PAIR-SET-ID__
23251   /network/site-pair-sets/site-pair-set/{site-pair-set-id}:
23252     get:
23253       tags:
23254         - Network
23255       summary: returns site-pair-set
23256       description: returns site-pair-set
23257       operationId: getNetworkSitePairSetsSitePairSet
23258       produces:
23259         - application/json
23260         - application/xml
23261       responses:
23262         "200":
23263           description: successful operation
23264           schema:
23265               $ref: "#/getDefinitions/site-pair-set"
23266         "default":
23267           description: Response codes found in [response codes](https://wiki.onap.org/).
23268       parameters:
23269         - name: site-pair-set-id
23270           in: path
23271           description: Unique id of site pair set.
23272           required: true
23273           type: string
23274           example: __SITE-PAIR-SET-ID__
23275     put:
23276       tags:
23277         - Network
23278       summary: create or update an existing site-pair-set
23279       description: |
23280         Create or update an existing site-pair-set.
23281         #
23282         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23283       operationId: createOrUpdateNetworkSitePairSetsSitePairSet
23284       consumes:
23285         - application/json
23286         - application/xml
23287       produces:
23288         - application/json
23289         - application/xml
23290       responses:
23291         "default":
23292           description: Response codes found in [response codes](https://wiki.onap.org/).
23293       parameters:
23294         - name: site-pair-set-id
23295           in: path
23296           description: Unique id of site pair set.
23297           required: true
23298           type: string
23299           example: __SITE-PAIR-SET-ID__
23300         - name: body
23301           in: body
23302           description: site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)
23303           required: true
23304           schema:
23305             $ref: "#/definitions/site-pair-set"
23306     patch:
23307       tags:
23308         - Network
23309       summary: update an existing site-pair-set
23310       description: |
23311         Update an existing site-pair-set
23312         #
23313         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23314         The PUT operation will entirely replace an existing object.
23315         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23316         #
23317         Other differences between PUT and PATCH are:
23318         #
23319         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23320         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23321         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23322       operationId: UpdateNetworkSitePairSetsSitePairSet
23323       consumes:
23324         - application/json
23325         - application/xml
23326       produces:
23327         - application/json
23328         - application/xml
23329       responses:
23330         "default":
23331           description: Response codes found in [response codes](https://wiki.onap.org/).
23332       parameters:
23333         - name: site-pair-set-id
23334           in: path
23335           description: Unique id of site pair set.
23336           required: true
23337           type: string
23338           example: __SITE-PAIR-SET-ID__
23339         - name: body
23340           in: body
23341           description: site-pair-set object that needs to be created or updated.
23342           required: true
23343           schema:
23344             $ref: "#/patchDefinitions/site-pair-set"
23345     delete:
23346       tags:
23347         - Network
23348       summary: delete an existing site-pair-set
23349       description: delete an existing site-pair-set
23350       operationId: deleteNetworkSitePairSetsSitePairSet
23351       consumes:
23352         - application/json
23353         - application/xml
23354       produces:
23355         - application/json
23356         - application/xml
23357       responses:
23358         "default":
23359           description: Response codes found in [response codes](https://wiki.onap.org/).
23360       parameters:
23361         - name: site-pair-set-id
23362           in: path
23363           description: Unique id of site pair set.
23364           required: true
23365           type: string
23366           example: __SITE-PAIR-SET-ID__
23367         - name: resource-version
23368           in: query
23369           description: resource-version for concurrency
23370           required: true
23371           type: string
23372   /network/site-pair-sets:
23373     get:
23374       tags:
23375         - Network
23376       summary: returns site-pair-sets
23377       description: returns site-pair-sets
23378       operationId: getNetworkSitePairSets
23379       produces:
23380         - application/json
23381         - application/xml
23382       responses:
23383         "200":
23384           description: successful operation
23385           schema:
23386               $ref: "#/getDefinitions/site-pair-sets"
23387         "default":
23388           description: Response codes found in [response codes](https://wiki.onap.org/).
23389   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship:
23390     put:
23391       tags:
23392         - Network
23393       summary: see node definition for valid relationships
23394       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
23395       consumes:
23396         - application/json
23397         - application/xml
23398       produces:
23399         - application/json
23400         - application/xml
23401       responses:
23402         "default":
23403           description: Response codes found in [response codes](https://wiki.onap.org/).
23404       parameters:
23405         - name: vpn-id
23406           in: path
23407           description: VPN ID, globally unique within A&AI
23408           required: true
23409           type: string
23410           example: __VPN-ID__
23411         - name: global-route-target
23412           in: path
23413           description: Number used to identify an RT, globally unique in the network
23414           required: true
23415           type: string
23416           example: __GLOBAL-ROUTE-TARGET__
23417         - name: route-target-role
23418           in: path
23419           description: Role assigned to this route target
23420           required: true
23421           type: string
23422           example: __ROUTE-TARGET-ROLE__
23423         - name: body
23424           in: body
23425           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
23426           required: true
23427           schema:
23428             $ref: "#/definitions/relationship"
23429     delete:
23430       tags:
23431         - Network
23432       summary: delete an existing relationship
23433       description: delete an existing relationship
23434       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTargetRelationshipListRelationship
23435       consumes:
23436         - application/json
23437         - application/xml
23438       produces:
23439         - application/json
23440         - application/xml
23441       responses:
23442         "default":
23443           description: Response codes found in [response codes](https://wiki.onap.org/).
23444       parameters:
23445         - name: vpn-id
23446           in: path
23447           description: VPN ID, globally unique within A&AI
23448           required: true
23449           type: string
23450           example: __VPN-ID__
23451         - name: global-route-target
23452           in: path
23453           description: Number used to identify an RT, globally unique in the network
23454           required: true
23455           type: string
23456           example: __GLOBAL-ROUTE-TARGET__
23457         - name: route-target-role
23458           in: path
23459           description: Role assigned to this route target
23460           required: true
23461           type: string
23462           example: __ROUTE-TARGET-ROLE__
23463   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}:
23464     get:
23465       tags:
23466         - Network
23467       summary: returns route-target
23468       description: returns route-target
23469       operationId: getNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23470       produces:
23471         - application/json
23472         - application/xml
23473       responses:
23474         "200":
23475           description: successful operation
23476           schema:
23477               $ref: "#/getDefinitions/route-target"
23478         "default":
23479           description: Response codes found in [response codes](https://wiki.onap.org/).
23480       parameters:
23481         - name: vpn-id
23482           in: path
23483           description: VPN ID, globally unique within A&AI
23484           required: true
23485           type: string
23486           example: __VPN-ID__
23487         - name: global-route-target
23488           in: path
23489           description: Number used to identify an RT, globally unique in the network
23490           required: true
23491           type: string
23492           example: __GLOBAL-ROUTE-TARGET__
23493         - name: route-target-role
23494           in: path
23495           description: Role assigned to this route target
23496           required: true
23497           type: string
23498           example: __ROUTE-TARGET-ROLE__
23499         - name: vpn-name
23500           in: query
23501           description: VPN Name
23502           required: false
23503           type: string
23504         - name: vpn-type
23505           in: query
23506           description: Type of the vpn, should be taken from enumerated/valid values
23507           required: false
23508           type: string
23509     put:
23510       tags:
23511         - Network
23512       summary: create or update an existing route-target
23513       description: |
23514         Create or update an existing route-target.
23515         #
23516         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23517       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23518       consumes:
23519         - application/json
23520         - application/xml
23521       produces:
23522         - application/json
23523         - application/xml
23524       responses:
23525         "default":
23526           description: Response codes found in [response codes](https://wiki.onap.org/).
23527       parameters:
23528         - name: vpn-id
23529           in: path
23530           description: VPN ID, globally unique within A&AI
23531           required: true
23532           type: string
23533           example: __VPN-ID__
23534         - name: global-route-target
23535           in: path
23536           description: Number used to identify an RT, globally unique in the network
23537           required: true
23538           type: string
23539           example: __GLOBAL-ROUTE-TARGET__
23540         - name: route-target-role
23541           in: path
23542           description: Role assigned to this route target
23543           required: true
23544           type: string
23545           example: __ROUTE-TARGET-ROLE__
23546         - name: body
23547           in: body
23548           description: route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)
23549           required: true
23550           schema:
23551             $ref: "#/definitions/route-target"
23552     patch:
23553       tags:
23554         - Network
23555       summary: update an existing route-target
23556       description: |
23557         Update an existing route-target
23558         #
23559         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23560         The PUT operation will entirely replace an existing object.
23561         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23562         #
23563         Other differences between PUT and PATCH are:
23564         #
23565         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23566         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23567         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23568       operationId: UpdateNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23569       consumes:
23570         - application/json
23571         - application/xml
23572       produces:
23573         - application/json
23574         - application/xml
23575       responses:
23576         "default":
23577           description: Response codes found in [response codes](https://wiki.onap.org/).
23578       parameters:
23579         - name: vpn-id
23580           in: path
23581           description: VPN ID, globally unique within A&AI
23582           required: true
23583           type: string
23584           example: __VPN-ID__
23585         - name: global-route-target
23586           in: path
23587           description: Number used to identify an RT, globally unique in the network
23588           required: true
23589           type: string
23590           example: __GLOBAL-ROUTE-TARGET__
23591         - name: route-target-role
23592           in: path
23593           description: Role assigned to this route target
23594           required: true
23595           type: string
23596           example: __ROUTE-TARGET-ROLE__
23597         - name: body
23598           in: body
23599           description: route-target object that needs to be created or updated.
23600           required: true
23601           schema:
23602             $ref: "#/patchDefinitions/route-target"
23603     delete:
23604       tags:
23605         - Network
23606       summary: delete an existing route-target
23607       description: delete an existing route-target
23608       operationId: deleteNetworkVpnBindingsVpnBindingRouteTargetsRouteTarget
23609       consumes:
23610         - application/json
23611         - application/xml
23612       produces:
23613         - application/json
23614         - application/xml
23615       responses:
23616         "default":
23617           description: Response codes found in [response codes](https://wiki.onap.org/).
23618       parameters:
23619         - name: vpn-id
23620           in: path
23621           description: VPN ID, globally unique within A&AI
23622           required: true
23623           type: string
23624           example: __VPN-ID__
23625         - name: global-route-target
23626           in: path
23627           description: Number used to identify an RT, globally unique in the network
23628           required: true
23629           type: string
23630           example: __GLOBAL-ROUTE-TARGET__
23631         - name: route-target-role
23632           in: path
23633           description: Role assigned to this route target
23634           required: true
23635           type: string
23636           example: __ROUTE-TARGET-ROLE__
23637         - name: resource-version
23638           in: query
23639           description: resource-version for concurrency
23640           required: true
23641           type: string
23642   /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets:
23643     get:
23644       tags:
23645         - Network
23646       summary: returns route-targets
23647       description: returns route-targets
23648       operationId: getNetworkVpnBindingsVpnBindingRouteTargets
23649       produces:
23650         - application/json
23651         - application/xml
23652       responses:
23653         "200":
23654           description: successful operation
23655           schema:
23656               $ref: "#/getDefinitions/route-targets"
23657         "default":
23658           description: Response codes found in [response codes](https://wiki.onap.org/).
23659       parameters:
23660         - name: vpn-id
23661           in: path
23662           description: VPN ID, globally unique within A&AI
23663           required: true
23664           type: string
23665           example: __VPN-ID__
23666         - name: vpn-name
23667           in: query
23668           description: VPN Name
23669           required: false
23670           type: string
23671         - name: vpn-type
23672           in: query
23673           description: Type of the vpn, should be taken from enumerated/valid values
23674           required: false
23675           type: string
23676   /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship:
23677     put:
23678       tags:
23679         - Network
23680       summary: see node definition for valid relationships
23681       operationId: createOrUpdateNetworkVpnBindingsVpnBindingRelationshipListRelationship
23682       consumes:
23683         - application/json
23684         - application/xml
23685       produces:
23686         - application/json
23687         - application/xml
23688       responses:
23689         "default":
23690           description: Response codes found in [response codes](https://wiki.onap.org/).
23691       parameters:
23692         - name: vpn-id
23693           in: path
23694           description: VPN ID, globally unique within A&AI
23695           required: true
23696           type: string
23697           example: __VPN-ID__
23698         - name: body
23699           in: body
23700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
23701           required: true
23702           schema:
23703             $ref: "#/definitions/relationship"
23704     delete:
23705       tags:
23706         - Network
23707       summary: delete an existing relationship
23708       description: delete an existing relationship
23709       operationId: deleteNetworkVpnBindingsVpnBindingRelationshipListRelationship
23710       consumes:
23711         - application/json
23712         - application/xml
23713       produces:
23714         - application/json
23715         - application/xml
23716       responses:
23717         "default":
23718           description: Response codes found in [response codes](https://wiki.onap.org/).
23719       parameters:
23720         - name: vpn-id
23721           in: path
23722           description: VPN ID, globally unique within A&AI
23723           required: true
23724           type: string
23725           example: __VPN-ID__
23726   /network/vpn-bindings/vpn-binding/{vpn-id}:
23727     get:
23728       tags:
23729         - Network
23730       summary: returns vpn-binding
23731       description: returns vpn-binding
23732       operationId: getNetworkVpnBindingsVpnBinding
23733       produces:
23734         - application/json
23735         - application/xml
23736       responses:
23737         "200":
23738           description: successful operation
23739           schema:
23740               $ref: "#/getDefinitions/vpn-binding"
23741         "default":
23742           description: Response codes found in [response codes](https://wiki.onap.org/).
23743       parameters:
23744         - name: vpn-id
23745           in: path
23746           description: VPN ID, globally unique within A&AI
23747           required: true
23748           type: string
23749           example: __VPN-ID__
23750         - name: vpn-name
23751           in: query
23752           description: VPN Name
23753           required: false
23754           type: string
23755         - name: vpn-type
23756           in: query
23757           description: Type of the vpn, should be taken from enumerated/valid values
23758           required: false
23759           type: string
23760     put:
23761       tags:
23762         - Network
23763       summary: create or update an existing vpn-binding
23764       description: |
23765         Create or update an existing vpn-binding.
23766         #
23767         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
23768       operationId: createOrUpdateNetworkVpnBindingsVpnBinding
23769       consumes:
23770         - application/json
23771         - application/xml
23772       produces:
23773         - application/json
23774         - application/xml
23775       responses:
23776         "default":
23777           description: Response codes found in [response codes](https://wiki.onap.org/).
23778       parameters:
23779         - name: vpn-id
23780           in: path
23781           description: VPN ID, globally unique within A&AI
23782           required: true
23783           type: string
23784           example: __VPN-ID__
23785         - name: body
23786           in: body
23787           description: vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)
23788           required: true
23789           schema:
23790             $ref: "#/definitions/vpn-binding"
23791     patch:
23792       tags:
23793         - Network
23794       summary: update an existing vpn-binding
23795       description: |
23796         Update an existing vpn-binding
23797         #
23798         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
23799         The PUT operation will entirely replace an existing object.
23800         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
23801         #
23802         Other differences between PUT and PATCH are:
23803         #
23804         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
23805         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
23806         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
23807       operationId: UpdateNetworkVpnBindingsVpnBinding
23808       consumes:
23809         - application/json
23810         - application/xml
23811       produces:
23812         - application/json
23813         - application/xml
23814       responses:
23815         "default":
23816           description: Response codes found in [response codes](https://wiki.onap.org/).
23817       parameters:
23818         - name: vpn-id
23819           in: path
23820           description: VPN ID, globally unique within A&AI
23821           required: true
23822           type: string
23823           example: __VPN-ID__
23824         - name: body
23825           in: body
23826           description: vpn-binding object that needs to be created or updated.
23827           required: true
23828           schema:
23829             $ref: "#/patchDefinitions/vpn-binding"
23830     delete:
23831       tags:
23832         - Network
23833       summary: delete an existing vpn-binding
23834       description: delete an existing vpn-binding
23835       operationId: deleteNetworkVpnBindingsVpnBinding
23836       consumes:
23837         - application/json
23838         - application/xml
23839       produces:
23840         - application/json
23841         - application/xml
23842       responses:
23843         "default":
23844           description: Response codes found in [response codes](https://wiki.onap.org/).
23845       parameters:
23846         - name: vpn-id
23847           in: path
23848           description: VPN ID, globally unique within A&AI
23849           required: true
23850           type: string
23851           example: __VPN-ID__
23852         - name: resource-version
23853           in: query
23854           description: resource-version for concurrency
23855           required: true
23856           type: string
23857   /network/vpn-bindings:
23858     get:
23859       tags:
23860         - Network
23861       summary: returns vpn-bindings
23862       description: returns vpn-bindings
23863       operationId: getNetworkVpnBindings
23864       produces:
23865         - application/json
23866         - application/xml
23867       responses:
23868         "200":
23869           description: successful operation
23870           schema:
23871               $ref: "#/getDefinitions/vpn-bindings"
23872         "default":
23873           description: Response codes found in [response codes](https://wiki.onap.org/).
23874   /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship:
23875     put:
23876       tags:
23877         - Network
23878       summary: see node definition for valid relationships
23879       operationId: createOrUpdateNetworkVplsPesVplsPeRelationshipListRelationship
23880       consumes:
23881         - application/json
23882         - application/xml
23883       produces:
23884         - application/json
23885         - application/xml
23886       responses:
23887         "default":
23888           description: Response codes found in [response codes](https://wiki.onap.org/).
23889       parameters:
23890         - name: equipment-name
23891           in: path
23892           required: true
23893           type: string
23894           example: __EQUIPMENT-NAME__
23895         - name: body
23896           in: body
23897           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
23898           required: true
23899           schema:
23900             $ref: "#/definitions/relationship"
23901     delete:
23902       tags:
23903         - Network
23904       summary: delete an existing relationship
23905       description: delete an existing relationship
23906       operationId: deleteNetworkVplsPesVplsPeRelationshipListRelationship
23907       consumes:
23908         - application/json
23909         - application/xml
23910       produces:
23911         - application/json
23912         - application/xml
23913       responses:
23914         "default":
23915           description: Response codes found in [response codes](https://wiki.onap.org/).
23916       parameters:
23917         - name: equipment-name
23918           in: path
23919           required: true
23920           type: string
23921           example: __EQUIPMENT-NAME__
23922   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
23923     put:
23924       tags:
23925         - Network
23926       summary: see node definition for valid relationships
23927       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
23928       consumes:
23929         - application/json
23930         - application/xml
23931       produces:
23932         - application/json
23933         - application/xml
23934       responses:
23935         "default":
23936           description: Response codes found in [response codes](https://wiki.onap.org/).
23937       parameters:
23938         - name: equipment-name
23939           in: path
23940           required: true
23941           type: string
23942           example: __EQUIPMENT-NAME__
23943         - name: interface-name
23944           in: path
23945           description: Name that identifies the physical interface
23946           required: true
23947           type: string
23948           example: __INTERFACE-NAME__
23949         - name: body
23950           in: body
23951           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
23952           required: true
23953           schema:
23954             $ref: "#/definitions/relationship"
23955     delete:
23956       tags:
23957         - Network
23958       summary: delete an existing relationship
23959       description: delete an existing relationship
23960       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceRelationshipListRelationship
23961       consumes:
23962         - application/json
23963         - application/xml
23964       produces:
23965         - application/json
23966         - application/xml
23967       responses:
23968         "default":
23969           description: Response codes found in [response codes](https://wiki.onap.org/).
23970       parameters:
23971         - name: equipment-name
23972           in: path
23973           required: true
23974           type: string
23975           example: __EQUIPMENT-NAME__
23976         - name: interface-name
23977           in: path
23978           description: Name that identifies the physical interface
23979           required: true
23980           type: string
23981           example: __INTERFACE-NAME__
23982   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
23983     put:
23984       tags:
23985         - Network
23986       summary: see node definition for valid relationships
23987       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
23988       consumes:
23989         - application/json
23990         - application/xml
23991       produces:
23992         - application/json
23993         - application/xml
23994       responses:
23995         "default":
23996           description: Response codes found in [response codes](https://wiki.onap.org/).
23997       parameters:
23998         - name: equipment-name
23999           in: path
24000           required: true
24001           type: string
24002           example: __EQUIPMENT-NAME__
24003         - name: interface-name
24004           in: path
24005           description: Name that identifies the physical interface
24006           required: true
24007           type: string
24008           example: __INTERFACE-NAME__
24009         - name: pf-pci-id
24010           in: path
24011           description: Identifier for the sriov-pf
24012           required: true
24013           type: string
24014           example: __PF-PCI-ID__
24015         - name: body
24016           in: body
24017           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
24018           required: true
24019           schema:
24020             $ref: "#/definitions/relationship"
24021     delete:
24022       tags:
24023         - Network
24024       summary: delete an existing relationship
24025       description: delete an existing relationship
24026       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
24027       consumes:
24028         - application/json
24029         - application/xml
24030       produces:
24031         - application/json
24032         - application/xml
24033       responses:
24034         "default":
24035           description: Response codes found in [response codes](https://wiki.onap.org/).
24036       parameters:
24037         - name: equipment-name
24038           in: path
24039           required: true
24040           type: string
24041           example: __EQUIPMENT-NAME__
24042         - name: interface-name
24043           in: path
24044           description: Name that identifies the physical interface
24045           required: true
24046           type: string
24047           example: __INTERFACE-NAME__
24048         - name: pf-pci-id
24049           in: path
24050           description: Identifier for the sriov-pf
24051           required: true
24052           type: string
24053           example: __PF-PCI-ID__
24054   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
24055     get:
24056       tags:
24057         - Network
24058       summary: returns sriov-pf
24059       description: returns sriov-pf
24060       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24061       produces:
24062         - application/json
24063         - application/xml
24064       responses:
24065         "200":
24066           description: successful operation
24067           schema:
24068               $ref: "#/getDefinitions/sriov-pf"
24069         "default":
24070           description: Response codes found in [response codes](https://wiki.onap.org/).
24071       parameters:
24072         - name: equipment-name
24073           in: path
24074           required: true
24075           type: string
24076           example: __EQUIPMENT-NAME__
24077         - name: interface-name
24078           in: path
24079           description: Name that identifies the physical interface
24080           required: true
24081           type: string
24082           example: __INTERFACE-NAME__
24083         - name: pf-pci-id
24084           in: path
24085           description: Identifier for the sriov-pf
24086           required: true
24087           type: string
24088           example: __PF-PCI-ID__
24089         - name: prov-status
24090           in: query
24091           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24092           required: false
24093           type: string
24094         - name: prov-status
24095           in: query
24096           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24097           required: false
24098           type: string
24099     put:
24100       tags:
24101         - Network
24102       summary: create or update an existing sriov-pf
24103       description: |
24104         Create or update an existing sriov-pf.
24105         #
24106         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24107       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24108       consumes:
24109         - application/json
24110         - application/xml
24111       produces:
24112         - application/json
24113         - application/xml
24114       responses:
24115         "default":
24116           description: Response codes found in [response codes](https://wiki.onap.org/).
24117       parameters:
24118         - name: equipment-name
24119           in: path
24120           required: true
24121           type: string
24122           example: __EQUIPMENT-NAME__
24123         - name: interface-name
24124           in: path
24125           description: Name that identifies the physical interface
24126           required: true
24127           type: string
24128           example: __INTERFACE-NAME__
24129         - name: pf-pci-id
24130           in: path
24131           description: Identifier for the sriov-pf
24132           required: true
24133           type: string
24134           example: __PF-PCI-ID__
24135         - name: body
24136           in: body
24137           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)
24138           required: true
24139           schema:
24140             $ref: "#/definitions/sriov-pf"
24141     patch:
24142       tags:
24143         - Network
24144       summary: update an existing sriov-pf
24145       description: |
24146         Update an existing sriov-pf
24147         #
24148         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24149         The PUT operation will entirely replace an existing object.
24150         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24151         #
24152         Other differences between PUT and PATCH are:
24153         #
24154         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24155         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24156         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24157       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24158       consumes:
24159         - application/json
24160         - application/xml
24161       produces:
24162         - application/json
24163         - application/xml
24164       responses:
24165         "default":
24166           description: Response codes found in [response codes](https://wiki.onap.org/).
24167       parameters:
24168         - name: equipment-name
24169           in: path
24170           required: true
24171           type: string
24172           example: __EQUIPMENT-NAME__
24173         - name: interface-name
24174           in: path
24175           description: Name that identifies the physical interface
24176           required: true
24177           type: string
24178           example: __INTERFACE-NAME__
24179         - name: pf-pci-id
24180           in: path
24181           description: Identifier for the sriov-pf
24182           required: true
24183           type: string
24184           example: __PF-PCI-ID__
24185         - name: body
24186           in: body
24187           description: sriov-pf object that needs to be created or updated.
24188           required: true
24189           schema:
24190             $ref: "#/patchDefinitions/sriov-pf"
24191     delete:
24192       tags:
24193         - Network
24194       summary: delete an existing sriov-pf
24195       description: delete an existing sriov-pf
24196       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf
24197       consumes:
24198         - application/json
24199         - application/xml
24200       produces:
24201         - application/json
24202         - application/xml
24203       responses:
24204         "default":
24205           description: Response codes found in [response codes](https://wiki.onap.org/).
24206       parameters:
24207         - name: equipment-name
24208           in: path
24209           required: true
24210           type: string
24211           example: __EQUIPMENT-NAME__
24212         - name: interface-name
24213           in: path
24214           description: Name that identifies the physical interface
24215           required: true
24216           type: string
24217           example: __INTERFACE-NAME__
24218         - name: pf-pci-id
24219           in: path
24220           description: Identifier for the sriov-pf
24221           required: true
24222           type: string
24223           example: __PF-PCI-ID__
24224         - name: resource-version
24225           in: query
24226           description: resource-version for concurrency
24227           required: true
24228           type: string
24229   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
24230     get:
24231       tags:
24232         - Network
24233       summary: returns sriov-pfs
24234       description: returns sriov-pfs
24235       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceSriovPfs
24236       produces:
24237         - application/json
24238         - application/xml
24239       responses:
24240         "200":
24241           description: successful operation
24242           schema:
24243               $ref: "#/getDefinitions/sriov-pfs"
24244         "default":
24245           description: Response codes found in [response codes](https://wiki.onap.org/).
24246       parameters:
24247         - name: equipment-name
24248           in: path
24249           required: true
24250           type: string
24251           example: __EQUIPMENT-NAME__
24252         - name: interface-name
24253           in: path
24254           description: Name that identifies the physical interface
24255           required: true
24256           type: string
24257           example: __INTERFACE-NAME__
24258         - name: prov-status
24259           in: query
24260           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24261           required: false
24262           type: string
24263         - name: prov-status
24264           in: query
24265           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24266           required: false
24267           type: string
24268   /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:
24269     put:
24270       tags:
24271         - Network
24272       summary: see node definition for valid relationships
24273       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24274       consumes:
24275         - application/json
24276         - application/xml
24277       produces:
24278         - application/json
24279         - application/xml
24280       responses:
24281         "default":
24282           description: Response codes found in [response codes](https://wiki.onap.org/).
24283       parameters:
24284         - name: equipment-name
24285           in: path
24286           required: true
24287           type: string
24288           example: __EQUIPMENT-NAME__
24289         - name: interface-name
24290           in: path
24291           description: Name that identifies the physical interface
24292           required: true
24293           type: string
24294           example: __INTERFACE-NAME__
24295         - name: interface-name
24296           in: path
24297           description: Name given to the interface
24298           required: true
24299           type: string
24300           example: __INTERFACE-NAME__
24301         - name: vlan-interface
24302           in: path
24303           description: String that identifies the interface
24304           required: true
24305           type: string
24306           example: __VLAN-INTERFACE__
24307         - name: body
24308           in: body
24309           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
24310           required: true
24311           schema:
24312             $ref: "#/definitions/relationship"
24313     delete:
24314       tags:
24315         - Network
24316       summary: delete an existing relationship
24317       description: delete an existing relationship
24318       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
24319       consumes:
24320         - application/json
24321         - application/xml
24322       produces:
24323         - application/json
24324         - application/xml
24325       responses:
24326         "default":
24327           description: Response codes found in [response codes](https://wiki.onap.org/).
24328       parameters:
24329         - name: equipment-name
24330           in: path
24331           required: true
24332           type: string
24333           example: __EQUIPMENT-NAME__
24334         - name: interface-name
24335           in: path
24336           description: Name that identifies the physical interface
24337           required: true
24338           type: string
24339           example: __INTERFACE-NAME__
24340         - name: interface-name
24341           in: path
24342           description: Name given to the interface
24343           required: true
24344           type: string
24345           example: __INTERFACE-NAME__
24346         - name: vlan-interface
24347           in: path
24348           description: String that identifies the interface
24349           required: true
24350           type: string
24351           example: __VLAN-INTERFACE__
24352   /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:
24353     put:
24354       tags:
24355         - Network
24356       summary: see node definition for valid relationships
24357       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24358       consumes:
24359         - application/json
24360         - application/xml
24361       produces:
24362         - application/json
24363         - application/xml
24364       responses:
24365         "default":
24366           description: Response codes found in [response codes](https://wiki.onap.org/).
24367       parameters:
24368         - name: equipment-name
24369           in: path
24370           required: true
24371           type: string
24372           example: __EQUIPMENT-NAME__
24373         - name: interface-name
24374           in: path
24375           description: Name that identifies the physical interface
24376           required: true
24377           type: string
24378           example: __INTERFACE-NAME__
24379         - name: interface-name
24380           in: path
24381           description: Name given to the interface
24382           required: true
24383           type: string
24384           example: __INTERFACE-NAME__
24385         - name: vlan-interface
24386           in: path
24387           description: String that identifies the interface
24388           required: true
24389           type: string
24390           example: __VLAN-INTERFACE__
24391         - name: l3-interface-ipv4-address
24392           in: path
24393           description: IP address
24394           required: true
24395           type: string
24396           example: __L3-INTERFACE-IPV4-ADDRESS__
24397         - name: body
24398           in: body
24399           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24400           required: true
24401           schema:
24402             $ref: "#/definitions/relationship"
24403     delete:
24404       tags:
24405         - Network
24406       summary: delete an existing relationship
24407       description: delete an existing relationship
24408       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
24409       consumes:
24410         - application/json
24411         - application/xml
24412       produces:
24413         - application/json
24414         - application/xml
24415       responses:
24416         "default":
24417           description: Response codes found in [response codes](https://wiki.onap.org/).
24418       parameters:
24419         - name: equipment-name
24420           in: path
24421           required: true
24422           type: string
24423           example: __EQUIPMENT-NAME__
24424         - name: interface-name
24425           in: path
24426           description: Name that identifies the physical interface
24427           required: true
24428           type: string
24429           example: __INTERFACE-NAME__
24430         - name: interface-name
24431           in: path
24432           description: Name given to the interface
24433           required: true
24434           type: string
24435           example: __INTERFACE-NAME__
24436         - name: vlan-interface
24437           in: path
24438           description: String that identifies the interface
24439           required: true
24440           type: string
24441           example: __VLAN-INTERFACE__
24442         - name: l3-interface-ipv4-address
24443           in: path
24444           description: IP address
24445           required: true
24446           type: string
24447           example: __L3-INTERFACE-IPV4-ADDRESS__
24448   /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}:
24449     get:
24450       tags:
24451         - Network
24452       summary: returns l3-interface-ipv4-address-list
24453       description: returns l3-interface-ipv4-address-list
24454       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24455       produces:
24456         - application/json
24457         - application/xml
24458       responses:
24459         "200":
24460           description: successful operation
24461           schema:
24462               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
24463         "default":
24464           description: Response codes found in [response codes](https://wiki.onap.org/).
24465       parameters:
24466         - name: equipment-name
24467           in: path
24468           required: true
24469           type: string
24470           example: __EQUIPMENT-NAME__
24471         - name: interface-name
24472           in: path
24473           description: Name that identifies the physical interface
24474           required: true
24475           type: string
24476           example: __INTERFACE-NAME__
24477         - name: interface-name
24478           in: path
24479           description: Name given to the interface
24480           required: true
24481           type: string
24482           example: __INTERFACE-NAME__
24483         - name: vlan-interface
24484           in: path
24485           description: String that identifies the interface
24486           required: true
24487           type: string
24488           example: __VLAN-INTERFACE__
24489         - name: l3-interface-ipv4-address
24490           in: path
24491           description: IP address
24492           required: true
24493           type: string
24494           example: __L3-INTERFACE-IPV4-ADDRESS__
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         - name: prov-status
24501           in: query
24502           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24503           required: false
24504           type: string
24505         - name: interface-id
24506           in: query
24507           description: ID of interface
24508           required: false
24509           type: string
24510         - name: macaddr
24511           in: query
24512           description: MAC address for the interface
24513           required: false
24514           type: string
24515         - name: network-name
24516           in: query
24517           description: Name of the network
24518           required: false
24519           type: string
24520         - name: vlan-id-inner
24521           in: query
24522           description: Inner VLAN tag
24523           required: false
24524           type: integer
24525           format: int64
24526         - name: vpn-key
24527           in: query
24528           description: This indicates the customers VPN ID associated with this vlan
24529           required: false
24530           type: string
24531         - name: vlan-id-inner
24532           in: query
24533           description: Inner VLAN tag
24534           required: false
24535           type: integer
24536           format: int64
24537         - name: neutron-network-id
24538           in: query
24539           description: Neutron network id of the interface that address belongs to
24540           required: false
24541           type: string
24542         - name: neutron-subnet-id
24543           in: query
24544           description: Neutron id of subnet that address belongs to
24545           required: false
24546           type: string
24547     put:
24548       tags:
24549         - Network
24550       summary: create or update an existing l3-interface-ipv4-address-list
24551       description: |
24552         Create or update an existing l3-interface-ipv4-address-list.
24553         #
24554         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24555       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24556       consumes:
24557         - application/json
24558         - application/xml
24559       produces:
24560         - application/json
24561         - application/xml
24562       responses:
24563         "default":
24564           description: Response codes found in [response codes](https://wiki.onap.org/).
24565       parameters:
24566         - name: equipment-name
24567           in: path
24568           required: true
24569           type: string
24570           example: __EQUIPMENT-NAME__
24571         - name: interface-name
24572           in: path
24573           description: Name that identifies the physical interface
24574           required: true
24575           type: string
24576           example: __INTERFACE-NAME__
24577         - name: interface-name
24578           in: path
24579           description: Name given to the interface
24580           required: true
24581           type: string
24582           example: __INTERFACE-NAME__
24583         - name: vlan-interface
24584           in: path
24585           description: String that identifies the interface
24586           required: true
24587           type: string
24588           example: __VLAN-INTERFACE__
24589         - name: l3-interface-ipv4-address
24590           in: path
24591           description: IP address
24592           required: true
24593           type: string
24594           example: __L3-INTERFACE-IPV4-ADDRESS__
24595         - name: body
24596           in: body
24597           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
24598           required: true
24599           schema:
24600             $ref: "#/definitions/l3-interface-ipv4-address-list"
24601     patch:
24602       tags:
24603         - Network
24604       summary: update an existing l3-interface-ipv4-address-list
24605       description: |
24606         Update an existing l3-interface-ipv4-address-list
24607         #
24608         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24609         The PUT operation will entirely replace an existing object.
24610         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24611         #
24612         Other differences between PUT and PATCH are:
24613         #
24614         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24615         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24616         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24617       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24618       consumes:
24619         - application/json
24620         - application/xml
24621       produces:
24622         - application/json
24623         - application/xml
24624       responses:
24625         "default":
24626           description: Response codes found in [response codes](https://wiki.onap.org/).
24627       parameters:
24628         - name: equipment-name
24629           in: path
24630           required: true
24631           type: string
24632           example: __EQUIPMENT-NAME__
24633         - name: interface-name
24634           in: path
24635           description: Name that identifies the physical interface
24636           required: true
24637           type: string
24638           example: __INTERFACE-NAME__
24639         - name: interface-name
24640           in: path
24641           description: Name given to the interface
24642           required: true
24643           type: string
24644           example: __INTERFACE-NAME__
24645         - name: vlan-interface
24646           in: path
24647           description: String that identifies the interface
24648           required: true
24649           type: string
24650           example: __VLAN-INTERFACE__
24651         - name: l3-interface-ipv4-address
24652           in: path
24653           description: IP address
24654           required: true
24655           type: string
24656           example: __L3-INTERFACE-IPV4-ADDRESS__
24657         - name: body
24658           in: body
24659           description: l3-interface-ipv4-address-list object that needs to be created or updated.
24660           required: true
24661           schema:
24662             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
24663     delete:
24664       tags:
24665         - Network
24666       summary: delete an existing l3-interface-ipv4-address-list
24667       description: delete an existing l3-interface-ipv4-address-list
24668       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
24669       consumes:
24670         - application/json
24671         - application/xml
24672       produces:
24673         - application/json
24674         - application/xml
24675       responses:
24676         "default":
24677           description: Response codes found in [response codes](https://wiki.onap.org/).
24678       parameters:
24679         - name: equipment-name
24680           in: path
24681           required: true
24682           type: string
24683           example: __EQUIPMENT-NAME__
24684         - name: interface-name
24685           in: path
24686           description: Name that identifies the physical interface
24687           required: true
24688           type: string
24689           example: __INTERFACE-NAME__
24690         - name: interface-name
24691           in: path
24692           description: Name given to the interface
24693           required: true
24694           type: string
24695           example: __INTERFACE-NAME__
24696         - name: vlan-interface
24697           in: path
24698           description: String that identifies the interface
24699           required: true
24700           type: string
24701           example: __VLAN-INTERFACE__
24702         - name: l3-interface-ipv4-address
24703           in: path
24704           description: IP address
24705           required: true
24706           type: string
24707           example: __L3-INTERFACE-IPV4-ADDRESS__
24708         - name: resource-version
24709           in: query
24710           description: resource-version for concurrency
24711           required: true
24712           type: string
24713   /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:
24714     put:
24715       tags:
24716         - Network
24717       summary: see node definition for valid relationships
24718       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24719       consumes:
24720         - application/json
24721         - application/xml
24722       produces:
24723         - application/json
24724         - application/xml
24725       responses:
24726         "default":
24727           description: Response codes found in [response codes](https://wiki.onap.org/).
24728       parameters:
24729         - name: equipment-name
24730           in: path
24731           required: true
24732           type: string
24733           example: __EQUIPMENT-NAME__
24734         - name: interface-name
24735           in: path
24736           description: Name that identifies the physical interface
24737           required: true
24738           type: string
24739           example: __INTERFACE-NAME__
24740         - name: interface-name
24741           in: path
24742           description: Name given to the interface
24743           required: true
24744           type: string
24745           example: __INTERFACE-NAME__
24746         - name: vlan-interface
24747           in: path
24748           description: String that identifies the interface
24749           required: true
24750           type: string
24751           example: __VLAN-INTERFACE__
24752         - name: l3-interface-ipv6-address
24753           in: path
24754           description: IP address
24755           required: true
24756           type: string
24757           example: __L3-INTERFACE-IPV6-ADDRESS__
24758         - name: body
24759           in: body
24760           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24761           required: true
24762           schema:
24763             $ref: "#/definitions/relationship"
24764     delete:
24765       tags:
24766         - Network
24767       summary: delete an existing relationship
24768       description: delete an existing relationship
24769       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
24770       consumes:
24771         - application/json
24772         - application/xml
24773       produces:
24774         - application/json
24775         - application/xml
24776       responses:
24777         "default":
24778           description: Response codes found in [response codes](https://wiki.onap.org/).
24779       parameters:
24780         - name: equipment-name
24781           in: path
24782           required: true
24783           type: string
24784           example: __EQUIPMENT-NAME__
24785         - name: interface-name
24786           in: path
24787           description: Name that identifies the physical interface
24788           required: true
24789           type: string
24790           example: __INTERFACE-NAME__
24791         - name: interface-name
24792           in: path
24793           description: Name given to the interface
24794           required: true
24795           type: string
24796           example: __INTERFACE-NAME__
24797         - name: vlan-interface
24798           in: path
24799           description: String that identifies the interface
24800           required: true
24801           type: string
24802           example: __VLAN-INTERFACE__
24803         - name: l3-interface-ipv6-address
24804           in: path
24805           description: IP address
24806           required: true
24807           type: string
24808           example: __L3-INTERFACE-IPV6-ADDRESS__
24809   /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}:
24810     get:
24811       tags:
24812         - Network
24813       summary: returns l3-interface-ipv6-address-list
24814       description: returns l3-interface-ipv6-address-list
24815       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24816       produces:
24817         - application/json
24818         - application/xml
24819       responses:
24820         "200":
24821           description: successful operation
24822           schema:
24823               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
24824         "default":
24825           description: Response codes found in [response codes](https://wiki.onap.org/).
24826       parameters:
24827         - name: equipment-name
24828           in: path
24829           required: true
24830           type: string
24831           example: __EQUIPMENT-NAME__
24832         - name: interface-name
24833           in: path
24834           description: Name that identifies the physical interface
24835           required: true
24836           type: string
24837           example: __INTERFACE-NAME__
24838         - name: interface-name
24839           in: path
24840           description: Name given to the interface
24841           required: true
24842           type: string
24843           example: __INTERFACE-NAME__
24844         - name: vlan-interface
24845           in: path
24846           description: String that identifies the interface
24847           required: true
24848           type: string
24849           example: __VLAN-INTERFACE__
24850         - name: l3-interface-ipv6-address
24851           in: path
24852           description: IP address
24853           required: true
24854           type: string
24855           example: __L3-INTERFACE-IPV6-ADDRESS__
24856         - name: prov-status
24857           in: query
24858           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
24859           required: false
24860           type: string
24861         - name: prov-status
24862           in: query
24863           description: Trigger for operational monitoring of this resource by Service Assurance systems.
24864           required: false
24865           type: string
24866         - name: interface-id
24867           in: query
24868           description: ID of interface
24869           required: false
24870           type: string
24871         - name: macaddr
24872           in: query
24873           description: MAC address for the interface
24874           required: false
24875           type: string
24876         - name: network-name
24877           in: query
24878           description: Name of the network
24879           required: false
24880           type: string
24881         - name: vlan-id-inner
24882           in: query
24883           description: Inner VLAN tag
24884           required: false
24885           type: integer
24886           format: int64
24887         - name: vpn-key
24888           in: query
24889           description: This indicates the customers VPN ID associated with this vlan
24890           required: false
24891           type: string
24892         - name: vlan-id-inner
24893           in: query
24894           description: Inner VLAN tag
24895           required: false
24896           type: integer
24897           format: int64
24898         - name: neutron-network-id
24899           in: query
24900           description: Neutron network id of the interface that address belongs to
24901           required: false
24902           type: string
24903         - name: neutron-subnet-id
24904           in: query
24905           description: Neutron id of subnet that address belongs to
24906           required: false
24907           type: string
24908     put:
24909       tags:
24910         - Network
24911       summary: create or update an existing l3-interface-ipv6-address-list
24912       description: |
24913         Create or update an existing l3-interface-ipv6-address-list.
24914         #
24915         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
24916       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24917       consumes:
24918         - application/json
24919         - application/xml
24920       produces:
24921         - application/json
24922         - application/xml
24923       responses:
24924         "default":
24925           description: Response codes found in [response codes](https://wiki.onap.org/).
24926       parameters:
24927         - name: equipment-name
24928           in: path
24929           required: true
24930           type: string
24931           example: __EQUIPMENT-NAME__
24932         - name: interface-name
24933           in: path
24934           description: Name that identifies the physical interface
24935           required: true
24936           type: string
24937           example: __INTERFACE-NAME__
24938         - name: interface-name
24939           in: path
24940           description: Name given to the interface
24941           required: true
24942           type: string
24943           example: __INTERFACE-NAME__
24944         - name: vlan-interface
24945           in: path
24946           description: String that identifies the interface
24947           required: true
24948           type: string
24949           example: __VLAN-INTERFACE__
24950         - name: l3-interface-ipv6-address
24951           in: path
24952           description: IP address
24953           required: true
24954           type: string
24955           example: __L3-INTERFACE-IPV6-ADDRESS__
24956         - name: body
24957           in: body
24958           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
24959           required: true
24960           schema:
24961             $ref: "#/definitions/l3-interface-ipv6-address-list"
24962     patch:
24963       tags:
24964         - Network
24965       summary: update an existing l3-interface-ipv6-address-list
24966       description: |
24967         Update an existing l3-interface-ipv6-address-list
24968         #
24969         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
24970         The PUT operation will entirely replace an existing object.
24971         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
24972         #
24973         Other differences between PUT and PATCH are:
24974         #
24975         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
24976         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
24977         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
24978       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
24979       consumes:
24980         - application/json
24981         - application/xml
24982       produces:
24983         - application/json
24984         - application/xml
24985       responses:
24986         "default":
24987           description: Response codes found in [response codes](https://wiki.onap.org/).
24988       parameters:
24989         - name: equipment-name
24990           in: path
24991           required: true
24992           type: string
24993           example: __EQUIPMENT-NAME__
24994         - name: interface-name
24995           in: path
24996           description: Name that identifies the physical interface
24997           required: true
24998           type: string
24999           example: __INTERFACE-NAME__
25000         - name: interface-name
25001           in: path
25002           description: Name given to the interface
25003           required: true
25004           type: string
25005           example: __INTERFACE-NAME__
25006         - name: vlan-interface
25007           in: path
25008           description: String that identifies the interface
25009           required: true
25010           type: string
25011           example: __VLAN-INTERFACE__
25012         - name: l3-interface-ipv6-address
25013           in: path
25014           description: IP address
25015           required: true
25016           type: string
25017           example: __L3-INTERFACE-IPV6-ADDRESS__
25018         - name: body
25019           in: body
25020           description: l3-interface-ipv6-address-list object that needs to be created or updated.
25021           required: true
25022           schema:
25023             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
25024     delete:
25025       tags:
25026         - Network
25027       summary: delete an existing l3-interface-ipv6-address-list
25028       description: delete an existing l3-interface-ipv6-address-list
25029       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
25030       consumes:
25031         - application/json
25032         - application/xml
25033       produces:
25034         - application/json
25035         - application/xml
25036       responses:
25037         "default":
25038           description: Response codes found in [response codes](https://wiki.onap.org/).
25039       parameters:
25040         - name: equipment-name
25041           in: path
25042           required: true
25043           type: string
25044           example: __EQUIPMENT-NAME__
25045         - name: interface-name
25046           in: path
25047           description: Name that identifies the physical interface
25048           required: true
25049           type: string
25050           example: __INTERFACE-NAME__
25051         - name: interface-name
25052           in: path
25053           description: Name given to the interface
25054           required: true
25055           type: string
25056           example: __INTERFACE-NAME__
25057         - name: vlan-interface
25058           in: path
25059           description: String that identifies the interface
25060           required: true
25061           type: string
25062           example: __VLAN-INTERFACE__
25063         - name: l3-interface-ipv6-address
25064           in: path
25065           description: IP address
25066           required: true
25067           type: string
25068           example: __L3-INTERFACE-IPV6-ADDRESS__
25069         - name: resource-version
25070           in: query
25071           description: resource-version for concurrency
25072           required: true
25073           type: string
25074   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
25075     get:
25076       tags:
25077         - Network
25078       summary: returns vlan
25079       description: returns vlan
25080       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25081       produces:
25082         - application/json
25083         - application/xml
25084       responses:
25085         "200":
25086           description: successful operation
25087           schema:
25088               $ref: "#/getDefinitions/vlan"
25089         "default":
25090           description: Response codes found in [response codes](https://wiki.onap.org/).
25091       parameters:
25092         - name: equipment-name
25093           in: path
25094           required: true
25095           type: string
25096           example: __EQUIPMENT-NAME__
25097         - name: interface-name
25098           in: path
25099           description: Name that identifies the physical interface
25100           required: true
25101           type: string
25102           example: __INTERFACE-NAME__
25103         - name: interface-name
25104           in: path
25105           description: Name given to the interface
25106           required: true
25107           type: string
25108           example: __INTERFACE-NAME__
25109         - name: vlan-interface
25110           in: path
25111           description: String that identifies the interface
25112           required: true
25113           type: string
25114           example: __VLAN-INTERFACE__
25115         - name: prov-status
25116           in: query
25117           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25118           required: false
25119           type: string
25120         - name: prov-status
25121           in: query
25122           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25123           required: false
25124           type: string
25125         - name: interface-id
25126           in: query
25127           description: ID of interface
25128           required: false
25129           type: string
25130         - name: macaddr
25131           in: query
25132           description: MAC address for the interface
25133           required: false
25134           type: string
25135         - name: network-name
25136           in: query
25137           description: Name of the network
25138           required: false
25139           type: string
25140         - name: vlan-id-inner
25141           in: query
25142           description: Inner VLAN tag
25143           required: false
25144           type: integer
25145           format: int64
25146         - name: vpn-key
25147           in: query
25148           description: This indicates the customers VPN ID associated with this vlan
25149           required: false
25150           type: string
25151     put:
25152       tags:
25153         - Network
25154       summary: create or update an existing vlan
25155       description: |
25156         Create or update an existing vlan.
25157         #
25158         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25159       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25160       consumes:
25161         - application/json
25162         - application/xml
25163       produces:
25164         - application/json
25165         - application/xml
25166       responses:
25167         "default":
25168           description: Response codes found in [response codes](https://wiki.onap.org/).
25169       parameters:
25170         - name: equipment-name
25171           in: path
25172           required: true
25173           type: string
25174           example: __EQUIPMENT-NAME__
25175         - name: interface-name
25176           in: path
25177           description: Name that identifies the physical interface
25178           required: true
25179           type: string
25180           example: __INTERFACE-NAME__
25181         - name: interface-name
25182           in: path
25183           description: Name given to the interface
25184           required: true
25185           type: string
25186           example: __INTERFACE-NAME__
25187         - name: vlan-interface
25188           in: path
25189           description: String that identifies the interface
25190           required: true
25191           type: string
25192           example: __VLAN-INTERFACE__
25193         - name: body
25194           in: body
25195           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
25196           required: true
25197           schema:
25198             $ref: "#/definitions/vlan"
25199     patch:
25200       tags:
25201         - Network
25202       summary: update an existing vlan
25203       description: |
25204         Update an existing vlan
25205         #
25206         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25207         The PUT operation will entirely replace an existing object.
25208         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25209         #
25210         Other differences between PUT and PATCH are:
25211         #
25212         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25213         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25214         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25215       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25216       consumes:
25217         - application/json
25218         - application/xml
25219       produces:
25220         - application/json
25221         - application/xml
25222       responses:
25223         "default":
25224           description: Response codes found in [response codes](https://wiki.onap.org/).
25225       parameters:
25226         - name: equipment-name
25227           in: path
25228           required: true
25229           type: string
25230           example: __EQUIPMENT-NAME__
25231         - name: interface-name
25232           in: path
25233           description: Name that identifies the physical interface
25234           required: true
25235           type: string
25236           example: __INTERFACE-NAME__
25237         - name: interface-name
25238           in: path
25239           description: Name given to the interface
25240           required: true
25241           type: string
25242           example: __INTERFACE-NAME__
25243         - name: vlan-interface
25244           in: path
25245           description: String that identifies the interface
25246           required: true
25247           type: string
25248           example: __VLAN-INTERFACE__
25249         - name: body
25250           in: body
25251           description: vlan object that needs to be created or updated.
25252           required: true
25253           schema:
25254             $ref: "#/patchDefinitions/vlan"
25255     delete:
25256       tags:
25257         - Network
25258       summary: delete an existing vlan
25259       description: delete an existing vlan
25260       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
25261       consumes:
25262         - application/json
25263         - application/xml
25264       produces:
25265         - application/json
25266         - application/xml
25267       responses:
25268         "default":
25269           description: Response codes found in [response codes](https://wiki.onap.org/).
25270       parameters:
25271         - name: equipment-name
25272           in: path
25273           required: true
25274           type: string
25275           example: __EQUIPMENT-NAME__
25276         - name: interface-name
25277           in: path
25278           description: Name that identifies the physical interface
25279           required: true
25280           type: string
25281           example: __INTERFACE-NAME__
25282         - name: interface-name
25283           in: path
25284           description: Name given to the interface
25285           required: true
25286           type: string
25287           example: __INTERFACE-NAME__
25288         - name: vlan-interface
25289           in: path
25290           description: String that identifies the interface
25291           required: true
25292           type: string
25293           example: __VLAN-INTERFACE__
25294         - name: resource-version
25295           in: query
25296           description: resource-version for concurrency
25297           required: true
25298           type: string
25299   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
25300     get:
25301       tags:
25302         - Network
25303       summary: returns vlans
25304       description: returns vlans
25305       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlans
25306       produces:
25307         - application/json
25308         - application/xml
25309       responses:
25310         "200":
25311           description: successful operation
25312           schema:
25313               $ref: "#/getDefinitions/vlans"
25314         "default":
25315           description: Response codes found in [response codes](https://wiki.onap.org/).
25316       parameters:
25317         - name: equipment-name
25318           in: path
25319           required: true
25320           type: string
25321           example: __EQUIPMENT-NAME__
25322         - name: interface-name
25323           in: path
25324           description: Name that identifies the physical interface
25325           required: true
25326           type: string
25327           example: __INTERFACE-NAME__
25328         - name: interface-name
25329           in: path
25330           description: Name given to the interface
25331           required: true
25332           type: string
25333           example: __INTERFACE-NAME__
25334         - name: prov-status
25335           in: query
25336           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25337           required: false
25338           type: string
25339         - name: prov-status
25340           in: query
25341           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25342           required: false
25343           type: string
25344         - name: interface-id
25345           in: query
25346           description: ID of interface
25347           required: false
25348           type: string
25349         - name: macaddr
25350           in: query
25351           description: MAC address for the interface
25352           required: false
25353           type: string
25354         - name: network-name
25355           in: query
25356           description: Name of the network
25357           required: false
25358           type: string
25359   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
25360     put:
25361       tags:
25362         - Network
25363       summary: see node definition for valid relationships
25364       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25365       consumes:
25366         - application/json
25367         - application/xml
25368       produces:
25369         - application/json
25370         - application/xml
25371       responses:
25372         "default":
25373           description: Response codes found in [response codes](https://wiki.onap.org/).
25374       parameters:
25375         - name: equipment-name
25376           in: path
25377           required: true
25378           type: string
25379           example: __EQUIPMENT-NAME__
25380         - name: interface-name
25381           in: path
25382           description: Name that identifies the physical interface
25383           required: true
25384           type: string
25385           example: __INTERFACE-NAME__
25386         - name: interface-name
25387           in: path
25388           description: Name given to the interface
25389           required: true
25390           type: string
25391           example: __INTERFACE-NAME__
25392         - name: pci-id
25393           in: path
25394           description: PCI ID used to identify the sriov-vf
25395           required: true
25396           type: string
25397           example: __PCI-ID__
25398         - name: body
25399           in: body
25400           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25401           required: true
25402           schema:
25403             $ref: "#/definitions/relationship"
25404     delete:
25405       tags:
25406         - Network
25407       summary: delete an existing relationship
25408       description: delete an existing relationship
25409       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
25410       consumes:
25411         - application/json
25412         - application/xml
25413       produces:
25414         - application/json
25415         - application/xml
25416       responses:
25417         "default":
25418           description: Response codes found in [response codes](https://wiki.onap.org/).
25419       parameters:
25420         - name: equipment-name
25421           in: path
25422           required: true
25423           type: string
25424           example: __EQUIPMENT-NAME__
25425         - name: interface-name
25426           in: path
25427           description: Name that identifies the physical interface
25428           required: true
25429           type: string
25430           example: __INTERFACE-NAME__
25431         - name: interface-name
25432           in: path
25433           description: Name given to the interface
25434           required: true
25435           type: string
25436           example: __INTERFACE-NAME__
25437         - name: pci-id
25438           in: path
25439           description: PCI ID used to identify the sriov-vf
25440           required: true
25441           type: string
25442           example: __PCI-ID__
25443   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
25444     get:
25445       tags:
25446         - Network
25447       summary: returns sriov-vf
25448       description: returns sriov-vf
25449       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25450       produces:
25451         - application/json
25452         - application/xml
25453       responses:
25454         "200":
25455           description: successful operation
25456           schema:
25457               $ref: "#/getDefinitions/sriov-vf"
25458         "default":
25459           description: Response codes found in [response codes](https://wiki.onap.org/).
25460       parameters:
25461         - name: equipment-name
25462           in: path
25463           required: true
25464           type: string
25465           example: __EQUIPMENT-NAME__
25466         - name: interface-name
25467           in: path
25468           description: Name that identifies the physical interface
25469           required: true
25470           type: string
25471           example: __INTERFACE-NAME__
25472         - name: interface-name
25473           in: path
25474           description: Name given to the interface
25475           required: true
25476           type: string
25477           example: __INTERFACE-NAME__
25478         - name: pci-id
25479           in: path
25480           description: PCI ID used to identify the sriov-vf
25481           required: true
25482           type: string
25483           example: __PCI-ID__
25484         - name: prov-status
25485           in: query
25486           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25487           required: false
25488           type: string
25489         - name: prov-status
25490           in: query
25491           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25492           required: false
25493           type: string
25494         - name: interface-id
25495           in: query
25496           description: ID of interface
25497           required: false
25498           type: string
25499         - name: macaddr
25500           in: query
25501           description: MAC address for the interface
25502           required: false
25503           type: string
25504         - name: network-name
25505           in: query
25506           description: Name of the network
25507           required: false
25508           type: string
25509         - name: vf-vlan-filter
25510           in: query
25511           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
25512           required: false
25513           type: string
25514         - name: vf-mac-filter
25515           in: query
25516           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
25517           required: false
25518           type: string
25519         - name: vf-vlan-strip
25520           in: query
25521           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
25522           required: false
25523           type: boolean
25524         - name: neutron-network-id
25525           in: query
25526           description: Neutron network id of the interface
25527           required: false
25528           type: string
25529     put:
25530       tags:
25531         - Network
25532       summary: create or update an existing sriov-vf
25533       description: |
25534         Create or update an existing sriov-vf.
25535         #
25536         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25537       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25538       consumes:
25539         - application/json
25540         - application/xml
25541       produces:
25542         - application/json
25543         - application/xml
25544       responses:
25545         "default":
25546           description: Response codes found in [response codes](https://wiki.onap.org/).
25547       parameters:
25548         - name: equipment-name
25549           in: path
25550           required: true
25551           type: string
25552           example: __EQUIPMENT-NAME__
25553         - name: interface-name
25554           in: path
25555           description: Name that identifies the physical interface
25556           required: true
25557           type: string
25558           example: __INTERFACE-NAME__
25559         - name: interface-name
25560           in: path
25561           description: Name given to the interface
25562           required: true
25563           type: string
25564           example: __INTERFACE-NAME__
25565         - name: pci-id
25566           in: path
25567           description: PCI ID used to identify the sriov-vf
25568           required: true
25569           type: string
25570           example: __PCI-ID__
25571         - name: body
25572           in: body
25573           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
25574           required: true
25575           schema:
25576             $ref: "#/definitions/sriov-vf"
25577     patch:
25578       tags:
25579         - Network
25580       summary: update an existing sriov-vf
25581       description: |
25582         Update an existing sriov-vf
25583         #
25584         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
25585         The PUT operation will entirely replace an existing object.
25586         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
25587         #
25588         Other differences between PUT and PATCH are:
25589         #
25590         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
25591         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
25592         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
25593       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25594       consumes:
25595         - application/json
25596         - application/xml
25597       produces:
25598         - application/json
25599         - application/xml
25600       responses:
25601         "default":
25602           description: Response codes found in [response codes](https://wiki.onap.org/).
25603       parameters:
25604         - name: equipment-name
25605           in: path
25606           required: true
25607           type: string
25608           example: __EQUIPMENT-NAME__
25609         - name: interface-name
25610           in: path
25611           description: Name that identifies the physical interface
25612           required: true
25613           type: string
25614           example: __INTERFACE-NAME__
25615         - name: interface-name
25616           in: path
25617           description: Name given to the interface
25618           required: true
25619           type: string
25620           example: __INTERFACE-NAME__
25621         - name: pci-id
25622           in: path
25623           description: PCI ID used to identify the sriov-vf
25624           required: true
25625           type: string
25626           example: __PCI-ID__
25627         - name: body
25628           in: body
25629           description: sriov-vf object that needs to be created or updated.
25630           required: true
25631           schema:
25632             $ref: "#/patchDefinitions/sriov-vf"
25633     delete:
25634       tags:
25635         - Network
25636       summary: delete an existing sriov-vf
25637       description: delete an existing sriov-vf
25638       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
25639       consumes:
25640         - application/json
25641         - application/xml
25642       produces:
25643         - application/json
25644         - application/xml
25645       responses:
25646         "default":
25647           description: Response codes found in [response codes](https://wiki.onap.org/).
25648       parameters:
25649         - name: equipment-name
25650           in: path
25651           required: true
25652           type: string
25653           example: __EQUIPMENT-NAME__
25654         - name: interface-name
25655           in: path
25656           description: Name that identifies the physical interface
25657           required: true
25658           type: string
25659           example: __INTERFACE-NAME__
25660         - name: interface-name
25661           in: path
25662           description: Name given to the interface
25663           required: true
25664           type: string
25665           example: __INTERFACE-NAME__
25666         - name: pci-id
25667           in: path
25668           description: PCI ID used to identify the sriov-vf
25669           required: true
25670           type: string
25671           example: __PCI-ID__
25672         - name: resource-version
25673           in: query
25674           description: resource-version for concurrency
25675           required: true
25676           type: string
25677   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
25678     get:
25679       tags:
25680         - Network
25681       summary: returns sriov-vfs
25682       description: returns sriov-vfs
25683       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
25684       produces:
25685         - application/json
25686         - application/xml
25687       responses:
25688         "200":
25689           description: successful operation
25690           schema:
25691               $ref: "#/getDefinitions/sriov-vfs"
25692         "default":
25693           description: Response codes found in [response codes](https://wiki.onap.org/).
25694       parameters:
25695         - name: equipment-name
25696           in: path
25697           required: true
25698           type: string
25699           example: __EQUIPMENT-NAME__
25700         - name: interface-name
25701           in: path
25702           description: Name that identifies the physical interface
25703           required: true
25704           type: string
25705           example: __INTERFACE-NAME__
25706         - name: interface-name
25707           in: path
25708           description: Name given to the interface
25709           required: true
25710           type: string
25711           example: __INTERFACE-NAME__
25712         - name: prov-status
25713           in: query
25714           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25715           required: false
25716           type: string
25717         - name: prov-status
25718           in: query
25719           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25720           required: false
25721           type: string
25722         - name: interface-id
25723           in: query
25724           description: ID of interface
25725           required: false
25726           type: string
25727         - name: macaddr
25728           in: query
25729           description: MAC address for the interface
25730           required: false
25731           type: string
25732         - name: network-name
25733           in: query
25734           description: Name of the network
25735           required: false
25736           type: string
25737   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
25738     put:
25739       tags:
25740         - Network
25741       summary: see node definition for valid relationships
25742       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
25743       consumes:
25744         - application/json
25745         - application/xml
25746       produces:
25747         - application/json
25748         - application/xml
25749       responses:
25750         "default":
25751           description: Response codes found in [response codes](https://wiki.onap.org/).
25752       parameters:
25753         - name: equipment-name
25754           in: path
25755           required: true
25756           type: string
25757           example: __EQUIPMENT-NAME__
25758         - name: interface-name
25759           in: path
25760           description: Name that identifies the physical interface
25761           required: true
25762           type: string
25763           example: __INTERFACE-NAME__
25764         - name: interface-name
25765           in: path
25766           description: Name given to the interface
25767           required: true
25768           type: string
25769           example: __INTERFACE-NAME__
25770         - name: body
25771           in: body
25772           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
25773           required: true
25774           schema:
25775             $ref: "#/definitions/relationship"
25776     delete:
25777       tags:
25778         - Network
25779       summary: delete an existing relationship
25780       description: delete an existing relationship
25781       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
25782       consumes:
25783         - application/json
25784         - application/xml
25785       produces:
25786         - application/json
25787         - application/xml
25788       responses:
25789         "default":
25790           description: Response codes found in [response codes](https://wiki.onap.org/).
25791       parameters:
25792         - name: equipment-name
25793           in: path
25794           required: true
25795           type: string
25796           example: __EQUIPMENT-NAME__
25797         - name: interface-name
25798           in: path
25799           description: Name that identifies the physical interface
25800           required: true
25801           type: string
25802           example: __INTERFACE-NAME__
25803         - name: interface-name
25804           in: path
25805           description: Name given to the interface
25806           required: true
25807           type: string
25808           example: __INTERFACE-NAME__
25809   /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:
25810     put:
25811       tags:
25812         - Network
25813       summary: see node definition for valid relationships
25814       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25815       consumes:
25816         - application/json
25817         - application/xml
25818       produces:
25819         - application/json
25820         - application/xml
25821       responses:
25822         "default":
25823           description: Response codes found in [response codes](https://wiki.onap.org/).
25824       parameters:
25825         - name: equipment-name
25826           in: path
25827           required: true
25828           type: string
25829           example: __EQUIPMENT-NAME__
25830         - name: interface-name
25831           in: path
25832           description: Name that identifies the physical interface
25833           required: true
25834           type: string
25835           example: __INTERFACE-NAME__
25836         - name: interface-name
25837           in: path
25838           description: Name given to the interface
25839           required: true
25840           type: string
25841           example: __INTERFACE-NAME__
25842         - name: l3-interface-ipv4-address
25843           in: path
25844           description: IP address
25845           required: true
25846           type: string
25847           example: __L3-INTERFACE-IPV4-ADDRESS__
25848         - name: body
25849           in: body
25850           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
25851           required: true
25852           schema:
25853             $ref: "#/definitions/relationship"
25854     delete:
25855       tags:
25856         - Network
25857       summary: delete an existing relationship
25858       description: delete an existing relationship
25859       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
25860       consumes:
25861         - application/json
25862         - application/xml
25863       produces:
25864         - application/json
25865         - application/xml
25866       responses:
25867         "default":
25868           description: Response codes found in [response codes](https://wiki.onap.org/).
25869       parameters:
25870         - name: equipment-name
25871           in: path
25872           required: true
25873           type: string
25874           example: __EQUIPMENT-NAME__
25875         - name: interface-name
25876           in: path
25877           description: Name that identifies the physical interface
25878           required: true
25879           type: string
25880           example: __INTERFACE-NAME__
25881         - name: interface-name
25882           in: path
25883           description: Name given to the interface
25884           required: true
25885           type: string
25886           example: __INTERFACE-NAME__
25887         - name: l3-interface-ipv4-address
25888           in: path
25889           description: IP address
25890           required: true
25891           type: string
25892           example: __L3-INTERFACE-IPV4-ADDRESS__
25893   /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}:
25894     get:
25895       tags:
25896         - Network
25897       summary: returns l3-interface-ipv4-address-list
25898       description: returns l3-interface-ipv4-address-list
25899       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25900       produces:
25901         - application/json
25902         - application/xml
25903       responses:
25904         "200":
25905           description: successful operation
25906           schema:
25907               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
25908         "default":
25909           description: Response codes found in [response codes](https://wiki.onap.org/).
25910       parameters:
25911         - name: equipment-name
25912           in: path
25913           required: true
25914           type: string
25915           example: __EQUIPMENT-NAME__
25916         - name: interface-name
25917           in: path
25918           description: Name that identifies the physical interface
25919           required: true
25920           type: string
25921           example: __INTERFACE-NAME__
25922         - name: interface-name
25923           in: path
25924           description: Name given to the interface
25925           required: true
25926           type: string
25927           example: __INTERFACE-NAME__
25928         - name: l3-interface-ipv4-address
25929           in: path
25930           description: IP address
25931           required: true
25932           type: string
25933           example: __L3-INTERFACE-IPV4-ADDRESS__
25934         - name: prov-status
25935           in: query
25936           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
25937           required: false
25938           type: string
25939         - name: prov-status
25940           in: query
25941           description: Trigger for operational monitoring of this resource by Service Assurance systems.
25942           required: false
25943           type: string
25944         - name: interface-id
25945           in: query
25946           description: ID of interface
25947           required: false
25948           type: string
25949         - name: macaddr
25950           in: query
25951           description: MAC address for the interface
25952           required: false
25953           type: string
25954         - name: network-name
25955           in: query
25956           description: Name of the network
25957           required: false
25958           type: string
25959         - name: vlan-id-inner
25960           in: query
25961           description: Inner VLAN tag
25962           required: false
25963           type: integer
25964           format: int64
25965         - name: neutron-network-id
25966           in: query
25967           description: Neutron network id of the interface that address belongs to
25968           required: false
25969           type: string
25970         - name: neutron-subnet-id
25971           in: query
25972           description: Neutron id of subnet that address belongs to
25973           required: false
25974           type: string
25975     put:
25976       tags:
25977         - Network
25978       summary: create or update an existing l3-interface-ipv4-address-list
25979       description: |
25980         Create or update an existing l3-interface-ipv4-address-list.
25981         #
25982         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
25983       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
25984       consumes:
25985         - application/json
25986         - application/xml
25987       produces:
25988         - application/json
25989         - application/xml
25990       responses:
25991         "default":
25992           description: Response codes found in [response codes](https://wiki.onap.org/).
25993       parameters:
25994         - name: equipment-name
25995           in: path
25996           required: true
25997           type: string
25998           example: __EQUIPMENT-NAME__
25999         - name: interface-name
26000           in: path
26001           description: Name that identifies the physical interface
26002           required: true
26003           type: string
26004           example: __INTERFACE-NAME__
26005         - name: interface-name
26006           in: path
26007           description: Name given to the interface
26008           required: true
26009           type: string
26010           example: __INTERFACE-NAME__
26011         - name: l3-interface-ipv4-address
26012           in: path
26013           description: IP address
26014           required: true
26015           type: string
26016           example: __L3-INTERFACE-IPV4-ADDRESS__
26017         - name: body
26018           in: body
26019           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
26020           required: true
26021           schema:
26022             $ref: "#/definitions/l3-interface-ipv4-address-list"
26023     patch:
26024       tags:
26025         - Network
26026       summary: update an existing l3-interface-ipv4-address-list
26027       description: |
26028         Update an existing l3-interface-ipv4-address-list
26029         #
26030         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26031         The PUT operation will entirely replace an existing object.
26032         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26033         #
26034         Other differences between PUT and PATCH are:
26035         #
26036         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26037         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26038         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26039       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26040       consumes:
26041         - application/json
26042         - application/xml
26043       produces:
26044         - application/json
26045         - application/xml
26046       responses:
26047         "default":
26048           description: Response codes found in [response codes](https://wiki.onap.org/).
26049       parameters:
26050         - name: equipment-name
26051           in: path
26052           required: true
26053           type: string
26054           example: __EQUIPMENT-NAME__
26055         - name: interface-name
26056           in: path
26057           description: Name that identifies the physical interface
26058           required: true
26059           type: string
26060           example: __INTERFACE-NAME__
26061         - name: interface-name
26062           in: path
26063           description: Name given to the interface
26064           required: true
26065           type: string
26066           example: __INTERFACE-NAME__
26067         - name: l3-interface-ipv4-address
26068           in: path
26069           description: IP address
26070           required: true
26071           type: string
26072           example: __L3-INTERFACE-IPV4-ADDRESS__
26073         - name: body
26074           in: body
26075           description: l3-interface-ipv4-address-list object that needs to be created or updated.
26076           required: true
26077           schema:
26078             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
26079     delete:
26080       tags:
26081         - Network
26082       summary: delete an existing l3-interface-ipv4-address-list
26083       description: delete an existing l3-interface-ipv4-address-list
26084       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
26085       consumes:
26086         - application/json
26087         - application/xml
26088       produces:
26089         - application/json
26090         - application/xml
26091       responses:
26092         "default":
26093           description: Response codes found in [response codes](https://wiki.onap.org/).
26094       parameters:
26095         - name: equipment-name
26096           in: path
26097           required: true
26098           type: string
26099           example: __EQUIPMENT-NAME__
26100         - name: interface-name
26101           in: path
26102           description: Name that identifies the physical interface
26103           required: true
26104           type: string
26105           example: __INTERFACE-NAME__
26106         - name: interface-name
26107           in: path
26108           description: Name given to the interface
26109           required: true
26110           type: string
26111           example: __INTERFACE-NAME__
26112         - name: l3-interface-ipv4-address
26113           in: path
26114           description: IP address
26115           required: true
26116           type: string
26117           example: __L3-INTERFACE-IPV4-ADDRESS__
26118         - name: resource-version
26119           in: query
26120           description: resource-version for concurrency
26121           required: true
26122           type: string
26123   /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:
26124     put:
26125       tags:
26126         - Network
26127       summary: see node definition for valid relationships
26128       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26129       consumes:
26130         - application/json
26131         - application/xml
26132       produces:
26133         - application/json
26134         - application/xml
26135       responses:
26136         "default":
26137           description: Response codes found in [response codes](https://wiki.onap.org/).
26138       parameters:
26139         - name: equipment-name
26140           in: path
26141           required: true
26142           type: string
26143           example: __EQUIPMENT-NAME__
26144         - name: interface-name
26145           in: path
26146           description: Name that identifies the physical interface
26147           required: true
26148           type: string
26149           example: __INTERFACE-NAME__
26150         - name: interface-name
26151           in: path
26152           description: Name given to the interface
26153           required: true
26154           type: string
26155           example: __INTERFACE-NAME__
26156         - name: l3-interface-ipv6-address
26157           in: path
26158           description: IP address
26159           required: true
26160           type: string
26161           example: __L3-INTERFACE-IPV6-ADDRESS__
26162         - name: body
26163           in: body
26164           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26165           required: true
26166           schema:
26167             $ref: "#/definitions/relationship"
26168     delete:
26169       tags:
26170         - Network
26171       summary: delete an existing relationship
26172       description: delete an existing relationship
26173       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
26174       consumes:
26175         - application/json
26176         - application/xml
26177       produces:
26178         - application/json
26179         - application/xml
26180       responses:
26181         "default":
26182           description: Response codes found in [response codes](https://wiki.onap.org/).
26183       parameters:
26184         - name: equipment-name
26185           in: path
26186           required: true
26187           type: string
26188           example: __EQUIPMENT-NAME__
26189         - name: interface-name
26190           in: path
26191           description: Name that identifies the physical interface
26192           required: true
26193           type: string
26194           example: __INTERFACE-NAME__
26195         - name: interface-name
26196           in: path
26197           description: Name given to the interface
26198           required: true
26199           type: string
26200           example: __INTERFACE-NAME__
26201         - name: l3-interface-ipv6-address
26202           in: path
26203           description: IP address
26204           required: true
26205           type: string
26206           example: __L3-INTERFACE-IPV6-ADDRESS__
26207   /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}:
26208     get:
26209       tags:
26210         - Network
26211       summary: returns l3-interface-ipv6-address-list
26212       description: returns l3-interface-ipv6-address-list
26213       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26214       produces:
26215         - application/json
26216         - application/xml
26217       responses:
26218         "200":
26219           description: successful operation
26220           schema:
26221               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
26222         "default":
26223           description: Response codes found in [response codes](https://wiki.onap.org/).
26224       parameters:
26225         - name: equipment-name
26226           in: path
26227           required: true
26228           type: string
26229           example: __EQUIPMENT-NAME__
26230         - name: interface-name
26231           in: path
26232           description: Name that identifies the physical interface
26233           required: true
26234           type: string
26235           example: __INTERFACE-NAME__
26236         - name: interface-name
26237           in: path
26238           description: Name given to the interface
26239           required: true
26240           type: string
26241           example: __INTERFACE-NAME__
26242         - name: l3-interface-ipv6-address
26243           in: path
26244           description: IP address
26245           required: true
26246           type: string
26247           example: __L3-INTERFACE-IPV6-ADDRESS__
26248         - name: prov-status
26249           in: query
26250           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26251           required: false
26252           type: string
26253         - name: prov-status
26254           in: query
26255           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26256           required: false
26257           type: string
26258         - name: interface-id
26259           in: query
26260           description: ID of interface
26261           required: false
26262           type: string
26263         - name: macaddr
26264           in: query
26265           description: MAC address for the interface
26266           required: false
26267           type: string
26268         - name: network-name
26269           in: query
26270           description: Name of the network
26271           required: false
26272           type: string
26273         - name: vlan-id-inner
26274           in: query
26275           description: Inner VLAN tag
26276           required: false
26277           type: integer
26278           format: int64
26279         - name: neutron-network-id
26280           in: query
26281           description: Neutron network id of the interface that address belongs to
26282           required: false
26283           type: string
26284         - name: neutron-subnet-id
26285           in: query
26286           description: Neutron id of subnet that address belongs to
26287           required: false
26288           type: string
26289     put:
26290       tags:
26291         - Network
26292       summary: create or update an existing l3-interface-ipv6-address-list
26293       description: |
26294         Create or update an existing l3-interface-ipv6-address-list.
26295         #
26296         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26297       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26298       consumes:
26299         - application/json
26300         - application/xml
26301       produces:
26302         - application/json
26303         - application/xml
26304       responses:
26305         "default":
26306           description: Response codes found in [response codes](https://wiki.onap.org/).
26307       parameters:
26308         - name: equipment-name
26309           in: path
26310           required: true
26311           type: string
26312           example: __EQUIPMENT-NAME__
26313         - name: interface-name
26314           in: path
26315           description: Name that identifies the physical interface
26316           required: true
26317           type: string
26318           example: __INTERFACE-NAME__
26319         - name: interface-name
26320           in: path
26321           description: Name given to the interface
26322           required: true
26323           type: string
26324           example: __INTERFACE-NAME__
26325         - name: l3-interface-ipv6-address
26326           in: path
26327           description: IP address
26328           required: true
26329           type: string
26330           example: __L3-INTERFACE-IPV6-ADDRESS__
26331         - name: body
26332           in: body
26333           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
26334           required: true
26335           schema:
26336             $ref: "#/definitions/l3-interface-ipv6-address-list"
26337     patch:
26338       tags:
26339         - Network
26340       summary: update an existing l3-interface-ipv6-address-list
26341       description: |
26342         Update an existing l3-interface-ipv6-address-list
26343         #
26344         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26345         The PUT operation will entirely replace an existing object.
26346         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26347         #
26348         Other differences between PUT and PATCH are:
26349         #
26350         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26351         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26352         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26353       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26354       consumes:
26355         - application/json
26356         - application/xml
26357       produces:
26358         - application/json
26359         - application/xml
26360       responses:
26361         "default":
26362           description: Response codes found in [response codes](https://wiki.onap.org/).
26363       parameters:
26364         - name: equipment-name
26365           in: path
26366           required: true
26367           type: string
26368           example: __EQUIPMENT-NAME__
26369         - name: interface-name
26370           in: path
26371           description: Name that identifies the physical interface
26372           required: true
26373           type: string
26374           example: __INTERFACE-NAME__
26375         - name: interface-name
26376           in: path
26377           description: Name given to the interface
26378           required: true
26379           type: string
26380           example: __INTERFACE-NAME__
26381         - name: l3-interface-ipv6-address
26382           in: path
26383           description: IP address
26384           required: true
26385           type: string
26386           example: __L3-INTERFACE-IPV6-ADDRESS__
26387         - name: body
26388           in: body
26389           description: l3-interface-ipv6-address-list object that needs to be created or updated.
26390           required: true
26391           schema:
26392             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
26393     delete:
26394       tags:
26395         - Network
26396       summary: delete an existing l3-interface-ipv6-address-list
26397       description: delete an existing l3-interface-ipv6-address-list
26398       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
26399       consumes:
26400         - application/json
26401         - application/xml
26402       produces:
26403         - application/json
26404         - application/xml
26405       responses:
26406         "default":
26407           description: Response codes found in [response codes](https://wiki.onap.org/).
26408       parameters:
26409         - name: equipment-name
26410           in: path
26411           required: true
26412           type: string
26413           example: __EQUIPMENT-NAME__
26414         - name: interface-name
26415           in: path
26416           description: Name that identifies the physical interface
26417           required: true
26418           type: string
26419           example: __INTERFACE-NAME__
26420         - name: interface-name
26421           in: path
26422           description: Name given to the interface
26423           required: true
26424           type: string
26425           example: __INTERFACE-NAME__
26426         - name: l3-interface-ipv6-address
26427           in: path
26428           description: IP address
26429           required: true
26430           type: string
26431           example: __L3-INTERFACE-IPV6-ADDRESS__
26432         - name: resource-version
26433           in: query
26434           description: resource-version for concurrency
26435           required: true
26436           type: string
26437   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
26438     get:
26439       tags:
26440         - Network
26441       summary: returns l-interface
26442       description: returns l-interface
26443       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26444       produces:
26445         - application/json
26446         - application/xml
26447       responses:
26448         "200":
26449           description: successful operation
26450           schema:
26451               $ref: "#/getDefinitions/l-interface"
26452         "default":
26453           description: Response codes found in [response codes](https://wiki.onap.org/).
26454       parameters:
26455         - name: equipment-name
26456           in: path
26457           required: true
26458           type: string
26459           example: __EQUIPMENT-NAME__
26460         - name: interface-name
26461           in: path
26462           description: Name that identifies the physical interface
26463           required: true
26464           type: string
26465           example: __INTERFACE-NAME__
26466         - name: interface-name
26467           in: path
26468           description: Name given to the interface
26469           required: true
26470           type: string
26471           example: __INTERFACE-NAME__
26472         - name: prov-status
26473           in: query
26474           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26475           required: false
26476           type: string
26477         - name: prov-status
26478           in: query
26479           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26480           required: false
26481           type: string
26482         - name: interface-id
26483           in: query
26484           description: ID of interface
26485           required: false
26486           type: string
26487         - name: macaddr
26488           in: query
26489           description: MAC address for the interface
26490           required: false
26491           type: string
26492         - name: network-name
26493           in: query
26494           description: Name of the network
26495           required: false
26496           type: string
26497     put:
26498       tags:
26499         - Network
26500       summary: create or update an existing l-interface
26501       description: |
26502         Create or update an existing l-interface.
26503         #
26504         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26505       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26506       consumes:
26507         - application/json
26508         - application/xml
26509       produces:
26510         - application/json
26511         - application/xml
26512       responses:
26513         "default":
26514           description: Response codes found in [response codes](https://wiki.onap.org/).
26515       parameters:
26516         - name: equipment-name
26517           in: path
26518           required: true
26519           type: string
26520           example: __EQUIPMENT-NAME__
26521         - name: interface-name
26522           in: path
26523           description: Name that identifies the physical interface
26524           required: true
26525           type: string
26526           example: __INTERFACE-NAME__
26527         - name: interface-name
26528           in: path
26529           description: Name given to the interface
26530           required: true
26531           type: string
26532           example: __INTERFACE-NAME__
26533         - name: body
26534           in: body
26535           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)
26536           required: true
26537           schema:
26538             $ref: "#/definitions/l-interface"
26539     patch:
26540       tags:
26541         - Network
26542       summary: update an existing l-interface
26543       description: |
26544         Update an existing l-interface
26545         #
26546         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26547         The PUT operation will entirely replace an existing object.
26548         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26549         #
26550         Other differences between PUT and PATCH are:
26551         #
26552         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26553         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26554         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26555       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26556       consumes:
26557         - application/json
26558         - application/xml
26559       produces:
26560         - application/json
26561         - application/xml
26562       responses:
26563         "default":
26564           description: Response codes found in [response codes](https://wiki.onap.org/).
26565       parameters:
26566         - name: equipment-name
26567           in: path
26568           required: true
26569           type: string
26570           example: __EQUIPMENT-NAME__
26571         - name: interface-name
26572           in: path
26573           description: Name that identifies the physical interface
26574           required: true
26575           type: string
26576           example: __INTERFACE-NAME__
26577         - name: interface-name
26578           in: path
26579           description: Name given to the interface
26580           required: true
26581           type: string
26582           example: __INTERFACE-NAME__
26583         - name: body
26584           in: body
26585           description: l-interface object that needs to be created or updated.
26586           required: true
26587           schema:
26588             $ref: "#/patchDefinitions/l-interface"
26589     delete:
26590       tags:
26591         - Network
26592       summary: delete an existing l-interface
26593       description: delete an existing l-interface
26594       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface
26595       consumes:
26596         - application/json
26597         - application/xml
26598       produces:
26599         - application/json
26600         - application/xml
26601       responses:
26602         "default":
26603           description: Response codes found in [response codes](https://wiki.onap.org/).
26604       parameters:
26605         - name: equipment-name
26606           in: path
26607           required: true
26608           type: string
26609           example: __EQUIPMENT-NAME__
26610         - name: interface-name
26611           in: path
26612           description: Name that identifies the physical interface
26613           required: true
26614           type: string
26615           example: __INTERFACE-NAME__
26616         - name: interface-name
26617           in: path
26618           description: Name given to the interface
26619           required: true
26620           type: string
26621           example: __INTERFACE-NAME__
26622         - name: resource-version
26623           in: query
26624           description: resource-version for concurrency
26625           required: true
26626           type: string
26627   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
26628     get:
26629       tags:
26630         - Network
26631       summary: returns l-interfaces
26632       description: returns l-interfaces
26633       operationId: getNetworkVplsPesVplsPePInterfacesPInterfaceLInterfaces
26634       produces:
26635         - application/json
26636         - application/xml
26637       responses:
26638         "200":
26639           description: successful operation
26640           schema:
26641               $ref: "#/getDefinitions/l-interfaces"
26642         "default":
26643           description: Response codes found in [response codes](https://wiki.onap.org/).
26644       parameters:
26645         - name: equipment-name
26646           in: path
26647           required: true
26648           type: string
26649           example: __EQUIPMENT-NAME__
26650         - name: interface-name
26651           in: path
26652           description: Name that identifies the physical interface
26653           required: true
26654           type: string
26655           example: __INTERFACE-NAME__
26656         - name: prov-status
26657           in: query
26658           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26659           required: false
26660           type: string
26661         - name: prov-status
26662           in: query
26663           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26664           required: false
26665           type: string
26666   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}:
26667     get:
26668       tags:
26669         - Network
26670       summary: returns p-interface
26671       description: returns p-interface
26672       operationId: getNetworkVplsPesVplsPePInterfacesPInterface
26673       produces:
26674         - application/json
26675         - application/xml
26676       responses:
26677         "200":
26678           description: successful operation
26679           schema:
26680               $ref: "#/getDefinitions/p-interface"
26681         "default":
26682           description: Response codes found in [response codes](https://wiki.onap.org/).
26683       parameters:
26684         - name: equipment-name
26685           in: path
26686           required: true
26687           type: string
26688           example: __EQUIPMENT-NAME__
26689         - name: interface-name
26690           in: path
26691           description: Name that identifies the physical interface
26692           required: true
26693           type: string
26694           example: __INTERFACE-NAME__
26695         - name: prov-status
26696           in: query
26697           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26698           required: false
26699           type: string
26700         - name: prov-status
26701           in: query
26702           description: Trigger for operational monitoring of this resource by Service Assurance systems.
26703           required: false
26704           type: string
26705     put:
26706       tags:
26707         - Network
26708       summary: create or update an existing p-interface
26709       description: |
26710         Create or update an existing p-interface.
26711         #
26712         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
26713       operationId: createOrUpdateNetworkVplsPesVplsPePInterfacesPInterface
26714       consumes:
26715         - application/json
26716         - application/xml
26717       produces:
26718         - application/json
26719         - application/xml
26720       responses:
26721         "default":
26722           description: Response codes found in [response codes](https://wiki.onap.org/).
26723       parameters:
26724         - name: equipment-name
26725           in: path
26726           required: true
26727           type: string
26728           example: __EQUIPMENT-NAME__
26729         - name: interface-name
26730           in: path
26731           description: Name that identifies the physical interface
26732           required: true
26733           type: string
26734           example: __INTERFACE-NAME__
26735         - name: body
26736           in: body
26737           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)
26738           required: true
26739           schema:
26740             $ref: "#/definitions/p-interface"
26741     patch:
26742       tags:
26743         - Network
26744       summary: update an existing p-interface
26745       description: |
26746         Update an existing p-interface
26747         #
26748         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
26749         The PUT operation will entirely replace an existing object.
26750         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
26751         #
26752         Other differences between PUT and PATCH are:
26753         #
26754         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
26755         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
26756         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
26757       operationId: UpdateNetworkVplsPesVplsPePInterfacesPInterface
26758       consumes:
26759         - application/json
26760         - application/xml
26761       produces:
26762         - application/json
26763         - application/xml
26764       responses:
26765         "default":
26766           description: Response codes found in [response codes](https://wiki.onap.org/).
26767       parameters:
26768         - name: equipment-name
26769           in: path
26770           required: true
26771           type: string
26772           example: __EQUIPMENT-NAME__
26773         - name: interface-name
26774           in: path
26775           description: Name that identifies the physical interface
26776           required: true
26777           type: string
26778           example: __INTERFACE-NAME__
26779         - name: body
26780           in: body
26781           description: p-interface object that needs to be created or updated.
26782           required: true
26783           schema:
26784             $ref: "#/patchDefinitions/p-interface"
26785     delete:
26786       tags:
26787         - Network
26788       summary: delete an existing p-interface
26789       description: delete an existing p-interface
26790       operationId: deleteNetworkVplsPesVplsPePInterfacesPInterface
26791       consumes:
26792         - application/json
26793         - application/xml
26794       produces:
26795         - application/json
26796         - application/xml
26797       responses:
26798         "default":
26799           description: Response codes found in [response codes](https://wiki.onap.org/).
26800       parameters:
26801         - name: equipment-name
26802           in: path
26803           required: true
26804           type: string
26805           example: __EQUIPMENT-NAME__
26806         - name: interface-name
26807           in: path
26808           description: Name that identifies the physical interface
26809           required: true
26810           type: string
26811           example: __INTERFACE-NAME__
26812         - name: resource-version
26813           in: query
26814           description: resource-version for concurrency
26815           required: true
26816           type: string
26817   /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces:
26818     get:
26819       tags:
26820         - Network
26821       summary: returns p-interfaces
26822       description: returns p-interfaces
26823       operationId: getNetworkVplsPesVplsPePInterfaces
26824       produces:
26825         - application/json
26826         - application/xml
26827       responses:
26828         "200":
26829           description: successful operation
26830           schema:
26831               $ref: "#/getDefinitions/p-interfaces"
26832         "default":
26833           description: Response codes found in [response codes](https://wiki.onap.org/).
26834       parameters:
26835         - name: equipment-name
26836           in: path
26837           required: true
26838           type: string
26839           example: __EQUIPMENT-NAME__
26840         - name: prov-status
26841           in: query
26842           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
26843           required: false
26844           type: string
26845   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
26846     put:
26847       tags:
26848         - Network
26849       summary: see node definition for valid relationships
26850       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
26851       consumes:
26852         - application/json
26853         - application/xml
26854       produces:
26855         - application/json
26856         - application/xml
26857       responses:
26858         "default":
26859           description: Response codes found in [response codes](https://wiki.onap.org/).
26860       parameters:
26861         - name: equipment-name
26862           in: path
26863           required: true
26864           type: string
26865           example: __EQUIPMENT-NAME__
26866         - name: interface-name
26867           in: path
26868           description: Name that identifies the link aggregate interface
26869           required: true
26870           type: string
26871           example: __INTERFACE-NAME__
26872         - name: body
26873           in: body
26874           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
26875           required: true
26876           schema:
26877             $ref: "#/definitions/relationship"
26878     delete:
26879       tags:
26880         - Network
26881       summary: delete an existing relationship
26882       description: delete an existing relationship
26883       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceRelationshipListRelationship
26884       consumes:
26885         - application/json
26886         - application/xml
26887       produces:
26888         - application/json
26889         - application/xml
26890       responses:
26891         "default":
26892           description: Response codes found in [response codes](https://wiki.onap.org/).
26893       parameters:
26894         - name: equipment-name
26895           in: path
26896           required: true
26897           type: string
26898           example: __EQUIPMENT-NAME__
26899         - name: interface-name
26900           in: path
26901           description: Name that identifies the link aggregate interface
26902           required: true
26903           type: string
26904           example: __INTERFACE-NAME__
26905   /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:
26906     put:
26907       tags:
26908         - Network
26909       summary: see node definition for valid relationships
26910       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
26911       consumes:
26912         - application/json
26913         - application/xml
26914       produces:
26915         - application/json
26916         - application/xml
26917       responses:
26918         "default":
26919           description: Response codes found in [response codes](https://wiki.onap.org/).
26920       parameters:
26921         - name: equipment-name
26922           in: path
26923           required: true
26924           type: string
26925           example: __EQUIPMENT-NAME__
26926         - name: interface-name
26927           in: path
26928           description: Name that identifies the link aggregate interface
26929           required: true
26930           type: string
26931           example: __INTERFACE-NAME__
26932         - name: interface-name
26933           in: path
26934           description: Name given to the interface
26935           required: true
26936           type: string
26937           example: __INTERFACE-NAME__
26938         - name: vlan-interface
26939           in: path
26940           description: String that identifies the interface
26941           required: true
26942           type: string
26943           example: __VLAN-INTERFACE__
26944         - name: body
26945           in: body
26946           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
26947           required: true
26948           schema:
26949             $ref: "#/definitions/relationship"
26950     delete:
26951       tags:
26952         - Network
26953       summary: delete an existing relationship
26954       description: delete an existing relationship
26955       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
26956       consumes:
26957         - application/json
26958         - application/xml
26959       produces:
26960         - application/json
26961         - application/xml
26962       responses:
26963         "default":
26964           description: Response codes found in [response codes](https://wiki.onap.org/).
26965       parameters:
26966         - name: equipment-name
26967           in: path
26968           required: true
26969           type: string
26970           example: __EQUIPMENT-NAME__
26971         - name: interface-name
26972           in: path
26973           description: Name that identifies the link aggregate interface
26974           required: true
26975           type: string
26976           example: __INTERFACE-NAME__
26977         - name: interface-name
26978           in: path
26979           description: Name given to the interface
26980           required: true
26981           type: string
26982           example: __INTERFACE-NAME__
26983         - name: vlan-interface
26984           in: path
26985           description: String that identifies the interface
26986           required: true
26987           type: string
26988           example: __VLAN-INTERFACE__
26989   /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:
26990     put:
26991       tags:
26992         - Network
26993       summary: see node definition for valid relationships
26994       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
26995       consumes:
26996         - application/json
26997         - application/xml
26998       produces:
26999         - application/json
27000         - application/xml
27001       responses:
27002         "default":
27003           description: Response codes found in [response codes](https://wiki.onap.org/).
27004       parameters:
27005         - name: equipment-name
27006           in: path
27007           required: true
27008           type: string
27009           example: __EQUIPMENT-NAME__
27010         - name: interface-name
27011           in: path
27012           description: Name that identifies the link aggregate interface
27013           required: true
27014           type: string
27015           example: __INTERFACE-NAME__
27016         - name: interface-name
27017           in: path
27018           description: Name given to the interface
27019           required: true
27020           type: string
27021           example: __INTERFACE-NAME__
27022         - name: vlan-interface
27023           in: path
27024           description: String that identifies the interface
27025           required: true
27026           type: string
27027           example: __VLAN-INTERFACE__
27028         - name: l3-interface-ipv4-address
27029           in: path
27030           description: IP address
27031           required: true
27032           type: string
27033           example: __L3-INTERFACE-IPV4-ADDRESS__
27034         - name: body
27035           in: body
27036           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27037           required: true
27038           schema:
27039             $ref: "#/definitions/relationship"
27040     delete:
27041       tags:
27042         - Network
27043       summary: delete an existing relationship
27044       description: delete an existing relationship
27045       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
27046       consumes:
27047         - application/json
27048         - application/xml
27049       produces:
27050         - application/json
27051         - application/xml
27052       responses:
27053         "default":
27054           description: Response codes found in [response codes](https://wiki.onap.org/).
27055       parameters:
27056         - name: equipment-name
27057           in: path
27058           required: true
27059           type: string
27060           example: __EQUIPMENT-NAME__
27061         - name: interface-name
27062           in: path
27063           description: Name that identifies the link aggregate interface
27064           required: true
27065           type: string
27066           example: __INTERFACE-NAME__
27067         - name: interface-name
27068           in: path
27069           description: Name given to the interface
27070           required: true
27071           type: string
27072           example: __INTERFACE-NAME__
27073         - name: vlan-interface
27074           in: path
27075           description: String that identifies the interface
27076           required: true
27077           type: string
27078           example: __VLAN-INTERFACE__
27079         - name: l3-interface-ipv4-address
27080           in: path
27081           description: IP address
27082           required: true
27083           type: string
27084           example: __L3-INTERFACE-IPV4-ADDRESS__
27085   /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}:
27086     get:
27087       tags:
27088         - Network
27089       summary: returns l3-interface-ipv4-address-list
27090       description: returns l3-interface-ipv4-address-list
27091       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27092       produces:
27093         - application/json
27094         - application/xml
27095       responses:
27096         "200":
27097           description: successful operation
27098           schema:
27099               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
27100         "default":
27101           description: Response codes found in [response codes](https://wiki.onap.org/).
27102       parameters:
27103         - name: equipment-name
27104           in: path
27105           required: true
27106           type: string
27107           example: __EQUIPMENT-NAME__
27108         - name: interface-name
27109           in: path
27110           description: Name that identifies the link aggregate interface
27111           required: true
27112           type: string
27113           example: __INTERFACE-NAME__
27114         - name: interface-name
27115           in: path
27116           description: Name given to the interface
27117           required: true
27118           type: string
27119           example: __INTERFACE-NAME__
27120         - name: vlan-interface
27121           in: path
27122           description: String that identifies the interface
27123           required: true
27124           type: string
27125           example: __VLAN-INTERFACE__
27126         - name: l3-interface-ipv4-address
27127           in: path
27128           description: IP address
27129           required: true
27130           type: string
27131           example: __L3-INTERFACE-IPV4-ADDRESS__
27132         - name: prov-status
27133           in: query
27134           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27135           required: false
27136           type: string
27137         - name: interface-id
27138           in: query
27139           description: ID of interface
27140           required: false
27141           type: string
27142         - name: interface-role
27143           in: query
27144           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27145           required: false
27146           type: string
27147         - name: interface-id
27148           in: query
27149           description: ID of interface
27150           required: false
27151           type: string
27152         - name: macaddr
27153           in: query
27154           description: MAC address for the interface
27155           required: false
27156           type: string
27157         - name: network-name
27158           in: query
27159           description: Name of the network
27160           required: false
27161           type: string
27162         - name: vlan-id-inner
27163           in: query
27164           description: Inner VLAN tag
27165           required: false
27166           type: integer
27167           format: int64
27168         - name: vpn-key
27169           in: query
27170           description: This indicates the customers VPN ID associated with this vlan
27171           required: false
27172           type: string
27173         - name: vlan-id-inner
27174           in: query
27175           description: Inner VLAN tag
27176           required: false
27177           type: integer
27178           format: int64
27179         - name: neutron-network-id
27180           in: query
27181           description: Neutron network id of the interface that address belongs to
27182           required: false
27183           type: string
27184         - name: neutron-subnet-id
27185           in: query
27186           description: Neutron id of subnet that address belongs to
27187           required: false
27188           type: string
27189     put:
27190       tags:
27191         - Network
27192       summary: create or update an existing l3-interface-ipv4-address-list
27193       description: |
27194         Create or update an existing l3-interface-ipv4-address-list.
27195         #
27196         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27197       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27198       consumes:
27199         - application/json
27200         - application/xml
27201       produces:
27202         - application/json
27203         - application/xml
27204       responses:
27205         "default":
27206           description: Response codes found in [response codes](https://wiki.onap.org/).
27207       parameters:
27208         - name: equipment-name
27209           in: path
27210           required: true
27211           type: string
27212           example: __EQUIPMENT-NAME__
27213         - name: interface-name
27214           in: path
27215           description: Name that identifies the link aggregate interface
27216           required: true
27217           type: string
27218           example: __INTERFACE-NAME__
27219         - name: interface-name
27220           in: path
27221           description: Name given to the interface
27222           required: true
27223           type: string
27224           example: __INTERFACE-NAME__
27225         - name: vlan-interface
27226           in: path
27227           description: String that identifies the interface
27228           required: true
27229           type: string
27230           example: __VLAN-INTERFACE__
27231         - name: l3-interface-ipv4-address
27232           in: path
27233           description: IP address
27234           required: true
27235           type: string
27236           example: __L3-INTERFACE-IPV4-ADDRESS__
27237         - name: body
27238           in: body
27239           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
27240           required: true
27241           schema:
27242             $ref: "#/definitions/l3-interface-ipv4-address-list"
27243     patch:
27244       tags:
27245         - Network
27246       summary: update an existing l3-interface-ipv4-address-list
27247       description: |
27248         Update an existing l3-interface-ipv4-address-list
27249         #
27250         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27251         The PUT operation will entirely replace an existing object.
27252         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27253         #
27254         Other differences between PUT and PATCH are:
27255         #
27256         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27257         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27258         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27259       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27260       consumes:
27261         - application/json
27262         - application/xml
27263       produces:
27264         - application/json
27265         - application/xml
27266       responses:
27267         "default":
27268           description: Response codes found in [response codes](https://wiki.onap.org/).
27269       parameters:
27270         - name: equipment-name
27271           in: path
27272           required: true
27273           type: string
27274           example: __EQUIPMENT-NAME__
27275         - name: interface-name
27276           in: path
27277           description: Name that identifies the link aggregate interface
27278           required: true
27279           type: string
27280           example: __INTERFACE-NAME__
27281         - name: interface-name
27282           in: path
27283           description: Name given to the interface
27284           required: true
27285           type: string
27286           example: __INTERFACE-NAME__
27287         - name: vlan-interface
27288           in: path
27289           description: String that identifies the interface
27290           required: true
27291           type: string
27292           example: __VLAN-INTERFACE__
27293         - name: l3-interface-ipv4-address
27294           in: path
27295           description: IP address
27296           required: true
27297           type: string
27298           example: __L3-INTERFACE-IPV4-ADDRESS__
27299         - name: body
27300           in: body
27301           description: l3-interface-ipv4-address-list object that needs to be created or updated.
27302           required: true
27303           schema:
27304             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
27305     delete:
27306       tags:
27307         - Network
27308       summary: delete an existing l3-interface-ipv4-address-list
27309       description: delete an existing l3-interface-ipv4-address-list
27310       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
27311       consumes:
27312         - application/json
27313         - application/xml
27314       produces:
27315         - application/json
27316         - application/xml
27317       responses:
27318         "default":
27319           description: Response codes found in [response codes](https://wiki.onap.org/).
27320       parameters:
27321         - name: equipment-name
27322           in: path
27323           required: true
27324           type: string
27325           example: __EQUIPMENT-NAME__
27326         - name: interface-name
27327           in: path
27328           description: Name that identifies the link aggregate interface
27329           required: true
27330           type: string
27331           example: __INTERFACE-NAME__
27332         - name: interface-name
27333           in: path
27334           description: Name given to the interface
27335           required: true
27336           type: string
27337           example: __INTERFACE-NAME__
27338         - name: vlan-interface
27339           in: path
27340           description: String that identifies the interface
27341           required: true
27342           type: string
27343           example: __VLAN-INTERFACE__
27344         - name: l3-interface-ipv4-address
27345           in: path
27346           description: IP address
27347           required: true
27348           type: string
27349           example: __L3-INTERFACE-IPV4-ADDRESS__
27350         - name: resource-version
27351           in: query
27352           description: resource-version for concurrency
27353           required: true
27354           type: string
27355   /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:
27356     put:
27357       tags:
27358         - Network
27359       summary: see node definition for valid relationships
27360       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27361       consumes:
27362         - application/json
27363         - application/xml
27364       produces:
27365         - application/json
27366         - application/xml
27367       responses:
27368         "default":
27369           description: Response codes found in [response codes](https://wiki.onap.org/).
27370       parameters:
27371         - name: equipment-name
27372           in: path
27373           required: true
27374           type: string
27375           example: __EQUIPMENT-NAME__
27376         - name: interface-name
27377           in: path
27378           description: Name that identifies the link aggregate interface
27379           required: true
27380           type: string
27381           example: __INTERFACE-NAME__
27382         - name: interface-name
27383           in: path
27384           description: Name given to the interface
27385           required: true
27386           type: string
27387           example: __INTERFACE-NAME__
27388         - name: vlan-interface
27389           in: path
27390           description: String that identifies the interface
27391           required: true
27392           type: string
27393           example: __VLAN-INTERFACE__
27394         - name: l3-interface-ipv6-address
27395           in: path
27396           description: IP address
27397           required: true
27398           type: string
27399           example: __L3-INTERFACE-IPV6-ADDRESS__
27400         - name: body
27401           in: body
27402           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27403           required: true
27404           schema:
27405             $ref: "#/definitions/relationship"
27406     delete:
27407       tags:
27408         - Network
27409       summary: delete an existing relationship
27410       description: delete an existing relationship
27411       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
27412       consumes:
27413         - application/json
27414         - application/xml
27415       produces:
27416         - application/json
27417         - application/xml
27418       responses:
27419         "default":
27420           description: Response codes found in [response codes](https://wiki.onap.org/).
27421       parameters:
27422         - name: equipment-name
27423           in: path
27424           required: true
27425           type: string
27426           example: __EQUIPMENT-NAME__
27427         - name: interface-name
27428           in: path
27429           description: Name that identifies the link aggregate interface
27430           required: true
27431           type: string
27432           example: __INTERFACE-NAME__
27433         - name: interface-name
27434           in: path
27435           description: Name given to the interface
27436           required: true
27437           type: string
27438           example: __INTERFACE-NAME__
27439         - name: vlan-interface
27440           in: path
27441           description: String that identifies the interface
27442           required: true
27443           type: string
27444           example: __VLAN-INTERFACE__
27445         - name: l3-interface-ipv6-address
27446           in: path
27447           description: IP address
27448           required: true
27449           type: string
27450           example: __L3-INTERFACE-IPV6-ADDRESS__
27451   /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}:
27452     get:
27453       tags:
27454         - Network
27455       summary: returns l3-interface-ipv6-address-list
27456       description: returns l3-interface-ipv6-address-list
27457       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27458       produces:
27459         - application/json
27460         - application/xml
27461       responses:
27462         "200":
27463           description: successful operation
27464           schema:
27465               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
27466         "default":
27467           description: Response codes found in [response codes](https://wiki.onap.org/).
27468       parameters:
27469         - name: equipment-name
27470           in: path
27471           required: true
27472           type: string
27473           example: __EQUIPMENT-NAME__
27474         - name: interface-name
27475           in: path
27476           description: Name that identifies the link aggregate interface
27477           required: true
27478           type: string
27479           example: __INTERFACE-NAME__
27480         - name: interface-name
27481           in: path
27482           description: Name given to the interface
27483           required: true
27484           type: string
27485           example: __INTERFACE-NAME__
27486         - name: vlan-interface
27487           in: path
27488           description: String that identifies the interface
27489           required: true
27490           type: string
27491           example: __VLAN-INTERFACE__
27492         - name: l3-interface-ipv6-address
27493           in: path
27494           description: IP address
27495           required: true
27496           type: string
27497           example: __L3-INTERFACE-IPV6-ADDRESS__
27498         - name: prov-status
27499           in: query
27500           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27501           required: false
27502           type: string
27503         - name: interface-id
27504           in: query
27505           description: ID of interface
27506           required: false
27507           type: string
27508         - name: interface-role
27509           in: query
27510           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27511           required: false
27512           type: string
27513         - name: interface-id
27514           in: query
27515           description: ID of interface
27516           required: false
27517           type: string
27518         - name: macaddr
27519           in: query
27520           description: MAC address for the interface
27521           required: false
27522           type: string
27523         - name: network-name
27524           in: query
27525           description: Name of the network
27526           required: false
27527           type: string
27528         - name: vlan-id-inner
27529           in: query
27530           description: Inner VLAN tag
27531           required: false
27532           type: integer
27533           format: int64
27534         - name: vpn-key
27535           in: query
27536           description: This indicates the customers VPN ID associated with this vlan
27537           required: false
27538           type: string
27539         - name: vlan-id-inner
27540           in: query
27541           description: Inner VLAN tag
27542           required: false
27543           type: integer
27544           format: int64
27545         - name: neutron-network-id
27546           in: query
27547           description: Neutron network id of the interface that address belongs to
27548           required: false
27549           type: string
27550         - name: neutron-subnet-id
27551           in: query
27552           description: Neutron id of subnet that address belongs to
27553           required: false
27554           type: string
27555     put:
27556       tags:
27557         - Network
27558       summary: create or update an existing l3-interface-ipv6-address-list
27559       description: |
27560         Create or update an existing l3-interface-ipv6-address-list.
27561         #
27562         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27563       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27564       consumes:
27565         - application/json
27566         - application/xml
27567       produces:
27568         - application/json
27569         - application/xml
27570       responses:
27571         "default":
27572           description: Response codes found in [response codes](https://wiki.onap.org/).
27573       parameters:
27574         - name: equipment-name
27575           in: path
27576           required: true
27577           type: string
27578           example: __EQUIPMENT-NAME__
27579         - name: interface-name
27580           in: path
27581           description: Name that identifies the link aggregate interface
27582           required: true
27583           type: string
27584           example: __INTERFACE-NAME__
27585         - name: interface-name
27586           in: path
27587           description: Name given to the interface
27588           required: true
27589           type: string
27590           example: __INTERFACE-NAME__
27591         - name: vlan-interface
27592           in: path
27593           description: String that identifies the interface
27594           required: true
27595           type: string
27596           example: __VLAN-INTERFACE__
27597         - name: l3-interface-ipv6-address
27598           in: path
27599           description: IP address
27600           required: true
27601           type: string
27602           example: __L3-INTERFACE-IPV6-ADDRESS__
27603         - name: body
27604           in: body
27605           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
27606           required: true
27607           schema:
27608             $ref: "#/definitions/l3-interface-ipv6-address-list"
27609     patch:
27610       tags:
27611         - Network
27612       summary: update an existing l3-interface-ipv6-address-list
27613       description: |
27614         Update an existing l3-interface-ipv6-address-list
27615         #
27616         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27617         The PUT operation will entirely replace an existing object.
27618         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27619         #
27620         Other differences between PUT and PATCH are:
27621         #
27622         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27623         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27624         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27625       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27626       consumes:
27627         - application/json
27628         - application/xml
27629       produces:
27630         - application/json
27631         - application/xml
27632       responses:
27633         "default":
27634           description: Response codes found in [response codes](https://wiki.onap.org/).
27635       parameters:
27636         - name: equipment-name
27637           in: path
27638           required: true
27639           type: string
27640           example: __EQUIPMENT-NAME__
27641         - name: interface-name
27642           in: path
27643           description: Name that identifies the link aggregate interface
27644           required: true
27645           type: string
27646           example: __INTERFACE-NAME__
27647         - name: interface-name
27648           in: path
27649           description: Name given to the interface
27650           required: true
27651           type: string
27652           example: __INTERFACE-NAME__
27653         - name: vlan-interface
27654           in: path
27655           description: String that identifies the interface
27656           required: true
27657           type: string
27658           example: __VLAN-INTERFACE__
27659         - name: l3-interface-ipv6-address
27660           in: path
27661           description: IP address
27662           required: true
27663           type: string
27664           example: __L3-INTERFACE-IPV6-ADDRESS__
27665         - name: body
27666           in: body
27667           description: l3-interface-ipv6-address-list object that needs to be created or updated.
27668           required: true
27669           schema:
27670             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
27671     delete:
27672       tags:
27673         - Network
27674       summary: delete an existing l3-interface-ipv6-address-list
27675       description: delete an existing l3-interface-ipv6-address-list
27676       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
27677       consumes:
27678         - application/json
27679         - application/xml
27680       produces:
27681         - application/json
27682         - application/xml
27683       responses:
27684         "default":
27685           description: Response codes found in [response codes](https://wiki.onap.org/).
27686       parameters:
27687         - name: equipment-name
27688           in: path
27689           required: true
27690           type: string
27691           example: __EQUIPMENT-NAME__
27692         - name: interface-name
27693           in: path
27694           description: Name that identifies the link aggregate interface
27695           required: true
27696           type: string
27697           example: __INTERFACE-NAME__
27698         - name: interface-name
27699           in: path
27700           description: Name given to the interface
27701           required: true
27702           type: string
27703           example: __INTERFACE-NAME__
27704         - name: vlan-interface
27705           in: path
27706           description: String that identifies the interface
27707           required: true
27708           type: string
27709           example: __VLAN-INTERFACE__
27710         - name: l3-interface-ipv6-address
27711           in: path
27712           description: IP address
27713           required: true
27714           type: string
27715           example: __L3-INTERFACE-IPV6-ADDRESS__
27716         - name: resource-version
27717           in: query
27718           description: resource-version for concurrency
27719           required: true
27720           type: string
27721   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
27722     get:
27723       tags:
27724         - Network
27725       summary: returns vlan
27726       description: returns vlan
27727       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27728       produces:
27729         - application/json
27730         - application/xml
27731       responses:
27732         "200":
27733           description: successful operation
27734           schema:
27735               $ref: "#/getDefinitions/vlan"
27736         "default":
27737           description: Response codes found in [response codes](https://wiki.onap.org/).
27738       parameters:
27739         - name: equipment-name
27740           in: path
27741           required: true
27742           type: string
27743           example: __EQUIPMENT-NAME__
27744         - name: interface-name
27745           in: path
27746           description: Name that identifies the link aggregate interface
27747           required: true
27748           type: string
27749           example: __INTERFACE-NAME__
27750         - name: interface-name
27751           in: path
27752           description: Name given to the interface
27753           required: true
27754           type: string
27755           example: __INTERFACE-NAME__
27756         - name: vlan-interface
27757           in: path
27758           description: String that identifies the interface
27759           required: true
27760           type: string
27761           example: __VLAN-INTERFACE__
27762         - name: prov-status
27763           in: query
27764           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27765           required: false
27766           type: string
27767         - name: interface-id
27768           in: query
27769           description: ID of interface
27770           required: false
27771           type: string
27772         - name: interface-role
27773           in: query
27774           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27775           required: false
27776           type: string
27777         - name: interface-id
27778           in: query
27779           description: ID of interface
27780           required: false
27781           type: string
27782         - name: macaddr
27783           in: query
27784           description: MAC address for the interface
27785           required: false
27786           type: string
27787         - name: network-name
27788           in: query
27789           description: Name of the network
27790           required: false
27791           type: string
27792         - name: vlan-id-inner
27793           in: query
27794           description: Inner VLAN tag
27795           required: false
27796           type: integer
27797           format: int64
27798         - name: vpn-key
27799           in: query
27800           description: This indicates the customers VPN ID associated with this vlan
27801           required: false
27802           type: string
27803     put:
27804       tags:
27805         - Network
27806       summary: create or update an existing vlan
27807       description: |
27808         Create or update an existing vlan.
27809         #
27810         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
27811       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27812       consumes:
27813         - application/json
27814         - application/xml
27815       produces:
27816         - application/json
27817         - application/xml
27818       responses:
27819         "default":
27820           description: Response codes found in [response codes](https://wiki.onap.org/).
27821       parameters:
27822         - name: equipment-name
27823           in: path
27824           required: true
27825           type: string
27826           example: __EQUIPMENT-NAME__
27827         - name: interface-name
27828           in: path
27829           description: Name that identifies the link aggregate interface
27830           required: true
27831           type: string
27832           example: __INTERFACE-NAME__
27833         - name: interface-name
27834           in: path
27835           description: Name given to the interface
27836           required: true
27837           type: string
27838           example: __INTERFACE-NAME__
27839         - name: vlan-interface
27840           in: path
27841           description: String that identifies the interface
27842           required: true
27843           type: string
27844           example: __VLAN-INTERFACE__
27845         - name: body
27846           in: body
27847           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
27848           required: true
27849           schema:
27850             $ref: "#/definitions/vlan"
27851     patch:
27852       tags:
27853         - Network
27854       summary: update an existing vlan
27855       description: |
27856         Update an existing vlan
27857         #
27858         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
27859         The PUT operation will entirely replace an existing object.
27860         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
27861         #
27862         Other differences between PUT and PATCH are:
27863         #
27864         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
27865         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
27866         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
27867       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27868       consumes:
27869         - application/json
27870         - application/xml
27871       produces:
27872         - application/json
27873         - application/xml
27874       responses:
27875         "default":
27876           description: Response codes found in [response codes](https://wiki.onap.org/).
27877       parameters:
27878         - name: equipment-name
27879           in: path
27880           required: true
27881           type: string
27882           example: __EQUIPMENT-NAME__
27883         - name: interface-name
27884           in: path
27885           description: Name that identifies the link aggregate interface
27886           required: true
27887           type: string
27888           example: __INTERFACE-NAME__
27889         - name: interface-name
27890           in: path
27891           description: Name given to the interface
27892           required: true
27893           type: string
27894           example: __INTERFACE-NAME__
27895         - name: vlan-interface
27896           in: path
27897           description: String that identifies the interface
27898           required: true
27899           type: string
27900           example: __VLAN-INTERFACE__
27901         - name: body
27902           in: body
27903           description: vlan object that needs to be created or updated.
27904           required: true
27905           schema:
27906             $ref: "#/patchDefinitions/vlan"
27907     delete:
27908       tags:
27909         - Network
27910       summary: delete an existing vlan
27911       description: delete an existing vlan
27912       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
27913       consumes:
27914         - application/json
27915         - application/xml
27916       produces:
27917         - application/json
27918         - application/xml
27919       responses:
27920         "default":
27921           description: Response codes found in [response codes](https://wiki.onap.org/).
27922       parameters:
27923         - name: equipment-name
27924           in: path
27925           required: true
27926           type: string
27927           example: __EQUIPMENT-NAME__
27928         - name: interface-name
27929           in: path
27930           description: Name that identifies the link aggregate interface
27931           required: true
27932           type: string
27933           example: __INTERFACE-NAME__
27934         - name: interface-name
27935           in: path
27936           description: Name given to the interface
27937           required: true
27938           type: string
27939           example: __INTERFACE-NAME__
27940         - name: vlan-interface
27941           in: path
27942           description: String that identifies the interface
27943           required: true
27944           type: string
27945           example: __VLAN-INTERFACE__
27946         - name: resource-version
27947           in: query
27948           description: resource-version for concurrency
27949           required: true
27950           type: string
27951   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
27952     get:
27953       tags:
27954         - Network
27955       summary: returns vlans
27956       description: returns vlans
27957       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
27958       produces:
27959         - application/json
27960         - application/xml
27961       responses:
27962         "200":
27963           description: successful operation
27964           schema:
27965               $ref: "#/getDefinitions/vlans"
27966         "default":
27967           description: Response codes found in [response codes](https://wiki.onap.org/).
27968       parameters:
27969         - name: equipment-name
27970           in: path
27971           required: true
27972           type: string
27973           example: __EQUIPMENT-NAME__
27974         - name: interface-name
27975           in: path
27976           description: Name that identifies the link aggregate interface
27977           required: true
27978           type: string
27979           example: __INTERFACE-NAME__
27980         - name: interface-name
27981           in: path
27982           description: Name given to the interface
27983           required: true
27984           type: string
27985           example: __INTERFACE-NAME__
27986         - name: prov-status
27987           in: query
27988           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
27989           required: false
27990           type: string
27991         - name: interface-id
27992           in: query
27993           description: ID of interface
27994           required: false
27995           type: string
27996         - name: interface-role
27997           in: query
27998           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
27999           required: false
28000           type: string
28001         - name: interface-id
28002           in: query
28003           description: ID of interface
28004           required: false
28005           type: string
28006         - name: macaddr
28007           in: query
28008           description: MAC address for the interface
28009           required: false
28010           type: string
28011         - name: network-name
28012           in: query
28013           description: Name of the network
28014           required: false
28015           type: string
28016   /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:
28017     put:
28018       tags:
28019         - Network
28020       summary: see node definition for valid relationships
28021       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28022       consumes:
28023         - application/json
28024         - application/xml
28025       produces:
28026         - application/json
28027         - application/xml
28028       responses:
28029         "default":
28030           description: Response codes found in [response codes](https://wiki.onap.org/).
28031       parameters:
28032         - name: equipment-name
28033           in: path
28034           required: true
28035           type: string
28036           example: __EQUIPMENT-NAME__
28037         - name: interface-name
28038           in: path
28039           description: Name that identifies the link aggregate interface
28040           required: true
28041           type: string
28042           example: __INTERFACE-NAME__
28043         - name: interface-name
28044           in: path
28045           description: Name given to the interface
28046           required: true
28047           type: string
28048           example: __INTERFACE-NAME__
28049         - name: pci-id
28050           in: path
28051           description: PCI ID used to identify the sriov-vf
28052           required: true
28053           type: string
28054           example: __PCI-ID__
28055         - name: body
28056           in: body
28057           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28058           required: true
28059           schema:
28060             $ref: "#/definitions/relationship"
28061     delete:
28062       tags:
28063         - Network
28064       summary: delete an existing relationship
28065       description: delete an existing relationship
28066       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
28067       consumes:
28068         - application/json
28069         - application/xml
28070       produces:
28071         - application/json
28072         - application/xml
28073       responses:
28074         "default":
28075           description: Response codes found in [response codes](https://wiki.onap.org/).
28076       parameters:
28077         - name: equipment-name
28078           in: path
28079           required: true
28080           type: string
28081           example: __EQUIPMENT-NAME__
28082         - name: interface-name
28083           in: path
28084           description: Name that identifies the link aggregate interface
28085           required: true
28086           type: string
28087           example: __INTERFACE-NAME__
28088         - name: interface-name
28089           in: path
28090           description: Name given to the interface
28091           required: true
28092           type: string
28093           example: __INTERFACE-NAME__
28094         - name: pci-id
28095           in: path
28096           description: PCI ID used to identify the sriov-vf
28097           required: true
28098           type: string
28099           example: __PCI-ID__
28100   /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}:
28101     get:
28102       tags:
28103         - Network
28104       summary: returns sriov-vf
28105       description: returns sriov-vf
28106       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28107       produces:
28108         - application/json
28109         - application/xml
28110       responses:
28111         "200":
28112           description: successful operation
28113           schema:
28114               $ref: "#/getDefinitions/sriov-vf"
28115         "default":
28116           description: Response codes found in [response codes](https://wiki.onap.org/).
28117       parameters:
28118         - name: equipment-name
28119           in: path
28120           required: true
28121           type: string
28122           example: __EQUIPMENT-NAME__
28123         - name: interface-name
28124           in: path
28125           description: Name that identifies the link aggregate interface
28126           required: true
28127           type: string
28128           example: __INTERFACE-NAME__
28129         - name: interface-name
28130           in: path
28131           description: Name given to the interface
28132           required: true
28133           type: string
28134           example: __INTERFACE-NAME__
28135         - name: pci-id
28136           in: path
28137           description: PCI ID used to identify the sriov-vf
28138           required: true
28139           type: string
28140           example: __PCI-ID__
28141         - name: prov-status
28142           in: query
28143           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28144           required: false
28145           type: string
28146         - name: interface-id
28147           in: query
28148           description: ID of interface
28149           required: false
28150           type: string
28151         - name: interface-role
28152           in: query
28153           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28154           required: false
28155           type: string
28156         - name: interface-id
28157           in: query
28158           description: ID of interface
28159           required: false
28160           type: string
28161         - name: macaddr
28162           in: query
28163           description: MAC address for the interface
28164           required: false
28165           type: string
28166         - name: network-name
28167           in: query
28168           description: Name of the network
28169           required: false
28170           type: string
28171         - name: vf-vlan-filter
28172           in: query
28173           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
28174           required: false
28175           type: string
28176         - name: vf-mac-filter
28177           in: query
28178           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
28179           required: false
28180           type: string
28181         - name: vf-vlan-strip
28182           in: query
28183           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
28184           required: false
28185           type: boolean
28186         - name: neutron-network-id
28187           in: query
28188           description: Neutron network id of the interface
28189           required: false
28190           type: string
28191     put:
28192       tags:
28193         - Network
28194       summary: create or update an existing sriov-vf
28195       description: |
28196         Create or update an existing sriov-vf.
28197         #
28198         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28199       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28200       consumes:
28201         - application/json
28202         - application/xml
28203       produces:
28204         - application/json
28205         - application/xml
28206       responses:
28207         "default":
28208           description: Response codes found in [response codes](https://wiki.onap.org/).
28209       parameters:
28210         - name: equipment-name
28211           in: path
28212           required: true
28213           type: string
28214           example: __EQUIPMENT-NAME__
28215         - name: interface-name
28216           in: path
28217           description: Name that identifies the link aggregate interface
28218           required: true
28219           type: string
28220           example: __INTERFACE-NAME__
28221         - name: interface-name
28222           in: path
28223           description: Name given to the interface
28224           required: true
28225           type: string
28226           example: __INTERFACE-NAME__
28227         - name: pci-id
28228           in: path
28229           description: PCI ID used to identify the sriov-vf
28230           required: true
28231           type: string
28232           example: __PCI-ID__
28233         - name: body
28234           in: body
28235           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
28236           required: true
28237           schema:
28238             $ref: "#/definitions/sriov-vf"
28239     patch:
28240       tags:
28241         - Network
28242       summary: update an existing sriov-vf
28243       description: |
28244         Update an existing sriov-vf
28245         #
28246         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28247         The PUT operation will entirely replace an existing object.
28248         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28249         #
28250         Other differences between PUT and PATCH are:
28251         #
28252         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28253         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28254         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28255       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28256       consumes:
28257         - application/json
28258         - application/xml
28259       produces:
28260         - application/json
28261         - application/xml
28262       responses:
28263         "default":
28264           description: Response codes found in [response codes](https://wiki.onap.org/).
28265       parameters:
28266         - name: equipment-name
28267           in: path
28268           required: true
28269           type: string
28270           example: __EQUIPMENT-NAME__
28271         - name: interface-name
28272           in: path
28273           description: Name that identifies the link aggregate interface
28274           required: true
28275           type: string
28276           example: __INTERFACE-NAME__
28277         - name: interface-name
28278           in: path
28279           description: Name given to the interface
28280           required: true
28281           type: string
28282           example: __INTERFACE-NAME__
28283         - name: pci-id
28284           in: path
28285           description: PCI ID used to identify the sriov-vf
28286           required: true
28287           type: string
28288           example: __PCI-ID__
28289         - name: body
28290           in: body
28291           description: sriov-vf object that needs to be created or updated.
28292           required: true
28293           schema:
28294             $ref: "#/patchDefinitions/sriov-vf"
28295     delete:
28296       tags:
28297         - Network
28298       summary: delete an existing sriov-vf
28299       description: delete an existing sriov-vf
28300       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
28301       consumes:
28302         - application/json
28303         - application/xml
28304       produces:
28305         - application/json
28306         - application/xml
28307       responses:
28308         "default":
28309           description: Response codes found in [response codes](https://wiki.onap.org/).
28310       parameters:
28311         - name: equipment-name
28312           in: path
28313           required: true
28314           type: string
28315           example: __EQUIPMENT-NAME__
28316         - name: interface-name
28317           in: path
28318           description: Name that identifies the link aggregate interface
28319           required: true
28320           type: string
28321           example: __INTERFACE-NAME__
28322         - name: interface-name
28323           in: path
28324           description: Name given to the interface
28325           required: true
28326           type: string
28327           example: __INTERFACE-NAME__
28328         - name: pci-id
28329           in: path
28330           description: PCI ID used to identify the sriov-vf
28331           required: true
28332           type: string
28333           example: __PCI-ID__
28334         - name: resource-version
28335           in: query
28336           description: resource-version for concurrency
28337           required: true
28338           type: string
28339   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
28340     get:
28341       tags:
28342         - Network
28343       summary: returns sriov-vfs
28344       description: returns sriov-vfs
28345       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
28346       produces:
28347         - application/json
28348         - application/xml
28349       responses:
28350         "200":
28351           description: successful operation
28352           schema:
28353               $ref: "#/getDefinitions/sriov-vfs"
28354         "default":
28355           description: Response codes found in [response codes](https://wiki.onap.org/).
28356       parameters:
28357         - name: equipment-name
28358           in: path
28359           required: true
28360           type: string
28361           example: __EQUIPMENT-NAME__
28362         - name: interface-name
28363           in: path
28364           description: Name that identifies the link aggregate interface
28365           required: true
28366           type: string
28367           example: __INTERFACE-NAME__
28368         - name: interface-name
28369           in: path
28370           description: Name given to the interface
28371           required: true
28372           type: string
28373           example: __INTERFACE-NAME__
28374         - name: prov-status
28375           in: query
28376           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28377           required: false
28378           type: string
28379         - name: interface-id
28380           in: query
28381           description: ID of interface
28382           required: false
28383           type: string
28384         - name: interface-role
28385           in: query
28386           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28387           required: false
28388           type: string
28389         - name: interface-id
28390           in: query
28391           description: ID of interface
28392           required: false
28393           type: string
28394         - name: macaddr
28395           in: query
28396           description: MAC address for the interface
28397           required: false
28398           type: string
28399         - name: network-name
28400           in: query
28401           description: Name of the network
28402           required: false
28403           type: string
28404   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
28405     put:
28406       tags:
28407         - Network
28408       summary: see node definition for valid relationships
28409       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28410       consumes:
28411         - application/json
28412         - application/xml
28413       produces:
28414         - application/json
28415         - application/xml
28416       responses:
28417         "default":
28418           description: Response codes found in [response codes](https://wiki.onap.org/).
28419       parameters:
28420         - name: equipment-name
28421           in: path
28422           required: true
28423           type: string
28424           example: __EQUIPMENT-NAME__
28425         - name: interface-name
28426           in: path
28427           description: Name that identifies the link aggregate interface
28428           required: true
28429           type: string
28430           example: __INTERFACE-NAME__
28431         - name: interface-name
28432           in: path
28433           description: Name given to the interface
28434           required: true
28435           type: string
28436           example: __INTERFACE-NAME__
28437         - name: body
28438           in: body
28439           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
28440           required: true
28441           schema:
28442             $ref: "#/definitions/relationship"
28443     delete:
28444       tags:
28445         - Network
28446       summary: delete an existing relationship
28447       description: delete an existing relationship
28448       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
28449       consumes:
28450         - application/json
28451         - application/xml
28452       produces:
28453         - application/json
28454         - application/xml
28455       responses:
28456         "default":
28457           description: Response codes found in [response codes](https://wiki.onap.org/).
28458       parameters:
28459         - name: equipment-name
28460           in: path
28461           required: true
28462           type: string
28463           example: __EQUIPMENT-NAME__
28464         - name: interface-name
28465           in: path
28466           description: Name that identifies the link aggregate interface
28467           required: true
28468           type: string
28469           example: __INTERFACE-NAME__
28470         - name: interface-name
28471           in: path
28472           description: Name given to the interface
28473           required: true
28474           type: string
28475           example: __INTERFACE-NAME__
28476   /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:
28477     put:
28478       tags:
28479         - Network
28480       summary: see node definition for valid relationships
28481       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28482       consumes:
28483         - application/json
28484         - application/xml
28485       produces:
28486         - application/json
28487         - application/xml
28488       responses:
28489         "default":
28490           description: Response codes found in [response codes](https://wiki.onap.org/).
28491       parameters:
28492         - name: equipment-name
28493           in: path
28494           required: true
28495           type: string
28496           example: __EQUIPMENT-NAME__
28497         - name: interface-name
28498           in: path
28499           description: Name that identifies the link aggregate interface
28500           required: true
28501           type: string
28502           example: __INTERFACE-NAME__
28503         - name: interface-name
28504           in: path
28505           description: Name given to the interface
28506           required: true
28507           type: string
28508           example: __INTERFACE-NAME__
28509         - name: l3-interface-ipv4-address
28510           in: path
28511           description: IP address
28512           required: true
28513           type: string
28514           example: __L3-INTERFACE-IPV4-ADDRESS__
28515         - name: body
28516           in: body
28517           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28518           required: true
28519           schema:
28520             $ref: "#/definitions/relationship"
28521     delete:
28522       tags:
28523         - Network
28524       summary: delete an existing relationship
28525       description: delete an existing relationship
28526       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
28527       consumes:
28528         - application/json
28529         - application/xml
28530       produces:
28531         - application/json
28532         - application/xml
28533       responses:
28534         "default":
28535           description: Response codes found in [response codes](https://wiki.onap.org/).
28536       parameters:
28537         - name: equipment-name
28538           in: path
28539           required: true
28540           type: string
28541           example: __EQUIPMENT-NAME__
28542         - name: interface-name
28543           in: path
28544           description: Name that identifies the link aggregate interface
28545           required: true
28546           type: string
28547           example: __INTERFACE-NAME__
28548         - name: interface-name
28549           in: path
28550           description: Name given to the interface
28551           required: true
28552           type: string
28553           example: __INTERFACE-NAME__
28554         - name: l3-interface-ipv4-address
28555           in: path
28556           description: IP address
28557           required: true
28558           type: string
28559           example: __L3-INTERFACE-IPV4-ADDRESS__
28560   /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}:
28561     get:
28562       tags:
28563         - Network
28564       summary: returns l3-interface-ipv4-address-list
28565       description: returns l3-interface-ipv4-address-list
28566       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28567       produces:
28568         - application/json
28569         - application/xml
28570       responses:
28571         "200":
28572           description: successful operation
28573           schema:
28574               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
28575         "default":
28576           description: Response codes found in [response codes](https://wiki.onap.org/).
28577       parameters:
28578         - name: equipment-name
28579           in: path
28580           required: true
28581           type: string
28582           example: __EQUIPMENT-NAME__
28583         - name: interface-name
28584           in: path
28585           description: Name that identifies the link aggregate interface
28586           required: true
28587           type: string
28588           example: __INTERFACE-NAME__
28589         - name: interface-name
28590           in: path
28591           description: Name given to the interface
28592           required: true
28593           type: string
28594           example: __INTERFACE-NAME__
28595         - name: l3-interface-ipv4-address
28596           in: path
28597           description: IP address
28598           required: true
28599           type: string
28600           example: __L3-INTERFACE-IPV4-ADDRESS__
28601         - name: prov-status
28602           in: query
28603           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28604           required: false
28605           type: string
28606         - name: interface-id
28607           in: query
28608           description: ID of interface
28609           required: false
28610           type: string
28611         - name: interface-role
28612           in: query
28613           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28614           required: false
28615           type: string
28616         - name: interface-id
28617           in: query
28618           description: ID of interface
28619           required: false
28620           type: string
28621         - name: macaddr
28622           in: query
28623           description: MAC address for the interface
28624           required: false
28625           type: string
28626         - name: network-name
28627           in: query
28628           description: Name of the network
28629           required: false
28630           type: string
28631         - name: vlan-id-inner
28632           in: query
28633           description: Inner VLAN tag
28634           required: false
28635           type: integer
28636           format: int64
28637         - name: neutron-network-id
28638           in: query
28639           description: Neutron network id of the interface that address belongs to
28640           required: false
28641           type: string
28642         - name: neutron-subnet-id
28643           in: query
28644           description: Neutron id of subnet that address belongs to
28645           required: false
28646           type: string
28647     put:
28648       tags:
28649         - Network
28650       summary: create or update an existing l3-interface-ipv4-address-list
28651       description: |
28652         Create or update an existing l3-interface-ipv4-address-list.
28653         #
28654         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28655       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28656       consumes:
28657         - application/json
28658         - application/xml
28659       produces:
28660         - application/json
28661         - application/xml
28662       responses:
28663         "default":
28664           description: Response codes found in [response codes](https://wiki.onap.org/).
28665       parameters:
28666         - name: equipment-name
28667           in: path
28668           required: true
28669           type: string
28670           example: __EQUIPMENT-NAME__
28671         - name: interface-name
28672           in: path
28673           description: Name that identifies the link aggregate interface
28674           required: true
28675           type: string
28676           example: __INTERFACE-NAME__
28677         - name: interface-name
28678           in: path
28679           description: Name given to the interface
28680           required: true
28681           type: string
28682           example: __INTERFACE-NAME__
28683         - name: l3-interface-ipv4-address
28684           in: path
28685           description: IP address
28686           required: true
28687           type: string
28688           example: __L3-INTERFACE-IPV4-ADDRESS__
28689         - name: body
28690           in: body
28691           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
28692           required: true
28693           schema:
28694             $ref: "#/definitions/l3-interface-ipv4-address-list"
28695     patch:
28696       tags:
28697         - Network
28698       summary: update an existing l3-interface-ipv4-address-list
28699       description: |
28700         Update an existing l3-interface-ipv4-address-list
28701         #
28702         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
28703         The PUT operation will entirely replace an existing object.
28704         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
28705         #
28706         Other differences between PUT and PATCH are:
28707         #
28708         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
28709         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
28710         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
28711       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28712       consumes:
28713         - application/json
28714         - application/xml
28715       produces:
28716         - application/json
28717         - application/xml
28718       responses:
28719         "default":
28720           description: Response codes found in [response codes](https://wiki.onap.org/).
28721       parameters:
28722         - name: equipment-name
28723           in: path
28724           required: true
28725           type: string
28726           example: __EQUIPMENT-NAME__
28727         - name: interface-name
28728           in: path
28729           description: Name that identifies the link aggregate interface
28730           required: true
28731           type: string
28732           example: __INTERFACE-NAME__
28733         - name: interface-name
28734           in: path
28735           description: Name given to the interface
28736           required: true
28737           type: string
28738           example: __INTERFACE-NAME__
28739         - name: l3-interface-ipv4-address
28740           in: path
28741           description: IP address
28742           required: true
28743           type: string
28744           example: __L3-INTERFACE-IPV4-ADDRESS__
28745         - name: body
28746           in: body
28747           description: l3-interface-ipv4-address-list object that needs to be created or updated.
28748           required: true
28749           schema:
28750             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
28751     delete:
28752       tags:
28753         - Network
28754       summary: delete an existing l3-interface-ipv4-address-list
28755       description: delete an existing l3-interface-ipv4-address-list
28756       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
28757       consumes:
28758         - application/json
28759         - application/xml
28760       produces:
28761         - application/json
28762         - application/xml
28763       responses:
28764         "default":
28765           description: Response codes found in [response codes](https://wiki.onap.org/).
28766       parameters:
28767         - name: equipment-name
28768           in: path
28769           required: true
28770           type: string
28771           example: __EQUIPMENT-NAME__
28772         - name: interface-name
28773           in: path
28774           description: Name that identifies the link aggregate interface
28775           required: true
28776           type: string
28777           example: __INTERFACE-NAME__
28778         - name: interface-name
28779           in: path
28780           description: Name given to the interface
28781           required: true
28782           type: string
28783           example: __INTERFACE-NAME__
28784         - name: l3-interface-ipv4-address
28785           in: path
28786           description: IP address
28787           required: true
28788           type: string
28789           example: __L3-INTERFACE-IPV4-ADDRESS__
28790         - name: resource-version
28791           in: query
28792           description: resource-version for concurrency
28793           required: true
28794           type: string
28795   /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:
28796     put:
28797       tags:
28798         - Network
28799       summary: see node definition for valid relationships
28800       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28801       consumes:
28802         - application/json
28803         - application/xml
28804       produces:
28805         - application/json
28806         - application/xml
28807       responses:
28808         "default":
28809           description: Response codes found in [response codes](https://wiki.onap.org/).
28810       parameters:
28811         - name: equipment-name
28812           in: path
28813           required: true
28814           type: string
28815           example: __EQUIPMENT-NAME__
28816         - name: interface-name
28817           in: path
28818           description: Name that identifies the link aggregate interface
28819           required: true
28820           type: string
28821           example: __INTERFACE-NAME__
28822         - name: interface-name
28823           in: path
28824           description: Name given to the interface
28825           required: true
28826           type: string
28827           example: __INTERFACE-NAME__
28828         - name: l3-interface-ipv6-address
28829           in: path
28830           description: IP address
28831           required: true
28832           type: string
28833           example: __L3-INTERFACE-IPV6-ADDRESS__
28834         - name: body
28835           in: body
28836           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
28837           required: true
28838           schema:
28839             $ref: "#/definitions/relationship"
28840     delete:
28841       tags:
28842         - Network
28843       summary: delete an existing relationship
28844       description: delete an existing relationship
28845       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
28846       consumes:
28847         - application/json
28848         - application/xml
28849       produces:
28850         - application/json
28851         - application/xml
28852       responses:
28853         "default":
28854           description: Response codes found in [response codes](https://wiki.onap.org/).
28855       parameters:
28856         - name: equipment-name
28857           in: path
28858           required: true
28859           type: string
28860           example: __EQUIPMENT-NAME__
28861         - name: interface-name
28862           in: path
28863           description: Name that identifies the link aggregate interface
28864           required: true
28865           type: string
28866           example: __INTERFACE-NAME__
28867         - name: interface-name
28868           in: path
28869           description: Name given to the interface
28870           required: true
28871           type: string
28872           example: __INTERFACE-NAME__
28873         - name: l3-interface-ipv6-address
28874           in: path
28875           description: IP address
28876           required: true
28877           type: string
28878           example: __L3-INTERFACE-IPV6-ADDRESS__
28879   /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}:
28880     get:
28881       tags:
28882         - Network
28883       summary: returns l3-interface-ipv6-address-list
28884       description: returns l3-interface-ipv6-address-list
28885       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28886       produces:
28887         - application/json
28888         - application/xml
28889       responses:
28890         "200":
28891           description: successful operation
28892           schema:
28893               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
28894         "default":
28895           description: Response codes found in [response codes](https://wiki.onap.org/).
28896       parameters:
28897         - name: equipment-name
28898           in: path
28899           required: true
28900           type: string
28901           example: __EQUIPMENT-NAME__
28902         - name: interface-name
28903           in: path
28904           description: Name that identifies the link aggregate interface
28905           required: true
28906           type: string
28907           example: __INTERFACE-NAME__
28908         - name: interface-name
28909           in: path
28910           description: Name given to the interface
28911           required: true
28912           type: string
28913           example: __INTERFACE-NAME__
28914         - name: l3-interface-ipv6-address
28915           in: path
28916           description: IP address
28917           required: true
28918           type: string
28919           example: __L3-INTERFACE-IPV6-ADDRESS__
28920         - name: prov-status
28921           in: query
28922           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
28923           required: false
28924           type: string
28925         - name: interface-id
28926           in: query
28927           description: ID of interface
28928           required: false
28929           type: string
28930         - name: interface-role
28931           in: query
28932           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
28933           required: false
28934           type: string
28935         - name: interface-id
28936           in: query
28937           description: ID of interface
28938           required: false
28939           type: string
28940         - name: macaddr
28941           in: query
28942           description: MAC address for the interface
28943           required: false
28944           type: string
28945         - name: network-name
28946           in: query
28947           description: Name of the network
28948           required: false
28949           type: string
28950         - name: vlan-id-inner
28951           in: query
28952           description: Inner VLAN tag
28953           required: false
28954           type: integer
28955           format: int64
28956         - name: neutron-network-id
28957           in: query
28958           description: Neutron network id of the interface that address belongs to
28959           required: false
28960           type: string
28961         - name: neutron-subnet-id
28962           in: query
28963           description: Neutron id of subnet that address belongs to
28964           required: false
28965           type: string
28966     put:
28967       tags:
28968         - Network
28969       summary: create or update an existing l3-interface-ipv6-address-list
28970       description: |
28971         Create or update an existing l3-interface-ipv6-address-list.
28972         #
28973         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
28974       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
28975       consumes:
28976         - application/json
28977         - application/xml
28978       produces:
28979         - application/json
28980         - application/xml
28981       responses:
28982         "default":
28983           description: Response codes found in [response codes](https://wiki.onap.org/).
28984       parameters:
28985         - name: equipment-name
28986           in: path
28987           required: true
28988           type: string
28989           example: __EQUIPMENT-NAME__
28990         - name: interface-name
28991           in: path
28992           description: Name that identifies the link aggregate interface
28993           required: true
28994           type: string
28995           example: __INTERFACE-NAME__
28996         - name: interface-name
28997           in: path
28998           description: Name given to the interface
28999           required: true
29000           type: string
29001           example: __INTERFACE-NAME__
29002         - name: l3-interface-ipv6-address
29003           in: path
29004           description: IP address
29005           required: true
29006           type: string
29007           example: __L3-INTERFACE-IPV6-ADDRESS__
29008         - name: body
29009           in: body
29010           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
29011           required: true
29012           schema:
29013             $ref: "#/definitions/l3-interface-ipv6-address-list"
29014     patch:
29015       tags:
29016         - Network
29017       summary: update an existing l3-interface-ipv6-address-list
29018       description: |
29019         Update an existing l3-interface-ipv6-address-list
29020         #
29021         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29022         The PUT operation will entirely replace an existing object.
29023         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29024         #
29025         Other differences between PUT and PATCH are:
29026         #
29027         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29028         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29029         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29030       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29031       consumes:
29032         - application/json
29033         - application/xml
29034       produces:
29035         - application/json
29036         - application/xml
29037       responses:
29038         "default":
29039           description: Response codes found in [response codes](https://wiki.onap.org/).
29040       parameters:
29041         - name: equipment-name
29042           in: path
29043           required: true
29044           type: string
29045           example: __EQUIPMENT-NAME__
29046         - name: interface-name
29047           in: path
29048           description: Name that identifies the link aggregate interface
29049           required: true
29050           type: string
29051           example: __INTERFACE-NAME__
29052         - name: interface-name
29053           in: path
29054           description: Name given to the interface
29055           required: true
29056           type: string
29057           example: __INTERFACE-NAME__
29058         - name: l3-interface-ipv6-address
29059           in: path
29060           description: IP address
29061           required: true
29062           type: string
29063           example: __L3-INTERFACE-IPV6-ADDRESS__
29064         - name: body
29065           in: body
29066           description: l3-interface-ipv6-address-list object that needs to be created or updated.
29067           required: true
29068           schema:
29069             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
29070     delete:
29071       tags:
29072         - Network
29073       summary: delete an existing l3-interface-ipv6-address-list
29074       description: delete an existing l3-interface-ipv6-address-list
29075       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
29076       consumes:
29077         - application/json
29078         - application/xml
29079       produces:
29080         - application/json
29081         - application/xml
29082       responses:
29083         "default":
29084           description: Response codes found in [response codes](https://wiki.onap.org/).
29085       parameters:
29086         - name: equipment-name
29087           in: path
29088           required: true
29089           type: string
29090           example: __EQUIPMENT-NAME__
29091         - name: interface-name
29092           in: path
29093           description: Name that identifies the link aggregate interface
29094           required: true
29095           type: string
29096           example: __INTERFACE-NAME__
29097         - name: interface-name
29098           in: path
29099           description: Name given to the interface
29100           required: true
29101           type: string
29102           example: __INTERFACE-NAME__
29103         - name: l3-interface-ipv6-address
29104           in: path
29105           description: IP address
29106           required: true
29107           type: string
29108           example: __L3-INTERFACE-IPV6-ADDRESS__
29109         - name: resource-version
29110           in: query
29111           description: resource-version for concurrency
29112           required: true
29113           type: string
29114   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
29115     get:
29116       tags:
29117         - Network
29118       summary: returns l-interface
29119       description: returns l-interface
29120       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29121       produces:
29122         - application/json
29123         - application/xml
29124       responses:
29125         "200":
29126           description: successful operation
29127           schema:
29128               $ref: "#/getDefinitions/l-interface"
29129         "default":
29130           description: Response codes found in [response codes](https://wiki.onap.org/).
29131       parameters:
29132         - name: equipment-name
29133           in: path
29134           required: true
29135           type: string
29136           example: __EQUIPMENT-NAME__
29137         - name: interface-name
29138           in: path
29139           description: Name that identifies the link aggregate interface
29140           required: true
29141           type: string
29142           example: __INTERFACE-NAME__
29143         - name: interface-name
29144           in: path
29145           description: Name given to the interface
29146           required: true
29147           type: string
29148           example: __INTERFACE-NAME__
29149         - name: prov-status
29150           in: query
29151           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29152           required: false
29153           type: string
29154         - name: interface-id
29155           in: query
29156           description: ID of interface
29157           required: false
29158           type: string
29159         - name: interface-role
29160           in: query
29161           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29162           required: false
29163           type: string
29164         - name: interface-id
29165           in: query
29166           description: ID of interface
29167           required: false
29168           type: string
29169         - name: macaddr
29170           in: query
29171           description: MAC address for the interface
29172           required: false
29173           type: string
29174         - name: network-name
29175           in: query
29176           description: Name of the network
29177           required: false
29178           type: string
29179     put:
29180       tags:
29181         - Network
29182       summary: create or update an existing l-interface
29183       description: |
29184         Create or update an existing l-interface.
29185         #
29186         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29187       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29188       consumes:
29189         - application/json
29190         - application/xml
29191       produces:
29192         - application/json
29193         - application/xml
29194       responses:
29195         "default":
29196           description: Response codes found in [response codes](https://wiki.onap.org/).
29197       parameters:
29198         - name: equipment-name
29199           in: path
29200           required: true
29201           type: string
29202           example: __EQUIPMENT-NAME__
29203         - name: interface-name
29204           in: path
29205           description: Name that identifies the link aggregate interface
29206           required: true
29207           type: string
29208           example: __INTERFACE-NAME__
29209         - name: interface-name
29210           in: path
29211           description: Name given to the interface
29212           required: true
29213           type: string
29214           example: __INTERFACE-NAME__
29215         - name: body
29216           in: body
29217           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)
29218           required: true
29219           schema:
29220             $ref: "#/definitions/l-interface"
29221     patch:
29222       tags:
29223         - Network
29224       summary: update an existing l-interface
29225       description: |
29226         Update an existing l-interface
29227         #
29228         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29229         The PUT operation will entirely replace an existing object.
29230         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29231         #
29232         Other differences between PUT and PATCH are:
29233         #
29234         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29235         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29236         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29237       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29238       consumes:
29239         - application/json
29240         - application/xml
29241       produces:
29242         - application/json
29243         - application/xml
29244       responses:
29245         "default":
29246           description: Response codes found in [response codes](https://wiki.onap.org/).
29247       parameters:
29248         - name: equipment-name
29249           in: path
29250           required: true
29251           type: string
29252           example: __EQUIPMENT-NAME__
29253         - name: interface-name
29254           in: path
29255           description: Name that identifies the link aggregate interface
29256           required: true
29257           type: string
29258           example: __INTERFACE-NAME__
29259         - name: interface-name
29260           in: path
29261           description: Name given to the interface
29262           required: true
29263           type: string
29264           example: __INTERFACE-NAME__
29265         - name: body
29266           in: body
29267           description: l-interface object that needs to be created or updated.
29268           required: true
29269           schema:
29270             $ref: "#/patchDefinitions/l-interface"
29271     delete:
29272       tags:
29273         - Network
29274       summary: delete an existing l-interface
29275       description: delete an existing l-interface
29276       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface
29277       consumes:
29278         - application/json
29279         - application/xml
29280       produces:
29281         - application/json
29282         - application/xml
29283       responses:
29284         "default":
29285           description: Response codes found in [response codes](https://wiki.onap.org/).
29286       parameters:
29287         - name: equipment-name
29288           in: path
29289           required: true
29290           type: string
29291           example: __EQUIPMENT-NAME__
29292         - name: interface-name
29293           in: path
29294           description: Name that identifies the link aggregate interface
29295           required: true
29296           type: string
29297           example: __INTERFACE-NAME__
29298         - name: interface-name
29299           in: path
29300           description: Name given to the interface
29301           required: true
29302           type: string
29303           example: __INTERFACE-NAME__
29304         - name: resource-version
29305           in: query
29306           description: resource-version for concurrency
29307           required: true
29308           type: string
29309   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
29310     get:
29311       tags:
29312         - Network
29313       summary: returns l-interfaces
29314       description: returns l-interfaces
29315       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfaces
29316       produces:
29317         - application/json
29318         - application/xml
29319       responses:
29320         "200":
29321           description: successful operation
29322           schema:
29323               $ref: "#/getDefinitions/l-interfaces"
29324         "default":
29325           description: Response codes found in [response codes](https://wiki.onap.org/).
29326       parameters:
29327         - name: equipment-name
29328           in: path
29329           required: true
29330           type: string
29331           example: __EQUIPMENT-NAME__
29332         - name: interface-name
29333           in: path
29334           description: Name that identifies the link aggregate interface
29335           required: true
29336           type: string
29337           example: __INTERFACE-NAME__
29338         - name: prov-status
29339           in: query
29340           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29341           required: false
29342           type: string
29343         - name: interface-id
29344           in: query
29345           description: ID of interface
29346           required: false
29347           type: string
29348         - name: interface-role
29349           in: query
29350           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29351           required: false
29352           type: string
29353   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}:
29354     get:
29355       tags:
29356         - Network
29357       summary: returns lag-interface
29358       description: returns lag-interface
29359       operationId: getNetworkVplsPesVplsPeLagInterfacesLagInterface
29360       produces:
29361         - application/json
29362         - application/xml
29363       responses:
29364         "200":
29365           description: successful operation
29366           schema:
29367               $ref: "#/getDefinitions/lag-interface"
29368         "default":
29369           description: Response codes found in [response codes](https://wiki.onap.org/).
29370       parameters:
29371         - name: equipment-name
29372           in: path
29373           required: true
29374           type: string
29375           example: __EQUIPMENT-NAME__
29376         - name: interface-name
29377           in: path
29378           description: Name that identifies the link aggregate interface
29379           required: true
29380           type: string
29381           example: __INTERFACE-NAME__
29382         - name: prov-status
29383           in: query
29384           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29385           required: false
29386           type: string
29387         - name: interface-id
29388           in: query
29389           description: ID of interface
29390           required: false
29391           type: string
29392         - name: interface-role
29393           in: query
29394           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
29395           required: false
29396           type: string
29397     put:
29398       tags:
29399         - Network
29400       summary: create or update an existing lag-interface
29401       description: |
29402         Create or update an existing lag-interface.
29403         #
29404         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29405       operationId: createOrUpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
29406       consumes:
29407         - application/json
29408         - application/xml
29409       produces:
29410         - application/json
29411         - application/xml
29412       responses:
29413         "default":
29414           description: Response codes found in [response codes](https://wiki.onap.org/).
29415       parameters:
29416         - name: equipment-name
29417           in: path
29418           required: true
29419           type: string
29420           example: __EQUIPMENT-NAME__
29421         - name: interface-name
29422           in: path
29423           description: Name that identifies the link aggregate interface
29424           required: true
29425           type: string
29426           example: __INTERFACE-NAME__
29427         - name: body
29428           in: body
29429           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)
29430           required: true
29431           schema:
29432             $ref: "#/definitions/lag-interface"
29433     patch:
29434       tags:
29435         - Network
29436       summary: update an existing lag-interface
29437       description: |
29438         Update an existing lag-interface
29439         #
29440         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29441         The PUT operation will entirely replace an existing object.
29442         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29443         #
29444         Other differences between PUT and PATCH are:
29445         #
29446         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29447         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29448         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29449       operationId: UpdateNetworkVplsPesVplsPeLagInterfacesLagInterface
29450       consumes:
29451         - application/json
29452         - application/xml
29453       produces:
29454         - application/json
29455         - application/xml
29456       responses:
29457         "default":
29458           description: Response codes found in [response codes](https://wiki.onap.org/).
29459       parameters:
29460         - name: equipment-name
29461           in: path
29462           required: true
29463           type: string
29464           example: __EQUIPMENT-NAME__
29465         - name: interface-name
29466           in: path
29467           description: Name that identifies the link aggregate interface
29468           required: true
29469           type: string
29470           example: __INTERFACE-NAME__
29471         - name: body
29472           in: body
29473           description: lag-interface object that needs to be created or updated.
29474           required: true
29475           schema:
29476             $ref: "#/patchDefinitions/lag-interface"
29477     delete:
29478       tags:
29479         - Network
29480       summary: delete an existing lag-interface
29481       description: delete an existing lag-interface
29482       operationId: deleteNetworkVplsPesVplsPeLagInterfacesLagInterface
29483       consumes:
29484         - application/json
29485         - application/xml
29486       produces:
29487         - application/json
29488         - application/xml
29489       responses:
29490         "default":
29491           description: Response codes found in [response codes](https://wiki.onap.org/).
29492       parameters:
29493         - name: equipment-name
29494           in: path
29495           required: true
29496           type: string
29497           example: __EQUIPMENT-NAME__
29498         - name: interface-name
29499           in: path
29500           description: Name that identifies the link aggregate interface
29501           required: true
29502           type: string
29503           example: __INTERFACE-NAME__
29504         - name: resource-version
29505           in: query
29506           description: resource-version for concurrency
29507           required: true
29508           type: string
29509   /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces:
29510     get:
29511       tags:
29512         - Network
29513       summary: returns lag-interfaces
29514       description: returns lag-interfaces
29515       operationId: getNetworkVplsPesVplsPeLagInterfaces
29516       produces:
29517         - application/json
29518         - application/xml
29519       responses:
29520         "200":
29521           description: successful operation
29522           schema:
29523               $ref: "#/getDefinitions/lag-interfaces"
29524         "default":
29525           description: Response codes found in [response codes](https://wiki.onap.org/).
29526       parameters:
29527         - name: equipment-name
29528           in: path
29529           required: true
29530           type: string
29531           example: __EQUIPMENT-NAME__
29532         - name: prov-status
29533           in: query
29534           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29535           required: false
29536           type: string
29537   /network/vpls-pes/vpls-pe/{equipment-name}:
29538     get:
29539       tags:
29540         - Network
29541       summary: returns vpls-pe
29542       description: returns vpls-pe
29543       operationId: getNetworkVplsPesVplsPe
29544       produces:
29545         - application/json
29546         - application/xml
29547       responses:
29548         "200":
29549           description: successful operation
29550           schema:
29551               $ref: "#/getDefinitions/vpls-pe"
29552         "default":
29553           description: Response codes found in [response codes](https://wiki.onap.org/).
29554       parameters:
29555         - name: equipment-name
29556           in: path
29557           required: true
29558           type: string
29559           example: __EQUIPMENT-NAME__
29560         - name: prov-status
29561           in: query
29562           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
29563           required: false
29564           type: string
29565     put:
29566       tags:
29567         - Network
29568       summary: create or update an existing vpls-pe
29569       description: |
29570         Create or update an existing vpls-pe.
29571         #
29572         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29573       operationId: createOrUpdateNetworkVplsPesVplsPe
29574       consumes:
29575         - application/json
29576         - application/xml
29577       produces:
29578         - application/json
29579         - application/xml
29580       responses:
29581         "default":
29582           description: Response codes found in [response codes](https://wiki.onap.org/).
29583       parameters:
29584         - name: equipment-name
29585           in: path
29586           required: true
29587           type: string
29588           example: __EQUIPMENT-NAME__
29589         - name: body
29590           in: body
29591           description: vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)
29592           required: true
29593           schema:
29594             $ref: "#/definitions/vpls-pe"
29595     patch:
29596       tags:
29597         - Network
29598       summary: update an existing vpls-pe
29599       description: |
29600         Update an existing vpls-pe
29601         #
29602         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29603         The PUT operation will entirely replace an existing object.
29604         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29605         #
29606         Other differences between PUT and PATCH are:
29607         #
29608         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29609         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29610         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29611       operationId: UpdateNetworkVplsPesVplsPe
29612       consumes:
29613         - application/json
29614         - application/xml
29615       produces:
29616         - application/json
29617         - application/xml
29618       responses:
29619         "default":
29620           description: Response codes found in [response codes](https://wiki.onap.org/).
29621       parameters:
29622         - name: equipment-name
29623           in: path
29624           required: true
29625           type: string
29626           example: __EQUIPMENT-NAME__
29627         - name: body
29628           in: body
29629           description: vpls-pe object that needs to be created or updated.
29630           required: true
29631           schema:
29632             $ref: "#/patchDefinitions/vpls-pe"
29633     delete:
29634       tags:
29635         - Network
29636       summary: delete an existing vpls-pe
29637       description: delete an existing vpls-pe
29638       operationId: deleteNetworkVplsPesVplsPe
29639       consumes:
29640         - application/json
29641         - application/xml
29642       produces:
29643         - application/json
29644         - application/xml
29645       responses:
29646         "default":
29647           description: Response codes found in [response codes](https://wiki.onap.org/).
29648       parameters:
29649         - name: equipment-name
29650           in: path
29651           required: true
29652           type: string
29653           example: __EQUIPMENT-NAME__
29654         - name: resource-version
29655           in: query
29656           description: resource-version for concurrency
29657           required: true
29658           type: string
29659   /network/vpls-pes:
29660     get:
29661       tags:
29662         - Network
29663       summary: returns vpls-pes
29664       description: returns vpls-pes
29665       operationId: getNetworkVplsPes
29666       produces:
29667         - application/json
29668         - application/xml
29669       responses:
29670         "200":
29671           description: successful operation
29672           schema:
29673               $ref: "#/getDefinitions/vpls-pes"
29674         "default":
29675           description: Response codes found in [response codes](https://wiki.onap.org/).
29676   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship:
29677     put:
29678       tags:
29679         - Network
29680       summary: see node definition for valid relationships
29681       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
29682       consumes:
29683         - application/json
29684         - application/xml
29685       produces:
29686         - application/json
29687         - application/xml
29688       responses:
29689         "default":
29690           description: Response codes found in [response codes](https://wiki.onap.org/).
29691       parameters:
29692         - name: multicast-configuration-id
29693           in: path
29694           description: Unique id of multicast configuration.
29695           required: true
29696           type: string
29697           example: __MULTICAST-CONFIGURATION-ID__
29698         - name: body
29699           in: body
29700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
29701           required: true
29702           schema:
29703             $ref: "#/definitions/relationship"
29704     delete:
29705       tags:
29706         - Network
29707       summary: delete an existing relationship
29708       description: delete an existing relationship
29709       operationId: deleteNetworkMulticastConfigurationsMulticastConfigurationRelationshipListRelationship
29710       consumes:
29711         - application/json
29712         - application/xml
29713       produces:
29714         - application/json
29715         - application/xml
29716       responses:
29717         "default":
29718           description: Response codes found in [response codes](https://wiki.onap.org/).
29719       parameters:
29720         - name: multicast-configuration-id
29721           in: path
29722           description: Unique id of multicast configuration.
29723           required: true
29724           type: string
29725           example: __MULTICAST-CONFIGURATION-ID__
29726   /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}:
29727     get:
29728       tags:
29729         - Network
29730       summary: returns multicast-configuration
29731       description: returns multicast-configuration
29732       operationId: getNetworkMulticastConfigurationsMulticastConfiguration
29733       produces:
29734         - application/json
29735         - application/xml
29736       responses:
29737         "200":
29738           description: successful operation
29739           schema:
29740               $ref: "#/getDefinitions/multicast-configuration"
29741         "default":
29742           description: Response codes found in [response codes](https://wiki.onap.org/).
29743       parameters:
29744         - name: multicast-configuration-id
29745           in: path
29746           description: Unique id of multicast configuration.
29747           required: true
29748           type: string
29749           example: __MULTICAST-CONFIGURATION-ID__
29750     put:
29751       tags:
29752         - Network
29753       summary: create or update an existing multicast-configuration
29754       description: |
29755         Create or update an existing multicast-configuration.
29756         #
29757         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
29758       operationId: createOrUpdateNetworkMulticastConfigurationsMulticastConfiguration
29759       consumes:
29760         - application/json
29761         - application/xml
29762       produces:
29763         - application/json
29764         - application/xml
29765       responses:
29766         "default":
29767           description: Response codes found in [response codes](https://wiki.onap.org/).
29768       parameters:
29769         - name: multicast-configuration-id
29770           in: path
29771           description: Unique id of multicast configuration.
29772           required: true
29773           type: string
29774           example: __MULTICAST-CONFIGURATION-ID__
29775         - name: body
29776           in: body
29777           description: multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)
29778           required: true
29779           schema:
29780             $ref: "#/definitions/multicast-configuration"
29781     patch:
29782       tags:
29783         - Network
29784       summary: update an existing multicast-configuration
29785       description: |
29786         Update an existing multicast-configuration
29787         #
29788         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
29789         The PUT operation will entirely replace an existing object.
29790         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
29791         #
29792         Other differences between PUT and PATCH are:
29793         #
29794         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
29795         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
29796         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
29797       operationId: UpdateNetworkMulticastConfigurationsMulticastConfiguration
29798       consumes:
29799         - application/json
29800         - application/xml
29801       produces:
29802         - application/json
29803         - application/xml
29804       responses:
29805         "default":
29806           description: Response codes found in [response codes](https://wiki.onap.org/).
29807       parameters:
29808         - name: multicast-configuration-id
29809           in: path
29810           description: Unique id of multicast configuration.
29811           required: true
29812           type: string
29813           example: __MULTICAST-CONFIGURATION-ID__
29814         - name: body
29815           in: body
29816           description: multicast-configuration object that needs to be created or updated.
29817           required: true
29818           schema:
29819             $ref: "#/patchDefinitions/multicast-configuration"
29820     delete:
29821       tags:
29822         - Network
29823       summary: delete an existing multicast-configuration
29824       description: delete an existing multicast-configuration
29825       operationId: deleteNetworkMulticastConfigurationsMulticastConfiguration
29826       consumes:
29827         - application/json
29828         - application/xml
29829       produces:
29830         - application/json
29831         - application/xml
29832       responses:
29833         "default":
29834           description: Response codes found in [response codes](https://wiki.onap.org/).
29835       parameters:
29836         - name: multicast-configuration-id
29837           in: path
29838           description: Unique id of multicast configuration.
29839           required: true
29840           type: string
29841           example: __MULTICAST-CONFIGURATION-ID__
29842         - name: resource-version
29843           in: query
29844           description: resource-version for concurrency
29845           required: true
29846           type: string
29847   /network/multicast-configurations:
29848     get:
29849       tags:
29850         - Network
29851       summary: returns multicast-configurations
29852       description: returns multicast-configurations
29853       operationId: getNetworkMulticastConfigurations
29854       produces:
29855         - application/json
29856         - application/xml
29857       responses:
29858         "200":
29859           description: successful operation
29860           schema:
29861               $ref: "#/getDefinitions/multicast-configurations"
29862         "default":
29863           description: Response codes found in [response codes](https://wiki.onap.org/).
29864   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship:
29865     put:
29866       tags:
29867         - Network
29868       summary: see node definition for valid relationships
29869       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
29870       consumes:
29871         - application/json
29872         - application/xml
29873       produces:
29874         - application/json
29875         - application/xml
29876       responses:
29877         "default":
29878           description: Response codes found in [response codes](https://wiki.onap.org/).
29879       parameters:
29880         - name: vnf-id
29881           in: path
29882           description: Unique id of VNF.  This is unique across the graph.
29883           required: true
29884           type: string
29885           example: __VNF-ID__
29886         - name: interface-id
29887           in: path
29888           description: Unique ID of the interface
29889           required: true
29890           type: string
29891           example: __INTERFACE-ID__
29892         - name: cvlan-tag
29893           in: path
29894           description: See mis-na-virtualization-platform.yang
29895           required: true
29896           type: integer
29897           format: int64
29898           example: __CVLAN-TAG__
29899         - name: body
29900           in: body
29901           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
29902           required: true
29903           schema:
29904             $ref: "#/definitions/relationship"
29905     delete:
29906       tags:
29907         - Network
29908       summary: delete an existing relationship
29909       description: delete an existing relationship
29910       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntryRelationshipListRelationship
29911       consumes:
29912         - application/json
29913         - application/xml
29914       produces:
29915         - application/json
29916         - application/xml
29917       responses:
29918         "default":
29919           description: Response codes found in [response codes](https://wiki.onap.org/).
29920       parameters:
29921         - name: vnf-id
29922           in: path
29923           description: Unique id of VNF.  This is unique across the graph.
29924           required: true
29925           type: string
29926           example: __VNF-ID__
29927         - name: interface-id
29928           in: path
29929           description: Unique ID of the interface
29930           required: true
29931           type: string
29932           example: __INTERFACE-ID__
29933         - name: cvlan-tag
29934           in: path
29935           description: See mis-na-virtualization-platform.yang
29936           required: true
29937           type: integer
29938           format: int64
29939           example: __CVLAN-TAG__
29940   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}:
29941     get:
29942       tags:
29943         - Network
29944       summary: returns cvlan-tag-entry
29945       description: returns cvlan-tag-entry
29946       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
29947       produces:
29948         - application/json
29949         - application/xml
29950       responses:
29951         "200":
29952           description: successful operation
29953           schema:
29954               $ref: "#/getDefinitions/cvlan-tag-entry"
29955         "default":
29956           description: Response codes found in [response codes](https://wiki.onap.org/).
29957       parameters:
29958         - name: vnf-id
29959           in: path
29960           description: Unique id of VNF.  This is unique across the graph.
29961           required: true
29962           type: string
29963           example: __VNF-ID__
29964         - name: interface-id
29965           in: path
29966           description: Unique ID of the interface
29967           required: true
29968           type: string
29969           example: __INTERFACE-ID__
29970         - name: cvlan-tag
29971           in: path
29972           description: See mis-na-virtualization-platform.yang
29973           required: true
29974           type: integer
29975           format: int64
29976           example: __CVLAN-TAG__
29977         - name: vnf-name
29978           in: query
29979           description: Name of VNF.
29980           required: false
29981           type: string
29982         - name: vnf-name2
29983           in: query
29984           description: Alternate name of VNF.
29985           required: false
29986           type: string
29987         - name: vnf-type
29988           in: query
29989           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.
29990           required: false
29991           type: string
29992         - name: service-id
29993           in: query
29994           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
29995           required: false
29996           type: string
29997         - name: regional-resource-zone
29998           in: query
29999           description: Regional way of organizing pservers, source of truth should define values
30000           required: false
30001           type: string
30002         - name: prov-status
30003           in: query
30004           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30005           required: false
30006           type: string
30007         - name: heat-stack-id
30008           in: query
30009           description: Heat stack id corresponding to this instance, managed by MSO
30010           required: false
30011           type: string
30012         - name: vpe-id
30013           in: query
30014           description: Unique ID of VPE connected to this VCE.
30015           required: false
30016           type: string
30017         - name: port-group-id
30018           in: query
30019           description: Unique ID for port group in vmware
30020           required: false
30021           type: string
30022         - name: switch-name
30023           in: query
30024           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30025           required: false
30026           type: string
30027         - name: heat-stack-id
30028           in: query
30029           description: Heat stack id corresponding to this instance, managed by MSO
30030           required: false
30031           type: string
30032     put:
30033       tags:
30034         - Network
30035       summary: create or update an existing cvlan-tag-entry
30036       description: |
30037         Create or update an existing cvlan-tag-entry.
30038         #
30039         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30040       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30041       consumes:
30042         - application/json
30043         - application/xml
30044       produces:
30045         - application/json
30046         - application/xml
30047       responses:
30048         "default":
30049           description: Response codes found in [response codes](https://wiki.onap.org/).
30050       parameters:
30051         - name: vnf-id
30052           in: path
30053           description: Unique id of VNF.  This is unique across the graph.
30054           required: true
30055           type: string
30056           example: __VNF-ID__
30057         - name: interface-id
30058           in: path
30059           description: Unique ID of the interface
30060           required: true
30061           type: string
30062           example: __INTERFACE-ID__
30063         - name: cvlan-tag
30064           in: path
30065           description: See mis-na-virtualization-platform.yang
30066           required: true
30067           type: integer
30068           format: int64
30069           example: __CVLAN-TAG__
30070         - name: body
30071           in: body
30072           description: cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)
30073           required: true
30074           schema:
30075             $ref: "#/definitions/cvlan-tag-entry"
30076     patch:
30077       tags:
30078         - Network
30079       summary: update an existing cvlan-tag-entry
30080       description: |
30081         Update an existing cvlan-tag-entry
30082         #
30083         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30084         The PUT operation will entirely replace an existing object.
30085         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30086         #
30087         Other differences between PUT and PATCH are:
30088         #
30089         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30090         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30091         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30092       operationId: UpdateNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30093       consumes:
30094         - application/json
30095         - application/xml
30096       produces:
30097         - application/json
30098         - application/xml
30099       responses:
30100         "default":
30101           description: Response codes found in [response codes](https://wiki.onap.org/).
30102       parameters:
30103         - name: vnf-id
30104           in: path
30105           description: Unique id of VNF.  This is unique across the graph.
30106           required: true
30107           type: string
30108           example: __VNF-ID__
30109         - name: interface-id
30110           in: path
30111           description: Unique ID of the interface
30112           required: true
30113           type: string
30114           example: __INTERFACE-ID__
30115         - name: cvlan-tag
30116           in: path
30117           description: See mis-na-virtualization-platform.yang
30118           required: true
30119           type: integer
30120           format: int64
30121           example: __CVLAN-TAG__
30122         - name: body
30123           in: body
30124           description: cvlan-tag-entry object that needs to be created or updated.
30125           required: true
30126           schema:
30127             $ref: "#/patchDefinitions/cvlan-tag-entry"
30128     delete:
30129       tags:
30130         - Network
30131       summary: delete an existing cvlan-tag-entry
30132       description: delete an existing cvlan-tag-entry
30133       operationId: deleteNetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry
30134       consumes:
30135         - application/json
30136         - application/xml
30137       produces:
30138         - application/json
30139         - application/xml
30140       responses:
30141         "default":
30142           description: Response codes found in [response codes](https://wiki.onap.org/).
30143       parameters:
30144         - name: vnf-id
30145           in: path
30146           description: Unique id of VNF.  This is unique across the graph.
30147           required: true
30148           type: string
30149           example: __VNF-ID__
30150         - name: interface-id
30151           in: path
30152           description: Unique ID of the interface
30153           required: true
30154           type: string
30155           example: __INTERFACE-ID__
30156         - name: cvlan-tag
30157           in: path
30158           description: See mis-na-virtualization-platform.yang
30159           required: true
30160           type: integer
30161           format: int64
30162           example: __CVLAN-TAG__
30163         - name: resource-version
30164           in: query
30165           description: resource-version for concurrency
30166           required: true
30167           type: string
30168   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags:
30169     get:
30170       tags:
30171         - Network
30172       summary: returns cvlan-tags
30173       description: returns cvlan-tags
30174       operationId: getNetworkVcesVcePortGroupsPortGroupCvlanTags
30175       produces:
30176         - application/json
30177         - application/xml
30178       responses:
30179         "200":
30180           description: successful operation
30181           schema:
30182               $ref: "#/getDefinitions/cvlan-tags"
30183         "default":
30184           description: Response codes found in [response codes](https://wiki.onap.org/).
30185       parameters:
30186         - name: vnf-id
30187           in: path
30188           description: Unique id of VNF.  This is unique across the graph.
30189           required: true
30190           type: string
30191           example: __VNF-ID__
30192         - name: interface-id
30193           in: path
30194           description: Unique ID of the interface
30195           required: true
30196           type: string
30197           example: __INTERFACE-ID__
30198         - name: vnf-name
30199           in: query
30200           description: Name of VNF.
30201           required: false
30202           type: string
30203         - name: vnf-name2
30204           in: query
30205           description: Alternate name of VNF.
30206           required: false
30207           type: string
30208         - name: vnf-type
30209           in: query
30210           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.
30211           required: false
30212           type: string
30213         - name: service-id
30214           in: query
30215           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30216           required: false
30217           type: string
30218         - name: regional-resource-zone
30219           in: query
30220           description: Regional way of organizing pservers, source of truth should define values
30221           required: false
30222           type: string
30223         - name: prov-status
30224           in: query
30225           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30226           required: false
30227           type: string
30228         - name: heat-stack-id
30229           in: query
30230           description: Heat stack id corresponding to this instance, managed by MSO
30231           required: false
30232           type: string
30233         - name: vpe-id
30234           in: query
30235           description: Unique ID of VPE connected to this VCE.
30236           required: false
30237           type: string
30238         - name: port-group-id
30239           in: query
30240           description: Unique ID for port group in vmware
30241           required: false
30242           type: string
30243         - name: switch-name
30244           in: query
30245           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30246           required: false
30247           type: string
30248         - name: heat-stack-id
30249           in: query
30250           description: Heat stack id corresponding to this instance, managed by MSO
30251           required: false
30252           type: string
30253   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship:
30254     put:
30255       tags:
30256         - Network
30257       summary: see node definition for valid relationships
30258       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
30259       consumes:
30260         - application/json
30261         - application/xml
30262       produces:
30263         - application/json
30264         - application/xml
30265       responses:
30266         "default":
30267           description: Response codes found in [response codes](https://wiki.onap.org/).
30268       parameters:
30269         - name: vnf-id
30270           in: path
30271           description: Unique id of VNF.  This is unique across the graph.
30272           required: true
30273           type: string
30274           example: __VNF-ID__
30275         - name: interface-id
30276           in: path
30277           description: Unique ID of the interface
30278           required: true
30279           type: string
30280           example: __INTERFACE-ID__
30281         - name: body
30282           in: body
30283           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
30284           required: true
30285           schema:
30286             $ref: "#/definitions/relationship"
30287     delete:
30288       tags:
30289         - Network
30290       summary: delete an existing relationship
30291       description: delete an existing relationship
30292       operationId: deleteNetworkVcesVcePortGroupsPortGroupRelationshipListRelationship
30293       consumes:
30294         - application/json
30295         - application/xml
30296       produces:
30297         - application/json
30298         - application/xml
30299       responses:
30300         "default":
30301           description: Response codes found in [response codes](https://wiki.onap.org/).
30302       parameters:
30303         - name: vnf-id
30304           in: path
30305           description: Unique id of VNF.  This is unique across the graph.
30306           required: true
30307           type: string
30308           example: __VNF-ID__
30309         - name: interface-id
30310           in: path
30311           description: Unique ID of the interface
30312           required: true
30313           type: string
30314           example: __INTERFACE-ID__
30315   /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}:
30316     get:
30317       tags:
30318         - Network
30319       summary: returns port-group
30320       description: returns port-group
30321       operationId: getNetworkVcesVcePortGroupsPortGroup
30322       produces:
30323         - application/json
30324         - application/xml
30325       responses:
30326         "200":
30327           description: successful operation
30328           schema:
30329               $ref: "#/getDefinitions/port-group"
30330         "default":
30331           description: Response codes found in [response codes](https://wiki.onap.org/).
30332       parameters:
30333         - name: vnf-id
30334           in: path
30335           description: Unique id of VNF.  This is unique across the graph.
30336           required: true
30337           type: string
30338           example: __VNF-ID__
30339         - name: interface-id
30340           in: path
30341           description: Unique ID of the interface
30342           required: true
30343           type: string
30344           example: __INTERFACE-ID__
30345         - name: vnf-name
30346           in: query
30347           description: Name of VNF.
30348           required: false
30349           type: string
30350         - name: vnf-name2
30351           in: query
30352           description: Alternate name of VNF.
30353           required: false
30354           type: string
30355         - name: vnf-type
30356           in: query
30357           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.
30358           required: false
30359           type: string
30360         - name: service-id
30361           in: query
30362           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30363           required: false
30364           type: string
30365         - name: regional-resource-zone
30366           in: query
30367           description: Regional way of organizing pservers, source of truth should define values
30368           required: false
30369           type: string
30370         - name: prov-status
30371           in: query
30372           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30373           required: false
30374           type: string
30375         - name: heat-stack-id
30376           in: query
30377           description: Heat stack id corresponding to this instance, managed by MSO
30378           required: false
30379           type: string
30380         - name: vpe-id
30381           in: query
30382           description: Unique ID of VPE connected to this VCE.
30383           required: false
30384           type: string
30385         - name: port-group-id
30386           in: query
30387           description: Unique ID for port group in vmware
30388           required: false
30389           type: string
30390         - name: switch-name
30391           in: query
30392           description: DVS or standard switch name (should be non-null for port groups associated with DVS)
30393           required: false
30394           type: string
30395         - name: heat-stack-id
30396           in: query
30397           description: Heat stack id corresponding to this instance, managed by MSO
30398           required: false
30399           type: string
30400     put:
30401       tags:
30402         - Network
30403       summary: create or update an existing port-group
30404       description: |
30405         Create or update an existing port-group.
30406         #
30407         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30408       operationId: createOrUpdateNetworkVcesVcePortGroupsPortGroup
30409       consumes:
30410         - application/json
30411         - application/xml
30412       produces:
30413         - application/json
30414         - application/xml
30415       responses:
30416         "default":
30417           description: Response codes found in [response codes](https://wiki.onap.org/).
30418       parameters:
30419         - name: vnf-id
30420           in: path
30421           description: Unique id of VNF.  This is unique across the graph.
30422           required: true
30423           type: string
30424           example: __VNF-ID__
30425         - name: interface-id
30426           in: path
30427           description: Unique ID of the interface
30428           required: true
30429           type: string
30430           example: __INTERFACE-ID__
30431         - name: body
30432           in: body
30433           description: port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)
30434           required: true
30435           schema:
30436             $ref: "#/definitions/port-group"
30437     patch:
30438       tags:
30439         - Network
30440       summary: update an existing port-group
30441       description: |
30442         Update an existing port-group
30443         #
30444         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30445         The PUT operation will entirely replace an existing object.
30446         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30447         #
30448         Other differences between PUT and PATCH are:
30449         #
30450         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30451         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30452         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30453       operationId: UpdateNetworkVcesVcePortGroupsPortGroup
30454       consumes:
30455         - application/json
30456         - application/xml
30457       produces:
30458         - application/json
30459         - application/xml
30460       responses:
30461         "default":
30462           description: Response codes found in [response codes](https://wiki.onap.org/).
30463       parameters:
30464         - name: vnf-id
30465           in: path
30466           description: Unique id of VNF.  This is unique across the graph.
30467           required: true
30468           type: string
30469           example: __VNF-ID__
30470         - name: interface-id
30471           in: path
30472           description: Unique ID of the interface
30473           required: true
30474           type: string
30475           example: __INTERFACE-ID__
30476         - name: body
30477           in: body
30478           description: port-group object that needs to be created or updated.
30479           required: true
30480           schema:
30481             $ref: "#/patchDefinitions/port-group"
30482     delete:
30483       tags:
30484         - Network
30485       summary: delete an existing port-group
30486       description: delete an existing port-group
30487       operationId: deleteNetworkVcesVcePortGroupsPortGroup
30488       consumes:
30489         - application/json
30490         - application/xml
30491       produces:
30492         - application/json
30493         - application/xml
30494       responses:
30495         "default":
30496           description: Response codes found in [response codes](https://wiki.onap.org/).
30497       parameters:
30498         - name: vnf-id
30499           in: path
30500           description: Unique id of VNF.  This is unique across the graph.
30501           required: true
30502           type: string
30503           example: __VNF-ID__
30504         - name: interface-id
30505           in: path
30506           description: Unique ID of the interface
30507           required: true
30508           type: string
30509           example: __INTERFACE-ID__
30510         - name: resource-version
30511           in: query
30512           description: resource-version for concurrency
30513           required: true
30514           type: string
30515   /network/vces/vce/{vnf-id}/port-groups:
30516     get:
30517       tags:
30518         - Network
30519       summary: returns port-groups
30520       description: returns port-groups
30521       operationId: getNetworkVcesVcePortGroups
30522       produces:
30523         - application/json
30524         - application/xml
30525       responses:
30526         "200":
30527           description: successful operation
30528           schema:
30529               $ref: "#/getDefinitions/port-groups"
30530         "default":
30531           description: Response codes found in [response codes](https://wiki.onap.org/).
30532       parameters:
30533         - name: vnf-id
30534           in: path
30535           description: Unique id of VNF.  This is unique across the graph.
30536           required: true
30537           type: string
30538           example: __VNF-ID__
30539         - name: vnf-name
30540           in: query
30541           description: Name of VNF.
30542           required: false
30543           type: string
30544         - name: vnf-name2
30545           in: query
30546           description: Alternate name of VNF.
30547           required: false
30548           type: string
30549         - name: vnf-type
30550           in: query
30551           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.
30552           required: false
30553           type: string
30554         - name: service-id
30555           in: query
30556           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30557           required: false
30558           type: string
30559         - name: regional-resource-zone
30560           in: query
30561           description: Regional way of organizing pservers, source of truth should define values
30562           required: false
30563           type: string
30564         - name: prov-status
30565           in: query
30566           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30567           required: false
30568           type: string
30569         - name: heat-stack-id
30570           in: query
30571           description: Heat stack id corresponding to this instance, managed by MSO
30572           required: false
30573           type: string
30574         - name: vpe-id
30575           in: query
30576           description: Unique ID of VPE connected to this VCE.
30577           required: false
30578           type: string
30579   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
30580     put:
30581       tags:
30582         - Network
30583       summary: see node definition for valid relationships
30584       operationId: createOrUpdateNetworkVcesVceLicensesLicenseRelationshipListRelationship
30585       consumes:
30586         - application/json
30587         - application/xml
30588       produces:
30589         - application/json
30590         - application/xml
30591       responses:
30592         "default":
30593           description: Response codes found in [response codes](https://wiki.onap.org/).
30594       parameters:
30595         - name: vnf-id
30596           in: path
30597           description: Unique id of VNF.  This is unique across the graph.
30598           required: true
30599           type: string
30600           example: __VNF-ID__
30601         - name: group-uuid
30602           in: path
30603           description: Unique ID for the license group the resource belongs to, should be uuid.
30604           required: true
30605           type: string
30606           example: __GROUP-UUID__
30607         - name: resource-uuid
30608           in: path
30609           description: Unique ID of a license resource.
30610           required: true
30611           type: string
30612           example: __RESOURCE-UUID__
30613         - name: body
30614           in: body
30615           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
30616           required: true
30617           schema:
30618             $ref: "#/definitions/relationship"
30619     delete:
30620       tags:
30621         - Network
30622       summary: delete an existing relationship
30623       description: delete an existing relationship
30624       operationId: deleteNetworkVcesVceLicensesLicenseRelationshipListRelationship
30625       consumes:
30626         - application/json
30627         - application/xml
30628       produces:
30629         - application/json
30630         - application/xml
30631       responses:
30632         "default":
30633           description: Response codes found in [response codes](https://wiki.onap.org/).
30634       parameters:
30635         - name: vnf-id
30636           in: path
30637           description: Unique id of VNF.  This is unique across the graph.
30638           required: true
30639           type: string
30640           example: __VNF-ID__
30641         - name: group-uuid
30642           in: path
30643           description: Unique ID for the license group the resource belongs to, should be uuid.
30644           required: true
30645           type: string
30646           example: __GROUP-UUID__
30647         - name: resource-uuid
30648           in: path
30649           description: Unique ID of a license resource.
30650           required: true
30651           type: string
30652           example: __RESOURCE-UUID__
30653   /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
30654     get:
30655       tags:
30656         - Network
30657       summary: returns license
30658       description: returns license
30659       operationId: getNetworkVcesVceLicensesLicense
30660       produces:
30661         - application/json
30662         - application/xml
30663       responses:
30664         "200":
30665           description: successful operation
30666           schema:
30667               $ref: "#/getDefinitions/license"
30668         "default":
30669           description: Response codes found in [response codes](https://wiki.onap.org/).
30670       parameters:
30671         - name: vnf-id
30672           in: path
30673           description: Unique id of VNF.  This is unique across the graph.
30674           required: true
30675           type: string
30676           example: __VNF-ID__
30677         - name: group-uuid
30678           in: path
30679           description: Unique ID for the license group the resource belongs to, should be uuid.
30680           required: true
30681           type: string
30682           example: __GROUP-UUID__
30683         - name: resource-uuid
30684           in: path
30685           description: Unique ID of a license resource.
30686           required: true
30687           type: string
30688           example: __RESOURCE-UUID__
30689         - name: vnf-name
30690           in: query
30691           description: Name of VNF.
30692           required: false
30693           type: string
30694         - name: vnf-name2
30695           in: query
30696           description: Alternate name of VNF.
30697           required: false
30698           type: string
30699         - name: vnf-type
30700           in: query
30701           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.
30702           required: false
30703           type: string
30704         - name: service-id
30705           in: query
30706           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30707           required: false
30708           type: string
30709         - name: regional-resource-zone
30710           in: query
30711           description: Regional way of organizing pservers, source of truth should define values
30712           required: false
30713           type: string
30714         - name: prov-status
30715           in: query
30716           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30717           required: false
30718           type: string
30719         - name: heat-stack-id
30720           in: query
30721           description: Heat stack id corresponding to this instance, managed by MSO
30722           required: false
30723           type: string
30724         - name: vpe-id
30725           in: query
30726           description: Unique ID of VPE connected to this VCE.
30727           required: false
30728           type: string
30729     put:
30730       tags:
30731         - Network
30732       summary: create or update an existing license
30733       description: |
30734         Create or update an existing license.
30735         #
30736         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
30737       operationId: createOrUpdateNetworkVcesVceLicensesLicense
30738       consumes:
30739         - application/json
30740         - application/xml
30741       produces:
30742         - application/json
30743         - application/xml
30744       responses:
30745         "default":
30746           description: Response codes found in [response codes](https://wiki.onap.org/).
30747       parameters:
30748         - name: vnf-id
30749           in: path
30750           description: Unique id of VNF.  This is unique across the graph.
30751           required: true
30752           type: string
30753           example: __VNF-ID__
30754         - name: group-uuid
30755           in: path
30756           description: Unique ID for the license group the resource belongs to, should be uuid.
30757           required: true
30758           type: string
30759           example: __GROUP-UUID__
30760         - name: resource-uuid
30761           in: path
30762           description: Unique ID of a license resource.
30763           required: true
30764           type: string
30765           example: __RESOURCE-UUID__
30766         - name: body
30767           in: body
30768           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)
30769           required: true
30770           schema:
30771             $ref: "#/definitions/license"
30772     patch:
30773       tags:
30774         - Network
30775       summary: update an existing license
30776       description: |
30777         Update an existing license
30778         #
30779         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
30780         The PUT operation will entirely replace an existing object.
30781         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
30782         #
30783         Other differences between PUT and PATCH are:
30784         #
30785         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
30786         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
30787         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
30788       operationId: UpdateNetworkVcesVceLicensesLicense
30789       consumes:
30790         - application/json
30791         - application/xml
30792       produces:
30793         - application/json
30794         - application/xml
30795       responses:
30796         "default":
30797           description: Response codes found in [response codes](https://wiki.onap.org/).
30798       parameters:
30799         - name: vnf-id
30800           in: path
30801           description: Unique id of VNF.  This is unique across the graph.
30802           required: true
30803           type: string
30804           example: __VNF-ID__
30805         - name: group-uuid
30806           in: path
30807           description: Unique ID for the license group the resource belongs to, should be uuid.
30808           required: true
30809           type: string
30810           example: __GROUP-UUID__
30811         - name: resource-uuid
30812           in: path
30813           description: Unique ID of a license resource.
30814           required: true
30815           type: string
30816           example: __RESOURCE-UUID__
30817         - name: body
30818           in: body
30819           description: license object that needs to be created or updated.
30820           required: true
30821           schema:
30822             $ref: "#/patchDefinitions/license"
30823     delete:
30824       tags:
30825         - Network
30826       summary: delete an existing license
30827       description: delete an existing license
30828       operationId: deleteNetworkVcesVceLicensesLicense
30829       consumes:
30830         - application/json
30831         - application/xml
30832       produces:
30833         - application/json
30834         - application/xml
30835       responses:
30836         "default":
30837           description: Response codes found in [response codes](https://wiki.onap.org/).
30838       parameters:
30839         - name: vnf-id
30840           in: path
30841           description: Unique id of VNF.  This is unique across the graph.
30842           required: true
30843           type: string
30844           example: __VNF-ID__
30845         - name: group-uuid
30846           in: path
30847           description: Unique ID for the license group the resource belongs to, should be uuid.
30848           required: true
30849           type: string
30850           example: __GROUP-UUID__
30851         - name: resource-uuid
30852           in: path
30853           description: Unique ID of a license resource.
30854           required: true
30855           type: string
30856           example: __RESOURCE-UUID__
30857         - name: resource-version
30858           in: query
30859           description: resource-version for concurrency
30860           required: true
30861           type: string
30862   /network/vces/vce/{vnf-id}/licenses:
30863     get:
30864       tags:
30865         - Network
30866       summary: returns licenses
30867       description: returns licenses
30868       operationId: getNetworkVcesVceLicenses
30869       produces:
30870         - application/json
30871         - application/xml
30872       responses:
30873         "200":
30874           description: successful operation
30875           schema:
30876               $ref: "#/getDefinitions/licenses"
30877         "default":
30878           description: Response codes found in [response codes](https://wiki.onap.org/).
30879       parameters:
30880         - name: vnf-id
30881           in: path
30882           description: Unique id of VNF.  This is unique across the graph.
30883           required: true
30884           type: string
30885           example: __VNF-ID__
30886         - name: vnf-name
30887           in: query
30888           description: Name of VNF.
30889           required: false
30890           type: string
30891         - name: vnf-name2
30892           in: query
30893           description: Alternate name of VNF.
30894           required: false
30895           type: string
30896         - name: vnf-type
30897           in: query
30898           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.
30899           required: false
30900           type: string
30901         - name: service-id
30902           in: query
30903           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
30904           required: false
30905           type: string
30906         - name: regional-resource-zone
30907           in: query
30908           description: Regional way of organizing pservers, source of truth should define values
30909           required: false
30910           type: string
30911         - name: prov-status
30912           in: query
30913           description: Trigger for operational monitoring of this resource by Service Assurance systems.
30914           required: false
30915           type: string
30916         - name: heat-stack-id
30917           in: query
30918           description: Heat stack id corresponding to this instance, managed by MSO
30919           required: false
30920           type: string
30921         - name: vpe-id
30922           in: query
30923           description: Unique ID of VPE connected to this VCE.
30924           required: false
30925           type: string
30926   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
30927     put:
30928       tags:
30929         - Network
30930       summary: see node definition for valid relationships
30931       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
30932       consumes:
30933         - application/json
30934         - application/xml
30935       produces:
30936         - application/json
30937         - application/xml
30938       responses:
30939         "default":
30940           description: Response codes found in [response codes](https://wiki.onap.org/).
30941       parameters:
30942         - name: vnf-id
30943           in: path
30944           description: Unique id of VNF.  This is unique across the graph.
30945           required: true
30946           type: string
30947           example: __VNF-ID__
30948         - name: group-uuid
30949           in: path
30950           description: Unique ID for the entitlement group the resource comes from, should be uuid.
30951           required: true
30952           type: string
30953           example: __GROUP-UUID__
30954         - name: resource-uuid
30955           in: path
30956           description: Unique ID of an entitlement resource.
30957           required: true
30958           type: string
30959           example: __RESOURCE-UUID__
30960         - name: body
30961           in: body
30962           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
30963           required: true
30964           schema:
30965             $ref: "#/definitions/relationship"
30966     delete:
30967       tags:
30968         - Network
30969       summary: delete an existing relationship
30970       description: delete an existing relationship
30971       operationId: deleteNetworkVcesVceEntitlementsEntitlementRelationshipListRelationship
30972       consumes:
30973         - application/json
30974         - application/xml
30975       produces:
30976         - application/json
30977         - application/xml
30978       responses:
30979         "default":
30980           description: Response codes found in [response codes](https://wiki.onap.org/).
30981       parameters:
30982         - name: vnf-id
30983           in: path
30984           description: Unique id of VNF.  This is unique across the graph.
30985           required: true
30986           type: string
30987           example: __VNF-ID__
30988         - name: group-uuid
30989           in: path
30990           description: Unique ID for the entitlement group the resource comes from, should be uuid.
30991           required: true
30992           type: string
30993           example: __GROUP-UUID__
30994         - name: resource-uuid
30995           in: path
30996           description: Unique ID of an entitlement resource.
30997           required: true
30998           type: string
30999           example: __RESOURCE-UUID__
31000   /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
31001     get:
31002       tags:
31003         - Network
31004       summary: returns entitlement
31005       description: returns entitlement
31006       operationId: getNetworkVcesVceEntitlementsEntitlement
31007       produces:
31008         - application/json
31009         - application/xml
31010       responses:
31011         "200":
31012           description: successful operation
31013           schema:
31014               $ref: "#/getDefinitions/entitlement"
31015         "default":
31016           description: Response codes found in [response codes](https://wiki.onap.org/).
31017       parameters:
31018         - name: vnf-id
31019           in: path
31020           description: Unique id of VNF.  This is unique across the graph.
31021           required: true
31022           type: string
31023           example: __VNF-ID__
31024         - name: group-uuid
31025           in: path
31026           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31027           required: true
31028           type: string
31029           example: __GROUP-UUID__
31030         - name: resource-uuid
31031           in: path
31032           description: Unique ID of an entitlement resource.
31033           required: true
31034           type: string
31035           example: __RESOURCE-UUID__
31036         - name: vnf-name
31037           in: query
31038           description: Name of VNF.
31039           required: false
31040           type: string
31041         - name: vnf-name2
31042           in: query
31043           description: Alternate name of VNF.
31044           required: false
31045           type: string
31046         - name: vnf-type
31047           in: query
31048           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.
31049           required: false
31050           type: string
31051         - name: service-id
31052           in: query
31053           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31054           required: false
31055           type: string
31056         - name: regional-resource-zone
31057           in: query
31058           description: Regional way of organizing pservers, source of truth should define values
31059           required: false
31060           type: string
31061         - name: prov-status
31062           in: query
31063           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31064           required: false
31065           type: string
31066         - name: heat-stack-id
31067           in: query
31068           description: Heat stack id corresponding to this instance, managed by MSO
31069           required: false
31070           type: string
31071         - name: vpe-id
31072           in: query
31073           description: Unique ID of VPE connected to this VCE.
31074           required: false
31075           type: string
31076     put:
31077       tags:
31078         - Network
31079       summary: create or update an existing entitlement
31080       description: |
31081         Create or update an existing entitlement.
31082         #
31083         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31084       operationId: createOrUpdateNetworkVcesVceEntitlementsEntitlement
31085       consumes:
31086         - application/json
31087         - application/xml
31088       produces:
31089         - application/json
31090         - application/xml
31091       responses:
31092         "default":
31093           description: Response codes found in [response codes](https://wiki.onap.org/).
31094       parameters:
31095         - name: vnf-id
31096           in: path
31097           description: Unique id of VNF.  This is unique across the graph.
31098           required: true
31099           type: string
31100           example: __VNF-ID__
31101         - name: group-uuid
31102           in: path
31103           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31104           required: true
31105           type: string
31106           example: __GROUP-UUID__
31107         - name: resource-uuid
31108           in: path
31109           description: Unique ID of an entitlement resource.
31110           required: true
31111           type: string
31112           example: __RESOURCE-UUID__
31113         - name: body
31114           in: body
31115           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)
31116           required: true
31117           schema:
31118             $ref: "#/definitions/entitlement"
31119     patch:
31120       tags:
31121         - Network
31122       summary: update an existing entitlement
31123       description: |
31124         Update an existing entitlement
31125         #
31126         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31127         The PUT operation will entirely replace an existing object.
31128         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31129         #
31130         Other differences between PUT and PATCH are:
31131         #
31132         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31133         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31134         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31135       operationId: UpdateNetworkVcesVceEntitlementsEntitlement
31136       consumes:
31137         - application/json
31138         - application/xml
31139       produces:
31140         - application/json
31141         - application/xml
31142       responses:
31143         "default":
31144           description: Response codes found in [response codes](https://wiki.onap.org/).
31145       parameters:
31146         - name: vnf-id
31147           in: path
31148           description: Unique id of VNF.  This is unique across the graph.
31149           required: true
31150           type: string
31151           example: __VNF-ID__
31152         - name: group-uuid
31153           in: path
31154           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31155           required: true
31156           type: string
31157           example: __GROUP-UUID__
31158         - name: resource-uuid
31159           in: path
31160           description: Unique ID of an entitlement resource.
31161           required: true
31162           type: string
31163           example: __RESOURCE-UUID__
31164         - name: body
31165           in: body
31166           description: entitlement object that needs to be created or updated.
31167           required: true
31168           schema:
31169             $ref: "#/patchDefinitions/entitlement"
31170     delete:
31171       tags:
31172         - Network
31173       summary: delete an existing entitlement
31174       description: delete an existing entitlement
31175       operationId: deleteNetworkVcesVceEntitlementsEntitlement
31176       consumes:
31177         - application/json
31178         - application/xml
31179       produces:
31180         - application/json
31181         - application/xml
31182       responses:
31183         "default":
31184           description: Response codes found in [response codes](https://wiki.onap.org/).
31185       parameters:
31186         - name: vnf-id
31187           in: path
31188           description: Unique id of VNF.  This is unique across the graph.
31189           required: true
31190           type: string
31191           example: __VNF-ID__
31192         - name: group-uuid
31193           in: path
31194           description: Unique ID for the entitlement group the resource comes from, should be uuid.
31195           required: true
31196           type: string
31197           example: __GROUP-UUID__
31198         - name: resource-uuid
31199           in: path
31200           description: Unique ID of an entitlement resource.
31201           required: true
31202           type: string
31203           example: __RESOURCE-UUID__
31204         - name: resource-version
31205           in: query
31206           description: resource-version for concurrency
31207           required: true
31208           type: string
31209   /network/vces/vce/{vnf-id}/entitlements:
31210     get:
31211       tags:
31212         - Network
31213       summary: returns entitlements
31214       description: returns entitlements
31215       operationId: getNetworkVcesVceEntitlements
31216       produces:
31217         - application/json
31218         - application/xml
31219       responses:
31220         "200":
31221           description: successful operation
31222           schema:
31223               $ref: "#/getDefinitions/entitlements"
31224         "default":
31225           description: Response codes found in [response codes](https://wiki.onap.org/).
31226       parameters:
31227         - name: vnf-id
31228           in: path
31229           description: Unique id of VNF.  This is unique across the graph.
31230           required: true
31231           type: string
31232           example: __VNF-ID__
31233         - name: vnf-name
31234           in: query
31235           description: Name of VNF.
31236           required: false
31237           type: string
31238         - name: vnf-name2
31239           in: query
31240           description: Alternate name of VNF.
31241           required: false
31242           type: string
31243         - name: vnf-type
31244           in: query
31245           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.
31246           required: false
31247           type: string
31248         - name: service-id
31249           in: query
31250           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31251           required: false
31252           type: string
31253         - name: regional-resource-zone
31254           in: query
31255           description: Regional way of organizing pservers, source of truth should define values
31256           required: false
31257           type: string
31258         - name: prov-status
31259           in: query
31260           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31261           required: false
31262           type: string
31263         - name: heat-stack-id
31264           in: query
31265           description: Heat stack id corresponding to this instance, managed by MSO
31266           required: false
31267           type: string
31268         - name: vpe-id
31269           in: query
31270           description: Unique ID of VPE connected to this VCE.
31271           required: false
31272           type: string
31273   /network/vces/vce/{vnf-id}/relationship-list/relationship:
31274     put:
31275       tags:
31276         - Network
31277       summary: see node definition for valid relationships
31278       operationId: createOrUpdateNetworkVcesVceRelationshipListRelationship
31279       consumes:
31280         - application/json
31281         - application/xml
31282       produces:
31283         - application/json
31284         - application/xml
31285       responses:
31286         "default":
31287           description: Response codes found in [response codes](https://wiki.onap.org/).
31288       parameters:
31289         - name: vnf-id
31290           in: path
31291           description: Unique id of VNF.  This is unique across the graph.
31292           required: true
31293           type: string
31294           example: __VNF-ID__
31295         - name: body
31296           in: body
31297           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
31298           required: true
31299           schema:
31300             $ref: "#/definitions/relationship"
31301     delete:
31302       tags:
31303         - Network
31304       summary: delete an existing relationship
31305       description: delete an existing relationship
31306       operationId: deleteNetworkVcesVceRelationshipListRelationship
31307       consumes:
31308         - application/json
31309         - application/xml
31310       produces:
31311         - application/json
31312         - application/xml
31313       responses:
31314         "default":
31315           description: Response codes found in [response codes](https://wiki.onap.org/).
31316       parameters:
31317         - name: vnf-id
31318           in: path
31319           description: Unique id of VNF.  This is unique across the graph.
31320           required: true
31321           type: string
31322           example: __VNF-ID__
31323   /network/vces/vce/{vnf-id}:
31324     get:
31325       tags:
31326         - Network
31327       summary: returns vce
31328       description: returns vce
31329       operationId: getNetworkVcesVce
31330       produces:
31331         - application/json
31332         - application/xml
31333       responses:
31334         "200":
31335           description: successful operation
31336           schema:
31337               $ref: "#/getDefinitions/vce"
31338         "default":
31339           description: Response codes found in [response codes](https://wiki.onap.org/).
31340       parameters:
31341         - name: vnf-id
31342           in: path
31343           description: Unique id of VNF.  This is unique across the graph.
31344           required: true
31345           type: string
31346           example: __VNF-ID__
31347         - name: vnf-name
31348           in: query
31349           description: Name of VNF.
31350           required: false
31351           type: string
31352         - name: vnf-name2
31353           in: query
31354           description: Alternate name of VNF.
31355           required: false
31356           type: string
31357         - name: vnf-type
31358           in: query
31359           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.
31360           required: false
31361           type: string
31362         - name: service-id
31363           in: query
31364           description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
31365           required: false
31366           type: string
31367         - name: regional-resource-zone
31368           in: query
31369           description: Regional way of organizing pservers, source of truth should define values
31370           required: false
31371           type: string
31372         - name: prov-status
31373           in: query
31374           description: Trigger for operational monitoring of this resource by Service Assurance systems.
31375           required: false
31376           type: string
31377         - name: heat-stack-id
31378           in: query
31379           description: Heat stack id corresponding to this instance, managed by MSO
31380           required: false
31381           type: string
31382         - name: vpe-id
31383           in: query
31384           description: Unique ID of VPE connected to this VCE.
31385           required: false
31386           type: string
31387     put:
31388       tags:
31389         - Network
31390       summary: create or update an existing vce
31391       description: |
31392         Create or update an existing vce.
31393         #
31394         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31395       operationId: createOrUpdateNetworkVcesVce
31396       consumes:
31397         - application/json
31398         - application/xml
31399       produces:
31400         - application/json
31401         - application/xml
31402       responses:
31403         "default":
31404           description: Response codes found in [response codes](https://wiki.onap.org/).
31405       parameters:
31406         - name: vnf-id
31407           in: path
31408           description: Unique id of VNF.  This is unique across the graph.
31409           required: true
31410           type: string
31411           example: __VNF-ID__
31412         - name: body
31413           in: body
31414           description: vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)
31415           required: true
31416           schema:
31417             $ref: "#/definitions/vce"
31418     patch:
31419       tags:
31420         - Network
31421       summary: update an existing vce
31422       description: |
31423         Update an existing vce
31424         #
31425         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31426         The PUT operation will entirely replace an existing object.
31427         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31428         #
31429         Other differences between PUT and PATCH are:
31430         #
31431         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31432         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31433         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31434       operationId: UpdateNetworkVcesVce
31435       consumes:
31436         - application/json
31437         - application/xml
31438       produces:
31439         - application/json
31440         - application/xml
31441       responses:
31442         "default":
31443           description: Response codes found in [response codes](https://wiki.onap.org/).
31444       parameters:
31445         - name: vnf-id
31446           in: path
31447           description: Unique id of VNF.  This is unique across the graph.
31448           required: true
31449           type: string
31450           example: __VNF-ID__
31451         - name: body
31452           in: body
31453           description: vce object that needs to be created or updated.
31454           required: true
31455           schema:
31456             $ref: "#/patchDefinitions/vce"
31457     delete:
31458       tags:
31459         - Network
31460       summary: delete an existing vce
31461       description: delete an existing vce
31462       operationId: deleteNetworkVcesVce
31463       consumes:
31464         - application/json
31465         - application/xml
31466       produces:
31467         - application/json
31468         - application/xml
31469       responses:
31470         "default":
31471           description: Response codes found in [response codes](https://wiki.onap.org/).
31472       parameters:
31473         - name: vnf-id
31474           in: path
31475           description: Unique id of VNF.  This is unique across the graph.
31476           required: true
31477           type: string
31478           example: __VNF-ID__
31479         - name: resource-version
31480           in: query
31481           description: resource-version for concurrency
31482           required: true
31483           type: string
31484   /network/vces:
31485     get:
31486       tags:
31487         - Network
31488       summary: returns vces
31489       description: returns vces
31490       operationId: getNetworkVces
31491       produces:
31492         - application/json
31493         - application/xml
31494       responses:
31495         "200":
31496           description: successful operation
31497           schema:
31498               $ref: "#/getDefinitions/vces"
31499         "default":
31500           description: Response codes found in [response codes](https://wiki.onap.org/).
31501   /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship:
31502     put:
31503       tags:
31504         - Network
31505       summary: see node definition for valid relationships
31506       operationId: createOrUpdateNetworkVnfcsVnfcRelationshipListRelationship
31507       consumes:
31508         - application/json
31509         - application/xml
31510       produces:
31511         - application/json
31512         - application/xml
31513       responses:
31514         "default":
31515           description: Response codes found in [response codes](https://wiki.onap.org/).
31516       parameters:
31517         - name: vnfc-name
31518           in: path
31519           description: Unique ID of vnfc.
31520           required: true
31521           type: string
31522           example: __VNFC-NAME__
31523         - name: body
31524           in: body
31525           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
31526           required: true
31527           schema:
31528             $ref: "#/definitions/relationship"
31529     delete:
31530       tags:
31531         - Network
31532       summary: delete an existing relationship
31533       description: delete an existing relationship
31534       operationId: deleteNetworkVnfcsVnfcRelationshipListRelationship
31535       consumes:
31536         - application/json
31537         - application/xml
31538       produces:
31539         - application/json
31540         - application/xml
31541       responses:
31542         "default":
31543           description: Response codes found in [response codes](https://wiki.onap.org/).
31544       parameters:
31545         - name: vnfc-name
31546           in: path
31547           description: Unique ID of vnfc.
31548           required: true
31549           type: string
31550           example: __VNFC-NAME__
31551   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
31552     put:
31553       tags:
31554         - Network
31555       summary: see node definition for valid relationships
31556       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
31557       consumes:
31558         - application/json
31559         - application/xml
31560       produces:
31561         - application/json
31562         - application/xml
31563       responses:
31564         "default":
31565           description: Response codes found in [response codes](https://wiki.onap.org/).
31566       parameters:
31567         - name: vnfc-name
31568           in: path
31569           description: Unique ID of vnfc.
31570           required: true
31571           type: string
31572           example: __VNFC-NAME__
31573         - name: l3-interface-ipv4-address
31574           in: path
31575           description: IP address
31576           required: true
31577           type: string
31578           example: __L3-INTERFACE-IPV4-ADDRESS__
31579         - name: body
31580           in: body
31581           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
31582           required: true
31583           schema:
31584             $ref: "#/definitions/relationship"
31585     delete:
31586       tags:
31587         - Network
31588       summary: delete an existing relationship
31589       description: delete an existing relationship
31590       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressListRelationshipListRelationship
31591       consumes:
31592         - application/json
31593         - application/xml
31594       produces:
31595         - application/json
31596         - application/xml
31597       responses:
31598         "default":
31599           description: Response codes found in [response codes](https://wiki.onap.org/).
31600       parameters:
31601         - name: vnfc-name
31602           in: path
31603           description: Unique ID of vnfc.
31604           required: true
31605           type: string
31606           example: __VNFC-NAME__
31607         - name: l3-interface-ipv4-address
31608           in: path
31609           description: IP address
31610           required: true
31611           type: string
31612           example: __L3-INTERFACE-IPV4-ADDRESS__
31613   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
31614     get:
31615       tags:
31616         - Network
31617       summary: returns l3-interface-ipv4-address-list
31618       description: returns l3-interface-ipv4-address-list
31619       operationId: getNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31620       produces:
31621         - application/json
31622         - application/xml
31623       responses:
31624         "200":
31625           description: successful operation
31626           schema:
31627               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
31628         "default":
31629           description: Response codes found in [response codes](https://wiki.onap.org/).
31630       parameters:
31631         - name: vnfc-name
31632           in: path
31633           description: Unique ID of vnfc.
31634           required: true
31635           type: string
31636           example: __VNFC-NAME__
31637         - name: l3-interface-ipv4-address
31638           in: path
31639           description: IP address
31640           required: true
31641           type: string
31642           example: __L3-INTERFACE-IPV4-ADDRESS__
31643         - name: nfc-naming-code
31644           in: query
31645           description: Short code that is used in naming instances of the item being modeled
31646           required: false
31647           type: string
31648         - name: nfc-function
31649           in: query
31650           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
31651           required: false
31652           type: string
31653         - name: prov-status
31654           in: query
31655           description: prov status of this vnfc
31656           required: false
31657           type: string
31658         - name: ipaddress-v4-oam-vip
31659           in: query
31660           description: Oam V4 vip address of this vnfc
31661           required: false
31662           type: string
31663         - name: in-maint
31664           in: query
31665           required: false
31666           type: boolean
31667         - name: is-closed-loop-disabled
31668           in: query
31669           required: false
31670           type: boolean
31671         - name: group-notation
31672           in: query
31673           description: Group notation of VNFC
31674           required: false
31675           type: string
31676         - name: model-invariant-id
31677           in: query
31678           description: the ASDC model id for this resource or service model.
31679           required: false
31680           type: string
31681         - name: model-version-id
31682           in: query
31683           description: the ASDC model version for this resource or service model.
31684           required: false
31685           type: string
31686         - name: vlan-id-inner
31687           in: query
31688           description: Inner VLAN tag
31689           required: false
31690           type: integer
31691           format: int64
31692         - name: neutron-network-id
31693           in: query
31694           description: Neutron network id of the interface that address belongs to
31695           required: false
31696           type: string
31697         - name: neutron-subnet-id
31698           in: query
31699           description: Neutron id of subnet that address belongs to
31700           required: false
31701           type: string
31702     put:
31703       tags:
31704         - Network
31705       summary: create or update an existing l3-interface-ipv4-address-list
31706       description: |
31707         Create or update an existing l3-interface-ipv4-address-list.
31708         #
31709         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31710       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31711       consumes:
31712         - application/json
31713         - application/xml
31714       produces:
31715         - application/json
31716         - application/xml
31717       responses:
31718         "default":
31719           description: Response codes found in [response codes](https://wiki.onap.org/).
31720       parameters:
31721         - name: vnfc-name
31722           in: path
31723           description: Unique ID of vnfc.
31724           required: true
31725           type: string
31726           example: __VNFC-NAME__
31727         - name: l3-interface-ipv4-address
31728           in: path
31729           description: IP address
31730           required: true
31731           type: string
31732           example: __L3-INTERFACE-IPV4-ADDRESS__
31733         - name: body
31734           in: body
31735           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)
31736           required: true
31737           schema:
31738             $ref: "#/definitions/l3-interface-ipv4-address-list"
31739     patch:
31740       tags:
31741         - Network
31742       summary: update an existing l3-interface-ipv4-address-list
31743       description: |
31744         Update an existing l3-interface-ipv4-address-list
31745         #
31746         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
31747         The PUT operation will entirely replace an existing object.
31748         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
31749         #
31750         Other differences between PUT and PATCH are:
31751         #
31752         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
31753         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
31754         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
31755       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31756       consumes:
31757         - application/json
31758         - application/xml
31759       produces:
31760         - application/json
31761         - application/xml
31762       responses:
31763         "default":
31764           description: Response codes found in [response codes](https://wiki.onap.org/).
31765       parameters:
31766         - name: vnfc-name
31767           in: path
31768           description: Unique ID of vnfc.
31769           required: true
31770           type: string
31771           example: __VNFC-NAME__
31772         - name: l3-interface-ipv4-address
31773           in: path
31774           description: IP address
31775           required: true
31776           type: string
31777           example: __L3-INTERFACE-IPV4-ADDRESS__
31778         - name: body
31779           in: body
31780           description: l3-interface-ipv4-address-list object that needs to be created or updated.
31781           required: true
31782           schema:
31783             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
31784     delete:
31785       tags:
31786         - Network
31787       summary: delete an existing l3-interface-ipv4-address-list
31788       description: delete an existing l3-interface-ipv4-address-list
31789       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv4AddressList
31790       consumes:
31791         - application/json
31792         - application/xml
31793       produces:
31794         - application/json
31795         - application/xml
31796       responses:
31797         "default":
31798           description: Response codes found in [response codes](https://wiki.onap.org/).
31799       parameters:
31800         - name: vnfc-name
31801           in: path
31802           description: Unique ID of vnfc.
31803           required: true
31804           type: string
31805           example: __VNFC-NAME__
31806         - name: l3-interface-ipv4-address
31807           in: path
31808           description: IP address
31809           required: true
31810           type: string
31811           example: __L3-INTERFACE-IPV4-ADDRESS__
31812         - name: resource-version
31813           in: query
31814           description: resource-version for concurrency
31815           required: true
31816           type: string
31817   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
31818     put:
31819       tags:
31820         - Network
31821       summary: see node definition for valid relationships
31822       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
31823       consumes:
31824         - application/json
31825         - application/xml
31826       produces:
31827         - application/json
31828         - application/xml
31829       responses:
31830         "default":
31831           description: Response codes found in [response codes](https://wiki.onap.org/).
31832       parameters:
31833         - name: vnfc-name
31834           in: path
31835           description: Unique ID of vnfc.
31836           required: true
31837           type: string
31838           example: __VNFC-NAME__
31839         - name: l3-interface-ipv6-address
31840           in: path
31841           description: IP address
31842           required: true
31843           type: string
31844           example: __L3-INTERFACE-IPV6-ADDRESS__
31845         - name: body
31846           in: body
31847           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
31848           required: true
31849           schema:
31850             $ref: "#/definitions/relationship"
31851     delete:
31852       tags:
31853         - Network
31854       summary: delete an existing relationship
31855       description: delete an existing relationship
31856       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressListRelationshipListRelationship
31857       consumes:
31858         - application/json
31859         - application/xml
31860       produces:
31861         - application/json
31862         - application/xml
31863       responses:
31864         "default":
31865           description: Response codes found in [response codes](https://wiki.onap.org/).
31866       parameters:
31867         - name: vnfc-name
31868           in: path
31869           description: Unique ID of vnfc.
31870           required: true
31871           type: string
31872           example: __VNFC-NAME__
31873         - name: l3-interface-ipv6-address
31874           in: path
31875           description: IP address
31876           required: true
31877           type: string
31878           example: __L3-INTERFACE-IPV6-ADDRESS__
31879   /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
31880     get:
31881       tags:
31882         - Network
31883       summary: returns l3-interface-ipv6-address-list
31884       description: returns l3-interface-ipv6-address-list
31885       operationId: getNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31886       produces:
31887         - application/json
31888         - application/xml
31889       responses:
31890         "200":
31891           description: successful operation
31892           schema:
31893               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
31894         "default":
31895           description: Response codes found in [response codes](https://wiki.onap.org/).
31896       parameters:
31897         - name: vnfc-name
31898           in: path
31899           description: Unique ID of vnfc.
31900           required: true
31901           type: string
31902           example: __VNFC-NAME__
31903         - name: l3-interface-ipv6-address
31904           in: path
31905           description: IP address
31906           required: true
31907           type: string
31908           example: __L3-INTERFACE-IPV6-ADDRESS__
31909         - name: nfc-naming-code
31910           in: query
31911           description: Short code that is used in naming instances of the item being modeled
31912           required: false
31913           type: string
31914         - name: nfc-function
31915           in: query
31916           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
31917           required: false
31918           type: string
31919         - name: prov-status
31920           in: query
31921           description: prov status of this vnfc
31922           required: false
31923           type: string
31924         - name: ipaddress-v4-oam-vip
31925           in: query
31926           description: Oam V4 vip address of this vnfc
31927           required: false
31928           type: string
31929         - name: in-maint
31930           in: query
31931           required: false
31932           type: boolean
31933         - name: is-closed-loop-disabled
31934           in: query
31935           required: false
31936           type: boolean
31937         - name: group-notation
31938           in: query
31939           description: Group notation of VNFC
31940           required: false
31941           type: string
31942         - name: model-invariant-id
31943           in: query
31944           description: the ASDC model id for this resource or service model.
31945           required: false
31946           type: string
31947         - name: model-version-id
31948           in: query
31949           description: the ASDC model version for this resource or service model.
31950           required: false
31951           type: string
31952         - name: vlan-id-inner
31953           in: query
31954           description: Inner VLAN tag
31955           required: false
31956           type: integer
31957           format: int64
31958         - name: neutron-network-id
31959           in: query
31960           description: Neutron network id of the interface that address belongs to
31961           required: false
31962           type: string
31963         - name: neutron-subnet-id
31964           in: query
31965           description: Neutron id of subnet that address belongs to
31966           required: false
31967           type: string
31968     put:
31969       tags:
31970         - Network
31971       summary: create or update an existing l3-interface-ipv6-address-list
31972       description: |
31973         Create or update an existing l3-interface-ipv6-address-list.
31974         #
31975         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
31976       operationId: createOrUpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
31977       consumes:
31978         - application/json
31979         - application/xml
31980       produces:
31981         - application/json
31982         - application/xml
31983       responses:
31984         "default":
31985           description: Response codes found in [response codes](https://wiki.onap.org/).
31986       parameters:
31987         - name: vnfc-name
31988           in: path
31989           description: Unique ID of vnfc.
31990           required: true
31991           type: string
31992           example: __VNFC-NAME__
31993         - name: l3-interface-ipv6-address
31994           in: path
31995           description: IP address
31996           required: true
31997           type: string
31998           example: __L3-INTERFACE-IPV6-ADDRESS__
31999         - name: body
32000           in: body
32001           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)
32002           required: true
32003           schema:
32004             $ref: "#/definitions/l3-interface-ipv6-address-list"
32005     patch:
32006       tags:
32007         - Network
32008       summary: update an existing l3-interface-ipv6-address-list
32009       description: |
32010         Update an existing l3-interface-ipv6-address-list
32011         #
32012         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32013         The PUT operation will entirely replace an existing object.
32014         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32015         #
32016         Other differences between PUT and PATCH are:
32017         #
32018         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32019         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32020         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32021       operationId: UpdateNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32022       consumes:
32023         - application/json
32024         - application/xml
32025       produces:
32026         - application/json
32027         - application/xml
32028       responses:
32029         "default":
32030           description: Response codes found in [response codes](https://wiki.onap.org/).
32031       parameters:
32032         - name: vnfc-name
32033           in: path
32034           description: Unique ID of vnfc.
32035           required: true
32036           type: string
32037           example: __VNFC-NAME__
32038         - name: l3-interface-ipv6-address
32039           in: path
32040           description: IP address
32041           required: true
32042           type: string
32043           example: __L3-INTERFACE-IPV6-ADDRESS__
32044         - name: body
32045           in: body
32046           description: l3-interface-ipv6-address-list object that needs to be created or updated.
32047           required: true
32048           schema:
32049             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
32050     delete:
32051       tags:
32052         - Network
32053       summary: delete an existing l3-interface-ipv6-address-list
32054       description: delete an existing l3-interface-ipv6-address-list
32055       operationId: deleteNetworkVnfcsVnfcL3InterfaceIpv6AddressList
32056       consumes:
32057         - application/json
32058         - application/xml
32059       produces:
32060         - application/json
32061         - application/xml
32062       responses:
32063         "default":
32064           description: Response codes found in [response codes](https://wiki.onap.org/).
32065       parameters:
32066         - name: vnfc-name
32067           in: path
32068           description: Unique ID of vnfc.
32069           required: true
32070           type: string
32071           example: __VNFC-NAME__
32072         - name: l3-interface-ipv6-address
32073           in: path
32074           description: IP address
32075           required: true
32076           type: string
32077           example: __L3-INTERFACE-IPV6-ADDRESS__
32078         - name: resource-version
32079           in: query
32080           description: resource-version for concurrency
32081           required: true
32082           type: string
32083   /network/vnfcs/vnfc/{vnfc-name}:
32084     get:
32085       tags:
32086         - Network
32087       summary: returns vnfc
32088       description: returns vnfc
32089       operationId: getNetworkVnfcsVnfc
32090       produces:
32091         - application/json
32092         - application/xml
32093       responses:
32094         "200":
32095           description: successful operation
32096           schema:
32097               $ref: "#/getDefinitions/vnfc"
32098         "default":
32099           description: Response codes found in [response codes](https://wiki.onap.org/).
32100       parameters:
32101         - name: vnfc-name
32102           in: path
32103           description: Unique ID of vnfc.
32104           required: true
32105           type: string
32106           example: __VNFC-NAME__
32107         - name: nfc-naming-code
32108           in: query
32109           description: Short code that is used in naming instances of the item being modeled
32110           required: false
32111           type: string
32112         - name: nfc-function
32113           in: query
32114           description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
32115           required: false
32116           type: string
32117         - name: prov-status
32118           in: query
32119           description: prov status of this vnfc
32120           required: false
32121           type: string
32122         - name: ipaddress-v4-oam-vip
32123           in: query
32124           description: Oam V4 vip address of this vnfc
32125           required: false
32126           type: string
32127         - name: in-maint
32128           in: query
32129           required: false
32130           type: boolean
32131         - name: is-closed-loop-disabled
32132           in: query
32133           required: false
32134           type: boolean
32135         - name: group-notation
32136           in: query
32137           description: Group notation of VNFC
32138           required: false
32139           type: string
32140         - name: model-invariant-id
32141           in: query
32142           description: the ASDC model id for this resource or service model.
32143           required: false
32144           type: string
32145         - name: model-version-id
32146           in: query
32147           description: the ASDC model version for this resource or service model.
32148           required: false
32149           type: string
32150     put:
32151       tags:
32152         - Network
32153       summary: create or update an existing vnfc
32154       description: |
32155         Create or update an existing vnfc.
32156         #
32157         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32158       operationId: createOrUpdateNetworkVnfcsVnfc
32159       consumes:
32160         - application/json
32161         - application/xml
32162       produces:
32163         - application/json
32164         - application/xml
32165       responses:
32166         "default":
32167           description: Response codes found in [response codes](https://wiki.onap.org/).
32168       parameters:
32169         - name: vnfc-name
32170           in: path
32171           description: Unique ID of vnfc.
32172           required: true
32173           type: string
32174           example: __VNFC-NAME__
32175         - name: body
32176           in: body
32177           description: vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)
32178           required: true
32179           schema:
32180             $ref: "#/definitions/vnfc"
32181     patch:
32182       tags:
32183         - Network
32184       summary: update an existing vnfc
32185       description: |
32186         Update an existing vnfc
32187         #
32188         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32189         The PUT operation will entirely replace an existing object.
32190         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32191         #
32192         Other differences between PUT and PATCH are:
32193         #
32194         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32195         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32196         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32197       operationId: UpdateNetworkVnfcsVnfc
32198       consumes:
32199         - application/json
32200         - application/xml
32201       produces:
32202         - application/json
32203         - application/xml
32204       responses:
32205         "default":
32206           description: Response codes found in [response codes](https://wiki.onap.org/).
32207       parameters:
32208         - name: vnfc-name
32209           in: path
32210           description: Unique ID of vnfc.
32211           required: true
32212           type: string
32213           example: __VNFC-NAME__
32214         - name: body
32215           in: body
32216           description: vnfc object that needs to be created or updated.
32217           required: true
32218           schema:
32219             $ref: "#/patchDefinitions/vnfc"
32220     delete:
32221       tags:
32222         - Network
32223       summary: delete an existing vnfc
32224       description: delete an existing vnfc
32225       operationId: deleteNetworkVnfcsVnfc
32226       consumes:
32227         - application/json
32228         - application/xml
32229       produces:
32230         - application/json
32231         - application/xml
32232       responses:
32233         "default":
32234           description: Response codes found in [response codes](https://wiki.onap.org/).
32235       parameters:
32236         - name: vnfc-name
32237           in: path
32238           description: Unique ID of vnfc.
32239           required: true
32240           type: string
32241           example: __VNFC-NAME__
32242         - name: resource-version
32243           in: query
32244           description: resource-version for concurrency
32245           required: true
32246           type: string
32247   /network/vnfcs:
32248     get:
32249       tags:
32250         - Network
32251       summary: returns vnfcs
32252       description: returns vnfcs
32253       operationId: getNetworkVnfcs
32254       produces:
32255         - application/json
32256         - application/xml
32257       responses:
32258         "200":
32259           description: successful operation
32260           schema:
32261               $ref: "#/getDefinitions/vnfcs"
32262         "default":
32263           description: Response codes found in [response codes](https://wiki.onap.org/).
32264   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship:
32265     put:
32266       tags:
32267         - Network
32268       summary: see node definition for valid relationships
32269       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
32270       consumes:
32271         - application/json
32272         - application/xml
32273       produces:
32274         - application/json
32275         - application/xml
32276       responses:
32277         "default":
32278           description: Response codes found in [response codes](https://wiki.onap.org/).
32279       parameters:
32280         - name: network-id
32281           in: path
32282           description: Network ID, should be uuid. Unique across A&AI.
32283           required: true
32284           type: string
32285           example: __NETWORK-ID__
32286         - name: subnet-id
32287           in: path
32288           description: Subnet ID, should be UUID.
32289           required: true
32290           type: string
32291           example: __SUBNET-ID__
32292         - name: host-route-id
32293           in: path
32294           description: host-route id
32295           required: true
32296           type: string
32297           example: __HOST-ROUTE-ID__
32298         - name: body
32299           in: body
32300           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
32301           required: true
32302           schema:
32303             $ref: "#/definitions/relationship"
32304     delete:
32305       tags:
32306         - Network
32307       summary: delete an existing relationship
32308       description: delete an existing relationship
32309       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRouteRelationshipListRelationship
32310       consumes:
32311         - application/json
32312         - application/xml
32313       produces:
32314         - application/json
32315         - application/xml
32316       responses:
32317         "default":
32318           description: Response codes found in [response codes](https://wiki.onap.org/).
32319       parameters:
32320         - name: network-id
32321           in: path
32322           description: Network ID, should be uuid. Unique across A&AI.
32323           required: true
32324           type: string
32325           example: __NETWORK-ID__
32326         - name: subnet-id
32327           in: path
32328           description: Subnet ID, should be UUID.
32329           required: true
32330           type: string
32331           example: __SUBNET-ID__
32332         - name: host-route-id
32333           in: path
32334           description: host-route id
32335           required: true
32336           type: string
32337           example: __HOST-ROUTE-ID__
32338   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}:
32339     get:
32340       tags:
32341         - Network
32342       summary: returns host-route
32343       description: returns host-route
32344       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32345       produces:
32346         - application/json
32347         - application/xml
32348       responses:
32349         "200":
32350           description: successful operation
32351           schema:
32352               $ref: "#/getDefinitions/host-route"
32353         "default":
32354           description: Response codes found in [response codes](https://wiki.onap.org/).
32355       parameters:
32356         - name: network-id
32357           in: path
32358           description: Network ID, should be uuid. Unique across A&AI.
32359           required: true
32360           type: string
32361           example: __NETWORK-ID__
32362         - name: subnet-id
32363           in: path
32364           description: Subnet ID, should be UUID.
32365           required: true
32366           type: string
32367           example: __SUBNET-ID__
32368         - name: host-route-id
32369           in: path
32370           description: host-route id
32371           required: true
32372           type: string
32373           example: __HOST-ROUTE-ID__
32374         - name: network-name
32375           in: query
32376           description: Name of the network, governed by some naming convention..
32377           required: false
32378           type: string
32379         - name: network-role
32380           in: query
32381           description: Role the network plans - who defines these values?
32382           required: false
32383           type: string
32384         - name: service-id
32385           in: query
32386           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32387           required: false
32388           type: string
32389         - name: heat-stack-id
32390           in: query
32391           description: Heat stack id corresponding to this instance, managed by MSO
32392           required: false
32393           type: string
32394         - name: contrail-network-fqdn
32395           in: query
32396           description: Contrail FQDN for the network
32397           required: false
32398           type: string
32399         - name: model-invariant-id
32400           in: query
32401           description: the ASDC model id for this resource or service model.
32402           required: false
32403           type: string
32404         - name: model-version-id
32405           in: query
32406           description: the ASDC model version for this resource or service model.
32407           required: false
32408           type: string
32409         - name: widget-model-id
32410           in: query
32411           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32412           required: false
32413           type: string
32414         - name: widget-model-version
32415           in: query
32416           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32417           required: false
32418           type: string
32419         - name: subnet-name
32420           in: query
32421           description: Name associated with the subnet.
32422           required: false
32423           type: string
32424     put:
32425       tags:
32426         - Network
32427       summary: create or update an existing host-route
32428       description: |
32429         Create or update an existing host-route.
32430         #
32431         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32432       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32433       consumes:
32434         - application/json
32435         - application/xml
32436       produces:
32437         - application/json
32438         - application/xml
32439       responses:
32440         "default":
32441           description: Response codes found in [response codes](https://wiki.onap.org/).
32442       parameters:
32443         - name: network-id
32444           in: path
32445           description: Network ID, should be uuid. Unique across A&AI.
32446           required: true
32447           type: string
32448           example: __NETWORK-ID__
32449         - name: subnet-id
32450           in: path
32451           description: Subnet ID, should be UUID.
32452           required: true
32453           type: string
32454           example: __SUBNET-ID__
32455         - name: host-route-id
32456           in: path
32457           description: host-route id
32458           required: true
32459           type: string
32460           example: __HOST-ROUTE-ID__
32461         - name: body
32462           in: body
32463           description: host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)
32464           required: true
32465           schema:
32466             $ref: "#/definitions/host-route"
32467     patch:
32468       tags:
32469         - Network
32470       summary: update an existing host-route
32471       description: |
32472         Update an existing host-route
32473         #
32474         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32475         The PUT operation will entirely replace an existing object.
32476         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32477         #
32478         Other differences between PUT and PATCH are:
32479         #
32480         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32481         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32482         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32483       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32484       consumes:
32485         - application/json
32486         - application/xml
32487       produces:
32488         - application/json
32489         - application/xml
32490       responses:
32491         "default":
32492           description: Response codes found in [response codes](https://wiki.onap.org/).
32493       parameters:
32494         - name: network-id
32495           in: path
32496           description: Network ID, should be uuid. Unique across A&AI.
32497           required: true
32498           type: string
32499           example: __NETWORK-ID__
32500         - name: subnet-id
32501           in: path
32502           description: Subnet ID, should be UUID.
32503           required: true
32504           type: string
32505           example: __SUBNET-ID__
32506         - name: host-route-id
32507           in: path
32508           description: host-route id
32509           required: true
32510           type: string
32511           example: __HOST-ROUTE-ID__
32512         - name: body
32513           in: body
32514           description: host-route object that needs to be created or updated.
32515           required: true
32516           schema:
32517             $ref: "#/patchDefinitions/host-route"
32518     delete:
32519       tags:
32520         - Network
32521       summary: delete an existing host-route
32522       description: delete an existing host-route
32523       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute
32524       consumes:
32525         - application/json
32526         - application/xml
32527       produces:
32528         - application/json
32529         - application/xml
32530       responses:
32531         "default":
32532           description: Response codes found in [response codes](https://wiki.onap.org/).
32533       parameters:
32534         - name: network-id
32535           in: path
32536           description: Network ID, should be uuid. Unique across A&AI.
32537           required: true
32538           type: string
32539           example: __NETWORK-ID__
32540         - name: subnet-id
32541           in: path
32542           description: Subnet ID, should be UUID.
32543           required: true
32544           type: string
32545           example: __SUBNET-ID__
32546         - name: host-route-id
32547           in: path
32548           description: host-route id
32549           required: true
32550           type: string
32551           example: __HOST-ROUTE-ID__
32552         - name: resource-version
32553           in: query
32554           description: resource-version for concurrency
32555           required: true
32556           type: string
32557   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes:
32558     get:
32559       tags:
32560         - Network
32561       summary: returns host-routes
32562       description: returns host-routes
32563       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnetHostRoutes
32564       produces:
32565         - application/json
32566         - application/xml
32567       responses:
32568         "200":
32569           description: successful operation
32570           schema:
32571               $ref: "#/getDefinitions/host-routes"
32572         "default":
32573           description: Response codes found in [response codes](https://wiki.onap.org/).
32574       parameters:
32575         - name: network-id
32576           in: path
32577           description: Network ID, should be uuid. Unique across A&AI.
32578           required: true
32579           type: string
32580           example: __NETWORK-ID__
32581         - name: subnet-id
32582           in: path
32583           description: Subnet ID, should be UUID.
32584           required: true
32585           type: string
32586           example: __SUBNET-ID__
32587         - name: network-name
32588           in: query
32589           description: Name of the network, governed by some naming convention..
32590           required: false
32591           type: string
32592         - name: network-role
32593           in: query
32594           description: Role the network plans - who defines these values?
32595           required: false
32596           type: string
32597         - name: service-id
32598           in: query
32599           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32600           required: false
32601           type: string
32602         - name: heat-stack-id
32603           in: query
32604           description: Heat stack id corresponding to this instance, managed by MSO
32605           required: false
32606           type: string
32607         - name: contrail-network-fqdn
32608           in: query
32609           description: Contrail FQDN for the network
32610           required: false
32611           type: string
32612         - name: model-invariant-id
32613           in: query
32614           description: the ASDC model id for this resource or service model.
32615           required: false
32616           type: string
32617         - name: model-version-id
32618           in: query
32619           description: the ASDC model version for this resource or service model.
32620           required: false
32621           type: string
32622         - name: widget-model-id
32623           in: query
32624           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32625           required: false
32626           type: string
32627         - name: widget-model-version
32628           in: query
32629           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32630           required: false
32631           type: string
32632         - name: subnet-name
32633           in: query
32634           description: Name associated with the subnet.
32635           required: false
32636           type: string
32637   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship:
32638     put:
32639       tags:
32640         - Network
32641       summary: see node definition for valid relationships
32642       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
32643       consumes:
32644         - application/json
32645         - application/xml
32646       produces:
32647         - application/json
32648         - application/xml
32649       responses:
32650         "default":
32651           description: Response codes found in [response codes](https://wiki.onap.org/).
32652       parameters:
32653         - name: network-id
32654           in: path
32655           description: Network ID, should be uuid. Unique across A&AI.
32656           required: true
32657           type: string
32658           example: __NETWORK-ID__
32659         - name: subnet-id
32660           in: path
32661           description: Subnet ID, should be UUID.
32662           required: true
32663           type: string
32664           example: __SUBNET-ID__
32665         - name: body
32666           in: body
32667           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
32668           required: true
32669           schema:
32670             $ref: "#/definitions/relationship"
32671     delete:
32672       tags:
32673         - Network
32674       summary: delete an existing relationship
32675       description: delete an existing relationship
32676       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnetRelationshipListRelationship
32677       consumes:
32678         - application/json
32679         - application/xml
32680       produces:
32681         - application/json
32682         - application/xml
32683       responses:
32684         "default":
32685           description: Response codes found in [response codes](https://wiki.onap.org/).
32686       parameters:
32687         - name: network-id
32688           in: path
32689           description: Network ID, should be uuid. Unique across A&AI.
32690           required: true
32691           type: string
32692           example: __NETWORK-ID__
32693         - name: subnet-id
32694           in: path
32695           description: Subnet ID, should be UUID.
32696           required: true
32697           type: string
32698           example: __SUBNET-ID__
32699   /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}:
32700     get:
32701       tags:
32702         - Network
32703       summary: returns subnet
32704       description: returns subnet
32705       operationId: getNetworkL3NetworksL3NetworkSubnetsSubnet
32706       produces:
32707         - application/json
32708         - application/xml
32709       responses:
32710         "200":
32711           description: successful operation
32712           schema:
32713               $ref: "#/getDefinitions/subnet"
32714         "default":
32715           description: Response codes found in [response codes](https://wiki.onap.org/).
32716       parameters:
32717         - name: network-id
32718           in: path
32719           description: Network ID, should be uuid. Unique across A&AI.
32720           required: true
32721           type: string
32722           example: __NETWORK-ID__
32723         - name: subnet-id
32724           in: path
32725           description: Subnet ID, should be UUID.
32726           required: true
32727           type: string
32728           example: __SUBNET-ID__
32729         - name: network-name
32730           in: query
32731           description: Name of the network, governed by some naming convention..
32732           required: false
32733           type: string
32734         - name: network-role
32735           in: query
32736           description: Role the network plans - who defines these values?
32737           required: false
32738           type: string
32739         - name: service-id
32740           in: query
32741           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32742           required: false
32743           type: string
32744         - name: heat-stack-id
32745           in: query
32746           description: Heat stack id corresponding to this instance, managed by MSO
32747           required: false
32748           type: string
32749         - name: contrail-network-fqdn
32750           in: query
32751           description: Contrail FQDN for the network
32752           required: false
32753           type: string
32754         - name: model-invariant-id
32755           in: query
32756           description: the ASDC model id for this resource or service model.
32757           required: false
32758           type: string
32759         - name: model-version-id
32760           in: query
32761           description: the ASDC model version for this resource or service model.
32762           required: false
32763           type: string
32764         - name: widget-model-id
32765           in: query
32766           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32767           required: false
32768           type: string
32769         - name: widget-model-version
32770           in: query
32771           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32772           required: false
32773           type: string
32774         - name: subnet-name
32775           in: query
32776           description: Name associated with the subnet.
32777           required: false
32778           type: string
32779     put:
32780       tags:
32781         - Network
32782       summary: create or update an existing subnet
32783       description: |
32784         Create or update an existing subnet.
32785         #
32786         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
32787       operationId: createOrUpdateNetworkL3NetworksL3NetworkSubnetsSubnet
32788       consumes:
32789         - application/json
32790         - application/xml
32791       produces:
32792         - application/json
32793         - application/xml
32794       responses:
32795         "default":
32796           description: Response codes found in [response codes](https://wiki.onap.org/).
32797       parameters:
32798         - name: network-id
32799           in: path
32800           description: Network ID, should be uuid. Unique across A&AI.
32801           required: true
32802           type: string
32803           example: __NETWORK-ID__
32804         - name: subnet-id
32805           in: path
32806           description: Subnet ID, should be UUID.
32807           required: true
32808           type: string
32809           example: __SUBNET-ID__
32810         - name: body
32811           in: body
32812           description: subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)
32813           required: true
32814           schema:
32815             $ref: "#/definitions/subnet"
32816     patch:
32817       tags:
32818         - Network
32819       summary: update an existing subnet
32820       description: |
32821         Update an existing subnet
32822         #
32823         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
32824         The PUT operation will entirely replace an existing object.
32825         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
32826         #
32827         Other differences between PUT and PATCH are:
32828         #
32829         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
32830         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
32831         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
32832       operationId: UpdateNetworkL3NetworksL3NetworkSubnetsSubnet
32833       consumes:
32834         - application/json
32835         - application/xml
32836       produces:
32837         - application/json
32838         - application/xml
32839       responses:
32840         "default":
32841           description: Response codes found in [response codes](https://wiki.onap.org/).
32842       parameters:
32843         - name: network-id
32844           in: path
32845           description: Network ID, should be uuid. Unique across A&AI.
32846           required: true
32847           type: string
32848           example: __NETWORK-ID__
32849         - name: subnet-id
32850           in: path
32851           description: Subnet ID, should be UUID.
32852           required: true
32853           type: string
32854           example: __SUBNET-ID__
32855         - name: body
32856           in: body
32857           description: subnet object that needs to be created or updated.
32858           required: true
32859           schema:
32860             $ref: "#/patchDefinitions/subnet"
32861     delete:
32862       tags:
32863         - Network
32864       summary: delete an existing subnet
32865       description: delete an existing subnet
32866       operationId: deleteNetworkL3NetworksL3NetworkSubnetsSubnet
32867       consumes:
32868         - application/json
32869         - application/xml
32870       produces:
32871         - application/json
32872         - application/xml
32873       responses:
32874         "default":
32875           description: Response codes found in [response codes](https://wiki.onap.org/).
32876       parameters:
32877         - name: network-id
32878           in: path
32879           description: Network ID, should be uuid. Unique across A&AI.
32880           required: true
32881           type: string
32882           example: __NETWORK-ID__
32883         - name: subnet-id
32884           in: path
32885           description: Subnet ID, should be UUID.
32886           required: true
32887           type: string
32888           example: __SUBNET-ID__
32889         - name: resource-version
32890           in: query
32891           description: resource-version for concurrency
32892           required: true
32893           type: string
32894   /network/l3-networks/l3-network/{network-id}/subnets:
32895     get:
32896       tags:
32897         - Network
32898       summary: returns subnets
32899       description: returns subnets
32900       operationId: getNetworkL3NetworksL3NetworkSubnets
32901       produces:
32902         - application/json
32903         - application/xml
32904       responses:
32905         "200":
32906           description: successful operation
32907           schema:
32908               $ref: "#/getDefinitions/subnets"
32909         "default":
32910           description: Response codes found in [response codes](https://wiki.onap.org/).
32911       parameters:
32912         - name: network-id
32913           in: path
32914           description: Network ID, should be uuid. Unique across A&AI.
32915           required: true
32916           type: string
32917           example: __NETWORK-ID__
32918         - name: network-name
32919           in: query
32920           description: Name of the network, governed by some naming convention..
32921           required: false
32922           type: string
32923         - name: network-role
32924           in: query
32925           description: Role the network plans - who defines these values?
32926           required: false
32927           type: string
32928         - name: service-id
32929           in: query
32930           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
32931           required: false
32932           type: string
32933         - name: heat-stack-id
32934           in: query
32935           description: Heat stack id corresponding to this instance, managed by MSO
32936           required: false
32937           type: string
32938         - name: contrail-network-fqdn
32939           in: query
32940           description: Contrail FQDN for the network
32941           required: false
32942           type: string
32943         - name: model-invariant-id
32944           in: query
32945           description: the ASDC model id for this resource or service model.
32946           required: false
32947           type: string
32948         - name: model-version-id
32949           in: query
32950           description: the ASDC model version for this resource or service model.
32951           required: false
32952           type: string
32953         - name: widget-model-id
32954           in: query
32955           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
32956           required: false
32957           type: string
32958         - name: widget-model-version
32959           in: query
32960           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
32961           required: false
32962           type: string
32963   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship:
32964     put:
32965       tags:
32966         - Network
32967       summary: see node definition for valid relationships
32968       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
32969       consumes:
32970         - application/json
32971         - application/xml
32972       produces:
32973         - application/json
32974         - application/xml
32975       responses:
32976         "default":
32977           description: Response codes found in [response codes](https://wiki.onap.org/).
32978       parameters:
32979         - name: network-id
32980           in: path
32981           description: Network ID, should be uuid. Unique across A&AI.
32982           required: true
32983           type: string
32984           example: __NETWORK-ID__
32985         - name: vlan-id-inner
32986           in: path
32987           description: id.
32988           required: true
32989           type: integer
32990           format: int64
32991           example: __VLAN-ID-INNER__
32992         - name: body
32993           in: body
32994           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
32995           required: true
32996           schema:
32997             $ref: "#/definitions/relationship"
32998     delete:
32999       tags:
33000         - Network
33001       summary: delete an existing relationship
33002       description: delete an existing relationship
33003       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignmentRelationshipListRelationship
33004       consumes:
33005         - application/json
33006         - application/xml
33007       produces:
33008         - application/json
33009         - application/xml
33010       responses:
33011         "default":
33012           description: Response codes found in [response codes](https://wiki.onap.org/).
33013       parameters:
33014         - name: network-id
33015           in: path
33016           description: Network ID, should be uuid. Unique across A&AI.
33017           required: true
33018           type: string
33019           example: __NETWORK-ID__
33020         - name: vlan-id-inner
33021           in: path
33022           description: id.
33023           required: true
33024           type: integer
33025           format: int64
33026           example: __VLAN-ID-INNER__
33027   /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}:
33028     get:
33029       tags:
33030         - Network
33031       summary: returns ctag-assignment
33032       description: returns ctag-assignment
33033       operationId: getNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33034       produces:
33035         - application/json
33036         - application/xml
33037       responses:
33038         "200":
33039           description: successful operation
33040           schema:
33041               $ref: "#/getDefinitions/ctag-assignment"
33042         "default":
33043           description: Response codes found in [response codes](https://wiki.onap.org/).
33044       parameters:
33045         - name: network-id
33046           in: path
33047           description: Network ID, should be uuid. Unique across A&AI.
33048           required: true
33049           type: string
33050           example: __NETWORK-ID__
33051         - name: vlan-id-inner
33052           in: path
33053           description: id.
33054           required: true
33055           type: integer
33056           format: int64
33057           example: __VLAN-ID-INNER__
33058         - name: network-name
33059           in: query
33060           description: Name of the network, governed by some naming convention..
33061           required: false
33062           type: string
33063         - name: network-role
33064           in: query
33065           description: Role the network plans - who defines these values?
33066           required: false
33067           type: string
33068         - name: service-id
33069           in: query
33070           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33071           required: false
33072           type: string
33073         - name: heat-stack-id
33074           in: query
33075           description: Heat stack id corresponding to this instance, managed by MSO
33076           required: false
33077           type: string
33078         - name: contrail-network-fqdn
33079           in: query
33080           description: Contrail FQDN for the network
33081           required: false
33082           type: string
33083         - name: model-invariant-id
33084           in: query
33085           description: the ASDC model id for this resource or service model.
33086           required: false
33087           type: string
33088         - name: model-version-id
33089           in: query
33090           description: the ASDC model version for this resource or service model.
33091           required: false
33092           type: string
33093         - name: widget-model-id
33094           in: query
33095           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33096           required: false
33097           type: string
33098         - name: widget-model-version
33099           in: query
33100           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33101           required: false
33102           type: string
33103     put:
33104       tags:
33105         - Network
33106       summary: create or update an existing ctag-assignment
33107       description: |
33108         Create or update an existing ctag-assignment.
33109         #
33110         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33111       operationId: createOrUpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33112       consumes:
33113         - application/json
33114         - application/xml
33115       produces:
33116         - application/json
33117         - application/xml
33118       responses:
33119         "default":
33120           description: Response codes found in [response codes](https://wiki.onap.org/).
33121       parameters:
33122         - name: network-id
33123           in: path
33124           description: Network ID, should be uuid. Unique across A&AI.
33125           required: true
33126           type: string
33127           example: __NETWORK-ID__
33128         - name: vlan-id-inner
33129           in: path
33130           description: id.
33131           required: true
33132           type: integer
33133           format: int64
33134           example: __VLAN-ID-INNER__
33135         - name: body
33136           in: body
33137           description: ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)
33138           required: true
33139           schema:
33140             $ref: "#/definitions/ctag-assignment"
33141     patch:
33142       tags:
33143         - Network
33144       summary: update an existing ctag-assignment
33145       description: |
33146         Update an existing ctag-assignment
33147         #
33148         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33149         The PUT operation will entirely replace an existing object.
33150         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33151         #
33152         Other differences between PUT and PATCH are:
33153         #
33154         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33155         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33156         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33157       operationId: UpdateNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33158       consumes:
33159         - application/json
33160         - application/xml
33161       produces:
33162         - application/json
33163         - application/xml
33164       responses:
33165         "default":
33166           description: Response codes found in [response codes](https://wiki.onap.org/).
33167       parameters:
33168         - name: network-id
33169           in: path
33170           description: Network ID, should be uuid. Unique across A&AI.
33171           required: true
33172           type: string
33173           example: __NETWORK-ID__
33174         - name: vlan-id-inner
33175           in: path
33176           description: id.
33177           required: true
33178           type: integer
33179           format: int64
33180           example: __VLAN-ID-INNER__
33181         - name: body
33182           in: body
33183           description: ctag-assignment object that needs to be created or updated.
33184           required: true
33185           schema:
33186             $ref: "#/patchDefinitions/ctag-assignment"
33187     delete:
33188       tags:
33189         - Network
33190       summary: delete an existing ctag-assignment
33191       description: delete an existing ctag-assignment
33192       operationId: deleteNetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment
33193       consumes:
33194         - application/json
33195         - application/xml
33196       produces:
33197         - application/json
33198         - application/xml
33199       responses:
33200         "default":
33201           description: Response codes found in [response codes](https://wiki.onap.org/).
33202       parameters:
33203         - name: network-id
33204           in: path
33205           description: Network ID, should be uuid. Unique across A&AI.
33206           required: true
33207           type: string
33208           example: __NETWORK-ID__
33209         - name: vlan-id-inner
33210           in: path
33211           description: id.
33212           required: true
33213           type: integer
33214           format: int64
33215           example: __VLAN-ID-INNER__
33216         - name: resource-version
33217           in: query
33218           description: resource-version for concurrency
33219           required: true
33220           type: string
33221   /network/l3-networks/l3-network/{network-id}/ctag-assignments:
33222     get:
33223       tags:
33224         - Network
33225       summary: returns ctag-assignments
33226       description: returns ctag-assignments
33227       operationId: getNetworkL3NetworksL3NetworkCtagAssignments
33228       produces:
33229         - application/json
33230         - application/xml
33231       responses:
33232         "200":
33233           description: successful operation
33234           schema:
33235               $ref: "#/getDefinitions/ctag-assignments"
33236         "default":
33237           description: Response codes found in [response codes](https://wiki.onap.org/).
33238       parameters:
33239         - name: network-id
33240           in: path
33241           description: Network ID, should be uuid. Unique across A&AI.
33242           required: true
33243           type: string
33244           example: __NETWORK-ID__
33245         - name: network-name
33246           in: query
33247           description: Name of the network, governed by some naming convention..
33248           required: false
33249           type: string
33250         - name: network-role
33251           in: query
33252           description: Role the network plans - who defines these values?
33253           required: false
33254           type: string
33255         - name: service-id
33256           in: query
33257           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33258           required: false
33259           type: string
33260         - name: heat-stack-id
33261           in: query
33262           description: Heat stack id corresponding to this instance, managed by MSO
33263           required: false
33264           type: string
33265         - name: contrail-network-fqdn
33266           in: query
33267           description: Contrail FQDN for the network
33268           required: false
33269           type: string
33270         - name: model-invariant-id
33271           in: query
33272           description: the ASDC model id for this resource or service model.
33273           required: false
33274           type: string
33275         - name: model-version-id
33276           in: query
33277           description: the ASDC model version for this resource or service model.
33278           required: false
33279           type: string
33280         - name: widget-model-id
33281           in: query
33282           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33283           required: false
33284           type: string
33285         - name: widget-model-version
33286           in: query
33287           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33288           required: false
33289           type: string
33290   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship:
33291     put:
33292       tags:
33293         - Network
33294       summary: see node definition for valid relationships
33295       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
33296       consumes:
33297         - application/json
33298         - application/xml
33299       produces:
33300         - application/json
33301         - application/xml
33302       responses:
33303         "default":
33304           description: Response codes found in [response codes](https://wiki.onap.org/).
33305       parameters:
33306         - name: network-id
33307           in: path
33308           description: Network ID, should be uuid. Unique across A&AI.
33309           required: true
33310           type: string
33311           example: __NETWORK-ID__
33312         - name: segmentation-id
33313           in: path
33314           description: Route Table Reference id, UUID assigned to this instance.
33315           required: true
33316           type: string
33317           example: __SEGMENTATION-ID__
33318         - name: body
33319           in: body
33320           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
33321           required: true
33322           schema:
33323             $ref: "#/definitions/relationship"
33324     delete:
33325       tags:
33326         - Network
33327       summary: delete an existing relationship
33328       description: delete an existing relationship
33329       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignmentRelationshipListRelationship
33330       consumes:
33331         - application/json
33332         - application/xml
33333       produces:
33334         - application/json
33335         - application/xml
33336       responses:
33337         "default":
33338           description: Response codes found in [response codes](https://wiki.onap.org/).
33339       parameters:
33340         - name: network-id
33341           in: path
33342           description: Network ID, should be uuid. Unique across A&AI.
33343           required: true
33344           type: string
33345           example: __NETWORK-ID__
33346         - name: segmentation-id
33347           in: path
33348           description: Route Table Reference id, UUID assigned to this instance.
33349           required: true
33350           type: string
33351           example: __SEGMENTATION-ID__
33352   /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}:
33353     get:
33354       tags:
33355         - Network
33356       summary: returns segmentation-assignment
33357       description: returns segmentation-assignment
33358       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33359       produces:
33360         - application/json
33361         - application/xml
33362       responses:
33363         "200":
33364           description: successful operation
33365           schema:
33366               $ref: "#/getDefinitions/segmentation-assignment"
33367         "default":
33368           description: Response codes found in [response codes](https://wiki.onap.org/).
33369       parameters:
33370         - name: network-id
33371           in: path
33372           description: Network ID, should be uuid. Unique across A&AI.
33373           required: true
33374           type: string
33375           example: __NETWORK-ID__
33376         - name: segmentation-id
33377           in: path
33378           description: Route Table Reference id, UUID assigned to this instance.
33379           required: true
33380           type: string
33381           example: __SEGMENTATION-ID__
33382         - name: network-name
33383           in: query
33384           description: Name of the network, governed by some naming convention..
33385           required: false
33386           type: string
33387         - name: network-role
33388           in: query
33389           description: Role the network plans - who defines these values?
33390           required: false
33391           type: string
33392         - name: service-id
33393           in: query
33394           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33395           required: false
33396           type: string
33397         - name: heat-stack-id
33398           in: query
33399           description: Heat stack id corresponding to this instance, managed by MSO
33400           required: false
33401           type: string
33402         - name: contrail-network-fqdn
33403           in: query
33404           description: Contrail FQDN for the network
33405           required: false
33406           type: string
33407         - name: model-invariant-id
33408           in: query
33409           description: the ASDC model id for this resource or service model.
33410           required: false
33411           type: string
33412         - name: model-version-id
33413           in: query
33414           description: the ASDC model version for this resource or service model.
33415           required: false
33416           type: string
33417         - name: widget-model-id
33418           in: query
33419           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33420           required: false
33421           type: string
33422         - name: widget-model-version
33423           in: query
33424           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33425           required: false
33426           type: string
33427     put:
33428       tags:
33429         - Network
33430       summary: create or update an existing segmentation-assignment
33431       description: |
33432         Create or update an existing segmentation-assignment.
33433         #
33434         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33435       operationId: createOrUpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33436       consumes:
33437         - application/json
33438         - application/xml
33439       produces:
33440         - application/json
33441         - application/xml
33442       responses:
33443         "default":
33444           description: Response codes found in [response codes](https://wiki.onap.org/).
33445       parameters:
33446         - name: network-id
33447           in: path
33448           description: Network ID, should be uuid. Unique across A&AI.
33449           required: true
33450           type: string
33451           example: __NETWORK-ID__
33452         - name: segmentation-id
33453           in: path
33454           description: Route Table Reference id, UUID assigned to this instance.
33455           required: true
33456           type: string
33457           example: __SEGMENTATION-ID__
33458         - name: body
33459           in: body
33460           description: segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)
33461           required: true
33462           schema:
33463             $ref: "#/definitions/segmentation-assignment"
33464     patch:
33465       tags:
33466         - Network
33467       summary: update an existing segmentation-assignment
33468       description: |
33469         Update an existing segmentation-assignment
33470         #
33471         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33472         The PUT operation will entirely replace an existing object.
33473         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33474         #
33475         Other differences between PUT and PATCH are:
33476         #
33477         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33478         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33479         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33480       operationId: UpdateNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33481       consumes:
33482         - application/json
33483         - application/xml
33484       produces:
33485         - application/json
33486         - application/xml
33487       responses:
33488         "default":
33489           description: Response codes found in [response codes](https://wiki.onap.org/).
33490       parameters:
33491         - name: network-id
33492           in: path
33493           description: Network ID, should be uuid. Unique across A&AI.
33494           required: true
33495           type: string
33496           example: __NETWORK-ID__
33497         - name: segmentation-id
33498           in: path
33499           description: Route Table Reference id, UUID assigned to this instance.
33500           required: true
33501           type: string
33502           example: __SEGMENTATION-ID__
33503         - name: body
33504           in: body
33505           description: segmentation-assignment object that needs to be created or updated.
33506           required: true
33507           schema:
33508             $ref: "#/patchDefinitions/segmentation-assignment"
33509     delete:
33510       tags:
33511         - Network
33512       summary: delete an existing segmentation-assignment
33513       description: delete an existing segmentation-assignment
33514       operationId: deleteNetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment
33515       consumes:
33516         - application/json
33517         - application/xml
33518       produces:
33519         - application/json
33520         - application/xml
33521       responses:
33522         "default":
33523           description: Response codes found in [response codes](https://wiki.onap.org/).
33524       parameters:
33525         - name: network-id
33526           in: path
33527           description: Network ID, should be uuid. Unique across A&AI.
33528           required: true
33529           type: string
33530           example: __NETWORK-ID__
33531         - name: segmentation-id
33532           in: path
33533           description: Route Table Reference id, UUID assigned to this instance.
33534           required: true
33535           type: string
33536           example: __SEGMENTATION-ID__
33537         - name: resource-version
33538           in: query
33539           description: resource-version for concurrency
33540           required: true
33541           type: string
33542   /network/l3-networks/l3-network/{network-id}/segmentation-assignments:
33543     get:
33544       tags:
33545         - Network
33546       summary: returns segmentation-assignments
33547       description: returns segmentation-assignments
33548       operationId: getNetworkL3NetworksL3NetworkSegmentationAssignments
33549       produces:
33550         - application/json
33551         - application/xml
33552       responses:
33553         "200":
33554           description: successful operation
33555           schema:
33556               $ref: "#/getDefinitions/segmentation-assignments"
33557         "default":
33558           description: Response codes found in [response codes](https://wiki.onap.org/).
33559       parameters:
33560         - name: network-id
33561           in: path
33562           description: Network ID, should be uuid. Unique across A&AI.
33563           required: true
33564           type: string
33565           example: __NETWORK-ID__
33566         - name: network-name
33567           in: query
33568           description: Name of the network, governed by some naming convention..
33569           required: false
33570           type: string
33571         - name: network-role
33572           in: query
33573           description: Role the network plans - who defines these values?
33574           required: false
33575           type: string
33576         - name: service-id
33577           in: query
33578           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33579           required: false
33580           type: string
33581         - name: heat-stack-id
33582           in: query
33583           description: Heat stack id corresponding to this instance, managed by MSO
33584           required: false
33585           type: string
33586         - name: contrail-network-fqdn
33587           in: query
33588           description: Contrail FQDN for the network
33589           required: false
33590           type: string
33591         - name: model-invariant-id
33592           in: query
33593           description: the ASDC model id for this resource or service model.
33594           required: false
33595           type: string
33596         - name: model-version-id
33597           in: query
33598           description: the ASDC model version for this resource or service model.
33599           required: false
33600           type: string
33601         - name: widget-model-id
33602           in: query
33603           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33604           required: false
33605           type: string
33606         - name: widget-model-version
33607           in: query
33608           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33609           required: false
33610           type: string
33611   /network/l3-networks/l3-network/{network-id}/relationship-list/relationship:
33612     put:
33613       tags:
33614         - Network
33615       summary: see node definition for valid relationships
33616       operationId: createOrUpdateNetworkL3NetworksL3NetworkRelationshipListRelationship
33617       consumes:
33618         - application/json
33619         - application/xml
33620       produces:
33621         - application/json
33622         - application/xml
33623       responses:
33624         "default":
33625           description: Response codes found in [response codes](https://wiki.onap.org/).
33626       parameters:
33627         - name: network-id
33628           in: path
33629           description: Network ID, should be uuid. Unique across A&AI.
33630           required: true
33631           type: string
33632           example: __NETWORK-ID__
33633         - name: body
33634           in: body
33635           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
33636           required: true
33637           schema:
33638             $ref: "#/definitions/relationship"
33639     delete:
33640       tags:
33641         - Network
33642       summary: delete an existing relationship
33643       description: delete an existing relationship
33644       operationId: deleteNetworkL3NetworksL3NetworkRelationshipListRelationship
33645       consumes:
33646         - application/json
33647         - application/xml
33648       produces:
33649         - application/json
33650         - application/xml
33651       responses:
33652         "default":
33653           description: Response codes found in [response codes](https://wiki.onap.org/).
33654       parameters:
33655         - name: network-id
33656           in: path
33657           description: Network ID, should be uuid. Unique across A&AI.
33658           required: true
33659           type: string
33660           example: __NETWORK-ID__
33661   /network/l3-networks/l3-network/{network-id}:
33662     get:
33663       tags:
33664         - Network
33665       summary: returns l3-network
33666       description: returns l3-network
33667       operationId: getNetworkL3NetworksL3Network
33668       produces:
33669         - application/json
33670         - application/xml
33671       responses:
33672         "200":
33673           description: successful operation
33674           schema:
33675               $ref: "#/getDefinitions/l3-network"
33676         "default":
33677           description: Response codes found in [response codes](https://wiki.onap.org/).
33678       parameters:
33679         - name: network-id
33680           in: path
33681           description: Network ID, should be uuid. Unique across A&AI.
33682           required: true
33683           type: string
33684           example: __NETWORK-ID__
33685         - name: network-name
33686           in: query
33687           description: Name of the network, governed by some naming convention..
33688           required: false
33689           type: string
33690         - name: network-role
33691           in: query
33692           description: Role the network plans - who defines these values?
33693           required: false
33694           type: string
33695         - name: service-id
33696           in: query
33697           description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
33698           required: false
33699           type: string
33700         - name: heat-stack-id
33701           in: query
33702           description: Heat stack id corresponding to this instance, managed by MSO
33703           required: false
33704           type: string
33705         - name: contrail-network-fqdn
33706           in: query
33707           description: Contrail FQDN for the network
33708           required: false
33709           type: string
33710         - name: model-invariant-id
33711           in: query
33712           description: the ASDC model id for this resource or service model.
33713           required: false
33714           type: string
33715         - name: model-version-id
33716           in: query
33717           description: the ASDC model version for this resource or service model.
33718           required: false
33719           type: string
33720         - name: widget-model-id
33721           in: query
33722           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
33723           required: false
33724           type: string
33725         - name: widget-model-version
33726           in: query
33727           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
33728           required: false
33729           type: string
33730     put:
33731       tags:
33732         - Network
33733       summary: create or update an existing l3-network
33734       description: |
33735         Create or update an existing l3-network.
33736         #
33737         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33738       operationId: createOrUpdateNetworkL3NetworksL3Network
33739       consumes:
33740         - application/json
33741         - application/xml
33742       produces:
33743         - application/json
33744         - application/xml
33745       responses:
33746         "default":
33747           description: Response codes found in [response codes](https://wiki.onap.org/).
33748       parameters:
33749         - name: network-id
33750           in: path
33751           description: Network ID, should be uuid. Unique across A&AI.
33752           required: true
33753           type: string
33754           example: __NETWORK-ID__
33755         - name: body
33756           in: body
33757           description: l3-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)
33758           required: true
33759           schema:
33760             $ref: "#/definitions/l3-network"
33761     patch:
33762       tags:
33763         - Network
33764       summary: update an existing l3-network
33765       description: |
33766         Update an existing l3-network
33767         #
33768         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33769         The PUT operation will entirely replace an existing object.
33770         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33771         #
33772         Other differences between PUT and PATCH are:
33773         #
33774         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33775         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33776         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33777       operationId: UpdateNetworkL3NetworksL3Network
33778       consumes:
33779         - application/json
33780         - application/xml
33781       produces:
33782         - application/json
33783         - application/xml
33784       responses:
33785         "default":
33786           description: Response codes found in [response codes](https://wiki.onap.org/).
33787       parameters:
33788         - name: network-id
33789           in: path
33790           description: Network ID, should be uuid. Unique across A&AI.
33791           required: true
33792           type: string
33793           example: __NETWORK-ID__
33794         - name: body
33795           in: body
33796           description: l3-network object that needs to be created or updated.
33797           required: true
33798           schema:
33799             $ref: "#/patchDefinitions/l3-network"
33800     delete:
33801       tags:
33802         - Network
33803       summary: delete an existing l3-network
33804       description: delete an existing l3-network
33805       operationId: deleteNetworkL3NetworksL3Network
33806       consumes:
33807         - application/json
33808         - application/xml
33809       produces:
33810         - application/json
33811         - application/xml
33812       responses:
33813         "default":
33814           description: Response codes found in [response codes](https://wiki.onap.org/).
33815       parameters:
33816         - name: network-id
33817           in: path
33818           description: Network ID, should be uuid. Unique across A&AI.
33819           required: true
33820           type: string
33821           example: __NETWORK-ID__
33822         - name: resource-version
33823           in: query
33824           description: resource-version for concurrency
33825           required: true
33826           type: string
33827   /network/l3-networks:
33828     get:
33829       tags:
33830         - Network
33831       summary: returns l3-networks
33832       description: returns l3-networks
33833       operationId: getNetworkL3Networks
33834       produces:
33835         - application/json
33836         - application/xml
33837       responses:
33838         "200":
33839           description: successful operation
33840           schema:
33841               $ref: "#/getDefinitions/l3-networks"
33842         "default":
33843           description: Response codes found in [response codes](https://wiki.onap.org/).
33844   /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship:
33845     put:
33846       tags:
33847         - Network
33848       summary: see node definition for valid relationships
33849       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
33850       consumes:
33851         - application/json
33852         - application/xml
33853       produces:
33854         - application/json
33855         - application/xml
33856       responses:
33857         "default":
33858           description: Response codes found in [response codes](https://wiki.onap.org/).
33859       parameters:
33860         - name: network-policy-id
33861           in: path
33862           description: UUID representing unique key to this instance
33863           required: true
33864           type: string
33865           example: __NETWORK-POLICY-ID__
33866         - name: body
33867           in: body
33868           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
33869           required: true
33870           schema:
33871             $ref: "#/definitions/relationship"
33872     delete:
33873       tags:
33874         - Network
33875       summary: delete an existing relationship
33876       description: delete an existing relationship
33877       operationId: deleteNetworkNetworkPoliciesNetworkPolicyRelationshipListRelationship
33878       consumes:
33879         - application/json
33880         - application/xml
33881       produces:
33882         - application/json
33883         - application/xml
33884       responses:
33885         "default":
33886           description: Response codes found in [response codes](https://wiki.onap.org/).
33887       parameters:
33888         - name: network-policy-id
33889           in: path
33890           description: UUID representing unique key to this instance
33891           required: true
33892           type: string
33893           example: __NETWORK-POLICY-ID__
33894   /network/network-policies/network-policy/{network-policy-id}:
33895     get:
33896       tags:
33897         - Network
33898       summary: returns network-policy
33899       description: returns network-policy
33900       operationId: getNetworkNetworkPoliciesNetworkPolicy
33901       produces:
33902         - application/json
33903         - application/xml
33904       responses:
33905         "200":
33906           description: successful operation
33907           schema:
33908               $ref: "#/getDefinitions/network-policy"
33909         "default":
33910           description: Response codes found in [response codes](https://wiki.onap.org/).
33911       parameters:
33912         - name: network-policy-id
33913           in: path
33914           description: UUID representing unique key to this instance
33915           required: true
33916           type: string
33917           example: __NETWORK-POLICY-ID__
33918         - name: network-policy-fqdn
33919           in: query
33920           description: Contrail FQDN for the policy
33921           required: false
33922           type: string
33923     put:
33924       tags:
33925         - Network
33926       summary: create or update an existing network-policy
33927       description: |
33928         Create or update an existing network-policy.
33929         #
33930         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
33931       operationId: createOrUpdateNetworkNetworkPoliciesNetworkPolicy
33932       consumes:
33933         - application/json
33934         - application/xml
33935       produces:
33936         - application/json
33937         - application/xml
33938       responses:
33939         "default":
33940           description: Response codes found in [response codes](https://wiki.onap.org/).
33941       parameters:
33942         - name: network-policy-id
33943           in: path
33944           description: UUID representing unique key to this instance
33945           required: true
33946           type: string
33947           example: __NETWORK-POLICY-ID__
33948         - name: body
33949           in: body
33950           description: network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)
33951           required: true
33952           schema:
33953             $ref: "#/definitions/network-policy"
33954     patch:
33955       tags:
33956         - Network
33957       summary: update an existing network-policy
33958       description: |
33959         Update an existing network-policy
33960         #
33961         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
33962         The PUT operation will entirely replace an existing object.
33963         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
33964         #
33965         Other differences between PUT and PATCH are:
33966         #
33967         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
33968         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
33969         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
33970       operationId: UpdateNetworkNetworkPoliciesNetworkPolicy
33971       consumes:
33972         - application/json
33973         - application/xml
33974       produces:
33975         - application/json
33976         - application/xml
33977       responses:
33978         "default":
33979           description: Response codes found in [response codes](https://wiki.onap.org/).
33980       parameters:
33981         - name: network-policy-id
33982           in: path
33983           description: UUID representing unique key to this instance
33984           required: true
33985           type: string
33986           example: __NETWORK-POLICY-ID__
33987         - name: body
33988           in: body
33989           description: network-policy object that needs to be created or updated.
33990           required: true
33991           schema:
33992             $ref: "#/patchDefinitions/network-policy"
33993     delete:
33994       tags:
33995         - Network
33996       summary: delete an existing network-policy
33997       description: delete an existing network-policy
33998       operationId: deleteNetworkNetworkPoliciesNetworkPolicy
33999       consumes:
34000         - application/json
34001         - application/xml
34002       produces:
34003         - application/json
34004         - application/xml
34005       responses:
34006         "default":
34007           description: Response codes found in [response codes](https://wiki.onap.org/).
34008       parameters:
34009         - name: network-policy-id
34010           in: path
34011           description: UUID representing unique key to this instance
34012           required: true
34013           type: string
34014           example: __NETWORK-POLICY-ID__
34015         - name: resource-version
34016           in: query
34017           description: resource-version for concurrency
34018           required: true
34019           type: string
34020   /network/network-policies:
34021     get:
34022       tags:
34023         - Network
34024       summary: returns network-policies
34025       description: returns network-policies
34026       operationId: getNetworkNetworkPolicies
34027       produces:
34028         - application/json
34029         - application/xml
34030       responses:
34031         "200":
34032           description: successful operation
34033           schema:
34034               $ref: "#/getDefinitions/network-policies"
34035         "default":
34036           description: Response codes found in [response codes](https://wiki.onap.org/).
34037   /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship:
34038     put:
34039       tags:
34040         - Network
34041       summary: see node definition for valid relationships
34042       operationId: createOrUpdateNetworkGenericVnfsGenericVnfRelationshipListRelationship
34043       consumes:
34044         - application/json
34045         - application/xml
34046       produces:
34047         - application/json
34048         - application/xml
34049       responses:
34050         "default":
34051           description: Response codes found in [response codes](https://wiki.onap.org/).
34052       parameters:
34053         - name: vnf-id
34054           in: path
34055           description: Unique id of VNF.  This is unique across the graph.
34056           required: true
34057           type: string
34058           example: __VNF-ID__
34059         - name: body
34060           in: body
34061           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
34062           required: true
34063           schema:
34064             $ref: "#/definitions/relationship"
34065     delete:
34066       tags:
34067         - Network
34068       summary: delete an existing relationship
34069       description: delete an existing relationship
34070       operationId: deleteNetworkGenericVnfsGenericVnfRelationshipListRelationship
34071       consumes:
34072         - application/json
34073         - application/xml
34074       produces:
34075         - application/json
34076         - application/xml
34077       responses:
34078         "default":
34079           description: Response codes found in [response codes](https://wiki.onap.org/).
34080       parameters:
34081         - name: vnf-id
34082           in: path
34083           description: Unique id of VNF.  This is unique across the graph.
34084           required: true
34085           type: string
34086           example: __VNF-ID__
34087   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
34088     put:
34089       tags:
34090         - Network
34091       summary: see node definition for valid relationships
34092       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34093       consumes:
34094         - application/json
34095         - application/xml
34096       produces:
34097         - application/json
34098         - application/xml
34099       responses:
34100         "default":
34101           description: Response codes found in [response codes](https://wiki.onap.org/).
34102       parameters:
34103         - name: vnf-id
34104           in: path
34105           description: Unique id of VNF.  This is unique across the graph.
34106           required: true
34107           type: string
34108           example: __VNF-ID__
34109         - name: interface-name
34110           in: path
34111           description: Name given to the interface
34112           required: true
34113           type: string
34114           example: __INTERFACE-NAME__
34115         - name: vlan-interface
34116           in: path
34117           description: String that identifies the interface
34118           required: true
34119           type: string
34120           example: __VLAN-INTERFACE__
34121         - name: body
34122           in: body
34123           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
34124           required: true
34125           schema:
34126             $ref: "#/definitions/relationship"
34127     delete:
34128       tags:
34129         - Network
34130       summary: delete an existing relationship
34131       description: delete an existing relationship
34132       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanRelationshipListRelationship
34133       consumes:
34134         - application/json
34135         - application/xml
34136       produces:
34137         - application/json
34138         - application/xml
34139       responses:
34140         "default":
34141           description: Response codes found in [response codes](https://wiki.onap.org/).
34142       parameters:
34143         - name: vnf-id
34144           in: path
34145           description: Unique id of VNF.  This is unique across the graph.
34146           required: true
34147           type: string
34148           example: __VNF-ID__
34149         - name: interface-name
34150           in: path
34151           description: Name given to the interface
34152           required: true
34153           type: string
34154           example: __INTERFACE-NAME__
34155         - name: vlan-interface
34156           in: path
34157           description: String that identifies the interface
34158           required: true
34159           type: string
34160           example: __VLAN-INTERFACE__
34161   /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:
34162     put:
34163       tags:
34164         - Network
34165       summary: see node definition for valid relationships
34166       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34167       consumes:
34168         - application/json
34169         - application/xml
34170       produces:
34171         - application/json
34172         - application/xml
34173       responses:
34174         "default":
34175           description: Response codes found in [response codes](https://wiki.onap.org/).
34176       parameters:
34177         - name: vnf-id
34178           in: path
34179           description: Unique id of VNF.  This is unique across the graph.
34180           required: true
34181           type: string
34182           example: __VNF-ID__
34183         - name: interface-name
34184           in: path
34185           description: Name given to the interface
34186           required: true
34187           type: string
34188           example: __INTERFACE-NAME__
34189         - name: vlan-interface
34190           in: path
34191           description: String that identifies the interface
34192           required: true
34193           type: string
34194           example: __VLAN-INTERFACE__
34195         - name: l3-interface-ipv4-address
34196           in: path
34197           description: IP address
34198           required: true
34199           type: string
34200           example: __L3-INTERFACE-IPV4-ADDRESS__
34201         - name: body
34202           in: body
34203           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34204           required: true
34205           schema:
34206             $ref: "#/definitions/relationship"
34207     delete:
34208       tags:
34209         - Network
34210       summary: delete an existing relationship
34211       description: delete an existing relationship
34212       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
34213       consumes:
34214         - application/json
34215         - application/xml
34216       produces:
34217         - application/json
34218         - application/xml
34219       responses:
34220         "default":
34221           description: Response codes found in [response codes](https://wiki.onap.org/).
34222       parameters:
34223         - name: vnf-id
34224           in: path
34225           description: Unique id of VNF.  This is unique across the graph.
34226           required: true
34227           type: string
34228           example: __VNF-ID__
34229         - name: interface-name
34230           in: path
34231           description: Name given to the interface
34232           required: true
34233           type: string
34234           example: __INTERFACE-NAME__
34235         - name: vlan-interface
34236           in: path
34237           description: String that identifies the interface
34238           required: true
34239           type: string
34240           example: __VLAN-INTERFACE__
34241         - name: l3-interface-ipv4-address
34242           in: path
34243           description: IP address
34244           required: true
34245           type: string
34246           example: __L3-INTERFACE-IPV4-ADDRESS__
34247   /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}:
34248     get:
34249       tags:
34250         - Network
34251       summary: returns l3-interface-ipv4-address-list
34252       description: returns l3-interface-ipv4-address-list
34253       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34254       produces:
34255         - application/json
34256         - application/xml
34257       responses:
34258         "200":
34259           description: successful operation
34260           schema:
34261               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
34262         "default":
34263           description: Response codes found in [response codes](https://wiki.onap.org/).
34264       parameters:
34265         - name: vnf-id
34266           in: path
34267           description: Unique id of VNF.  This is unique across the graph.
34268           required: true
34269           type: string
34270           example: __VNF-ID__
34271         - name: interface-name
34272           in: path
34273           description: Name given to the interface
34274           required: true
34275           type: string
34276           example: __INTERFACE-NAME__
34277         - name: vlan-interface
34278           in: path
34279           description: String that identifies the interface
34280           required: true
34281           type: string
34282           example: __VLAN-INTERFACE__
34283         - name: l3-interface-ipv4-address
34284           in: path
34285           description: IP address
34286           required: true
34287           type: string
34288           example: __L3-INTERFACE-IPV4-ADDRESS__
34289         - name: vnf-name
34290           in: query
34291           description: Name of VNF.
34292           required: false
34293           type: string
34294         - name: vnf-name2
34295           in: query
34296           description: Alternate name of VNF.
34297           required: false
34298           type: string
34299         - name: vnf-type
34300           in: query
34301           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.
34302           required: false
34303           type: string
34304         - name: service-id
34305           in: query
34306           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34307           required: false
34308           type: string
34309         - name: regional-resource-zone
34310           in: query
34311           description: Regional way of organizing pservers, source of truth should define values
34312           required: false
34313           type: string
34314         - name: prov-status
34315           in: query
34316           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34317           required: false
34318           type: string
34319         - name: heat-stack-id
34320           in: query
34321           description: Heat stack id corresponding to this instance, managed by MSO
34322           required: false
34323           type: string
34324         - name: in-maint
34325           in: query
34326           required: false
34327           type: boolean
34328         - name: is-closed-loop-disabled
34329           in: query
34330           required: false
34331           type: boolean
34332         - name: model-invariant-id
34333           in: query
34334           description: the ASDC model id for this resource or service model.
34335           required: false
34336           type: string
34337         - name: model-version-id
34338           in: query
34339           description: the ASDC model version for this resource or service model.
34340           required: false
34341           type: string
34342         - name: widget-model-id
34343           in: query
34344           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34345           required: false
34346           type: string
34347         - name: widget-model-version
34348           in: query
34349           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34350           required: false
34351           type: string
34352         - name: nf-type
34353           in: query
34354           description: Generic description of the type of NF
34355           required: false
34356           type: string
34357         - name: nf-function
34358           in: query
34359           description: English description of Network function that the specific VNF deployment is providing
34360           required: false
34361           type: string
34362         - name: nf-role
34363           in: query
34364           description: role in the network that this model will be providing
34365           required: false
34366           type: string
34367         - name: nf-naming-code
34368           in: query
34369           description: string assigned to this model used for naming purposes
34370           required: false
34371           type: string
34372         - name: interface-id
34373           in: query
34374           description: ID of interface
34375           required: false
34376           type: string
34377         - name: macaddr
34378           in: query
34379           description: MAC address for the interface
34380           required: false
34381           type: string
34382         - name: network-name
34383           in: query
34384           description: Name of the network
34385           required: false
34386           type: string
34387         - name: vlan-id-inner
34388           in: query
34389           description: Inner VLAN tag
34390           required: false
34391           type: integer
34392           format: int64
34393         - name: vpn-key
34394           in: query
34395           description: This indicates the customers VPN ID associated with this vlan
34396           required: false
34397           type: string
34398         - name: vlan-id-inner
34399           in: query
34400           description: Inner VLAN tag
34401           required: false
34402           type: integer
34403           format: int64
34404         - name: neutron-network-id
34405           in: query
34406           description: Neutron network id of the interface that address belongs to
34407           required: false
34408           type: string
34409         - name: neutron-subnet-id
34410           in: query
34411           description: Neutron id of subnet that address belongs to
34412           required: false
34413           type: string
34414     put:
34415       tags:
34416         - Network
34417       summary: create or update an existing l3-interface-ipv4-address-list
34418       description: |
34419         Create or update an existing l3-interface-ipv4-address-list.
34420         #
34421         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34422       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34423       consumes:
34424         - application/json
34425         - application/xml
34426       produces:
34427         - application/json
34428         - application/xml
34429       responses:
34430         "default":
34431           description: Response codes found in [response codes](https://wiki.onap.org/).
34432       parameters:
34433         - name: vnf-id
34434           in: path
34435           description: Unique id of VNF.  This is unique across the graph.
34436           required: true
34437           type: string
34438           example: __VNF-ID__
34439         - name: interface-name
34440           in: path
34441           description: Name given to the interface
34442           required: true
34443           type: string
34444           example: __INTERFACE-NAME__
34445         - name: vlan-interface
34446           in: path
34447           description: String that identifies the interface
34448           required: true
34449           type: string
34450           example: __VLAN-INTERFACE__
34451         - name: l3-interface-ipv4-address
34452           in: path
34453           description: IP address
34454           required: true
34455           type: string
34456           example: __L3-INTERFACE-IPV4-ADDRESS__
34457         - name: body
34458           in: body
34459           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
34460           required: true
34461           schema:
34462             $ref: "#/definitions/l3-interface-ipv4-address-list"
34463     patch:
34464       tags:
34465         - Network
34466       summary: update an existing l3-interface-ipv4-address-list
34467       description: |
34468         Update an existing l3-interface-ipv4-address-list
34469         #
34470         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34471         The PUT operation will entirely replace an existing object.
34472         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34473         #
34474         Other differences between PUT and PATCH are:
34475         #
34476         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34477         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34478         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34479       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34480       consumes:
34481         - application/json
34482         - application/xml
34483       produces:
34484         - application/json
34485         - application/xml
34486       responses:
34487         "default":
34488           description: Response codes found in [response codes](https://wiki.onap.org/).
34489       parameters:
34490         - name: vnf-id
34491           in: path
34492           description: Unique id of VNF.  This is unique across the graph.
34493           required: true
34494           type: string
34495           example: __VNF-ID__
34496         - name: interface-name
34497           in: path
34498           description: Name given to the interface
34499           required: true
34500           type: string
34501           example: __INTERFACE-NAME__
34502         - name: vlan-interface
34503           in: path
34504           description: String that identifies the interface
34505           required: true
34506           type: string
34507           example: __VLAN-INTERFACE__
34508         - name: l3-interface-ipv4-address
34509           in: path
34510           description: IP address
34511           required: true
34512           type: string
34513           example: __L3-INTERFACE-IPV4-ADDRESS__
34514         - name: body
34515           in: body
34516           description: l3-interface-ipv4-address-list object that needs to be created or updated.
34517           required: true
34518           schema:
34519             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
34520     delete:
34521       tags:
34522         - Network
34523       summary: delete an existing l3-interface-ipv4-address-list
34524       description: delete an existing l3-interface-ipv4-address-list
34525       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
34526       consumes:
34527         - application/json
34528         - application/xml
34529       produces:
34530         - application/json
34531         - application/xml
34532       responses:
34533         "default":
34534           description: Response codes found in [response codes](https://wiki.onap.org/).
34535       parameters:
34536         - name: vnf-id
34537           in: path
34538           description: Unique id of VNF.  This is unique across the graph.
34539           required: true
34540           type: string
34541           example: __VNF-ID__
34542         - name: interface-name
34543           in: path
34544           description: Name given to the interface
34545           required: true
34546           type: string
34547           example: __INTERFACE-NAME__
34548         - name: vlan-interface
34549           in: path
34550           description: String that identifies the interface
34551           required: true
34552           type: string
34553           example: __VLAN-INTERFACE__
34554         - name: l3-interface-ipv4-address
34555           in: path
34556           description: IP address
34557           required: true
34558           type: string
34559           example: __L3-INTERFACE-IPV4-ADDRESS__
34560         - name: resource-version
34561           in: query
34562           description: resource-version for concurrency
34563           required: true
34564           type: string
34565   /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:
34566     put:
34567       tags:
34568         - Network
34569       summary: see node definition for valid relationships
34570       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34571       consumes:
34572         - application/json
34573         - application/xml
34574       produces:
34575         - application/json
34576         - application/xml
34577       responses:
34578         "default":
34579           description: Response codes found in [response codes](https://wiki.onap.org/).
34580       parameters:
34581         - name: vnf-id
34582           in: path
34583           description: Unique id of VNF.  This is unique across the graph.
34584           required: true
34585           type: string
34586           example: __VNF-ID__
34587         - name: interface-name
34588           in: path
34589           description: Name given to the interface
34590           required: true
34591           type: string
34592           example: __INTERFACE-NAME__
34593         - name: vlan-interface
34594           in: path
34595           description: String that identifies the interface
34596           required: true
34597           type: string
34598           example: __VLAN-INTERFACE__
34599         - name: l3-interface-ipv6-address
34600           in: path
34601           description: IP address
34602           required: true
34603           type: string
34604           example: __L3-INTERFACE-IPV6-ADDRESS__
34605         - name: body
34606           in: body
34607           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34608           required: true
34609           schema:
34610             $ref: "#/definitions/relationship"
34611     delete:
34612       tags:
34613         - Network
34614       summary: delete an existing relationship
34615       description: delete an existing relationship
34616       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
34617       consumes:
34618         - application/json
34619         - application/xml
34620       produces:
34621         - application/json
34622         - application/xml
34623       responses:
34624         "default":
34625           description: Response codes found in [response codes](https://wiki.onap.org/).
34626       parameters:
34627         - name: vnf-id
34628           in: path
34629           description: Unique id of VNF.  This is unique across the graph.
34630           required: true
34631           type: string
34632           example: __VNF-ID__
34633         - name: interface-name
34634           in: path
34635           description: Name given to the interface
34636           required: true
34637           type: string
34638           example: __INTERFACE-NAME__
34639         - name: vlan-interface
34640           in: path
34641           description: String that identifies the interface
34642           required: true
34643           type: string
34644           example: __VLAN-INTERFACE__
34645         - name: l3-interface-ipv6-address
34646           in: path
34647           description: IP address
34648           required: true
34649           type: string
34650           example: __L3-INTERFACE-IPV6-ADDRESS__
34651   /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}:
34652     get:
34653       tags:
34654         - Network
34655       summary: returns l3-interface-ipv6-address-list
34656       description: returns l3-interface-ipv6-address-list
34657       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34658       produces:
34659         - application/json
34660         - application/xml
34661       responses:
34662         "200":
34663           description: successful operation
34664           schema:
34665               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
34666         "default":
34667           description: Response codes found in [response codes](https://wiki.onap.org/).
34668       parameters:
34669         - name: vnf-id
34670           in: path
34671           description: Unique id of VNF.  This is unique across the graph.
34672           required: true
34673           type: string
34674           example: __VNF-ID__
34675         - name: interface-name
34676           in: path
34677           description: Name given to the interface
34678           required: true
34679           type: string
34680           example: __INTERFACE-NAME__
34681         - name: vlan-interface
34682           in: path
34683           description: String that identifies the interface
34684           required: true
34685           type: string
34686           example: __VLAN-INTERFACE__
34687         - name: l3-interface-ipv6-address
34688           in: path
34689           description: IP address
34690           required: true
34691           type: string
34692           example: __L3-INTERFACE-IPV6-ADDRESS__
34693         - name: vnf-name
34694           in: query
34695           description: Name of VNF.
34696           required: false
34697           type: string
34698         - name: vnf-name2
34699           in: query
34700           description: Alternate name of VNF.
34701           required: false
34702           type: string
34703         - name: vnf-type
34704           in: query
34705           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.
34706           required: false
34707           type: string
34708         - name: service-id
34709           in: query
34710           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
34711           required: false
34712           type: string
34713         - name: regional-resource-zone
34714           in: query
34715           description: Regional way of organizing pservers, source of truth should define values
34716           required: false
34717           type: string
34718         - name: prov-status
34719           in: query
34720           description: Trigger for operational monitoring of this resource by Service Assurance systems.
34721           required: false
34722           type: string
34723         - name: heat-stack-id
34724           in: query
34725           description: Heat stack id corresponding to this instance, managed by MSO
34726           required: false
34727           type: string
34728         - name: in-maint
34729           in: query
34730           required: false
34731           type: boolean
34732         - name: is-closed-loop-disabled
34733           in: query
34734           required: false
34735           type: boolean
34736         - name: model-invariant-id
34737           in: query
34738           description: the ASDC model id for this resource or service model.
34739           required: false
34740           type: string
34741         - name: model-version-id
34742           in: query
34743           description: the ASDC model version for this resource or service model.
34744           required: false
34745           type: string
34746         - name: widget-model-id
34747           in: query
34748           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
34749           required: false
34750           type: string
34751         - name: widget-model-version
34752           in: query
34753           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
34754           required: false
34755           type: string
34756         - name: nf-type
34757           in: query
34758           description: Generic description of the type of NF
34759           required: false
34760           type: string
34761         - name: nf-function
34762           in: query
34763           description: English description of Network function that the specific VNF deployment is providing
34764           required: false
34765           type: string
34766         - name: nf-role
34767           in: query
34768           description: role in the network that this model will be providing
34769           required: false
34770           type: string
34771         - name: nf-naming-code
34772           in: query
34773           description: string assigned to this model used for naming purposes
34774           required: false
34775           type: string
34776         - name: interface-id
34777           in: query
34778           description: ID of interface
34779           required: false
34780           type: string
34781         - name: macaddr
34782           in: query
34783           description: MAC address for the interface
34784           required: false
34785           type: string
34786         - name: network-name
34787           in: query
34788           description: Name of the network
34789           required: false
34790           type: string
34791         - name: vlan-id-inner
34792           in: query
34793           description: Inner VLAN tag
34794           required: false
34795           type: integer
34796           format: int64
34797         - name: vpn-key
34798           in: query
34799           description: This indicates the customers VPN ID associated with this vlan
34800           required: false
34801           type: string
34802         - name: vlan-id-inner
34803           in: query
34804           description: Inner VLAN tag
34805           required: false
34806           type: integer
34807           format: int64
34808         - name: neutron-network-id
34809           in: query
34810           description: Neutron network id of the interface that address belongs to
34811           required: false
34812           type: string
34813         - name: neutron-subnet-id
34814           in: query
34815           description: Neutron id of subnet that address belongs to
34816           required: false
34817           type: string
34818     put:
34819       tags:
34820         - Network
34821       summary: create or update an existing l3-interface-ipv6-address-list
34822       description: |
34823         Create or update an existing l3-interface-ipv6-address-list.
34824         #
34825         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
34826       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34827       consumes:
34828         - application/json
34829         - application/xml
34830       produces:
34831         - application/json
34832         - application/xml
34833       responses:
34834         "default":
34835           description: Response codes found in [response codes](https://wiki.onap.org/).
34836       parameters:
34837         - name: vnf-id
34838           in: path
34839           description: Unique id of VNF.  This is unique across the graph.
34840           required: true
34841           type: string
34842           example: __VNF-ID__
34843         - name: interface-name
34844           in: path
34845           description: Name given to the interface
34846           required: true
34847           type: string
34848           example: __INTERFACE-NAME__
34849         - name: vlan-interface
34850           in: path
34851           description: String that identifies the interface
34852           required: true
34853           type: string
34854           example: __VLAN-INTERFACE__
34855         - name: l3-interface-ipv6-address
34856           in: path
34857           description: IP address
34858           required: true
34859           type: string
34860           example: __L3-INTERFACE-IPV6-ADDRESS__
34861         - name: body
34862           in: body
34863           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
34864           required: true
34865           schema:
34866             $ref: "#/definitions/l3-interface-ipv6-address-list"
34867     patch:
34868       tags:
34869         - Network
34870       summary: update an existing l3-interface-ipv6-address-list
34871       description: |
34872         Update an existing l3-interface-ipv6-address-list
34873         #
34874         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
34875         The PUT operation will entirely replace an existing object.
34876         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
34877         #
34878         Other differences between PUT and PATCH are:
34879         #
34880         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
34881         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
34882         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
34883       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34884       consumes:
34885         - application/json
34886         - application/xml
34887       produces:
34888         - application/json
34889         - application/xml
34890       responses:
34891         "default":
34892           description: Response codes found in [response codes](https://wiki.onap.org/).
34893       parameters:
34894         - name: vnf-id
34895           in: path
34896           description: Unique id of VNF.  This is unique across the graph.
34897           required: true
34898           type: string
34899           example: __VNF-ID__
34900         - name: interface-name
34901           in: path
34902           description: Name given to the interface
34903           required: true
34904           type: string
34905           example: __INTERFACE-NAME__
34906         - name: vlan-interface
34907           in: path
34908           description: String that identifies the interface
34909           required: true
34910           type: string
34911           example: __VLAN-INTERFACE__
34912         - name: l3-interface-ipv6-address
34913           in: path
34914           description: IP address
34915           required: true
34916           type: string
34917           example: __L3-INTERFACE-IPV6-ADDRESS__
34918         - name: body
34919           in: body
34920           description: l3-interface-ipv6-address-list object that needs to be created or updated.
34921           required: true
34922           schema:
34923             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
34924     delete:
34925       tags:
34926         - Network
34927       summary: delete an existing l3-interface-ipv6-address-list
34928       description: delete an existing l3-interface-ipv6-address-list
34929       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
34930       consumes:
34931         - application/json
34932         - application/xml
34933       produces:
34934         - application/json
34935         - application/xml
34936       responses:
34937         "default":
34938           description: Response codes found in [response codes](https://wiki.onap.org/).
34939       parameters:
34940         - name: vnf-id
34941           in: path
34942           description: Unique id of VNF.  This is unique across the graph.
34943           required: true
34944           type: string
34945           example: __VNF-ID__
34946         - name: interface-name
34947           in: path
34948           description: Name given to the interface
34949           required: true
34950           type: string
34951           example: __INTERFACE-NAME__
34952         - name: vlan-interface
34953           in: path
34954           description: String that identifies the interface
34955           required: true
34956           type: string
34957           example: __VLAN-INTERFACE__
34958         - name: l3-interface-ipv6-address
34959           in: path
34960           description: IP address
34961           required: true
34962           type: string
34963           example: __L3-INTERFACE-IPV6-ADDRESS__
34964         - name: resource-version
34965           in: query
34966           description: resource-version for concurrency
34967           required: true
34968           type: string
34969   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
34970     get:
34971       tags:
34972         - Network
34973       summary: returns vlan
34974       description: returns vlan
34975       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
34976       produces:
34977         - application/json
34978         - application/xml
34979       responses:
34980         "200":
34981           description: successful operation
34982           schema:
34983               $ref: "#/getDefinitions/vlan"
34984         "default":
34985           description: Response codes found in [response codes](https://wiki.onap.org/).
34986       parameters:
34987         - name: vnf-id
34988           in: path
34989           description: Unique id of VNF.  This is unique across the graph.
34990           required: true
34991           type: string
34992           example: __VNF-ID__
34993         - name: interface-name
34994           in: path
34995           description: Name given to the interface
34996           required: true
34997           type: string
34998           example: __INTERFACE-NAME__
34999         - name: vlan-interface
35000           in: path
35001           description: String that identifies the interface
35002           required: true
35003           type: string
35004           example: __VLAN-INTERFACE__
35005         - name: vnf-name
35006           in: query
35007           description: Name of VNF.
35008           required: false
35009           type: string
35010         - name: vnf-name2
35011           in: query
35012           description: Alternate name of VNF.
35013           required: false
35014           type: string
35015         - name: vnf-type
35016           in: query
35017           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.
35018           required: false
35019           type: string
35020         - name: service-id
35021           in: query
35022           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35023           required: false
35024           type: string
35025         - name: regional-resource-zone
35026           in: query
35027           description: Regional way of organizing pservers, source of truth should define values
35028           required: false
35029           type: string
35030         - name: prov-status
35031           in: query
35032           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35033           required: false
35034           type: string
35035         - name: heat-stack-id
35036           in: query
35037           description: Heat stack id corresponding to this instance, managed by MSO
35038           required: false
35039           type: string
35040         - name: in-maint
35041           in: query
35042           required: false
35043           type: boolean
35044         - name: is-closed-loop-disabled
35045           in: query
35046           required: false
35047           type: boolean
35048         - name: model-invariant-id
35049           in: query
35050           description: the ASDC model id for this resource or service model.
35051           required: false
35052           type: string
35053         - name: model-version-id
35054           in: query
35055           description: the ASDC model version for this resource or service model.
35056           required: false
35057           type: string
35058         - name: widget-model-id
35059           in: query
35060           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35061           required: false
35062           type: string
35063         - name: widget-model-version
35064           in: query
35065           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35066           required: false
35067           type: string
35068         - name: nf-type
35069           in: query
35070           description: Generic description of the type of NF
35071           required: false
35072           type: string
35073         - name: nf-function
35074           in: query
35075           description: English description of Network function that the specific VNF deployment is providing
35076           required: false
35077           type: string
35078         - name: nf-role
35079           in: query
35080           description: role in the network that this model will be providing
35081           required: false
35082           type: string
35083         - name: nf-naming-code
35084           in: query
35085           description: string assigned to this model used for naming purposes
35086           required: false
35087           type: string
35088         - name: interface-id
35089           in: query
35090           description: ID of interface
35091           required: false
35092           type: string
35093         - name: macaddr
35094           in: query
35095           description: MAC address for the interface
35096           required: false
35097           type: string
35098         - name: network-name
35099           in: query
35100           description: Name of the network
35101           required: false
35102           type: string
35103         - name: vlan-id-inner
35104           in: query
35105           description: Inner VLAN tag
35106           required: false
35107           type: integer
35108           format: int64
35109         - name: vpn-key
35110           in: query
35111           description: This indicates the customers VPN ID associated with this vlan
35112           required: false
35113           type: string
35114     put:
35115       tags:
35116         - Network
35117       summary: create or update an existing vlan
35118       description: |
35119         Create or update an existing vlan.
35120         #
35121         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35122       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35123       consumes:
35124         - application/json
35125         - application/xml
35126       produces:
35127         - application/json
35128         - application/xml
35129       responses:
35130         "default":
35131           description: Response codes found in [response codes](https://wiki.onap.org/).
35132       parameters:
35133         - name: vnf-id
35134           in: path
35135           description: Unique id of VNF.  This is unique across the graph.
35136           required: true
35137           type: string
35138           example: __VNF-ID__
35139         - name: interface-name
35140           in: path
35141           description: Name given to the interface
35142           required: true
35143           type: string
35144           example: __INTERFACE-NAME__
35145         - name: vlan-interface
35146           in: path
35147           description: String that identifies the interface
35148           required: true
35149           type: string
35150           example: __VLAN-INTERFACE__
35151         - name: body
35152           in: body
35153           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)
35154           required: true
35155           schema:
35156             $ref: "#/definitions/vlan"
35157     patch:
35158       tags:
35159         - Network
35160       summary: update an existing vlan
35161       description: |
35162         Update an existing vlan
35163         #
35164         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35165         The PUT operation will entirely replace an existing object.
35166         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35167         #
35168         Other differences between PUT and PATCH are:
35169         #
35170         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35171         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35172         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35173       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35174       consumes:
35175         - application/json
35176         - application/xml
35177       produces:
35178         - application/json
35179         - application/xml
35180       responses:
35181         "default":
35182           description: Response codes found in [response codes](https://wiki.onap.org/).
35183       parameters:
35184         - name: vnf-id
35185           in: path
35186           description: Unique id of VNF.  This is unique across the graph.
35187           required: true
35188           type: string
35189           example: __VNF-ID__
35190         - name: interface-name
35191           in: path
35192           description: Name given to the interface
35193           required: true
35194           type: string
35195           example: __INTERFACE-NAME__
35196         - name: vlan-interface
35197           in: path
35198           description: String that identifies the interface
35199           required: true
35200           type: string
35201           example: __VLAN-INTERFACE__
35202         - name: body
35203           in: body
35204           description: vlan object that needs to be created or updated.
35205           required: true
35206           schema:
35207             $ref: "#/patchDefinitions/vlan"
35208     delete:
35209       tags:
35210         - Network
35211       summary: delete an existing vlan
35212       description: delete an existing vlan
35213       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan
35214       consumes:
35215         - application/json
35216         - application/xml
35217       produces:
35218         - application/json
35219         - application/xml
35220       responses:
35221         "default":
35222           description: Response codes found in [response codes](https://wiki.onap.org/).
35223       parameters:
35224         - name: vnf-id
35225           in: path
35226           description: Unique id of VNF.  This is unique across the graph.
35227           required: true
35228           type: string
35229           example: __VNF-ID__
35230         - name: interface-name
35231           in: path
35232           description: Name given to the interface
35233           required: true
35234           type: string
35235           example: __INTERFACE-NAME__
35236         - name: vlan-interface
35237           in: path
35238           description: String that identifies the interface
35239           required: true
35240           type: string
35241           example: __VLAN-INTERFACE__
35242         - name: resource-version
35243           in: query
35244           description: resource-version for concurrency
35245           required: true
35246           type: string
35247   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans:
35248     get:
35249       tags:
35250         - Network
35251       summary: returns vlans
35252       description: returns vlans
35253       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlans
35254       produces:
35255         - application/json
35256         - application/xml
35257       responses:
35258         "200":
35259           description: successful operation
35260           schema:
35261               $ref: "#/getDefinitions/vlans"
35262         "default":
35263           description: Response codes found in [response codes](https://wiki.onap.org/).
35264       parameters:
35265         - name: vnf-id
35266           in: path
35267           description: Unique id of VNF.  This is unique across the graph.
35268           required: true
35269           type: string
35270           example: __VNF-ID__
35271         - name: interface-name
35272           in: path
35273           description: Name given to the interface
35274           required: true
35275           type: string
35276           example: __INTERFACE-NAME__
35277         - name: vnf-name
35278           in: query
35279           description: Name of VNF.
35280           required: false
35281           type: string
35282         - name: vnf-name2
35283           in: query
35284           description: Alternate name of VNF.
35285           required: false
35286           type: string
35287         - name: vnf-type
35288           in: query
35289           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.
35290           required: false
35291           type: string
35292         - name: service-id
35293           in: query
35294           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35295           required: false
35296           type: string
35297         - name: regional-resource-zone
35298           in: query
35299           description: Regional way of organizing pservers, source of truth should define values
35300           required: false
35301           type: string
35302         - name: prov-status
35303           in: query
35304           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35305           required: false
35306           type: string
35307         - name: heat-stack-id
35308           in: query
35309           description: Heat stack id corresponding to this instance, managed by MSO
35310           required: false
35311           type: string
35312         - name: in-maint
35313           in: query
35314           required: false
35315           type: boolean
35316         - name: is-closed-loop-disabled
35317           in: query
35318           required: false
35319           type: boolean
35320         - name: model-invariant-id
35321           in: query
35322           description: the ASDC model id for this resource or service model.
35323           required: false
35324           type: string
35325         - name: model-version-id
35326           in: query
35327           description: the ASDC model version for this resource or service model.
35328           required: false
35329           type: string
35330         - name: widget-model-id
35331           in: query
35332           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35333           required: false
35334           type: string
35335         - name: widget-model-version
35336           in: query
35337           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35338           required: false
35339           type: string
35340         - name: nf-type
35341           in: query
35342           description: Generic description of the type of NF
35343           required: false
35344           type: string
35345         - name: nf-function
35346           in: query
35347           description: English description of Network function that the specific VNF deployment is providing
35348           required: false
35349           type: string
35350         - name: nf-role
35351           in: query
35352           description: role in the network that this model will be providing
35353           required: false
35354           type: string
35355         - name: nf-naming-code
35356           in: query
35357           description: string assigned to this model used for naming purposes
35358           required: false
35359           type: string
35360         - name: interface-id
35361           in: query
35362           description: ID of interface
35363           required: false
35364           type: string
35365         - name: macaddr
35366           in: query
35367           description: MAC address for the interface
35368           required: false
35369           type: string
35370         - name: network-name
35371           in: query
35372           description: Name of the network
35373           required: false
35374           type: string
35375   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
35376     put:
35377       tags:
35378         - Network
35379       summary: see node definition for valid relationships
35380       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35381       consumes:
35382         - application/json
35383         - application/xml
35384       produces:
35385         - application/json
35386         - application/xml
35387       responses:
35388         "default":
35389           description: Response codes found in [response codes](https://wiki.onap.org/).
35390       parameters:
35391         - name: vnf-id
35392           in: path
35393           description: Unique id of VNF.  This is unique across the graph.
35394           required: true
35395           type: string
35396           example: __VNF-ID__
35397         - name: interface-name
35398           in: path
35399           description: Name given to the interface
35400           required: true
35401           type: string
35402           example: __INTERFACE-NAME__
35403         - name: pci-id
35404           in: path
35405           description: PCI ID used to identify the sriov-vf
35406           required: true
35407           type: string
35408           example: __PCI-ID__
35409         - name: body
35410           in: body
35411           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
35412           required: true
35413           schema:
35414             $ref: "#/definitions/relationship"
35415     delete:
35416       tags:
35417         - Network
35418       summary: delete an existing relationship
35419       description: delete an existing relationship
35420       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
35421       consumes:
35422         - application/json
35423         - application/xml
35424       produces:
35425         - application/json
35426         - application/xml
35427       responses:
35428         "default":
35429           description: Response codes found in [response codes](https://wiki.onap.org/).
35430       parameters:
35431         - name: vnf-id
35432           in: path
35433           description: Unique id of VNF.  This is unique across the graph.
35434           required: true
35435           type: string
35436           example: __VNF-ID__
35437         - name: interface-name
35438           in: path
35439           description: Name given to the interface
35440           required: true
35441           type: string
35442           example: __INTERFACE-NAME__
35443         - name: pci-id
35444           in: path
35445           description: PCI ID used to identify the sriov-vf
35446           required: true
35447           type: string
35448           example: __PCI-ID__
35449   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
35450     get:
35451       tags:
35452         - Network
35453       summary: returns sriov-vf
35454       description: returns sriov-vf
35455       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35456       produces:
35457         - application/json
35458         - application/xml
35459       responses:
35460         "200":
35461           description: successful operation
35462           schema:
35463               $ref: "#/getDefinitions/sriov-vf"
35464         "default":
35465           description: Response codes found in [response codes](https://wiki.onap.org/).
35466       parameters:
35467         - name: vnf-id
35468           in: path
35469           description: Unique id of VNF.  This is unique across the graph.
35470           required: true
35471           type: string
35472           example: __VNF-ID__
35473         - name: interface-name
35474           in: path
35475           description: Name given to the interface
35476           required: true
35477           type: string
35478           example: __INTERFACE-NAME__
35479         - name: pci-id
35480           in: path
35481           description: PCI ID used to identify the sriov-vf
35482           required: true
35483           type: string
35484           example: __PCI-ID__
35485         - name: vnf-name
35486           in: query
35487           description: Name of VNF.
35488           required: false
35489           type: string
35490         - name: vnf-name2
35491           in: query
35492           description: Alternate name of VNF.
35493           required: false
35494           type: string
35495         - name: vnf-type
35496           in: query
35497           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.
35498           required: false
35499           type: string
35500         - name: service-id
35501           in: query
35502           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35503           required: false
35504           type: string
35505         - name: regional-resource-zone
35506           in: query
35507           description: Regional way of organizing pservers, source of truth should define values
35508           required: false
35509           type: string
35510         - name: prov-status
35511           in: query
35512           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35513           required: false
35514           type: string
35515         - name: heat-stack-id
35516           in: query
35517           description: Heat stack id corresponding to this instance, managed by MSO
35518           required: false
35519           type: string
35520         - name: in-maint
35521           in: query
35522           required: false
35523           type: boolean
35524         - name: is-closed-loop-disabled
35525           in: query
35526           required: false
35527           type: boolean
35528         - name: model-invariant-id
35529           in: query
35530           description: the ASDC model id for this resource or service model.
35531           required: false
35532           type: string
35533         - name: model-version-id
35534           in: query
35535           description: the ASDC model version for this resource or service model.
35536           required: false
35537           type: string
35538         - name: widget-model-id
35539           in: query
35540           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35541           required: false
35542           type: string
35543         - name: widget-model-version
35544           in: query
35545           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35546           required: false
35547           type: string
35548         - name: nf-type
35549           in: query
35550           description: Generic description of the type of NF
35551           required: false
35552           type: string
35553         - name: nf-function
35554           in: query
35555           description: English description of Network function that the specific VNF deployment is providing
35556           required: false
35557           type: string
35558         - name: nf-role
35559           in: query
35560           description: role in the network that this model will be providing
35561           required: false
35562           type: string
35563         - name: nf-naming-code
35564           in: query
35565           description: string assigned to this model used for naming purposes
35566           required: false
35567           type: string
35568         - name: interface-id
35569           in: query
35570           description: ID of interface
35571           required: false
35572           type: string
35573         - name: macaddr
35574           in: query
35575           description: MAC address for the interface
35576           required: false
35577           type: string
35578         - name: network-name
35579           in: query
35580           description: Name of the network
35581           required: false
35582           type: string
35583         - name: vf-vlan-filter
35584           in: query
35585           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
35586           required: false
35587           type: string
35588         - name: vf-mac-filter
35589           in: query
35590           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
35591           required: false
35592           type: string
35593         - name: vf-vlan-strip
35594           in: query
35595           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
35596           required: false
35597           type: boolean
35598         - name: neutron-network-id
35599           in: query
35600           description: Neutron network id of the interface
35601           required: false
35602           type: string
35603     put:
35604       tags:
35605         - Network
35606       summary: create or update an existing sriov-vf
35607       description: |
35608         Create or update an existing sriov-vf.
35609         #
35610         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
35611       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35612       consumes:
35613         - application/json
35614         - application/xml
35615       produces:
35616         - application/json
35617         - application/xml
35618       responses:
35619         "default":
35620           description: Response codes found in [response codes](https://wiki.onap.org/).
35621       parameters:
35622         - name: vnf-id
35623           in: path
35624           description: Unique id of VNF.  This is unique across the graph.
35625           required: true
35626           type: string
35627           example: __VNF-ID__
35628         - name: interface-name
35629           in: path
35630           description: Name given to the interface
35631           required: true
35632           type: string
35633           example: __INTERFACE-NAME__
35634         - name: pci-id
35635           in: path
35636           description: PCI ID used to identify the sriov-vf
35637           required: true
35638           type: string
35639           example: __PCI-ID__
35640         - name: body
35641           in: body
35642           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)
35643           required: true
35644           schema:
35645             $ref: "#/definitions/sriov-vf"
35646     patch:
35647       tags:
35648         - Network
35649       summary: update an existing sriov-vf
35650       description: |
35651         Update an existing sriov-vf
35652         #
35653         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
35654         The PUT operation will entirely replace an existing object.
35655         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
35656         #
35657         Other differences between PUT and PATCH are:
35658         #
35659         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
35660         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
35661         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
35662       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35663       consumes:
35664         - application/json
35665         - application/xml
35666       produces:
35667         - application/json
35668         - application/xml
35669       responses:
35670         "default":
35671           description: Response codes found in [response codes](https://wiki.onap.org/).
35672       parameters:
35673         - name: vnf-id
35674           in: path
35675           description: Unique id of VNF.  This is unique across the graph.
35676           required: true
35677           type: string
35678           example: __VNF-ID__
35679         - name: interface-name
35680           in: path
35681           description: Name given to the interface
35682           required: true
35683           type: string
35684           example: __INTERFACE-NAME__
35685         - name: pci-id
35686           in: path
35687           description: PCI ID used to identify the sriov-vf
35688           required: true
35689           type: string
35690           example: __PCI-ID__
35691         - name: body
35692           in: body
35693           description: sriov-vf object that needs to be created or updated.
35694           required: true
35695           schema:
35696             $ref: "#/patchDefinitions/sriov-vf"
35697     delete:
35698       tags:
35699         - Network
35700       summary: delete an existing sriov-vf
35701       description: delete an existing sriov-vf
35702       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf
35703       consumes:
35704         - application/json
35705         - application/xml
35706       produces:
35707         - application/json
35708         - application/xml
35709       responses:
35710         "default":
35711           description: Response codes found in [response codes](https://wiki.onap.org/).
35712       parameters:
35713         - name: vnf-id
35714           in: path
35715           description: Unique id of VNF.  This is unique across the graph.
35716           required: true
35717           type: string
35718           example: __VNF-ID__
35719         - name: interface-name
35720           in: path
35721           description: Name given to the interface
35722           required: true
35723           type: string
35724           example: __INTERFACE-NAME__
35725         - name: pci-id
35726           in: path
35727           description: PCI ID used to identify the sriov-vf
35728           required: true
35729           type: string
35730           example: __PCI-ID__
35731         - name: resource-version
35732           in: query
35733           description: resource-version for concurrency
35734           required: true
35735           type: string
35736   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
35737     get:
35738       tags:
35739         - Network
35740       summary: returns sriov-vfs
35741       description: returns sriov-vfs
35742       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfs
35743       produces:
35744         - application/json
35745         - application/xml
35746       responses:
35747         "200":
35748           description: successful operation
35749           schema:
35750               $ref: "#/getDefinitions/sriov-vfs"
35751         "default":
35752           description: Response codes found in [response codes](https://wiki.onap.org/).
35753       parameters:
35754         - name: vnf-id
35755           in: path
35756           description: Unique id of VNF.  This is unique across the graph.
35757           required: true
35758           type: string
35759           example: __VNF-ID__
35760         - name: interface-name
35761           in: path
35762           description: Name given to the interface
35763           required: true
35764           type: string
35765           example: __INTERFACE-NAME__
35766         - name: vnf-name
35767           in: query
35768           description: Name of VNF.
35769           required: false
35770           type: string
35771         - name: vnf-name2
35772           in: query
35773           description: Alternate name of VNF.
35774           required: false
35775           type: string
35776         - name: vnf-type
35777           in: query
35778           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.
35779           required: false
35780           type: string
35781         - name: service-id
35782           in: query
35783           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
35784           required: false
35785           type: string
35786         - name: regional-resource-zone
35787           in: query
35788           description: Regional way of organizing pservers, source of truth should define values
35789           required: false
35790           type: string
35791         - name: prov-status
35792           in: query
35793           description: Trigger for operational monitoring of this resource by Service Assurance systems.
35794           required: false
35795           type: string
35796         - name: heat-stack-id
35797           in: query
35798           description: Heat stack id corresponding to this instance, managed by MSO
35799           required: false
35800           type: string
35801         - name: in-maint
35802           in: query
35803           required: false
35804           type: boolean
35805         - name: is-closed-loop-disabled
35806           in: query
35807           required: false
35808           type: boolean
35809         - name: model-invariant-id
35810           in: query
35811           description: the ASDC model id for this resource or service model.
35812           required: false
35813           type: string
35814         - name: model-version-id
35815           in: query
35816           description: the ASDC model version for this resource or service model.
35817           required: false
35818           type: string
35819         - name: widget-model-id
35820           in: query
35821           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
35822           required: false
35823           type: string
35824         - name: widget-model-version
35825           in: query
35826           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
35827           required: false
35828           type: string
35829         - name: nf-type
35830           in: query
35831           description: Generic description of the type of NF
35832           required: false
35833           type: string
35834         - name: nf-function
35835           in: query
35836           description: English description of Network function that the specific VNF deployment is providing
35837           required: false
35838           type: string
35839         - name: nf-role
35840           in: query
35841           description: role in the network that this model will be providing
35842           required: false
35843           type: string
35844         - name: nf-naming-code
35845           in: query
35846           description: string assigned to this model used for naming purposes
35847           required: false
35848           type: string
35849         - name: interface-id
35850           in: query
35851           description: ID of interface
35852           required: false
35853           type: string
35854         - name: macaddr
35855           in: query
35856           description: MAC address for the interface
35857           required: false
35858           type: string
35859         - name: network-name
35860           in: query
35861           description: Name of the network
35862           required: false
35863           type: string
35864   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
35865     put:
35866       tags:
35867         - Network
35868       summary: see node definition for valid relationships
35869       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
35870       consumes:
35871         - application/json
35872         - application/xml
35873       produces:
35874         - application/json
35875         - application/xml
35876       responses:
35877         "default":
35878           description: Response codes found in [response codes](https://wiki.onap.org/).
35879       parameters:
35880         - name: vnf-id
35881           in: path
35882           description: Unique id of VNF.  This is unique across the graph.
35883           required: true
35884           type: string
35885           example: __VNF-ID__
35886         - name: interface-name
35887           in: path
35888           description: Name given to the interface
35889           required: true
35890           type: string
35891           example: __INTERFACE-NAME__
35892         - name: body
35893           in: body
35894           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
35895           required: true
35896           schema:
35897             $ref: "#/definitions/relationship"
35898     delete:
35899       tags:
35900         - Network
35901       summary: delete an existing relationship
35902       description: delete an existing relationship
35903       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceRelationshipListRelationship
35904       consumes:
35905         - application/json
35906         - application/xml
35907       produces:
35908         - application/json
35909         - application/xml
35910       responses:
35911         "default":
35912           description: Response codes found in [response codes](https://wiki.onap.org/).
35913       parameters:
35914         - name: vnf-id
35915           in: path
35916           description: Unique id of VNF.  This is unique across the graph.
35917           required: true
35918           type: string
35919           example: __VNF-ID__
35920         - name: interface-name
35921           in: path
35922           description: Name given to the interface
35923           required: true
35924           type: string
35925           example: __INTERFACE-NAME__
35926   /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:
35927     put:
35928       tags:
35929         - Network
35930       summary: see node definition for valid relationships
35931       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35932       consumes:
35933         - application/json
35934         - application/xml
35935       produces:
35936         - application/json
35937         - application/xml
35938       responses:
35939         "default":
35940           description: Response codes found in [response codes](https://wiki.onap.org/).
35941       parameters:
35942         - name: vnf-id
35943           in: path
35944           description: Unique id of VNF.  This is unique across the graph.
35945           required: true
35946           type: string
35947           example: __VNF-ID__
35948         - name: interface-name
35949           in: path
35950           description: Name given to the interface
35951           required: true
35952           type: string
35953           example: __INTERFACE-NAME__
35954         - name: l3-interface-ipv4-address
35955           in: path
35956           description: IP address
35957           required: true
35958           type: string
35959           example: __L3-INTERFACE-IPV4-ADDRESS__
35960         - name: body
35961           in: body
35962           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
35963           required: true
35964           schema:
35965             $ref: "#/definitions/relationship"
35966     delete:
35967       tags:
35968         - Network
35969       summary: delete an existing relationship
35970       description: delete an existing relationship
35971       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
35972       consumes:
35973         - application/json
35974         - application/xml
35975       produces:
35976         - application/json
35977         - application/xml
35978       responses:
35979         "default":
35980           description: Response codes found in [response codes](https://wiki.onap.org/).
35981       parameters:
35982         - name: vnf-id
35983           in: path
35984           description: Unique id of VNF.  This is unique across the graph.
35985           required: true
35986           type: string
35987           example: __VNF-ID__
35988         - name: interface-name
35989           in: path
35990           description: Name given to the interface
35991           required: true
35992           type: string
35993           example: __INTERFACE-NAME__
35994         - name: l3-interface-ipv4-address
35995           in: path
35996           description: IP address
35997           required: true
35998           type: string
35999           example: __L3-INTERFACE-IPV4-ADDRESS__
36000   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
36001     get:
36002       tags:
36003         - Network
36004       summary: returns l3-interface-ipv4-address-list
36005       description: returns l3-interface-ipv4-address-list
36006       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36007       produces:
36008         - application/json
36009         - application/xml
36010       responses:
36011         "200":
36012           description: successful operation
36013           schema:
36014               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
36015         "default":
36016           description: Response codes found in [response codes](https://wiki.onap.org/).
36017       parameters:
36018         - name: vnf-id
36019           in: path
36020           description: Unique id of VNF.  This is unique across the graph.
36021           required: true
36022           type: string
36023           example: __VNF-ID__
36024         - name: interface-name
36025           in: path
36026           description: Name given to the interface
36027           required: true
36028           type: string
36029           example: __INTERFACE-NAME__
36030         - name: l3-interface-ipv4-address
36031           in: path
36032           description: IP address
36033           required: true
36034           type: string
36035           example: __L3-INTERFACE-IPV4-ADDRESS__
36036         - name: vnf-name
36037           in: query
36038           description: Name of VNF.
36039           required: false
36040           type: string
36041         - name: vnf-name2
36042           in: query
36043           description: Alternate name of VNF.
36044           required: false
36045           type: string
36046         - name: vnf-type
36047           in: query
36048           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.
36049           required: false
36050           type: string
36051         - name: service-id
36052           in: query
36053           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36054           required: false
36055           type: string
36056         - name: regional-resource-zone
36057           in: query
36058           description: Regional way of organizing pservers, source of truth should define values
36059           required: false
36060           type: string
36061         - name: prov-status
36062           in: query
36063           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36064           required: false
36065           type: string
36066         - name: heat-stack-id
36067           in: query
36068           description: Heat stack id corresponding to this instance, managed by MSO
36069           required: false
36070           type: string
36071         - name: in-maint
36072           in: query
36073           required: false
36074           type: boolean
36075         - name: is-closed-loop-disabled
36076           in: query
36077           required: false
36078           type: boolean
36079         - name: model-invariant-id
36080           in: query
36081           description: the ASDC model id for this resource or service model.
36082           required: false
36083           type: string
36084         - name: model-version-id
36085           in: query
36086           description: the ASDC model version for this resource or service model.
36087           required: false
36088           type: string
36089         - name: widget-model-id
36090           in: query
36091           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36092           required: false
36093           type: string
36094         - name: widget-model-version
36095           in: query
36096           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36097           required: false
36098           type: string
36099         - name: nf-type
36100           in: query
36101           description: Generic description of the type of NF
36102           required: false
36103           type: string
36104         - name: nf-function
36105           in: query
36106           description: English description of Network function that the specific VNF deployment is providing
36107           required: false
36108           type: string
36109         - name: nf-role
36110           in: query
36111           description: role in the network that this model will be providing
36112           required: false
36113           type: string
36114         - name: nf-naming-code
36115           in: query
36116           description: string assigned to this model used for naming purposes
36117           required: false
36118           type: string
36119         - name: interface-id
36120           in: query
36121           description: ID of interface
36122           required: false
36123           type: string
36124         - name: macaddr
36125           in: query
36126           description: MAC address for the interface
36127           required: false
36128           type: string
36129         - name: network-name
36130           in: query
36131           description: Name of the network
36132           required: false
36133           type: string
36134         - name: vlan-id-inner
36135           in: query
36136           description: Inner VLAN tag
36137           required: false
36138           type: integer
36139           format: int64
36140         - name: neutron-network-id
36141           in: query
36142           description: Neutron network id of the interface that address belongs to
36143           required: false
36144           type: string
36145         - name: neutron-subnet-id
36146           in: query
36147           description: Neutron id of subnet that address belongs to
36148           required: false
36149           type: string
36150     put:
36151       tags:
36152         - Network
36153       summary: create or update an existing l3-interface-ipv4-address-list
36154       description: |
36155         Create or update an existing l3-interface-ipv4-address-list.
36156         #
36157         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36158       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36159       consumes:
36160         - application/json
36161         - application/xml
36162       produces:
36163         - application/json
36164         - application/xml
36165       responses:
36166         "default":
36167           description: Response codes found in [response codes](https://wiki.onap.org/).
36168       parameters:
36169         - name: vnf-id
36170           in: path
36171           description: Unique id of VNF.  This is unique across the graph.
36172           required: true
36173           type: string
36174           example: __VNF-ID__
36175         - name: interface-name
36176           in: path
36177           description: Name given to the interface
36178           required: true
36179           type: string
36180           example: __INTERFACE-NAME__
36181         - name: l3-interface-ipv4-address
36182           in: path
36183           description: IP address
36184           required: true
36185           type: string
36186           example: __L3-INTERFACE-IPV4-ADDRESS__
36187         - name: body
36188           in: body
36189           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
36190           required: true
36191           schema:
36192             $ref: "#/definitions/l3-interface-ipv4-address-list"
36193     patch:
36194       tags:
36195         - Network
36196       summary: update an existing l3-interface-ipv4-address-list
36197       description: |
36198         Update an existing l3-interface-ipv4-address-list
36199         #
36200         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36201         The PUT operation will entirely replace an existing object.
36202         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36203         #
36204         Other differences between PUT and PATCH are:
36205         #
36206         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36207         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36208         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36209       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36210       consumes:
36211         - application/json
36212         - application/xml
36213       produces:
36214         - application/json
36215         - application/xml
36216       responses:
36217         "default":
36218           description: Response codes found in [response codes](https://wiki.onap.org/).
36219       parameters:
36220         - name: vnf-id
36221           in: path
36222           description: Unique id of VNF.  This is unique across the graph.
36223           required: true
36224           type: string
36225           example: __VNF-ID__
36226         - name: interface-name
36227           in: path
36228           description: Name given to the interface
36229           required: true
36230           type: string
36231           example: __INTERFACE-NAME__
36232         - name: l3-interface-ipv4-address
36233           in: path
36234           description: IP address
36235           required: true
36236           type: string
36237           example: __L3-INTERFACE-IPV4-ADDRESS__
36238         - name: body
36239           in: body
36240           description: l3-interface-ipv4-address-list object that needs to be created or updated.
36241           required: true
36242           schema:
36243             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
36244     delete:
36245       tags:
36246         - Network
36247       summary: delete an existing l3-interface-ipv4-address-list
36248       description: delete an existing l3-interface-ipv4-address-list
36249       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList
36250       consumes:
36251         - application/json
36252         - application/xml
36253       produces:
36254         - application/json
36255         - application/xml
36256       responses:
36257         "default":
36258           description: Response codes found in [response codes](https://wiki.onap.org/).
36259       parameters:
36260         - name: vnf-id
36261           in: path
36262           description: Unique id of VNF.  This is unique across the graph.
36263           required: true
36264           type: string
36265           example: __VNF-ID__
36266         - name: interface-name
36267           in: path
36268           description: Name given to the interface
36269           required: true
36270           type: string
36271           example: __INTERFACE-NAME__
36272         - name: l3-interface-ipv4-address
36273           in: path
36274           description: IP address
36275           required: true
36276           type: string
36277           example: __L3-INTERFACE-IPV4-ADDRESS__
36278         - name: resource-version
36279           in: query
36280           description: resource-version for concurrency
36281           required: true
36282           type: string
36283   /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:
36284     put:
36285       tags:
36286         - Network
36287       summary: see node definition for valid relationships
36288       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36289       consumes:
36290         - application/json
36291         - application/xml
36292       produces:
36293         - application/json
36294         - application/xml
36295       responses:
36296         "default":
36297           description: Response codes found in [response codes](https://wiki.onap.org/).
36298       parameters:
36299         - name: vnf-id
36300           in: path
36301           description: Unique id of VNF.  This is unique across the graph.
36302           required: true
36303           type: string
36304           example: __VNF-ID__
36305         - name: interface-name
36306           in: path
36307           description: Name given to the interface
36308           required: true
36309           type: string
36310           example: __INTERFACE-NAME__
36311         - name: l3-interface-ipv6-address
36312           in: path
36313           description: IP address
36314           required: true
36315           type: string
36316           example: __L3-INTERFACE-IPV6-ADDRESS__
36317         - name: body
36318           in: body
36319           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36320           required: true
36321           schema:
36322             $ref: "#/definitions/relationship"
36323     delete:
36324       tags:
36325         - Network
36326       summary: delete an existing relationship
36327       description: delete an existing relationship
36328       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
36329       consumes:
36330         - application/json
36331         - application/xml
36332       produces:
36333         - application/json
36334         - application/xml
36335       responses:
36336         "default":
36337           description: Response codes found in [response codes](https://wiki.onap.org/).
36338       parameters:
36339         - name: vnf-id
36340           in: path
36341           description: Unique id of VNF.  This is unique across the graph.
36342           required: true
36343           type: string
36344           example: __VNF-ID__
36345         - name: interface-name
36346           in: path
36347           description: Name given to the interface
36348           required: true
36349           type: string
36350           example: __INTERFACE-NAME__
36351         - name: l3-interface-ipv6-address
36352           in: path
36353           description: IP address
36354           required: true
36355           type: string
36356           example: __L3-INTERFACE-IPV6-ADDRESS__
36357   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
36358     get:
36359       tags:
36360         - Network
36361       summary: returns l3-interface-ipv6-address-list
36362       description: returns l3-interface-ipv6-address-list
36363       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36364       produces:
36365         - application/json
36366         - application/xml
36367       responses:
36368         "200":
36369           description: successful operation
36370           schema:
36371               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
36372         "default":
36373           description: Response codes found in [response codes](https://wiki.onap.org/).
36374       parameters:
36375         - name: vnf-id
36376           in: path
36377           description: Unique id of VNF.  This is unique across the graph.
36378           required: true
36379           type: string
36380           example: __VNF-ID__
36381         - name: interface-name
36382           in: path
36383           description: Name given to the interface
36384           required: true
36385           type: string
36386           example: __INTERFACE-NAME__
36387         - name: l3-interface-ipv6-address
36388           in: path
36389           description: IP address
36390           required: true
36391           type: string
36392           example: __L3-INTERFACE-IPV6-ADDRESS__
36393         - name: vnf-name
36394           in: query
36395           description: Name of VNF.
36396           required: false
36397           type: string
36398         - name: vnf-name2
36399           in: query
36400           description: Alternate name of VNF.
36401           required: false
36402           type: string
36403         - name: vnf-type
36404           in: query
36405           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.
36406           required: false
36407           type: string
36408         - name: service-id
36409           in: query
36410           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36411           required: false
36412           type: string
36413         - name: regional-resource-zone
36414           in: query
36415           description: Regional way of organizing pservers, source of truth should define values
36416           required: false
36417           type: string
36418         - name: prov-status
36419           in: query
36420           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36421           required: false
36422           type: string
36423         - name: heat-stack-id
36424           in: query
36425           description: Heat stack id corresponding to this instance, managed by MSO
36426           required: false
36427           type: string
36428         - name: in-maint
36429           in: query
36430           required: false
36431           type: boolean
36432         - name: is-closed-loop-disabled
36433           in: query
36434           required: false
36435           type: boolean
36436         - name: model-invariant-id
36437           in: query
36438           description: the ASDC model id for this resource or service model.
36439           required: false
36440           type: string
36441         - name: model-version-id
36442           in: query
36443           description: the ASDC model version for this resource or service model.
36444           required: false
36445           type: string
36446         - name: widget-model-id
36447           in: query
36448           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36449           required: false
36450           type: string
36451         - name: widget-model-version
36452           in: query
36453           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36454           required: false
36455           type: string
36456         - name: nf-type
36457           in: query
36458           description: Generic description of the type of NF
36459           required: false
36460           type: string
36461         - name: nf-function
36462           in: query
36463           description: English description of Network function that the specific VNF deployment is providing
36464           required: false
36465           type: string
36466         - name: nf-role
36467           in: query
36468           description: role in the network that this model will be providing
36469           required: false
36470           type: string
36471         - name: nf-naming-code
36472           in: query
36473           description: string assigned to this model used for naming purposes
36474           required: false
36475           type: string
36476         - name: interface-id
36477           in: query
36478           description: ID of interface
36479           required: false
36480           type: string
36481         - name: macaddr
36482           in: query
36483           description: MAC address for the interface
36484           required: false
36485           type: string
36486         - name: network-name
36487           in: query
36488           description: Name of the network
36489           required: false
36490           type: string
36491         - name: vlan-id-inner
36492           in: query
36493           description: Inner VLAN tag
36494           required: false
36495           type: integer
36496           format: int64
36497         - name: neutron-network-id
36498           in: query
36499           description: Neutron network id of the interface that address belongs to
36500           required: false
36501           type: string
36502         - name: neutron-subnet-id
36503           in: query
36504           description: Neutron id of subnet that address belongs to
36505           required: false
36506           type: string
36507     put:
36508       tags:
36509         - Network
36510       summary: create or update an existing l3-interface-ipv6-address-list
36511       description: |
36512         Create or update an existing l3-interface-ipv6-address-list.
36513         #
36514         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36515       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36516       consumes:
36517         - application/json
36518         - application/xml
36519       produces:
36520         - application/json
36521         - application/xml
36522       responses:
36523         "default":
36524           description: Response codes found in [response codes](https://wiki.onap.org/).
36525       parameters:
36526         - name: vnf-id
36527           in: path
36528           description: Unique id of VNF.  This is unique across the graph.
36529           required: true
36530           type: string
36531           example: __VNF-ID__
36532         - name: interface-name
36533           in: path
36534           description: Name given to the interface
36535           required: true
36536           type: string
36537           example: __INTERFACE-NAME__
36538         - name: l3-interface-ipv6-address
36539           in: path
36540           description: IP address
36541           required: true
36542           type: string
36543           example: __L3-INTERFACE-IPV6-ADDRESS__
36544         - name: body
36545           in: body
36546           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
36547           required: true
36548           schema:
36549             $ref: "#/definitions/l3-interface-ipv6-address-list"
36550     patch:
36551       tags:
36552         - Network
36553       summary: update an existing l3-interface-ipv6-address-list
36554       description: |
36555         Update an existing l3-interface-ipv6-address-list
36556         #
36557         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36558         The PUT operation will entirely replace an existing object.
36559         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36560         #
36561         Other differences between PUT and PATCH are:
36562         #
36563         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36564         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36565         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36566       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36567       consumes:
36568         - application/json
36569         - application/xml
36570       produces:
36571         - application/json
36572         - application/xml
36573       responses:
36574         "default":
36575           description: Response codes found in [response codes](https://wiki.onap.org/).
36576       parameters:
36577         - name: vnf-id
36578           in: path
36579           description: Unique id of VNF.  This is unique across the graph.
36580           required: true
36581           type: string
36582           example: __VNF-ID__
36583         - name: interface-name
36584           in: path
36585           description: Name given to the interface
36586           required: true
36587           type: string
36588           example: __INTERFACE-NAME__
36589         - name: l3-interface-ipv6-address
36590           in: path
36591           description: IP address
36592           required: true
36593           type: string
36594           example: __L3-INTERFACE-IPV6-ADDRESS__
36595         - name: body
36596           in: body
36597           description: l3-interface-ipv6-address-list object that needs to be created or updated.
36598           required: true
36599           schema:
36600             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
36601     delete:
36602       tags:
36603         - Network
36604       summary: delete an existing l3-interface-ipv6-address-list
36605       description: delete an existing l3-interface-ipv6-address-list
36606       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList
36607       consumes:
36608         - application/json
36609         - application/xml
36610       produces:
36611         - application/json
36612         - application/xml
36613       responses:
36614         "default":
36615           description: Response codes found in [response codes](https://wiki.onap.org/).
36616       parameters:
36617         - name: vnf-id
36618           in: path
36619           description: Unique id of VNF.  This is unique across the graph.
36620           required: true
36621           type: string
36622           example: __VNF-ID__
36623         - name: interface-name
36624           in: path
36625           description: Name given to the interface
36626           required: true
36627           type: string
36628           example: __INTERFACE-NAME__
36629         - name: l3-interface-ipv6-address
36630           in: path
36631           description: IP address
36632           required: true
36633           type: string
36634           example: __L3-INTERFACE-IPV6-ADDRESS__
36635         - name: resource-version
36636           in: query
36637           description: resource-version for concurrency
36638           required: true
36639           type: string
36640   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}:
36641     get:
36642       tags:
36643         - Network
36644       summary: returns l-interface
36645       description: returns l-interface
36646       operationId: getNetworkGenericVnfsGenericVnfLInterfacesLInterface
36647       produces:
36648         - application/json
36649         - application/xml
36650       responses:
36651         "200":
36652           description: successful operation
36653           schema:
36654               $ref: "#/getDefinitions/l-interface"
36655         "default":
36656           description: Response codes found in [response codes](https://wiki.onap.org/).
36657       parameters:
36658         - name: vnf-id
36659           in: path
36660           description: Unique id of VNF.  This is unique across the graph.
36661           required: true
36662           type: string
36663           example: __VNF-ID__
36664         - name: interface-name
36665           in: path
36666           description: Name given to the interface
36667           required: true
36668           type: string
36669           example: __INTERFACE-NAME__
36670         - name: vnf-name
36671           in: query
36672           description: Name of VNF.
36673           required: false
36674           type: string
36675         - name: vnf-name2
36676           in: query
36677           description: Alternate name of VNF.
36678           required: false
36679           type: string
36680         - name: vnf-type
36681           in: query
36682           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.
36683           required: false
36684           type: string
36685         - name: service-id
36686           in: query
36687           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36688           required: false
36689           type: string
36690         - name: regional-resource-zone
36691           in: query
36692           description: Regional way of organizing pservers, source of truth should define values
36693           required: false
36694           type: string
36695         - name: prov-status
36696           in: query
36697           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36698           required: false
36699           type: string
36700         - name: heat-stack-id
36701           in: query
36702           description: Heat stack id corresponding to this instance, managed by MSO
36703           required: false
36704           type: string
36705         - name: in-maint
36706           in: query
36707           required: false
36708           type: boolean
36709         - name: is-closed-loop-disabled
36710           in: query
36711           required: false
36712           type: boolean
36713         - name: model-invariant-id
36714           in: query
36715           description: the ASDC model id for this resource or service model.
36716           required: false
36717           type: string
36718         - name: model-version-id
36719           in: query
36720           description: the ASDC model version for this resource or service model.
36721           required: false
36722           type: string
36723         - name: widget-model-id
36724           in: query
36725           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36726           required: false
36727           type: string
36728         - name: widget-model-version
36729           in: query
36730           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36731           required: false
36732           type: string
36733         - name: nf-type
36734           in: query
36735           description: Generic description of the type of NF
36736           required: false
36737           type: string
36738         - name: nf-function
36739           in: query
36740           description: English description of Network function that the specific VNF deployment is providing
36741           required: false
36742           type: string
36743         - name: nf-role
36744           in: query
36745           description: role in the network that this model will be providing
36746           required: false
36747           type: string
36748         - name: nf-naming-code
36749           in: query
36750           description: string assigned to this model used for naming purposes
36751           required: false
36752           type: string
36753         - name: interface-id
36754           in: query
36755           description: ID of interface
36756           required: false
36757           type: string
36758         - name: macaddr
36759           in: query
36760           description: MAC address for the interface
36761           required: false
36762           type: string
36763         - name: network-name
36764           in: query
36765           description: Name of the network
36766           required: false
36767           type: string
36768     put:
36769       tags:
36770         - Network
36771       summary: create or update an existing l-interface
36772       description: |
36773         Create or update an existing l-interface.
36774         #
36775         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
36776       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
36777       consumes:
36778         - application/json
36779         - application/xml
36780       produces:
36781         - application/json
36782         - application/xml
36783       responses:
36784         "default":
36785           description: Response codes found in [response codes](https://wiki.onap.org/).
36786       parameters:
36787         - name: vnf-id
36788           in: path
36789           description: Unique id of VNF.  This is unique across the graph.
36790           required: true
36791           type: string
36792           example: __VNF-ID__
36793         - name: interface-name
36794           in: path
36795           description: Name given to the interface
36796           required: true
36797           type: string
36798           example: __INTERFACE-NAME__
36799         - name: body
36800           in: body
36801           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)
36802           required: true
36803           schema:
36804             $ref: "#/definitions/l-interface"
36805     patch:
36806       tags:
36807         - Network
36808       summary: update an existing l-interface
36809       description: |
36810         Update an existing l-interface
36811         #
36812         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
36813         The PUT operation will entirely replace an existing object.
36814         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
36815         #
36816         Other differences between PUT and PATCH are:
36817         #
36818         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
36819         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
36820         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
36821       operationId: UpdateNetworkGenericVnfsGenericVnfLInterfacesLInterface
36822       consumes:
36823         - application/json
36824         - application/xml
36825       produces:
36826         - application/json
36827         - application/xml
36828       responses:
36829         "default":
36830           description: Response codes found in [response codes](https://wiki.onap.org/).
36831       parameters:
36832         - name: vnf-id
36833           in: path
36834           description: Unique id of VNF.  This is unique across the graph.
36835           required: true
36836           type: string
36837           example: __VNF-ID__
36838         - name: interface-name
36839           in: path
36840           description: Name given to the interface
36841           required: true
36842           type: string
36843           example: __INTERFACE-NAME__
36844         - name: body
36845           in: body
36846           description: l-interface object that needs to be created or updated.
36847           required: true
36848           schema:
36849             $ref: "#/patchDefinitions/l-interface"
36850     delete:
36851       tags:
36852         - Network
36853       summary: delete an existing l-interface
36854       description: delete an existing l-interface
36855       operationId: deleteNetworkGenericVnfsGenericVnfLInterfacesLInterface
36856       consumes:
36857         - application/json
36858         - application/xml
36859       produces:
36860         - application/json
36861         - application/xml
36862       responses:
36863         "default":
36864           description: Response codes found in [response codes](https://wiki.onap.org/).
36865       parameters:
36866         - name: vnf-id
36867           in: path
36868           description: Unique id of VNF.  This is unique across the graph.
36869           required: true
36870           type: string
36871           example: __VNF-ID__
36872         - name: interface-name
36873           in: path
36874           description: Name given to the interface
36875           required: true
36876           type: string
36877           example: __INTERFACE-NAME__
36878         - name: resource-version
36879           in: query
36880           description: resource-version for concurrency
36881           required: true
36882           type: string
36883   /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces:
36884     get:
36885       tags:
36886         - Network
36887       summary: returns l-interfaces
36888       description: returns l-interfaces
36889       operationId: getNetworkGenericVnfsGenericVnfLInterfaces
36890       produces:
36891         - application/json
36892         - application/xml
36893       responses:
36894         "200":
36895           description: successful operation
36896           schema:
36897               $ref: "#/getDefinitions/l-interfaces"
36898         "default":
36899           description: Response codes found in [response codes](https://wiki.onap.org/).
36900       parameters:
36901         - name: vnf-id
36902           in: path
36903           description: Unique id of VNF.  This is unique across the graph.
36904           required: true
36905           type: string
36906           example: __VNF-ID__
36907         - name: vnf-name
36908           in: query
36909           description: Name of VNF.
36910           required: false
36911           type: string
36912         - name: vnf-name2
36913           in: query
36914           description: Alternate name of VNF.
36915           required: false
36916           type: string
36917         - name: vnf-type
36918           in: query
36919           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.
36920           required: false
36921           type: string
36922         - name: service-id
36923           in: query
36924           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
36925           required: false
36926           type: string
36927         - name: regional-resource-zone
36928           in: query
36929           description: Regional way of organizing pservers, source of truth should define values
36930           required: false
36931           type: string
36932         - name: prov-status
36933           in: query
36934           description: Trigger for operational monitoring of this resource by Service Assurance systems.
36935           required: false
36936           type: string
36937         - name: heat-stack-id
36938           in: query
36939           description: Heat stack id corresponding to this instance, managed by MSO
36940           required: false
36941           type: string
36942         - name: in-maint
36943           in: query
36944           required: false
36945           type: boolean
36946         - name: is-closed-loop-disabled
36947           in: query
36948           required: false
36949           type: boolean
36950         - name: model-invariant-id
36951           in: query
36952           description: the ASDC model id for this resource or service model.
36953           required: false
36954           type: string
36955         - name: model-version-id
36956           in: query
36957           description: the ASDC model version for this resource or service model.
36958           required: false
36959           type: string
36960         - name: widget-model-id
36961           in: query
36962           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
36963           required: false
36964           type: string
36965         - name: widget-model-version
36966           in: query
36967           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
36968           required: false
36969           type: string
36970         - name: nf-type
36971           in: query
36972           description: Generic description of the type of NF
36973           required: false
36974           type: string
36975         - name: nf-function
36976           in: query
36977           description: English description of Network function that the specific VNF deployment is providing
36978           required: false
36979           type: string
36980         - name: nf-role
36981           in: query
36982           description: role in the network that this model will be providing
36983           required: false
36984           type: string
36985         - name: nf-naming-code
36986           in: query
36987           description: string assigned to this model used for naming purposes
36988           required: false
36989           type: string
36990   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
36991     put:
36992       tags:
36993         - Network
36994       summary: see node definition for valid relationships
36995       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
36996       consumes:
36997         - application/json
36998         - application/xml
36999       produces:
37000         - application/json
37001         - application/xml
37002       responses:
37003         "default":
37004           description: Response codes found in [response codes](https://wiki.onap.org/).
37005       parameters:
37006         - name: vnf-id
37007           in: path
37008           description: Unique id of VNF.  This is unique across the graph.
37009           required: true
37010           type: string
37011           example: __VNF-ID__
37012         - name: interface-name
37013           in: path
37014           description: Name that identifies the link aggregate interface
37015           required: true
37016           type: string
37017           example: __INTERFACE-NAME__
37018         - name: body
37019           in: body
37020           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
37021           required: true
37022           schema:
37023             $ref: "#/definitions/relationship"
37024     delete:
37025       tags:
37026         - Network
37027       summary: delete an existing relationship
37028       description: delete an existing relationship
37029       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceRelationshipListRelationship
37030       consumes:
37031         - application/json
37032         - application/xml
37033       produces:
37034         - application/json
37035         - application/xml
37036       responses:
37037         "default":
37038           description: Response codes found in [response codes](https://wiki.onap.org/).
37039       parameters:
37040         - name: vnf-id
37041           in: path
37042           description: Unique id of VNF.  This is unique across the graph.
37043           required: true
37044           type: string
37045           example: __VNF-ID__
37046         - name: interface-name
37047           in: path
37048           description: Name that identifies the link aggregate interface
37049           required: true
37050           type: string
37051           example: __INTERFACE-NAME__
37052   /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:
37053     put:
37054       tags:
37055         - Network
37056       summary: see node definition for valid relationships
37057       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37058       consumes:
37059         - application/json
37060         - application/xml
37061       produces:
37062         - application/json
37063         - application/xml
37064       responses:
37065         "default":
37066           description: Response codes found in [response codes](https://wiki.onap.org/).
37067       parameters:
37068         - name: vnf-id
37069           in: path
37070           description: Unique id of VNF.  This is unique across the graph.
37071           required: true
37072           type: string
37073           example: __VNF-ID__
37074         - name: interface-name
37075           in: path
37076           description: Name that identifies the link aggregate interface
37077           required: true
37078           type: string
37079           example: __INTERFACE-NAME__
37080         - name: interface-name
37081           in: path
37082           description: Name given to the interface
37083           required: true
37084           type: string
37085           example: __INTERFACE-NAME__
37086         - name: vlan-interface
37087           in: path
37088           description: String that identifies the interface
37089           required: true
37090           type: string
37091           example: __VLAN-INTERFACE__
37092         - name: body
37093           in: body
37094           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
37095           required: true
37096           schema:
37097             $ref: "#/definitions/relationship"
37098     delete:
37099       tags:
37100         - Network
37101       summary: delete an existing relationship
37102       description: delete an existing relationship
37103       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
37104       consumes:
37105         - application/json
37106         - application/xml
37107       produces:
37108         - application/json
37109         - application/xml
37110       responses:
37111         "default":
37112           description: Response codes found in [response codes](https://wiki.onap.org/).
37113       parameters:
37114         - name: vnf-id
37115           in: path
37116           description: Unique id of VNF.  This is unique across the graph.
37117           required: true
37118           type: string
37119           example: __VNF-ID__
37120         - name: interface-name
37121           in: path
37122           description: Name that identifies the link aggregate interface
37123           required: true
37124           type: string
37125           example: __INTERFACE-NAME__
37126         - name: interface-name
37127           in: path
37128           description: Name given to the interface
37129           required: true
37130           type: string
37131           example: __INTERFACE-NAME__
37132         - name: vlan-interface
37133           in: path
37134           description: String that identifies the interface
37135           required: true
37136           type: string
37137           example: __VLAN-INTERFACE__
37138   /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:
37139     put:
37140       tags:
37141         - Network
37142       summary: see node definition for valid relationships
37143       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37144       consumes:
37145         - application/json
37146         - application/xml
37147       produces:
37148         - application/json
37149         - application/xml
37150       responses:
37151         "default":
37152           description: Response codes found in [response codes](https://wiki.onap.org/).
37153       parameters:
37154         - name: vnf-id
37155           in: path
37156           description: Unique id of VNF.  This is unique across the graph.
37157           required: true
37158           type: string
37159           example: __VNF-ID__
37160         - name: interface-name
37161           in: path
37162           description: Name that identifies the link aggregate interface
37163           required: true
37164           type: string
37165           example: __INTERFACE-NAME__
37166         - name: interface-name
37167           in: path
37168           description: Name given to the interface
37169           required: true
37170           type: string
37171           example: __INTERFACE-NAME__
37172         - name: vlan-interface
37173           in: path
37174           description: String that identifies the interface
37175           required: true
37176           type: string
37177           example: __VLAN-INTERFACE__
37178         - name: l3-interface-ipv4-address
37179           in: path
37180           description: IP address
37181           required: true
37182           type: string
37183           example: __L3-INTERFACE-IPV4-ADDRESS__
37184         - name: body
37185           in: body
37186           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37187           required: true
37188           schema:
37189             $ref: "#/definitions/relationship"
37190     delete:
37191       tags:
37192         - Network
37193       summary: delete an existing relationship
37194       description: delete an existing relationship
37195       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
37196       consumes:
37197         - application/json
37198         - application/xml
37199       produces:
37200         - application/json
37201         - application/xml
37202       responses:
37203         "default":
37204           description: Response codes found in [response codes](https://wiki.onap.org/).
37205       parameters:
37206         - name: vnf-id
37207           in: path
37208           description: Unique id of VNF.  This is unique across the graph.
37209           required: true
37210           type: string
37211           example: __VNF-ID__
37212         - name: interface-name
37213           in: path
37214           description: Name that identifies the link aggregate interface
37215           required: true
37216           type: string
37217           example: __INTERFACE-NAME__
37218         - name: interface-name
37219           in: path
37220           description: Name given to the interface
37221           required: true
37222           type: string
37223           example: __INTERFACE-NAME__
37224         - name: vlan-interface
37225           in: path
37226           description: String that identifies the interface
37227           required: true
37228           type: string
37229           example: __VLAN-INTERFACE__
37230         - name: l3-interface-ipv4-address
37231           in: path
37232           description: IP address
37233           required: true
37234           type: string
37235           example: __L3-INTERFACE-IPV4-ADDRESS__
37236   /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}:
37237     get:
37238       tags:
37239         - Network
37240       summary: returns l3-interface-ipv4-address-list
37241       description: returns l3-interface-ipv4-address-list
37242       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37243       produces:
37244         - application/json
37245         - application/xml
37246       responses:
37247         "200":
37248           description: successful operation
37249           schema:
37250               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
37251         "default":
37252           description: Response codes found in [response codes](https://wiki.onap.org/).
37253       parameters:
37254         - name: vnf-id
37255           in: path
37256           description: Unique id of VNF.  This is unique across the graph.
37257           required: true
37258           type: string
37259           example: __VNF-ID__
37260         - name: interface-name
37261           in: path
37262           description: Name that identifies the link aggregate interface
37263           required: true
37264           type: string
37265           example: __INTERFACE-NAME__
37266         - name: interface-name
37267           in: path
37268           description: Name given to the interface
37269           required: true
37270           type: string
37271           example: __INTERFACE-NAME__
37272         - name: vlan-interface
37273           in: path
37274           description: String that identifies the interface
37275           required: true
37276           type: string
37277           example: __VLAN-INTERFACE__
37278         - name: l3-interface-ipv4-address
37279           in: path
37280           description: IP address
37281           required: true
37282           type: string
37283           example: __L3-INTERFACE-IPV4-ADDRESS__
37284         - name: vnf-name
37285           in: query
37286           description: Name of VNF.
37287           required: false
37288           type: string
37289         - name: vnf-name2
37290           in: query
37291           description: Alternate name of VNF.
37292           required: false
37293           type: string
37294         - name: vnf-type
37295           in: query
37296           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.
37297           required: false
37298           type: string
37299         - name: service-id
37300           in: query
37301           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37302           required: false
37303           type: string
37304         - name: regional-resource-zone
37305           in: query
37306           description: Regional way of organizing pservers, source of truth should define values
37307           required: false
37308           type: string
37309         - name: prov-status
37310           in: query
37311           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37312           required: false
37313           type: string
37314         - name: heat-stack-id
37315           in: query
37316           description: Heat stack id corresponding to this instance, managed by MSO
37317           required: false
37318           type: string
37319         - name: in-maint
37320           in: query
37321           required: false
37322           type: boolean
37323         - name: is-closed-loop-disabled
37324           in: query
37325           required: false
37326           type: boolean
37327         - name: model-invariant-id
37328           in: query
37329           description: the ASDC model id for this resource or service model.
37330           required: false
37331           type: string
37332         - name: model-version-id
37333           in: query
37334           description: the ASDC model version for this resource or service model.
37335           required: false
37336           type: string
37337         - name: widget-model-id
37338           in: query
37339           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37340           required: false
37341           type: string
37342         - name: widget-model-version
37343           in: query
37344           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37345           required: false
37346           type: string
37347         - name: nf-type
37348           in: query
37349           description: Generic description of the type of NF
37350           required: false
37351           type: string
37352         - name: nf-function
37353           in: query
37354           description: English description of Network function that the specific VNF deployment is providing
37355           required: false
37356           type: string
37357         - name: nf-role
37358           in: query
37359           description: role in the network that this model will be providing
37360           required: false
37361           type: string
37362         - name: nf-naming-code
37363           in: query
37364           description: string assigned to this model used for naming purposes
37365           required: false
37366           type: string
37367         - name: interface-id
37368           in: query
37369           description: ID of interface
37370           required: false
37371           type: string
37372         - name: interface-role
37373           in: query
37374           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37375           required: false
37376           type: string
37377         - name: interface-id
37378           in: query
37379           description: ID of interface
37380           required: false
37381           type: string
37382         - name: macaddr
37383           in: query
37384           description: MAC address for the interface
37385           required: false
37386           type: string
37387         - name: network-name
37388           in: query
37389           description: Name of the network
37390           required: false
37391           type: string
37392         - name: vlan-id-inner
37393           in: query
37394           description: Inner VLAN tag
37395           required: false
37396           type: integer
37397           format: int64
37398         - name: vpn-key
37399           in: query
37400           description: This indicates the customers VPN ID associated with this vlan
37401           required: false
37402           type: string
37403         - name: vlan-id-inner
37404           in: query
37405           description: Inner VLAN tag
37406           required: false
37407           type: integer
37408           format: int64
37409         - name: neutron-network-id
37410           in: query
37411           description: Neutron network id of the interface that address belongs to
37412           required: false
37413           type: string
37414         - name: neutron-subnet-id
37415           in: query
37416           description: Neutron id of subnet that address belongs to
37417           required: false
37418           type: string
37419     put:
37420       tags:
37421         - Network
37422       summary: create or update an existing l3-interface-ipv4-address-list
37423       description: |
37424         Create or update an existing l3-interface-ipv4-address-list.
37425         #
37426         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37427       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37428       consumes:
37429         - application/json
37430         - application/xml
37431       produces:
37432         - application/json
37433         - application/xml
37434       responses:
37435         "default":
37436           description: Response codes found in [response codes](https://wiki.onap.org/).
37437       parameters:
37438         - name: vnf-id
37439           in: path
37440           description: Unique id of VNF.  This is unique across the graph.
37441           required: true
37442           type: string
37443           example: __VNF-ID__
37444         - name: interface-name
37445           in: path
37446           description: Name that identifies the link aggregate interface
37447           required: true
37448           type: string
37449           example: __INTERFACE-NAME__
37450         - name: interface-name
37451           in: path
37452           description: Name given to the interface
37453           required: true
37454           type: string
37455           example: __INTERFACE-NAME__
37456         - name: vlan-interface
37457           in: path
37458           description: String that identifies the interface
37459           required: true
37460           type: string
37461           example: __VLAN-INTERFACE__
37462         - name: l3-interface-ipv4-address
37463           in: path
37464           description: IP address
37465           required: true
37466           type: string
37467           example: __L3-INTERFACE-IPV4-ADDRESS__
37468         - name: body
37469           in: body
37470           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
37471           required: true
37472           schema:
37473             $ref: "#/definitions/l3-interface-ipv4-address-list"
37474     patch:
37475       tags:
37476         - Network
37477       summary: update an existing l3-interface-ipv4-address-list
37478       description: |
37479         Update an existing l3-interface-ipv4-address-list
37480         #
37481         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37482         The PUT operation will entirely replace an existing object.
37483         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37484         #
37485         Other differences between PUT and PATCH are:
37486         #
37487         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37488         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37489         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37490       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37491       consumes:
37492         - application/json
37493         - application/xml
37494       produces:
37495         - application/json
37496         - application/xml
37497       responses:
37498         "default":
37499           description: Response codes found in [response codes](https://wiki.onap.org/).
37500       parameters:
37501         - name: vnf-id
37502           in: path
37503           description: Unique id of VNF.  This is unique across the graph.
37504           required: true
37505           type: string
37506           example: __VNF-ID__
37507         - name: interface-name
37508           in: path
37509           description: Name that identifies the link aggregate interface
37510           required: true
37511           type: string
37512           example: __INTERFACE-NAME__
37513         - name: interface-name
37514           in: path
37515           description: Name given to the interface
37516           required: true
37517           type: string
37518           example: __INTERFACE-NAME__
37519         - name: vlan-interface
37520           in: path
37521           description: String that identifies the interface
37522           required: true
37523           type: string
37524           example: __VLAN-INTERFACE__
37525         - name: l3-interface-ipv4-address
37526           in: path
37527           description: IP address
37528           required: true
37529           type: string
37530           example: __L3-INTERFACE-IPV4-ADDRESS__
37531         - name: body
37532           in: body
37533           description: l3-interface-ipv4-address-list object that needs to be created or updated.
37534           required: true
37535           schema:
37536             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
37537     delete:
37538       tags:
37539         - Network
37540       summary: delete an existing l3-interface-ipv4-address-list
37541       description: delete an existing l3-interface-ipv4-address-list
37542       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
37543       consumes:
37544         - application/json
37545         - application/xml
37546       produces:
37547         - application/json
37548         - application/xml
37549       responses:
37550         "default":
37551           description: Response codes found in [response codes](https://wiki.onap.org/).
37552       parameters:
37553         - name: vnf-id
37554           in: path
37555           description: Unique id of VNF.  This is unique across the graph.
37556           required: true
37557           type: string
37558           example: __VNF-ID__
37559         - name: interface-name
37560           in: path
37561           description: Name that identifies the link aggregate interface
37562           required: true
37563           type: string
37564           example: __INTERFACE-NAME__
37565         - name: interface-name
37566           in: path
37567           description: Name given to the interface
37568           required: true
37569           type: string
37570           example: __INTERFACE-NAME__
37571         - name: vlan-interface
37572           in: path
37573           description: String that identifies the interface
37574           required: true
37575           type: string
37576           example: __VLAN-INTERFACE__
37577         - name: l3-interface-ipv4-address
37578           in: path
37579           description: IP address
37580           required: true
37581           type: string
37582           example: __L3-INTERFACE-IPV4-ADDRESS__
37583         - name: resource-version
37584           in: query
37585           description: resource-version for concurrency
37586           required: true
37587           type: string
37588   /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:
37589     put:
37590       tags:
37591         - Network
37592       summary: see node definition for valid relationships
37593       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37594       consumes:
37595         - application/json
37596         - application/xml
37597       produces:
37598         - application/json
37599         - application/xml
37600       responses:
37601         "default":
37602           description: Response codes found in [response codes](https://wiki.onap.org/).
37603       parameters:
37604         - name: vnf-id
37605           in: path
37606           description: Unique id of VNF.  This is unique across the graph.
37607           required: true
37608           type: string
37609           example: __VNF-ID__
37610         - name: interface-name
37611           in: path
37612           description: Name that identifies the link aggregate interface
37613           required: true
37614           type: string
37615           example: __INTERFACE-NAME__
37616         - name: interface-name
37617           in: path
37618           description: Name given to the interface
37619           required: true
37620           type: string
37621           example: __INTERFACE-NAME__
37622         - name: vlan-interface
37623           in: path
37624           description: String that identifies the interface
37625           required: true
37626           type: string
37627           example: __VLAN-INTERFACE__
37628         - name: l3-interface-ipv6-address
37629           in: path
37630           description: IP address
37631           required: true
37632           type: string
37633           example: __L3-INTERFACE-IPV6-ADDRESS__
37634         - name: body
37635           in: body
37636           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37637           required: true
37638           schema:
37639             $ref: "#/definitions/relationship"
37640     delete:
37641       tags:
37642         - Network
37643       summary: delete an existing relationship
37644       description: delete an existing relationship
37645       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
37646       consumes:
37647         - application/json
37648         - application/xml
37649       produces:
37650         - application/json
37651         - application/xml
37652       responses:
37653         "default":
37654           description: Response codes found in [response codes](https://wiki.onap.org/).
37655       parameters:
37656         - name: vnf-id
37657           in: path
37658           description: Unique id of VNF.  This is unique across the graph.
37659           required: true
37660           type: string
37661           example: __VNF-ID__
37662         - name: interface-name
37663           in: path
37664           description: Name that identifies the link aggregate interface
37665           required: true
37666           type: string
37667           example: __INTERFACE-NAME__
37668         - name: interface-name
37669           in: path
37670           description: Name given to the interface
37671           required: true
37672           type: string
37673           example: __INTERFACE-NAME__
37674         - name: vlan-interface
37675           in: path
37676           description: String that identifies the interface
37677           required: true
37678           type: string
37679           example: __VLAN-INTERFACE__
37680         - name: l3-interface-ipv6-address
37681           in: path
37682           description: IP address
37683           required: true
37684           type: string
37685           example: __L3-INTERFACE-IPV6-ADDRESS__
37686   /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}:
37687     get:
37688       tags:
37689         - Network
37690       summary: returns l3-interface-ipv6-address-list
37691       description: returns l3-interface-ipv6-address-list
37692       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37693       produces:
37694         - application/json
37695         - application/xml
37696       responses:
37697         "200":
37698           description: successful operation
37699           schema:
37700               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
37701         "default":
37702           description: Response codes found in [response codes](https://wiki.onap.org/).
37703       parameters:
37704         - name: vnf-id
37705           in: path
37706           description: Unique id of VNF.  This is unique across the graph.
37707           required: true
37708           type: string
37709           example: __VNF-ID__
37710         - name: interface-name
37711           in: path
37712           description: Name that identifies the link aggregate interface
37713           required: true
37714           type: string
37715           example: __INTERFACE-NAME__
37716         - name: interface-name
37717           in: path
37718           description: Name given to the interface
37719           required: true
37720           type: string
37721           example: __INTERFACE-NAME__
37722         - name: vlan-interface
37723           in: path
37724           description: String that identifies the interface
37725           required: true
37726           type: string
37727           example: __VLAN-INTERFACE__
37728         - name: l3-interface-ipv6-address
37729           in: path
37730           description: IP address
37731           required: true
37732           type: string
37733           example: __L3-INTERFACE-IPV6-ADDRESS__
37734         - name: vnf-name
37735           in: query
37736           description: Name of VNF.
37737           required: false
37738           type: string
37739         - name: vnf-name2
37740           in: query
37741           description: Alternate name of VNF.
37742           required: false
37743           type: string
37744         - name: vnf-type
37745           in: query
37746           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.
37747           required: false
37748           type: string
37749         - name: service-id
37750           in: query
37751           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
37752           required: false
37753           type: string
37754         - name: regional-resource-zone
37755           in: query
37756           description: Regional way of organizing pservers, source of truth should define values
37757           required: false
37758           type: string
37759         - name: prov-status
37760           in: query
37761           description: Trigger for operational monitoring of this resource by Service Assurance systems.
37762           required: false
37763           type: string
37764         - name: heat-stack-id
37765           in: query
37766           description: Heat stack id corresponding to this instance, managed by MSO
37767           required: false
37768           type: string
37769         - name: in-maint
37770           in: query
37771           required: false
37772           type: boolean
37773         - name: is-closed-loop-disabled
37774           in: query
37775           required: false
37776           type: boolean
37777         - name: model-invariant-id
37778           in: query
37779           description: the ASDC model id for this resource or service model.
37780           required: false
37781           type: string
37782         - name: model-version-id
37783           in: query
37784           description: the ASDC model version for this resource or service model.
37785           required: false
37786           type: string
37787         - name: widget-model-id
37788           in: query
37789           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
37790           required: false
37791           type: string
37792         - name: widget-model-version
37793           in: query
37794           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
37795           required: false
37796           type: string
37797         - name: nf-type
37798           in: query
37799           description: Generic description of the type of NF
37800           required: false
37801           type: string
37802         - name: nf-function
37803           in: query
37804           description: English description of Network function that the specific VNF deployment is providing
37805           required: false
37806           type: string
37807         - name: nf-role
37808           in: query
37809           description: role in the network that this model will be providing
37810           required: false
37811           type: string
37812         - name: nf-naming-code
37813           in: query
37814           description: string assigned to this model used for naming purposes
37815           required: false
37816           type: string
37817         - name: interface-id
37818           in: query
37819           description: ID of interface
37820           required: false
37821           type: string
37822         - name: interface-role
37823           in: query
37824           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
37825           required: false
37826           type: string
37827         - name: interface-id
37828           in: query
37829           description: ID of interface
37830           required: false
37831           type: string
37832         - name: macaddr
37833           in: query
37834           description: MAC address for the interface
37835           required: false
37836           type: string
37837         - name: network-name
37838           in: query
37839           description: Name of the network
37840           required: false
37841           type: string
37842         - name: vlan-id-inner
37843           in: query
37844           description: Inner VLAN tag
37845           required: false
37846           type: integer
37847           format: int64
37848         - name: vpn-key
37849           in: query
37850           description: This indicates the customers VPN ID associated with this vlan
37851           required: false
37852           type: string
37853         - name: vlan-id-inner
37854           in: query
37855           description: Inner VLAN tag
37856           required: false
37857           type: integer
37858           format: int64
37859         - name: neutron-network-id
37860           in: query
37861           description: Neutron network id of the interface that address belongs to
37862           required: false
37863           type: string
37864         - name: neutron-subnet-id
37865           in: query
37866           description: Neutron id of subnet that address belongs to
37867           required: false
37868           type: string
37869     put:
37870       tags:
37871         - Network
37872       summary: create or update an existing l3-interface-ipv6-address-list
37873       description: |
37874         Create or update an existing l3-interface-ipv6-address-list.
37875         #
37876         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
37877       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37878       consumes:
37879         - application/json
37880         - application/xml
37881       produces:
37882         - application/json
37883         - application/xml
37884       responses:
37885         "default":
37886           description: Response codes found in [response codes](https://wiki.onap.org/).
37887       parameters:
37888         - name: vnf-id
37889           in: path
37890           description: Unique id of VNF.  This is unique across the graph.
37891           required: true
37892           type: string
37893           example: __VNF-ID__
37894         - name: interface-name
37895           in: path
37896           description: Name that identifies the link aggregate interface
37897           required: true
37898           type: string
37899           example: __INTERFACE-NAME__
37900         - name: interface-name
37901           in: path
37902           description: Name given to the interface
37903           required: true
37904           type: string
37905           example: __INTERFACE-NAME__
37906         - name: vlan-interface
37907           in: path
37908           description: String that identifies the interface
37909           required: true
37910           type: string
37911           example: __VLAN-INTERFACE__
37912         - name: l3-interface-ipv6-address
37913           in: path
37914           description: IP address
37915           required: true
37916           type: string
37917           example: __L3-INTERFACE-IPV6-ADDRESS__
37918         - name: body
37919           in: body
37920           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
37921           required: true
37922           schema:
37923             $ref: "#/definitions/l3-interface-ipv6-address-list"
37924     patch:
37925       tags:
37926         - Network
37927       summary: update an existing l3-interface-ipv6-address-list
37928       description: |
37929         Update an existing l3-interface-ipv6-address-list
37930         #
37931         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
37932         The PUT operation will entirely replace an existing object.
37933         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
37934         #
37935         Other differences between PUT and PATCH are:
37936         #
37937         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
37938         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
37939         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
37940       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37941       consumes:
37942         - application/json
37943         - application/xml
37944       produces:
37945         - application/json
37946         - application/xml
37947       responses:
37948         "default":
37949           description: Response codes found in [response codes](https://wiki.onap.org/).
37950       parameters:
37951         - name: vnf-id
37952           in: path
37953           description: Unique id of VNF.  This is unique across the graph.
37954           required: true
37955           type: string
37956           example: __VNF-ID__
37957         - name: interface-name
37958           in: path
37959           description: Name that identifies the link aggregate interface
37960           required: true
37961           type: string
37962           example: __INTERFACE-NAME__
37963         - name: interface-name
37964           in: path
37965           description: Name given to the interface
37966           required: true
37967           type: string
37968           example: __INTERFACE-NAME__
37969         - name: vlan-interface
37970           in: path
37971           description: String that identifies the interface
37972           required: true
37973           type: string
37974           example: __VLAN-INTERFACE__
37975         - name: l3-interface-ipv6-address
37976           in: path
37977           description: IP address
37978           required: true
37979           type: string
37980           example: __L3-INTERFACE-IPV6-ADDRESS__
37981         - name: body
37982           in: body
37983           description: l3-interface-ipv6-address-list object that needs to be created or updated.
37984           required: true
37985           schema:
37986             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
37987     delete:
37988       tags:
37989         - Network
37990       summary: delete an existing l3-interface-ipv6-address-list
37991       description: delete an existing l3-interface-ipv6-address-list
37992       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
37993       consumes:
37994         - application/json
37995         - application/xml
37996       produces:
37997         - application/json
37998         - application/xml
37999       responses:
38000         "default":
38001           description: Response codes found in [response codes](https://wiki.onap.org/).
38002       parameters:
38003         - name: vnf-id
38004           in: path
38005           description: Unique id of VNF.  This is unique across the graph.
38006           required: true
38007           type: string
38008           example: __VNF-ID__
38009         - name: interface-name
38010           in: path
38011           description: Name that identifies the link aggregate interface
38012           required: true
38013           type: string
38014           example: __INTERFACE-NAME__
38015         - name: interface-name
38016           in: path
38017           description: Name given to the interface
38018           required: true
38019           type: string
38020           example: __INTERFACE-NAME__
38021         - name: vlan-interface
38022           in: path
38023           description: String that identifies the interface
38024           required: true
38025           type: string
38026           example: __VLAN-INTERFACE__
38027         - name: l3-interface-ipv6-address
38028           in: path
38029           description: IP address
38030           required: true
38031           type: string
38032           example: __L3-INTERFACE-IPV6-ADDRESS__
38033         - name: resource-version
38034           in: query
38035           description: resource-version for concurrency
38036           required: true
38037           type: string
38038   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
38039     get:
38040       tags:
38041         - Network
38042       summary: returns vlan
38043       description: returns vlan
38044       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38045       produces:
38046         - application/json
38047         - application/xml
38048       responses:
38049         "200":
38050           description: successful operation
38051           schema:
38052               $ref: "#/getDefinitions/vlan"
38053         "default":
38054           description: Response codes found in [response codes](https://wiki.onap.org/).
38055       parameters:
38056         - name: vnf-id
38057           in: path
38058           description: Unique id of VNF.  This is unique across the graph.
38059           required: true
38060           type: string
38061           example: __VNF-ID__
38062         - name: interface-name
38063           in: path
38064           description: Name that identifies the link aggregate interface
38065           required: true
38066           type: string
38067           example: __INTERFACE-NAME__
38068         - name: interface-name
38069           in: path
38070           description: Name given to the interface
38071           required: true
38072           type: string
38073           example: __INTERFACE-NAME__
38074         - name: vlan-interface
38075           in: path
38076           description: String that identifies the interface
38077           required: true
38078           type: string
38079           example: __VLAN-INTERFACE__
38080         - name: vnf-name
38081           in: query
38082           description: Name of VNF.
38083           required: false
38084           type: string
38085         - name: vnf-name2
38086           in: query
38087           description: Alternate name of VNF.
38088           required: false
38089           type: string
38090         - name: vnf-type
38091           in: query
38092           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.
38093           required: false
38094           type: string
38095         - name: service-id
38096           in: query
38097           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38098           required: false
38099           type: string
38100         - name: regional-resource-zone
38101           in: query
38102           description: Regional way of organizing pservers, source of truth should define values
38103           required: false
38104           type: string
38105         - name: prov-status
38106           in: query
38107           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38108           required: false
38109           type: string
38110         - name: heat-stack-id
38111           in: query
38112           description: Heat stack id corresponding to this instance, managed by MSO
38113           required: false
38114           type: string
38115         - name: in-maint
38116           in: query
38117           required: false
38118           type: boolean
38119         - name: is-closed-loop-disabled
38120           in: query
38121           required: false
38122           type: boolean
38123         - name: model-invariant-id
38124           in: query
38125           description: the ASDC model id for this resource or service model.
38126           required: false
38127           type: string
38128         - name: model-version-id
38129           in: query
38130           description: the ASDC model version for this resource or service model.
38131           required: false
38132           type: string
38133         - name: widget-model-id
38134           in: query
38135           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38136           required: false
38137           type: string
38138         - name: widget-model-version
38139           in: query
38140           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38141           required: false
38142           type: string
38143         - name: nf-type
38144           in: query
38145           description: Generic description of the type of NF
38146           required: false
38147           type: string
38148         - name: nf-function
38149           in: query
38150           description: English description of Network function that the specific VNF deployment is providing
38151           required: false
38152           type: string
38153         - name: nf-role
38154           in: query
38155           description: role in the network that this model will be providing
38156           required: false
38157           type: string
38158         - name: nf-naming-code
38159           in: query
38160           description: string assigned to this model used for naming purposes
38161           required: false
38162           type: string
38163         - name: interface-id
38164           in: query
38165           description: ID of interface
38166           required: false
38167           type: string
38168         - name: interface-role
38169           in: query
38170           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38171           required: false
38172           type: string
38173         - name: interface-id
38174           in: query
38175           description: ID of interface
38176           required: false
38177           type: string
38178         - name: macaddr
38179           in: query
38180           description: MAC address for the interface
38181           required: false
38182           type: string
38183         - name: network-name
38184           in: query
38185           description: Name of the network
38186           required: false
38187           type: string
38188         - name: vlan-id-inner
38189           in: query
38190           description: Inner VLAN tag
38191           required: false
38192           type: integer
38193           format: int64
38194         - name: vpn-key
38195           in: query
38196           description: This indicates the customers VPN ID associated with this vlan
38197           required: false
38198           type: string
38199     put:
38200       tags:
38201         - Network
38202       summary: create or update an existing vlan
38203       description: |
38204         Create or update an existing vlan.
38205         #
38206         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38207       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38208       consumes:
38209         - application/json
38210         - application/xml
38211       produces:
38212         - application/json
38213         - application/xml
38214       responses:
38215         "default":
38216           description: Response codes found in [response codes](https://wiki.onap.org/).
38217       parameters:
38218         - name: vnf-id
38219           in: path
38220           description: Unique id of VNF.  This is unique across the graph.
38221           required: true
38222           type: string
38223           example: __VNF-ID__
38224         - name: interface-name
38225           in: path
38226           description: Name that identifies the link aggregate interface
38227           required: true
38228           type: string
38229           example: __INTERFACE-NAME__
38230         - name: interface-name
38231           in: path
38232           description: Name given to the interface
38233           required: true
38234           type: string
38235           example: __INTERFACE-NAME__
38236         - name: vlan-interface
38237           in: path
38238           description: String that identifies the interface
38239           required: true
38240           type: string
38241           example: __VLAN-INTERFACE__
38242         - name: body
38243           in: body
38244           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
38245           required: true
38246           schema:
38247             $ref: "#/definitions/vlan"
38248     patch:
38249       tags:
38250         - Network
38251       summary: update an existing vlan
38252       description: |
38253         Update an existing vlan
38254         #
38255         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38256         The PUT operation will entirely replace an existing object.
38257         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38258         #
38259         Other differences between PUT and PATCH are:
38260         #
38261         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38262         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38263         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38264       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38265       consumes:
38266         - application/json
38267         - application/xml
38268       produces:
38269         - application/json
38270         - application/xml
38271       responses:
38272         "default":
38273           description: Response codes found in [response codes](https://wiki.onap.org/).
38274       parameters:
38275         - name: vnf-id
38276           in: path
38277           description: Unique id of VNF.  This is unique across the graph.
38278           required: true
38279           type: string
38280           example: __VNF-ID__
38281         - name: interface-name
38282           in: path
38283           description: Name that identifies the link aggregate interface
38284           required: true
38285           type: string
38286           example: __INTERFACE-NAME__
38287         - name: interface-name
38288           in: path
38289           description: Name given to the interface
38290           required: true
38291           type: string
38292           example: __INTERFACE-NAME__
38293         - name: vlan-interface
38294           in: path
38295           description: String that identifies the interface
38296           required: true
38297           type: string
38298           example: __VLAN-INTERFACE__
38299         - name: body
38300           in: body
38301           description: vlan object that needs to be created or updated.
38302           required: true
38303           schema:
38304             $ref: "#/patchDefinitions/vlan"
38305     delete:
38306       tags:
38307         - Network
38308       summary: delete an existing vlan
38309       description: delete an existing vlan
38310       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
38311       consumes:
38312         - application/json
38313         - application/xml
38314       produces:
38315         - application/json
38316         - application/xml
38317       responses:
38318         "default":
38319           description: Response codes found in [response codes](https://wiki.onap.org/).
38320       parameters:
38321         - name: vnf-id
38322           in: path
38323           description: Unique id of VNF.  This is unique across the graph.
38324           required: true
38325           type: string
38326           example: __VNF-ID__
38327         - name: interface-name
38328           in: path
38329           description: Name that identifies the link aggregate interface
38330           required: true
38331           type: string
38332           example: __INTERFACE-NAME__
38333         - name: interface-name
38334           in: path
38335           description: Name given to the interface
38336           required: true
38337           type: string
38338           example: __INTERFACE-NAME__
38339         - name: vlan-interface
38340           in: path
38341           description: String that identifies the interface
38342           required: true
38343           type: string
38344           example: __VLAN-INTERFACE__
38345         - name: resource-version
38346           in: query
38347           description: resource-version for concurrency
38348           required: true
38349           type: string
38350   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
38351     get:
38352       tags:
38353         - Network
38354       summary: returns vlans
38355       description: returns vlans
38356       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
38357       produces:
38358         - application/json
38359         - application/xml
38360       responses:
38361         "200":
38362           description: successful operation
38363           schema:
38364               $ref: "#/getDefinitions/vlans"
38365         "default":
38366           description: Response codes found in [response codes](https://wiki.onap.org/).
38367       parameters:
38368         - name: vnf-id
38369           in: path
38370           description: Unique id of VNF.  This is unique across the graph.
38371           required: true
38372           type: string
38373           example: __VNF-ID__
38374         - name: interface-name
38375           in: path
38376           description: Name that identifies the link aggregate interface
38377           required: true
38378           type: string
38379           example: __INTERFACE-NAME__
38380         - name: interface-name
38381           in: path
38382           description: Name given to the interface
38383           required: true
38384           type: string
38385           example: __INTERFACE-NAME__
38386         - name: vnf-name
38387           in: query
38388           description: Name of VNF.
38389           required: false
38390           type: string
38391         - name: vnf-name2
38392           in: query
38393           description: Alternate name of VNF.
38394           required: false
38395           type: string
38396         - name: vnf-type
38397           in: query
38398           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.
38399           required: false
38400           type: string
38401         - name: service-id
38402           in: query
38403           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38404           required: false
38405           type: string
38406         - name: regional-resource-zone
38407           in: query
38408           description: Regional way of organizing pservers, source of truth should define values
38409           required: false
38410           type: string
38411         - name: prov-status
38412           in: query
38413           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38414           required: false
38415           type: string
38416         - name: heat-stack-id
38417           in: query
38418           description: Heat stack id corresponding to this instance, managed by MSO
38419           required: false
38420           type: string
38421         - name: in-maint
38422           in: query
38423           required: false
38424           type: boolean
38425         - name: is-closed-loop-disabled
38426           in: query
38427           required: false
38428           type: boolean
38429         - name: model-invariant-id
38430           in: query
38431           description: the ASDC model id for this resource or service model.
38432           required: false
38433           type: string
38434         - name: model-version-id
38435           in: query
38436           description: the ASDC model version for this resource or service model.
38437           required: false
38438           type: string
38439         - name: widget-model-id
38440           in: query
38441           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38442           required: false
38443           type: string
38444         - name: widget-model-version
38445           in: query
38446           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38447           required: false
38448           type: string
38449         - name: nf-type
38450           in: query
38451           description: Generic description of the type of NF
38452           required: false
38453           type: string
38454         - name: nf-function
38455           in: query
38456           description: English description of Network function that the specific VNF deployment is providing
38457           required: false
38458           type: string
38459         - name: nf-role
38460           in: query
38461           description: role in the network that this model will be providing
38462           required: false
38463           type: string
38464         - name: nf-naming-code
38465           in: query
38466           description: string assigned to this model used for naming purposes
38467           required: false
38468           type: string
38469         - name: interface-id
38470           in: query
38471           description: ID of interface
38472           required: false
38473           type: string
38474         - name: interface-role
38475           in: query
38476           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38477           required: false
38478           type: string
38479         - name: interface-id
38480           in: query
38481           description: ID of interface
38482           required: false
38483           type: string
38484         - name: macaddr
38485           in: query
38486           description: MAC address for the interface
38487           required: false
38488           type: string
38489         - name: network-name
38490           in: query
38491           description: Name of the network
38492           required: false
38493           type: string
38494   /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:
38495     put:
38496       tags:
38497         - Network
38498       summary: see node definition for valid relationships
38499       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38500       consumes:
38501         - application/json
38502         - application/xml
38503       produces:
38504         - application/json
38505         - application/xml
38506       responses:
38507         "default":
38508           description: Response codes found in [response codes](https://wiki.onap.org/).
38509       parameters:
38510         - name: vnf-id
38511           in: path
38512           description: Unique id of VNF.  This is unique across the graph.
38513           required: true
38514           type: string
38515           example: __VNF-ID__
38516         - name: interface-name
38517           in: path
38518           description: Name that identifies the link aggregate interface
38519           required: true
38520           type: string
38521           example: __INTERFACE-NAME__
38522         - name: interface-name
38523           in: path
38524           description: Name given to the interface
38525           required: true
38526           type: string
38527           example: __INTERFACE-NAME__
38528         - name: pci-id
38529           in: path
38530           description: PCI ID used to identify the sriov-vf
38531           required: true
38532           type: string
38533           example: __PCI-ID__
38534         - name: body
38535           in: body
38536           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38537           required: true
38538           schema:
38539             $ref: "#/definitions/relationship"
38540     delete:
38541       tags:
38542         - Network
38543       summary: delete an existing relationship
38544       description: delete an existing relationship
38545       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
38546       consumes:
38547         - application/json
38548         - application/xml
38549       produces:
38550         - application/json
38551         - application/xml
38552       responses:
38553         "default":
38554           description: Response codes found in [response codes](https://wiki.onap.org/).
38555       parameters:
38556         - name: vnf-id
38557           in: path
38558           description: Unique id of VNF.  This is unique across the graph.
38559           required: true
38560           type: string
38561           example: __VNF-ID__
38562         - name: interface-name
38563           in: path
38564           description: Name that identifies the link aggregate interface
38565           required: true
38566           type: string
38567           example: __INTERFACE-NAME__
38568         - name: interface-name
38569           in: path
38570           description: Name given to the interface
38571           required: true
38572           type: string
38573           example: __INTERFACE-NAME__
38574         - name: pci-id
38575           in: path
38576           description: PCI ID used to identify the sriov-vf
38577           required: true
38578           type: string
38579           example: __PCI-ID__
38580   /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}:
38581     get:
38582       tags:
38583         - Network
38584       summary: returns sriov-vf
38585       description: returns sriov-vf
38586       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38587       produces:
38588         - application/json
38589         - application/xml
38590       responses:
38591         "200":
38592           description: successful operation
38593           schema:
38594               $ref: "#/getDefinitions/sriov-vf"
38595         "default":
38596           description: Response codes found in [response codes](https://wiki.onap.org/).
38597       parameters:
38598         - name: vnf-id
38599           in: path
38600           description: Unique id of VNF.  This is unique across the graph.
38601           required: true
38602           type: string
38603           example: __VNF-ID__
38604         - name: interface-name
38605           in: path
38606           description: Name that identifies the link aggregate interface
38607           required: true
38608           type: string
38609           example: __INTERFACE-NAME__
38610         - name: interface-name
38611           in: path
38612           description: Name given to the interface
38613           required: true
38614           type: string
38615           example: __INTERFACE-NAME__
38616         - name: pci-id
38617           in: path
38618           description: PCI ID used to identify the sriov-vf
38619           required: true
38620           type: string
38621           example: __PCI-ID__
38622         - name: vnf-name
38623           in: query
38624           description: Name of VNF.
38625           required: false
38626           type: string
38627         - name: vnf-name2
38628           in: query
38629           description: Alternate name of VNF.
38630           required: false
38631           type: string
38632         - name: vnf-type
38633           in: query
38634           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.
38635           required: false
38636           type: string
38637         - name: service-id
38638           in: query
38639           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38640           required: false
38641           type: string
38642         - name: regional-resource-zone
38643           in: query
38644           description: Regional way of organizing pservers, source of truth should define values
38645           required: false
38646           type: string
38647         - name: prov-status
38648           in: query
38649           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38650           required: false
38651           type: string
38652         - name: heat-stack-id
38653           in: query
38654           description: Heat stack id corresponding to this instance, managed by MSO
38655           required: false
38656           type: string
38657         - name: in-maint
38658           in: query
38659           required: false
38660           type: boolean
38661         - name: is-closed-loop-disabled
38662           in: query
38663           required: false
38664           type: boolean
38665         - name: model-invariant-id
38666           in: query
38667           description: the ASDC model id for this resource or service model.
38668           required: false
38669           type: string
38670         - name: model-version-id
38671           in: query
38672           description: the ASDC model version for this resource or service model.
38673           required: false
38674           type: string
38675         - name: widget-model-id
38676           in: query
38677           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38678           required: false
38679           type: string
38680         - name: widget-model-version
38681           in: query
38682           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38683           required: false
38684           type: string
38685         - name: nf-type
38686           in: query
38687           description: Generic description of the type of NF
38688           required: false
38689           type: string
38690         - name: nf-function
38691           in: query
38692           description: English description of Network function that the specific VNF deployment is providing
38693           required: false
38694           type: string
38695         - name: nf-role
38696           in: query
38697           description: role in the network that this model will be providing
38698           required: false
38699           type: string
38700         - name: nf-naming-code
38701           in: query
38702           description: string assigned to this model used for naming purposes
38703           required: false
38704           type: string
38705         - name: interface-id
38706           in: query
38707           description: ID of interface
38708           required: false
38709           type: string
38710         - name: interface-role
38711           in: query
38712           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
38713           required: false
38714           type: string
38715         - name: interface-id
38716           in: query
38717           description: ID of interface
38718           required: false
38719           type: string
38720         - name: macaddr
38721           in: query
38722           description: MAC address for the interface
38723           required: false
38724           type: string
38725         - name: network-name
38726           in: query
38727           description: Name of the network
38728           required: false
38729           type: string
38730         - name: vf-vlan-filter
38731           in: query
38732           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
38733           required: false
38734           type: string
38735         - name: vf-mac-filter
38736           in: query
38737           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
38738           required: false
38739           type: string
38740         - name: vf-vlan-strip
38741           in: query
38742           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
38743           required: false
38744           type: boolean
38745         - name: neutron-network-id
38746           in: query
38747           description: Neutron network id of the interface
38748           required: false
38749           type: string
38750     put:
38751       tags:
38752         - Network
38753       summary: create or update an existing sriov-vf
38754       description: |
38755         Create or update an existing sriov-vf.
38756         #
38757         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
38758       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38759       consumes:
38760         - application/json
38761         - application/xml
38762       produces:
38763         - application/json
38764         - application/xml
38765       responses:
38766         "default":
38767           description: Response codes found in [response codes](https://wiki.onap.org/).
38768       parameters:
38769         - name: vnf-id
38770           in: path
38771           description: Unique id of VNF.  This is unique across the graph.
38772           required: true
38773           type: string
38774           example: __VNF-ID__
38775         - name: interface-name
38776           in: path
38777           description: Name that identifies the link aggregate interface
38778           required: true
38779           type: string
38780           example: __INTERFACE-NAME__
38781         - name: interface-name
38782           in: path
38783           description: Name given to the interface
38784           required: true
38785           type: string
38786           example: __INTERFACE-NAME__
38787         - name: pci-id
38788           in: path
38789           description: PCI ID used to identify the sriov-vf
38790           required: true
38791           type: string
38792           example: __PCI-ID__
38793         - name: body
38794           in: body
38795           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
38796           required: true
38797           schema:
38798             $ref: "#/definitions/sriov-vf"
38799     patch:
38800       tags:
38801         - Network
38802       summary: update an existing sriov-vf
38803       description: |
38804         Update an existing sriov-vf
38805         #
38806         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
38807         The PUT operation will entirely replace an existing object.
38808         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
38809         #
38810         Other differences between PUT and PATCH are:
38811         #
38812         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
38813         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
38814         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
38815       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38816       consumes:
38817         - application/json
38818         - application/xml
38819       produces:
38820         - application/json
38821         - application/xml
38822       responses:
38823         "default":
38824           description: Response codes found in [response codes](https://wiki.onap.org/).
38825       parameters:
38826         - name: vnf-id
38827           in: path
38828           description: Unique id of VNF.  This is unique across the graph.
38829           required: true
38830           type: string
38831           example: __VNF-ID__
38832         - name: interface-name
38833           in: path
38834           description: Name that identifies the link aggregate interface
38835           required: true
38836           type: string
38837           example: __INTERFACE-NAME__
38838         - name: interface-name
38839           in: path
38840           description: Name given to the interface
38841           required: true
38842           type: string
38843           example: __INTERFACE-NAME__
38844         - name: pci-id
38845           in: path
38846           description: PCI ID used to identify the sriov-vf
38847           required: true
38848           type: string
38849           example: __PCI-ID__
38850         - name: body
38851           in: body
38852           description: sriov-vf object that needs to be created or updated.
38853           required: true
38854           schema:
38855             $ref: "#/patchDefinitions/sriov-vf"
38856     delete:
38857       tags:
38858         - Network
38859       summary: delete an existing sriov-vf
38860       description: delete an existing sriov-vf
38861       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
38862       consumes:
38863         - application/json
38864         - application/xml
38865       produces:
38866         - application/json
38867         - application/xml
38868       responses:
38869         "default":
38870           description: Response codes found in [response codes](https://wiki.onap.org/).
38871       parameters:
38872         - name: vnf-id
38873           in: path
38874           description: Unique id of VNF.  This is unique across the graph.
38875           required: true
38876           type: string
38877           example: __VNF-ID__
38878         - name: interface-name
38879           in: path
38880           description: Name that identifies the link aggregate interface
38881           required: true
38882           type: string
38883           example: __INTERFACE-NAME__
38884         - name: interface-name
38885           in: path
38886           description: Name given to the interface
38887           required: true
38888           type: string
38889           example: __INTERFACE-NAME__
38890         - name: pci-id
38891           in: path
38892           description: PCI ID used to identify the sriov-vf
38893           required: true
38894           type: string
38895           example: __PCI-ID__
38896         - name: resource-version
38897           in: query
38898           description: resource-version for concurrency
38899           required: true
38900           type: string
38901   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
38902     get:
38903       tags:
38904         - Network
38905       summary: returns sriov-vfs
38906       description: returns sriov-vfs
38907       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
38908       produces:
38909         - application/json
38910         - application/xml
38911       responses:
38912         "200":
38913           description: successful operation
38914           schema:
38915               $ref: "#/getDefinitions/sriov-vfs"
38916         "default":
38917           description: Response codes found in [response codes](https://wiki.onap.org/).
38918       parameters:
38919         - name: vnf-id
38920           in: path
38921           description: Unique id of VNF.  This is unique across the graph.
38922           required: true
38923           type: string
38924           example: __VNF-ID__
38925         - name: interface-name
38926           in: path
38927           description: Name that identifies the link aggregate interface
38928           required: true
38929           type: string
38930           example: __INTERFACE-NAME__
38931         - name: interface-name
38932           in: path
38933           description: Name given to the interface
38934           required: true
38935           type: string
38936           example: __INTERFACE-NAME__
38937         - name: vnf-name
38938           in: query
38939           description: Name of VNF.
38940           required: false
38941           type: string
38942         - name: vnf-name2
38943           in: query
38944           description: Alternate name of VNF.
38945           required: false
38946           type: string
38947         - name: vnf-type
38948           in: query
38949           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.
38950           required: false
38951           type: string
38952         - name: service-id
38953           in: query
38954           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
38955           required: false
38956           type: string
38957         - name: regional-resource-zone
38958           in: query
38959           description: Regional way of organizing pservers, source of truth should define values
38960           required: false
38961           type: string
38962         - name: prov-status
38963           in: query
38964           description: Trigger for operational monitoring of this resource by Service Assurance systems.
38965           required: false
38966           type: string
38967         - name: heat-stack-id
38968           in: query
38969           description: Heat stack id corresponding to this instance, managed by MSO
38970           required: false
38971           type: string
38972         - name: in-maint
38973           in: query
38974           required: false
38975           type: boolean
38976         - name: is-closed-loop-disabled
38977           in: query
38978           required: false
38979           type: boolean
38980         - name: model-invariant-id
38981           in: query
38982           description: the ASDC model id for this resource or service model.
38983           required: false
38984           type: string
38985         - name: model-version-id
38986           in: query
38987           description: the ASDC model version for this resource or service model.
38988           required: false
38989           type: string
38990         - name: widget-model-id
38991           in: query
38992           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
38993           required: false
38994           type: string
38995         - name: widget-model-version
38996           in: query
38997           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
38998           required: false
38999           type: string
39000         - name: nf-type
39001           in: query
39002           description: Generic description of the type of NF
39003           required: false
39004           type: string
39005         - name: nf-function
39006           in: query
39007           description: English description of Network function that the specific VNF deployment is providing
39008           required: false
39009           type: string
39010         - name: nf-role
39011           in: query
39012           description: role in the network that this model will be providing
39013           required: false
39014           type: string
39015         - name: nf-naming-code
39016           in: query
39017           description: string assigned to this model used for naming purposes
39018           required: false
39019           type: string
39020         - name: interface-id
39021           in: query
39022           description: ID of interface
39023           required: false
39024           type: string
39025         - name: interface-role
39026           in: query
39027           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39028           required: false
39029           type: string
39030         - name: interface-id
39031           in: query
39032           description: ID of interface
39033           required: false
39034           type: string
39035         - name: macaddr
39036           in: query
39037           description: MAC address for the interface
39038           required: false
39039           type: string
39040         - name: network-name
39041           in: query
39042           description: Name of the network
39043           required: false
39044           type: string
39045   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
39046     put:
39047       tags:
39048         - Network
39049       summary: see node definition for valid relationships
39050       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
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: vnf-id
39062           in: path
39063           description: Unique id of VNF.  This is unique across the graph.
39064           required: true
39065           type: string
39066           example: __VNF-ID__
39067         - name: interface-name
39068           in: path
39069           description: Name that identifies the link aggregate interface
39070           required: true
39071           type: string
39072           example: __INTERFACE-NAME__
39073         - name: interface-name
39074           in: path
39075           description: Name given to the interface
39076           required: true
39077           type: string
39078           example: __INTERFACE-NAME__
39079         - name: body
39080           in: body
39081           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
39082           required: true
39083           schema:
39084             $ref: "#/definitions/relationship"
39085     delete:
39086       tags:
39087         - Network
39088       summary: delete an existing relationship
39089       description: delete an existing relationship
39090       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
39091       consumes:
39092         - application/json
39093         - application/xml
39094       produces:
39095         - application/json
39096         - application/xml
39097       responses:
39098         "default":
39099           description: Response codes found in [response codes](https://wiki.onap.org/).
39100       parameters:
39101         - name: vnf-id
39102           in: path
39103           description: Unique id of VNF.  This is unique across the graph.
39104           required: true
39105           type: string
39106           example: __VNF-ID__
39107         - name: interface-name
39108           in: path
39109           description: Name that identifies the link aggregate interface
39110           required: true
39111           type: string
39112           example: __INTERFACE-NAME__
39113         - name: interface-name
39114           in: path
39115           description: Name given to the interface
39116           required: true
39117           type: string
39118           example: __INTERFACE-NAME__
39119   /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:
39120     put:
39121       tags:
39122         - Network
39123       summary: see node definition for valid relationships
39124       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39125       consumes:
39126         - application/json
39127         - application/xml
39128       produces:
39129         - application/json
39130         - application/xml
39131       responses:
39132         "default":
39133           description: Response codes found in [response codes](https://wiki.onap.org/).
39134       parameters:
39135         - name: vnf-id
39136           in: path
39137           description: Unique id of VNF.  This is unique across the graph.
39138           required: true
39139           type: string
39140           example: __VNF-ID__
39141         - name: interface-name
39142           in: path
39143           description: Name that identifies the link aggregate interface
39144           required: true
39145           type: string
39146           example: __INTERFACE-NAME__
39147         - name: interface-name
39148           in: path
39149           description: Name given to the interface
39150           required: true
39151           type: string
39152           example: __INTERFACE-NAME__
39153         - name: l3-interface-ipv4-address
39154           in: path
39155           description: IP address
39156           required: true
39157           type: string
39158           example: __L3-INTERFACE-IPV4-ADDRESS__
39159         - name: body
39160           in: body
39161           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39162           required: true
39163           schema:
39164             $ref: "#/definitions/relationship"
39165     delete:
39166       tags:
39167         - Network
39168       summary: delete an existing relationship
39169       description: delete an existing relationship
39170       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
39171       consumes:
39172         - application/json
39173         - application/xml
39174       produces:
39175         - application/json
39176         - application/xml
39177       responses:
39178         "default":
39179           description: Response codes found in [response codes](https://wiki.onap.org/).
39180       parameters:
39181         - name: vnf-id
39182           in: path
39183           description: Unique id of VNF.  This is unique across the graph.
39184           required: true
39185           type: string
39186           example: __VNF-ID__
39187         - name: interface-name
39188           in: path
39189           description: Name that identifies the link aggregate interface
39190           required: true
39191           type: string
39192           example: __INTERFACE-NAME__
39193         - name: interface-name
39194           in: path
39195           description: Name given to the interface
39196           required: true
39197           type: string
39198           example: __INTERFACE-NAME__
39199         - name: l3-interface-ipv4-address
39200           in: path
39201           description: IP address
39202           required: true
39203           type: string
39204           example: __L3-INTERFACE-IPV4-ADDRESS__
39205   /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}:
39206     get:
39207       tags:
39208         - Network
39209       summary: returns l3-interface-ipv4-address-list
39210       description: returns l3-interface-ipv4-address-list
39211       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39212       produces:
39213         - application/json
39214         - application/xml
39215       responses:
39216         "200":
39217           description: successful operation
39218           schema:
39219               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
39220         "default":
39221           description: Response codes found in [response codes](https://wiki.onap.org/).
39222       parameters:
39223         - name: vnf-id
39224           in: path
39225           description: Unique id of VNF.  This is unique across the graph.
39226           required: true
39227           type: string
39228           example: __VNF-ID__
39229         - name: interface-name
39230           in: path
39231           description: Name that identifies the link aggregate interface
39232           required: true
39233           type: string
39234           example: __INTERFACE-NAME__
39235         - name: interface-name
39236           in: path
39237           description: Name given to the interface
39238           required: true
39239           type: string
39240           example: __INTERFACE-NAME__
39241         - name: l3-interface-ipv4-address
39242           in: path
39243           description: IP address
39244           required: true
39245           type: string
39246           example: __L3-INTERFACE-IPV4-ADDRESS__
39247         - name: vnf-name
39248           in: query
39249           description: Name of VNF.
39250           required: false
39251           type: string
39252         - name: vnf-name2
39253           in: query
39254           description: Alternate name of VNF.
39255           required: false
39256           type: string
39257         - name: vnf-type
39258           in: query
39259           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.
39260           required: false
39261           type: string
39262         - name: service-id
39263           in: query
39264           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39265           required: false
39266           type: string
39267         - name: regional-resource-zone
39268           in: query
39269           description: Regional way of organizing pservers, source of truth should define values
39270           required: false
39271           type: string
39272         - name: prov-status
39273           in: query
39274           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39275           required: false
39276           type: string
39277         - name: heat-stack-id
39278           in: query
39279           description: Heat stack id corresponding to this instance, managed by MSO
39280           required: false
39281           type: string
39282         - name: in-maint
39283           in: query
39284           required: false
39285           type: boolean
39286         - name: is-closed-loop-disabled
39287           in: query
39288           required: false
39289           type: boolean
39290         - name: model-invariant-id
39291           in: query
39292           description: the ASDC model id for this resource or service model.
39293           required: false
39294           type: string
39295         - name: model-version-id
39296           in: query
39297           description: the ASDC model version for this resource or service model.
39298           required: false
39299           type: string
39300         - name: widget-model-id
39301           in: query
39302           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39303           required: false
39304           type: string
39305         - name: widget-model-version
39306           in: query
39307           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39308           required: false
39309           type: string
39310         - name: nf-type
39311           in: query
39312           description: Generic description of the type of NF
39313           required: false
39314           type: string
39315         - name: nf-function
39316           in: query
39317           description: English description of Network function that the specific VNF deployment is providing
39318           required: false
39319           type: string
39320         - name: nf-role
39321           in: query
39322           description: role in the network that this model will be providing
39323           required: false
39324           type: string
39325         - name: nf-naming-code
39326           in: query
39327           description: string assigned to this model used for naming purposes
39328           required: false
39329           type: string
39330         - name: interface-id
39331           in: query
39332           description: ID of interface
39333           required: false
39334           type: string
39335         - name: interface-role
39336           in: query
39337           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39338           required: false
39339           type: string
39340         - name: interface-id
39341           in: query
39342           description: ID of interface
39343           required: false
39344           type: string
39345         - name: macaddr
39346           in: query
39347           description: MAC address for the interface
39348           required: false
39349           type: string
39350         - name: network-name
39351           in: query
39352           description: Name of the network
39353           required: false
39354           type: string
39355         - name: vlan-id-inner
39356           in: query
39357           description: Inner VLAN tag
39358           required: false
39359           type: integer
39360           format: int64
39361         - name: neutron-network-id
39362           in: query
39363           description: Neutron network id of the interface that address belongs to
39364           required: false
39365           type: string
39366         - name: neutron-subnet-id
39367           in: query
39368           description: Neutron id of subnet that address belongs to
39369           required: false
39370           type: string
39371     put:
39372       tags:
39373         - Network
39374       summary: create or update an existing l3-interface-ipv4-address-list
39375       description: |
39376         Create or update an existing l3-interface-ipv4-address-list.
39377         #
39378         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39379       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39380       consumes:
39381         - application/json
39382         - application/xml
39383       produces:
39384         - application/json
39385         - application/xml
39386       responses:
39387         "default":
39388           description: Response codes found in [response codes](https://wiki.onap.org/).
39389       parameters:
39390         - name: vnf-id
39391           in: path
39392           description: Unique id of VNF.  This is unique across the graph.
39393           required: true
39394           type: string
39395           example: __VNF-ID__
39396         - name: interface-name
39397           in: path
39398           description: Name that identifies the link aggregate interface
39399           required: true
39400           type: string
39401           example: __INTERFACE-NAME__
39402         - name: interface-name
39403           in: path
39404           description: Name given to the interface
39405           required: true
39406           type: string
39407           example: __INTERFACE-NAME__
39408         - name: l3-interface-ipv4-address
39409           in: path
39410           description: IP address
39411           required: true
39412           type: string
39413           example: __L3-INTERFACE-IPV4-ADDRESS__
39414         - name: body
39415           in: body
39416           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
39417           required: true
39418           schema:
39419             $ref: "#/definitions/l3-interface-ipv4-address-list"
39420     patch:
39421       tags:
39422         - Network
39423       summary: update an existing l3-interface-ipv4-address-list
39424       description: |
39425         Update an existing l3-interface-ipv4-address-list
39426         #
39427         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39428         The PUT operation will entirely replace an existing object.
39429         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39430         #
39431         Other differences between PUT and PATCH are:
39432         #
39433         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39434         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39435         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39436       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39437       consumes:
39438         - application/json
39439         - application/xml
39440       produces:
39441         - application/json
39442         - application/xml
39443       responses:
39444         "default":
39445           description: Response codes found in [response codes](https://wiki.onap.org/).
39446       parameters:
39447         - name: vnf-id
39448           in: path
39449           description: Unique id of VNF.  This is unique across the graph.
39450           required: true
39451           type: string
39452           example: __VNF-ID__
39453         - name: interface-name
39454           in: path
39455           description: Name that identifies the link aggregate interface
39456           required: true
39457           type: string
39458           example: __INTERFACE-NAME__
39459         - name: interface-name
39460           in: path
39461           description: Name given to the interface
39462           required: true
39463           type: string
39464           example: __INTERFACE-NAME__
39465         - name: l3-interface-ipv4-address
39466           in: path
39467           description: IP address
39468           required: true
39469           type: string
39470           example: __L3-INTERFACE-IPV4-ADDRESS__
39471         - name: body
39472           in: body
39473           description: l3-interface-ipv4-address-list object that needs to be created or updated.
39474           required: true
39475           schema:
39476             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
39477     delete:
39478       tags:
39479         - Network
39480       summary: delete an existing l3-interface-ipv4-address-list
39481       description: delete an existing l3-interface-ipv4-address-list
39482       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
39483       consumes:
39484         - application/json
39485         - application/xml
39486       produces:
39487         - application/json
39488         - application/xml
39489       responses:
39490         "default":
39491           description: Response codes found in [response codes](https://wiki.onap.org/).
39492       parameters:
39493         - name: vnf-id
39494           in: path
39495           description: Unique id of VNF.  This is unique across the graph.
39496           required: true
39497           type: string
39498           example: __VNF-ID__
39499         - name: interface-name
39500           in: path
39501           description: Name that identifies the link aggregate interface
39502           required: true
39503           type: string
39504           example: __INTERFACE-NAME__
39505         - name: interface-name
39506           in: path
39507           description: Name given to the interface
39508           required: true
39509           type: string
39510           example: __INTERFACE-NAME__
39511         - name: l3-interface-ipv4-address
39512           in: path
39513           description: IP address
39514           required: true
39515           type: string
39516           example: __L3-INTERFACE-IPV4-ADDRESS__
39517         - name: resource-version
39518           in: query
39519           description: resource-version for concurrency
39520           required: true
39521           type: string
39522   /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:
39523     put:
39524       tags:
39525         - Network
39526       summary: see node definition for valid relationships
39527       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39528       consumes:
39529         - application/json
39530         - application/xml
39531       produces:
39532         - application/json
39533         - application/xml
39534       responses:
39535         "default":
39536           description: Response codes found in [response codes](https://wiki.onap.org/).
39537       parameters:
39538         - name: vnf-id
39539           in: path
39540           description: Unique id of VNF.  This is unique across the graph.
39541           required: true
39542           type: string
39543           example: __VNF-ID__
39544         - name: interface-name
39545           in: path
39546           description: Name that identifies the link aggregate interface
39547           required: true
39548           type: string
39549           example: __INTERFACE-NAME__
39550         - name: interface-name
39551           in: path
39552           description: Name given to the interface
39553           required: true
39554           type: string
39555           example: __INTERFACE-NAME__
39556         - name: l3-interface-ipv6-address
39557           in: path
39558           description: IP address
39559           required: true
39560           type: string
39561           example: __L3-INTERFACE-IPV6-ADDRESS__
39562         - name: body
39563           in: body
39564           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39565           required: true
39566           schema:
39567             $ref: "#/definitions/relationship"
39568     delete:
39569       tags:
39570         - Network
39571       summary: delete an existing relationship
39572       description: delete an existing relationship
39573       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
39574       consumes:
39575         - application/json
39576         - application/xml
39577       produces:
39578         - application/json
39579         - application/xml
39580       responses:
39581         "default":
39582           description: Response codes found in [response codes](https://wiki.onap.org/).
39583       parameters:
39584         - name: vnf-id
39585           in: path
39586           description: Unique id of VNF.  This is unique across the graph.
39587           required: true
39588           type: string
39589           example: __VNF-ID__
39590         - name: interface-name
39591           in: path
39592           description: Name that identifies the link aggregate interface
39593           required: true
39594           type: string
39595           example: __INTERFACE-NAME__
39596         - name: interface-name
39597           in: path
39598           description: Name given to the interface
39599           required: true
39600           type: string
39601           example: __INTERFACE-NAME__
39602         - name: l3-interface-ipv6-address
39603           in: path
39604           description: IP address
39605           required: true
39606           type: string
39607           example: __L3-INTERFACE-IPV6-ADDRESS__
39608   /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}:
39609     get:
39610       tags:
39611         - Network
39612       summary: returns l3-interface-ipv6-address-list
39613       description: returns l3-interface-ipv6-address-list
39614       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39615       produces:
39616         - application/json
39617         - application/xml
39618       responses:
39619         "200":
39620           description: successful operation
39621           schema:
39622               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
39623         "default":
39624           description: Response codes found in [response codes](https://wiki.onap.org/).
39625       parameters:
39626         - name: vnf-id
39627           in: path
39628           description: Unique id of VNF.  This is unique across the graph.
39629           required: true
39630           type: string
39631           example: __VNF-ID__
39632         - name: interface-name
39633           in: path
39634           description: Name that identifies the link aggregate interface
39635           required: true
39636           type: string
39637           example: __INTERFACE-NAME__
39638         - name: interface-name
39639           in: path
39640           description: Name given to the interface
39641           required: true
39642           type: string
39643           example: __INTERFACE-NAME__
39644         - name: l3-interface-ipv6-address
39645           in: path
39646           description: IP address
39647           required: true
39648           type: string
39649           example: __L3-INTERFACE-IPV6-ADDRESS__
39650         - name: vnf-name
39651           in: query
39652           description: Name of VNF.
39653           required: false
39654           type: string
39655         - name: vnf-name2
39656           in: query
39657           description: Alternate name of VNF.
39658           required: false
39659           type: string
39660         - name: vnf-type
39661           in: query
39662           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.
39663           required: false
39664           type: string
39665         - name: service-id
39666           in: query
39667           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39668           required: false
39669           type: string
39670         - name: regional-resource-zone
39671           in: query
39672           description: Regional way of organizing pservers, source of truth should define values
39673           required: false
39674           type: string
39675         - name: prov-status
39676           in: query
39677           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39678           required: false
39679           type: string
39680         - name: heat-stack-id
39681           in: query
39682           description: Heat stack id corresponding to this instance, managed by MSO
39683           required: false
39684           type: string
39685         - name: in-maint
39686           in: query
39687           required: false
39688           type: boolean
39689         - name: is-closed-loop-disabled
39690           in: query
39691           required: false
39692           type: boolean
39693         - name: model-invariant-id
39694           in: query
39695           description: the ASDC model id for this resource or service model.
39696           required: false
39697           type: string
39698         - name: model-version-id
39699           in: query
39700           description: the ASDC model version for this resource or service model.
39701           required: false
39702           type: string
39703         - name: widget-model-id
39704           in: query
39705           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
39706           required: false
39707           type: string
39708         - name: widget-model-version
39709           in: query
39710           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
39711           required: false
39712           type: string
39713         - name: nf-type
39714           in: query
39715           description: Generic description of the type of NF
39716           required: false
39717           type: string
39718         - name: nf-function
39719           in: query
39720           description: English description of Network function that the specific VNF deployment is providing
39721           required: false
39722           type: string
39723         - name: nf-role
39724           in: query
39725           description: role in the network that this model will be providing
39726           required: false
39727           type: string
39728         - name: nf-naming-code
39729           in: query
39730           description: string assigned to this model used for naming purposes
39731           required: false
39732           type: string
39733         - name: interface-id
39734           in: query
39735           description: ID of interface
39736           required: false
39737           type: string
39738         - name: interface-role
39739           in: query
39740           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
39741           required: false
39742           type: string
39743         - name: interface-id
39744           in: query
39745           description: ID of interface
39746           required: false
39747           type: string
39748         - name: macaddr
39749           in: query
39750           description: MAC address for the interface
39751           required: false
39752           type: string
39753         - name: network-name
39754           in: query
39755           description: Name of the network
39756           required: false
39757           type: string
39758         - name: vlan-id-inner
39759           in: query
39760           description: Inner VLAN tag
39761           required: false
39762           type: integer
39763           format: int64
39764         - name: neutron-network-id
39765           in: query
39766           description: Neutron network id of the interface that address belongs to
39767           required: false
39768           type: string
39769         - name: neutron-subnet-id
39770           in: query
39771           description: Neutron id of subnet that address belongs to
39772           required: false
39773           type: string
39774     put:
39775       tags:
39776         - Network
39777       summary: create or update an existing l3-interface-ipv6-address-list
39778       description: |
39779         Create or update an existing l3-interface-ipv6-address-list.
39780         #
39781         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
39782       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39783       consumes:
39784         - application/json
39785         - application/xml
39786       produces:
39787         - application/json
39788         - application/xml
39789       responses:
39790         "default":
39791           description: Response codes found in [response codes](https://wiki.onap.org/).
39792       parameters:
39793         - name: vnf-id
39794           in: path
39795           description: Unique id of VNF.  This is unique across the graph.
39796           required: true
39797           type: string
39798           example: __VNF-ID__
39799         - name: interface-name
39800           in: path
39801           description: Name that identifies the link aggregate interface
39802           required: true
39803           type: string
39804           example: __INTERFACE-NAME__
39805         - name: interface-name
39806           in: path
39807           description: Name given to the interface
39808           required: true
39809           type: string
39810           example: __INTERFACE-NAME__
39811         - name: l3-interface-ipv6-address
39812           in: path
39813           description: IP address
39814           required: true
39815           type: string
39816           example: __L3-INTERFACE-IPV6-ADDRESS__
39817         - name: body
39818           in: body
39819           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
39820           required: true
39821           schema:
39822             $ref: "#/definitions/l3-interface-ipv6-address-list"
39823     patch:
39824       tags:
39825         - Network
39826       summary: update an existing l3-interface-ipv6-address-list
39827       description: |
39828         Update an existing l3-interface-ipv6-address-list
39829         #
39830         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
39831         The PUT operation will entirely replace an existing object.
39832         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
39833         #
39834         Other differences between PUT and PATCH are:
39835         #
39836         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
39837         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
39838         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
39839       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39840       consumes:
39841         - application/json
39842         - application/xml
39843       produces:
39844         - application/json
39845         - application/xml
39846       responses:
39847         "default":
39848           description: Response codes found in [response codes](https://wiki.onap.org/).
39849       parameters:
39850         - name: vnf-id
39851           in: path
39852           description: Unique id of VNF.  This is unique across the graph.
39853           required: true
39854           type: string
39855           example: __VNF-ID__
39856         - name: interface-name
39857           in: path
39858           description: Name that identifies the link aggregate interface
39859           required: true
39860           type: string
39861           example: __INTERFACE-NAME__
39862         - name: interface-name
39863           in: path
39864           description: Name given to the interface
39865           required: true
39866           type: string
39867           example: __INTERFACE-NAME__
39868         - name: l3-interface-ipv6-address
39869           in: path
39870           description: IP address
39871           required: true
39872           type: string
39873           example: __L3-INTERFACE-IPV6-ADDRESS__
39874         - name: body
39875           in: body
39876           description: l3-interface-ipv6-address-list object that needs to be created or updated.
39877           required: true
39878           schema:
39879             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
39880     delete:
39881       tags:
39882         - Network
39883       summary: delete an existing l3-interface-ipv6-address-list
39884       description: delete an existing l3-interface-ipv6-address-list
39885       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
39886       consumes:
39887         - application/json
39888         - application/xml
39889       produces:
39890         - application/json
39891         - application/xml
39892       responses:
39893         "default":
39894           description: Response codes found in [response codes](https://wiki.onap.org/).
39895       parameters:
39896         - name: vnf-id
39897           in: path
39898           description: Unique id of VNF.  This is unique across the graph.
39899           required: true
39900           type: string
39901           example: __VNF-ID__
39902         - name: interface-name
39903           in: path
39904           description: Name that identifies the link aggregate interface
39905           required: true
39906           type: string
39907           example: __INTERFACE-NAME__
39908         - name: interface-name
39909           in: path
39910           description: Name given to the interface
39911           required: true
39912           type: string
39913           example: __INTERFACE-NAME__
39914         - name: l3-interface-ipv6-address
39915           in: path
39916           description: IP address
39917           required: true
39918           type: string
39919           example: __L3-INTERFACE-IPV6-ADDRESS__
39920         - name: resource-version
39921           in: query
39922           description: resource-version for concurrency
39923           required: true
39924           type: string
39925   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
39926     get:
39927       tags:
39928         - Network
39929       summary: returns l-interface
39930       description: returns l-interface
39931       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
39932       produces:
39933         - application/json
39934         - application/xml
39935       responses:
39936         "200":
39937           description: successful operation
39938           schema:
39939               $ref: "#/getDefinitions/l-interface"
39940         "default":
39941           description: Response codes found in [response codes](https://wiki.onap.org/).
39942       parameters:
39943         - name: vnf-id
39944           in: path
39945           description: Unique id of VNF.  This is unique across the graph.
39946           required: true
39947           type: string
39948           example: __VNF-ID__
39949         - name: interface-name
39950           in: path
39951           description: Name that identifies the link aggregate interface
39952           required: true
39953           type: string
39954           example: __INTERFACE-NAME__
39955         - name: interface-name
39956           in: path
39957           description: Name given to the interface
39958           required: true
39959           type: string
39960           example: __INTERFACE-NAME__
39961         - name: vnf-name
39962           in: query
39963           description: Name of VNF.
39964           required: false
39965           type: string
39966         - name: vnf-name2
39967           in: query
39968           description: Alternate name of VNF.
39969           required: false
39970           type: string
39971         - name: vnf-type
39972           in: query
39973           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.
39974           required: false
39975           type: string
39976         - name: service-id
39977           in: query
39978           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
39979           required: false
39980           type: string
39981         - name: regional-resource-zone
39982           in: query
39983           description: Regional way of organizing pservers, source of truth should define values
39984           required: false
39985           type: string
39986         - name: prov-status
39987           in: query
39988           description: Trigger for operational monitoring of this resource by Service Assurance systems.
39989           required: false
39990           type: string
39991         - name: heat-stack-id
39992           in: query
39993           description: Heat stack id corresponding to this instance, managed by MSO
39994           required: false
39995           type: string
39996         - name: in-maint
39997           in: query
39998           required: false
39999           type: boolean
40000         - name: is-closed-loop-disabled
40001           in: query
40002           required: false
40003           type: boolean
40004         - name: model-invariant-id
40005           in: query
40006           description: the ASDC model id for this resource or service model.
40007           required: false
40008           type: string
40009         - name: model-version-id
40010           in: query
40011           description: the ASDC model version for this resource or service model.
40012           required: false
40013           type: string
40014         - name: widget-model-id
40015           in: query
40016           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40017           required: false
40018           type: string
40019         - name: widget-model-version
40020           in: query
40021           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40022           required: false
40023           type: string
40024         - name: nf-type
40025           in: query
40026           description: Generic description of the type of NF
40027           required: false
40028           type: string
40029         - name: nf-function
40030           in: query
40031           description: English description of Network function that the specific VNF deployment is providing
40032           required: false
40033           type: string
40034         - name: nf-role
40035           in: query
40036           description: role in the network that this model will be providing
40037           required: false
40038           type: string
40039         - name: nf-naming-code
40040           in: query
40041           description: string assigned to this model used for naming purposes
40042           required: false
40043           type: string
40044         - name: interface-id
40045           in: query
40046           description: ID of interface
40047           required: false
40048           type: string
40049         - name: interface-role
40050           in: query
40051           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40052           required: false
40053           type: string
40054         - name: interface-id
40055           in: query
40056           description: ID of interface
40057           required: false
40058           type: string
40059         - name: macaddr
40060           in: query
40061           description: MAC address for the interface
40062           required: false
40063           type: string
40064         - name: network-name
40065           in: query
40066           description: Name of the network
40067           required: false
40068           type: string
40069     put:
40070       tags:
40071         - Network
40072       summary: create or update an existing l-interface
40073       description: |
40074         Create or update an existing l-interface.
40075         #
40076         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40077       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40078       consumes:
40079         - application/json
40080         - application/xml
40081       produces:
40082         - application/json
40083         - application/xml
40084       responses:
40085         "default":
40086           description: Response codes found in [response codes](https://wiki.onap.org/).
40087       parameters:
40088         - name: vnf-id
40089           in: path
40090           description: Unique id of VNF.  This is unique across the graph.
40091           required: true
40092           type: string
40093           example: __VNF-ID__
40094         - name: interface-name
40095           in: path
40096           description: Name that identifies the link aggregate interface
40097           required: true
40098           type: string
40099           example: __INTERFACE-NAME__
40100         - name: interface-name
40101           in: path
40102           description: Name given to the interface
40103           required: true
40104           type: string
40105           example: __INTERFACE-NAME__
40106         - name: body
40107           in: body
40108           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
40109           required: true
40110           schema:
40111             $ref: "#/definitions/l-interface"
40112     patch:
40113       tags:
40114         - Network
40115       summary: update an existing l-interface
40116       description: |
40117         Update an existing l-interface
40118         #
40119         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40120         The PUT operation will entirely replace an existing object.
40121         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40122         #
40123         Other differences between PUT and PATCH are:
40124         #
40125         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40126         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40127         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40128       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40129       consumes:
40130         - application/json
40131         - application/xml
40132       produces:
40133         - application/json
40134         - application/xml
40135       responses:
40136         "default":
40137           description: Response codes found in [response codes](https://wiki.onap.org/).
40138       parameters:
40139         - name: vnf-id
40140           in: path
40141           description: Unique id of VNF.  This is unique across the graph.
40142           required: true
40143           type: string
40144           example: __VNF-ID__
40145         - name: interface-name
40146           in: path
40147           description: Name that identifies the link aggregate interface
40148           required: true
40149           type: string
40150           example: __INTERFACE-NAME__
40151         - name: interface-name
40152           in: path
40153           description: Name given to the interface
40154           required: true
40155           type: string
40156           example: __INTERFACE-NAME__
40157         - name: body
40158           in: body
40159           description: l-interface object that needs to be created or updated.
40160           required: true
40161           schema:
40162             $ref: "#/patchDefinitions/l-interface"
40163     delete:
40164       tags:
40165         - Network
40166       summary: delete an existing l-interface
40167       description: delete an existing l-interface
40168       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface
40169       consumes:
40170         - application/json
40171         - application/xml
40172       produces:
40173         - application/json
40174         - application/xml
40175       responses:
40176         "default":
40177           description: Response codes found in [response codes](https://wiki.onap.org/).
40178       parameters:
40179         - name: vnf-id
40180           in: path
40181           description: Unique id of VNF.  This is unique across the graph.
40182           required: true
40183           type: string
40184           example: __VNF-ID__
40185         - name: interface-name
40186           in: path
40187           description: Name that identifies the link aggregate interface
40188           required: true
40189           type: string
40190           example: __INTERFACE-NAME__
40191         - name: interface-name
40192           in: path
40193           description: Name given to the interface
40194           required: true
40195           type: string
40196           example: __INTERFACE-NAME__
40197         - name: resource-version
40198           in: query
40199           description: resource-version for concurrency
40200           required: true
40201           type: string
40202   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
40203     get:
40204       tags:
40205         - Network
40206       summary: returns l-interfaces
40207       description: returns l-interfaces
40208       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfaces
40209       produces:
40210         - application/json
40211         - application/xml
40212       responses:
40213         "200":
40214           description: successful operation
40215           schema:
40216               $ref: "#/getDefinitions/l-interfaces"
40217         "default":
40218           description: Response codes found in [response codes](https://wiki.onap.org/).
40219       parameters:
40220         - name: vnf-id
40221           in: path
40222           description: Unique id of VNF.  This is unique across the graph.
40223           required: true
40224           type: string
40225           example: __VNF-ID__
40226         - name: interface-name
40227           in: path
40228           description: Name that identifies the link aggregate interface
40229           required: true
40230           type: string
40231           example: __INTERFACE-NAME__
40232         - name: vnf-name
40233           in: query
40234           description: Name of VNF.
40235           required: false
40236           type: string
40237         - name: vnf-name2
40238           in: query
40239           description: Alternate name of VNF.
40240           required: false
40241           type: string
40242         - name: vnf-type
40243           in: query
40244           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.
40245           required: false
40246           type: string
40247         - name: service-id
40248           in: query
40249           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40250           required: false
40251           type: string
40252         - name: regional-resource-zone
40253           in: query
40254           description: Regional way of organizing pservers, source of truth should define values
40255           required: false
40256           type: string
40257         - name: prov-status
40258           in: query
40259           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40260           required: false
40261           type: string
40262         - name: heat-stack-id
40263           in: query
40264           description: Heat stack id corresponding to this instance, managed by MSO
40265           required: false
40266           type: string
40267         - name: in-maint
40268           in: query
40269           required: false
40270           type: boolean
40271         - name: is-closed-loop-disabled
40272           in: query
40273           required: false
40274           type: boolean
40275         - name: model-invariant-id
40276           in: query
40277           description: the ASDC model id for this resource or service model.
40278           required: false
40279           type: string
40280         - name: model-version-id
40281           in: query
40282           description: the ASDC model version for this resource or service model.
40283           required: false
40284           type: string
40285         - name: widget-model-id
40286           in: query
40287           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40288           required: false
40289           type: string
40290         - name: widget-model-version
40291           in: query
40292           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40293           required: false
40294           type: string
40295         - name: nf-type
40296           in: query
40297           description: Generic description of the type of NF
40298           required: false
40299           type: string
40300         - name: nf-function
40301           in: query
40302           description: English description of Network function that the specific VNF deployment is providing
40303           required: false
40304           type: string
40305         - name: nf-role
40306           in: query
40307           description: role in the network that this model will be providing
40308           required: false
40309           type: string
40310         - name: nf-naming-code
40311           in: query
40312           description: string assigned to this model used for naming purposes
40313           required: false
40314           type: string
40315         - name: interface-id
40316           in: query
40317           description: ID of interface
40318           required: false
40319           type: string
40320         - name: interface-role
40321           in: query
40322           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40323           required: false
40324           type: string
40325   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}:
40326     get:
40327       tags:
40328         - Network
40329       summary: returns lag-interface
40330       description: returns lag-interface
40331       operationId: getNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40332       produces:
40333         - application/json
40334         - application/xml
40335       responses:
40336         "200":
40337           description: successful operation
40338           schema:
40339               $ref: "#/getDefinitions/lag-interface"
40340         "default":
40341           description: Response codes found in [response codes](https://wiki.onap.org/).
40342       parameters:
40343         - name: vnf-id
40344           in: path
40345           description: Unique id of VNF.  This is unique across the graph.
40346           required: true
40347           type: string
40348           example: __VNF-ID__
40349         - name: interface-name
40350           in: path
40351           description: Name that identifies the link aggregate interface
40352           required: true
40353           type: string
40354           example: __INTERFACE-NAME__
40355         - name: vnf-name
40356           in: query
40357           description: Name of VNF.
40358           required: false
40359           type: string
40360         - name: vnf-name2
40361           in: query
40362           description: Alternate name of VNF.
40363           required: false
40364           type: string
40365         - name: vnf-type
40366           in: query
40367           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.
40368           required: false
40369           type: string
40370         - name: service-id
40371           in: query
40372           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40373           required: false
40374           type: string
40375         - name: regional-resource-zone
40376           in: query
40377           description: Regional way of organizing pservers, source of truth should define values
40378           required: false
40379           type: string
40380         - name: prov-status
40381           in: query
40382           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40383           required: false
40384           type: string
40385         - name: heat-stack-id
40386           in: query
40387           description: Heat stack id corresponding to this instance, managed by MSO
40388           required: false
40389           type: string
40390         - name: in-maint
40391           in: query
40392           required: false
40393           type: boolean
40394         - name: is-closed-loop-disabled
40395           in: query
40396           required: false
40397           type: boolean
40398         - name: model-invariant-id
40399           in: query
40400           description: the ASDC model id for this resource or service model.
40401           required: false
40402           type: string
40403         - name: model-version-id
40404           in: query
40405           description: the ASDC model version for this resource or service model.
40406           required: false
40407           type: string
40408         - name: widget-model-id
40409           in: query
40410           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40411           required: false
40412           type: string
40413         - name: widget-model-version
40414           in: query
40415           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40416           required: false
40417           type: string
40418         - name: nf-type
40419           in: query
40420           description: Generic description of the type of NF
40421           required: false
40422           type: string
40423         - name: nf-function
40424           in: query
40425           description: English description of Network function that the specific VNF deployment is providing
40426           required: false
40427           type: string
40428         - name: nf-role
40429           in: query
40430           description: role in the network that this model will be providing
40431           required: false
40432           type: string
40433         - name: nf-naming-code
40434           in: query
40435           description: string assigned to this model used for naming purposes
40436           required: false
40437           type: string
40438         - name: interface-id
40439           in: query
40440           description: ID of interface
40441           required: false
40442           type: string
40443         - name: interface-role
40444           in: query
40445           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
40446           required: false
40447           type: string
40448     put:
40449       tags:
40450         - Network
40451       summary: create or update an existing lag-interface
40452       description: |
40453         Create or update an existing lag-interface.
40454         #
40455         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40456       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40457       consumes:
40458         - application/json
40459         - application/xml
40460       produces:
40461         - application/json
40462         - application/xml
40463       responses:
40464         "default":
40465           description: Response codes found in [response codes](https://wiki.onap.org/).
40466       parameters:
40467         - name: vnf-id
40468           in: path
40469           description: Unique id of VNF.  This is unique across the graph.
40470           required: true
40471           type: string
40472           example: __VNF-ID__
40473         - name: interface-name
40474           in: path
40475           description: Name that identifies the link aggregate interface
40476           required: true
40477           type: string
40478           example: __INTERFACE-NAME__
40479         - name: body
40480           in: body
40481           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)
40482           required: true
40483           schema:
40484             $ref: "#/definitions/lag-interface"
40485     patch:
40486       tags:
40487         - Network
40488       summary: update an existing lag-interface
40489       description: |
40490         Update an existing lag-interface
40491         #
40492         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40493         The PUT operation will entirely replace an existing object.
40494         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40495         #
40496         Other differences between PUT and PATCH are:
40497         #
40498         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40499         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40500         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40501       operationId: UpdateNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40502       consumes:
40503         - application/json
40504         - application/xml
40505       produces:
40506         - application/json
40507         - application/xml
40508       responses:
40509         "default":
40510           description: Response codes found in [response codes](https://wiki.onap.org/).
40511       parameters:
40512         - name: vnf-id
40513           in: path
40514           description: Unique id of VNF.  This is unique across the graph.
40515           required: true
40516           type: string
40517           example: __VNF-ID__
40518         - name: interface-name
40519           in: path
40520           description: Name that identifies the link aggregate interface
40521           required: true
40522           type: string
40523           example: __INTERFACE-NAME__
40524         - name: body
40525           in: body
40526           description: lag-interface object that needs to be created or updated.
40527           required: true
40528           schema:
40529             $ref: "#/patchDefinitions/lag-interface"
40530     delete:
40531       tags:
40532         - Network
40533       summary: delete an existing lag-interface
40534       description: delete an existing lag-interface
40535       operationId: deleteNetworkGenericVnfsGenericVnfLagInterfacesLagInterface
40536       consumes:
40537         - application/json
40538         - application/xml
40539       produces:
40540         - application/json
40541         - application/xml
40542       responses:
40543         "default":
40544           description: Response codes found in [response codes](https://wiki.onap.org/).
40545       parameters:
40546         - name: vnf-id
40547           in: path
40548           description: Unique id of VNF.  This is unique across the graph.
40549           required: true
40550           type: string
40551           example: __VNF-ID__
40552         - name: interface-name
40553           in: path
40554           description: Name that identifies the link aggregate interface
40555           required: true
40556           type: string
40557           example: __INTERFACE-NAME__
40558         - name: resource-version
40559           in: query
40560           description: resource-version for concurrency
40561           required: true
40562           type: string
40563   /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces:
40564     get:
40565       tags:
40566         - Network
40567       summary: returns lag-interfaces
40568       description: returns lag-interfaces
40569       operationId: getNetworkGenericVnfsGenericVnfLagInterfaces
40570       produces:
40571         - application/json
40572         - application/xml
40573       responses:
40574         "200":
40575           description: successful operation
40576           schema:
40577               $ref: "#/getDefinitions/lag-interfaces"
40578         "default":
40579           description: Response codes found in [response codes](https://wiki.onap.org/).
40580       parameters:
40581         - name: vnf-id
40582           in: path
40583           description: Unique id of VNF.  This is unique across the graph.
40584           required: true
40585           type: string
40586           example: __VNF-ID__
40587         - name: vnf-name
40588           in: query
40589           description: Name of VNF.
40590           required: false
40591           type: string
40592         - name: vnf-name2
40593           in: query
40594           description: Alternate name of VNF.
40595           required: false
40596           type: string
40597         - name: vnf-type
40598           in: query
40599           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.
40600           required: false
40601           type: string
40602         - name: service-id
40603           in: query
40604           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40605           required: false
40606           type: string
40607         - name: regional-resource-zone
40608           in: query
40609           description: Regional way of organizing pservers, source of truth should define values
40610           required: false
40611           type: string
40612         - name: prov-status
40613           in: query
40614           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40615           required: false
40616           type: string
40617         - name: heat-stack-id
40618           in: query
40619           description: Heat stack id corresponding to this instance, managed by MSO
40620           required: false
40621           type: string
40622         - name: in-maint
40623           in: query
40624           required: false
40625           type: boolean
40626         - name: is-closed-loop-disabled
40627           in: query
40628           required: false
40629           type: boolean
40630         - name: model-invariant-id
40631           in: query
40632           description: the ASDC model id for this resource or service model.
40633           required: false
40634           type: string
40635         - name: model-version-id
40636           in: query
40637           description: the ASDC model version for this resource or service model.
40638           required: false
40639           type: string
40640         - name: widget-model-id
40641           in: query
40642           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40643           required: false
40644           type: string
40645         - name: widget-model-version
40646           in: query
40647           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40648           required: false
40649           type: string
40650         - name: nf-type
40651           in: query
40652           description: Generic description of the type of NF
40653           required: false
40654           type: string
40655         - name: nf-function
40656           in: query
40657           description: English description of Network function that the specific VNF deployment is providing
40658           required: false
40659           type: string
40660         - name: nf-role
40661           in: query
40662           description: role in the network that this model will be providing
40663           required: false
40664           type: string
40665         - name: nf-naming-code
40666           in: query
40667           description: string assigned to this model used for naming purposes
40668           required: false
40669           type: string
40670   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship:
40671     put:
40672       tags:
40673         - Network
40674       summary: see node definition for valid relationships
40675       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
40676       consumes:
40677         - application/json
40678         - application/xml
40679       produces:
40680         - application/json
40681         - application/xml
40682       responses:
40683         "default":
40684           description: Response codes found in [response codes](https://wiki.onap.org/).
40685       parameters:
40686         - name: vnf-id
40687           in: path
40688           description: Unique id of VNF.  This is unique across the graph.
40689           required: true
40690           type: string
40691           example: __VNF-ID__
40692         - name: vf-module-id
40693           in: path
40694           description: Unique ID of vf-module.
40695           required: true
40696           type: string
40697           example: __VF-MODULE-ID__
40698         - name: body
40699           in: body
40700           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
40701           required: true
40702           schema:
40703             $ref: "#/definitions/relationship"
40704     delete:
40705       tags:
40706         - Network
40707       summary: delete an existing relationship
40708       description: delete an existing relationship
40709       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModuleRelationshipListRelationship
40710       consumes:
40711         - application/json
40712         - application/xml
40713       produces:
40714         - application/json
40715         - application/xml
40716       responses:
40717         "default":
40718           description: Response codes found in [response codes](https://wiki.onap.org/).
40719       parameters:
40720         - name: vnf-id
40721           in: path
40722           description: Unique id of VNF.  This is unique across the graph.
40723           required: true
40724           type: string
40725           example: __VNF-ID__
40726         - name: vf-module-id
40727           in: path
40728           description: Unique ID of vf-module.
40729           required: true
40730           type: string
40731           example: __VF-MODULE-ID__
40732   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}:
40733     get:
40734       tags:
40735         - Network
40736       summary: returns vf-module
40737       description: returns vf-module
40738       operationId: getNetworkGenericVnfsGenericVnfVfModulesVfModule
40739       produces:
40740         - application/json
40741         - application/xml
40742       responses:
40743         "200":
40744           description: successful operation
40745           schema:
40746               $ref: "#/getDefinitions/vf-module"
40747         "default":
40748           description: Response codes found in [response codes](https://wiki.onap.org/).
40749       parameters:
40750         - name: vnf-id
40751           in: path
40752           description: Unique id of VNF.  This is unique across the graph.
40753           required: true
40754           type: string
40755           example: __VNF-ID__
40756         - name: vf-module-id
40757           in: path
40758           description: Unique ID of vf-module.
40759           required: true
40760           type: string
40761           example: __VF-MODULE-ID__
40762         - name: vnf-name
40763           in: query
40764           description: Name of VNF.
40765           required: false
40766           type: string
40767         - name: vnf-name2
40768           in: query
40769           description: Alternate name of VNF.
40770           required: false
40771           type: string
40772         - name: vnf-type
40773           in: query
40774           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.
40775           required: false
40776           type: string
40777         - name: service-id
40778           in: query
40779           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
40780           required: false
40781           type: string
40782         - name: regional-resource-zone
40783           in: query
40784           description: Regional way of organizing pservers, source of truth should define values
40785           required: false
40786           type: string
40787         - name: prov-status
40788           in: query
40789           description: Trigger for operational monitoring of this resource by Service Assurance systems.
40790           required: false
40791           type: string
40792         - name: heat-stack-id
40793           in: query
40794           description: Heat stack id corresponding to this instance, managed by MSO
40795           required: false
40796           type: string
40797         - name: in-maint
40798           in: query
40799           required: false
40800           type: boolean
40801         - name: is-closed-loop-disabled
40802           in: query
40803           required: false
40804           type: boolean
40805         - name: model-invariant-id
40806           in: query
40807           description: the ASDC model id for this resource or service model.
40808           required: false
40809           type: string
40810         - name: model-version-id
40811           in: query
40812           description: the ASDC model version for this resource or service model.
40813           required: false
40814           type: string
40815         - name: widget-model-id
40816           in: query
40817           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40818           required: false
40819           type: string
40820         - name: widget-model-version
40821           in: query
40822           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40823           required: false
40824           type: string
40825         - name: nf-type
40826           in: query
40827           description: Generic description of the type of NF
40828           required: false
40829           type: string
40830         - name: nf-function
40831           in: query
40832           description: English description of Network function that the specific VNF deployment is providing
40833           required: false
40834           type: string
40835         - name: nf-role
40836           in: query
40837           description: role in the network that this model will be providing
40838           required: false
40839           type: string
40840         - name: nf-naming-code
40841           in: query
40842           description: string assigned to this model used for naming purposes
40843           required: false
40844           type: string
40845         - name: vf-module-name
40846           in: query
40847           description: Name of vf-module
40848           required: false
40849           type: string
40850         - name: heat-stack-id
40851           in: query
40852           description: Heat stack id corresponding to this instance.
40853           required: false
40854           type: string
40855         - name: model-invariant-id
40856           in: query
40857           description: the ASDC model id for this resource or service model.
40858           required: false
40859           type: string
40860         - name: model-version-id
40861           in: query
40862           description: the ASDC model version for this resource or service model.
40863           required: false
40864           type: string
40865         - name: widget-model-id
40866           in: query
40867           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
40868           required: false
40869           type: string
40870         - name: widget-model-version
40871           in: query
40872           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
40873           required: false
40874           type: string
40875         - name: contrail-service-instance-fqdn
40876           in: query
40877           description: the Contrail unique ID for a service-instance
40878           required: false
40879           type: string
40880     put:
40881       tags:
40882         - Network
40883       summary: create or update an existing vf-module
40884       description: |
40885         Create or update an existing vf-module.
40886         #
40887         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
40888       operationId: createOrUpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
40889       consumes:
40890         - application/json
40891         - application/xml
40892       produces:
40893         - application/json
40894         - application/xml
40895       responses:
40896         "default":
40897           description: Response codes found in [response codes](https://wiki.onap.org/).
40898       parameters:
40899         - name: vnf-id
40900           in: path
40901           description: Unique id of VNF.  This is unique across the graph.
40902           required: true
40903           type: string
40904           example: __VNF-ID__
40905         - name: vf-module-id
40906           in: path
40907           description: Unique ID of vf-module.
40908           required: true
40909           type: string
40910           example: __VF-MODULE-ID__
40911         - name: body
40912           in: body
40913           description: vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)
40914           required: true
40915           schema:
40916             $ref: "#/definitions/vf-module"
40917     patch:
40918       tags:
40919         - Network
40920       summary: update an existing vf-module
40921       description: |
40922         Update an existing vf-module
40923         #
40924         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
40925         The PUT operation will entirely replace an existing object.
40926         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
40927         #
40928         Other differences between PUT and PATCH are:
40929         #
40930         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
40931         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
40932         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
40933       operationId: UpdateNetworkGenericVnfsGenericVnfVfModulesVfModule
40934       consumes:
40935         - application/json
40936         - application/xml
40937       produces:
40938         - application/json
40939         - application/xml
40940       responses:
40941         "default":
40942           description: Response codes found in [response codes](https://wiki.onap.org/).
40943       parameters:
40944         - name: vnf-id
40945           in: path
40946           description: Unique id of VNF.  This is unique across the graph.
40947           required: true
40948           type: string
40949           example: __VNF-ID__
40950         - name: vf-module-id
40951           in: path
40952           description: Unique ID of vf-module.
40953           required: true
40954           type: string
40955           example: __VF-MODULE-ID__
40956         - name: body
40957           in: body
40958           description: vf-module object that needs to be created or updated.
40959           required: true
40960           schema:
40961             $ref: "#/patchDefinitions/vf-module"
40962     delete:
40963       tags:
40964         - Network
40965       summary: delete an existing vf-module
40966       description: delete an existing vf-module
40967       operationId: deleteNetworkGenericVnfsGenericVnfVfModulesVfModule
40968       consumes:
40969         - application/json
40970         - application/xml
40971       produces:
40972         - application/json
40973         - application/xml
40974       responses:
40975         "default":
40976           description: Response codes found in [response codes](https://wiki.onap.org/).
40977       parameters:
40978         - name: vnf-id
40979           in: path
40980           description: Unique id of VNF.  This is unique across the graph.
40981           required: true
40982           type: string
40983           example: __VNF-ID__
40984         - name: vf-module-id
40985           in: path
40986           description: Unique ID of vf-module.
40987           required: true
40988           type: string
40989           example: __VF-MODULE-ID__
40990         - name: resource-version
40991           in: query
40992           description: resource-version for concurrency
40993           required: true
40994           type: string
40995   /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules:
40996     get:
40997       tags:
40998         - Network
40999       summary: returns vf-modules
41000       description: returns vf-modules
41001       operationId: getNetworkGenericVnfsGenericVnfVfModules
41002       produces:
41003         - application/json
41004         - application/xml
41005       responses:
41006         "200":
41007           description: successful operation
41008           schema:
41009               $ref: "#/getDefinitions/vf-modules"
41010         "default":
41011           description: Response codes found in [response codes](https://wiki.onap.org/).
41012       parameters:
41013         - name: vnf-id
41014           in: path
41015           description: Unique id of VNF.  This is unique across the graph.
41016           required: true
41017           type: string
41018           example: __VNF-ID__
41019         - name: vnf-name
41020           in: query
41021           description: Name of VNF.
41022           required: false
41023           type: string
41024         - name: vnf-name2
41025           in: query
41026           description: Alternate name of VNF.
41027           required: false
41028           type: string
41029         - name: vnf-type
41030           in: query
41031           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.
41032           required: false
41033           type: string
41034         - name: service-id
41035           in: query
41036           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41037           required: false
41038           type: string
41039         - name: regional-resource-zone
41040           in: query
41041           description: Regional way of organizing pservers, source of truth should define values
41042           required: false
41043           type: string
41044         - name: prov-status
41045           in: query
41046           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41047           required: false
41048           type: string
41049         - name: heat-stack-id
41050           in: query
41051           description: Heat stack id corresponding to this instance, managed by MSO
41052           required: false
41053           type: string
41054         - name: in-maint
41055           in: query
41056           required: false
41057           type: boolean
41058         - name: is-closed-loop-disabled
41059           in: query
41060           required: false
41061           type: boolean
41062         - name: model-invariant-id
41063           in: query
41064           description: the ASDC model id for this resource or service model.
41065           required: false
41066           type: string
41067         - name: model-version-id
41068           in: query
41069           description: the ASDC model version for this resource or service model.
41070           required: false
41071           type: string
41072         - name: widget-model-id
41073           in: query
41074           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41075           required: false
41076           type: string
41077         - name: widget-model-version
41078           in: query
41079           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41080           required: false
41081           type: string
41082         - name: nf-type
41083           in: query
41084           description: Generic description of the type of NF
41085           required: false
41086           type: string
41087         - name: nf-function
41088           in: query
41089           description: English description of Network function that the specific VNF deployment is providing
41090           required: false
41091           type: string
41092         - name: nf-role
41093           in: query
41094           description: role in the network that this model will be providing
41095           required: false
41096           type: string
41097         - name: nf-naming-code
41098           in: query
41099           description: string assigned to this model used for naming purposes
41100           required: false
41101           type: string
41102   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41103     put:
41104       tags:
41105         - Network
41106       summary: see node definition for valid relationships
41107       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41108       consumes:
41109         - application/json
41110         - application/xml
41111       produces:
41112         - application/json
41113         - application/xml
41114       responses:
41115         "default":
41116           description: Response codes found in [response codes](https://wiki.onap.org/).
41117       parameters:
41118         - name: vnf-id
41119           in: path
41120           description: Unique id of VNF.  This is unique across the graph.
41121           required: true
41122           type: string
41123           example: __VNF-ID__
41124         - name: group-uuid
41125           in: path
41126           description: Unique ID for the license group the resource belongs to, should be uuid.
41127           required: true
41128           type: string
41129           example: __GROUP-UUID__
41130         - name: resource-uuid
41131           in: path
41132           description: Unique ID of a license resource.
41133           required: true
41134           type: string
41135           example: __RESOURCE-UUID__
41136         - name: body
41137           in: body
41138           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
41139           required: true
41140           schema:
41141             $ref: "#/definitions/relationship"
41142     delete:
41143       tags:
41144         - Network
41145       summary: delete an existing relationship
41146       description: delete an existing relationship
41147       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicenseRelationshipListRelationship
41148       consumes:
41149         - application/json
41150         - application/xml
41151       produces:
41152         - application/json
41153         - application/xml
41154       responses:
41155         "default":
41156           description: Response codes found in [response codes](https://wiki.onap.org/).
41157       parameters:
41158         - name: vnf-id
41159           in: path
41160           description: Unique id of VNF.  This is unique across the graph.
41161           required: true
41162           type: string
41163           example: __VNF-ID__
41164         - name: group-uuid
41165           in: path
41166           description: Unique ID for the license group the resource belongs to, should be uuid.
41167           required: true
41168           type: string
41169           example: __GROUP-UUID__
41170         - name: resource-uuid
41171           in: path
41172           description: Unique ID of a license resource.
41173           required: true
41174           type: string
41175           example: __RESOURCE-UUID__
41176   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}:
41177     get:
41178       tags:
41179         - Network
41180       summary: returns license
41181       description: returns license
41182       operationId: getNetworkGenericVnfsGenericVnfLicensesLicense
41183       produces:
41184         - application/json
41185         - application/xml
41186       responses:
41187         "200":
41188           description: successful operation
41189           schema:
41190               $ref: "#/getDefinitions/license"
41191         "default":
41192           description: Response codes found in [response codes](https://wiki.onap.org/).
41193       parameters:
41194         - name: vnf-id
41195           in: path
41196           description: Unique id of VNF.  This is unique across the graph.
41197           required: true
41198           type: string
41199           example: __VNF-ID__
41200         - name: group-uuid
41201           in: path
41202           description: Unique ID for the license group the resource belongs to, should be uuid.
41203           required: true
41204           type: string
41205           example: __GROUP-UUID__
41206         - name: resource-uuid
41207           in: path
41208           description: Unique ID of a license resource.
41209           required: true
41210           type: string
41211           example: __RESOURCE-UUID__
41212         - name: vnf-name
41213           in: query
41214           description: Name of VNF.
41215           required: false
41216           type: string
41217         - name: vnf-name2
41218           in: query
41219           description: Alternate name of VNF.
41220           required: false
41221           type: string
41222         - name: vnf-type
41223           in: query
41224           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.
41225           required: false
41226           type: string
41227         - name: service-id
41228           in: query
41229           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41230           required: false
41231           type: string
41232         - name: regional-resource-zone
41233           in: query
41234           description: Regional way of organizing pservers, source of truth should define values
41235           required: false
41236           type: string
41237         - name: prov-status
41238           in: query
41239           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41240           required: false
41241           type: string
41242         - name: heat-stack-id
41243           in: query
41244           description: Heat stack id corresponding to this instance, managed by MSO
41245           required: false
41246           type: string
41247         - name: in-maint
41248           in: query
41249           required: false
41250           type: boolean
41251         - name: is-closed-loop-disabled
41252           in: query
41253           required: false
41254           type: boolean
41255         - name: model-invariant-id
41256           in: query
41257           description: the ASDC model id for this resource or service model.
41258           required: false
41259           type: string
41260         - name: model-version-id
41261           in: query
41262           description: the ASDC model version for this resource or service model.
41263           required: false
41264           type: string
41265         - name: widget-model-id
41266           in: query
41267           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41268           required: false
41269           type: string
41270         - name: widget-model-version
41271           in: query
41272           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41273           required: false
41274           type: string
41275         - name: nf-type
41276           in: query
41277           description: Generic description of the type of NF
41278           required: false
41279           type: string
41280         - name: nf-function
41281           in: query
41282           description: English description of Network function that the specific VNF deployment is providing
41283           required: false
41284           type: string
41285         - name: nf-role
41286           in: query
41287           description: role in the network that this model will be providing
41288           required: false
41289           type: string
41290         - name: nf-naming-code
41291           in: query
41292           description: string assigned to this model used for naming purposes
41293           required: false
41294           type: string
41295     put:
41296       tags:
41297         - Network
41298       summary: create or update an existing license
41299       description: |
41300         Create or update an existing license.
41301         #
41302         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41303       operationId: createOrUpdateNetworkGenericVnfsGenericVnfLicensesLicense
41304       consumes:
41305         - application/json
41306         - application/xml
41307       produces:
41308         - application/json
41309         - application/xml
41310       responses:
41311         "default":
41312           description: Response codes found in [response codes](https://wiki.onap.org/).
41313       parameters:
41314         - name: vnf-id
41315           in: path
41316           description: Unique id of VNF.  This is unique across the graph.
41317           required: true
41318           type: string
41319           example: __VNF-ID__
41320         - name: group-uuid
41321           in: path
41322           description: Unique ID for the license group the resource belongs to, should be uuid.
41323           required: true
41324           type: string
41325           example: __GROUP-UUID__
41326         - name: resource-uuid
41327           in: path
41328           description: Unique ID of a license resource.
41329           required: true
41330           type: string
41331           example: __RESOURCE-UUID__
41332         - name: body
41333           in: body
41334           description: license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)
41335           required: true
41336           schema:
41337             $ref: "#/definitions/license"
41338     patch:
41339       tags:
41340         - Network
41341       summary: update an existing license
41342       description: |
41343         Update an existing license
41344         #
41345         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41346         The PUT operation will entirely replace an existing object.
41347         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41348         #
41349         Other differences between PUT and PATCH are:
41350         #
41351         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41352         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41353         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41354       operationId: UpdateNetworkGenericVnfsGenericVnfLicensesLicense
41355       consumes:
41356         - application/json
41357         - application/xml
41358       produces:
41359         - application/json
41360         - application/xml
41361       responses:
41362         "default":
41363           description: Response codes found in [response codes](https://wiki.onap.org/).
41364       parameters:
41365         - name: vnf-id
41366           in: path
41367           description: Unique id of VNF.  This is unique across the graph.
41368           required: true
41369           type: string
41370           example: __VNF-ID__
41371         - name: group-uuid
41372           in: path
41373           description: Unique ID for the license group the resource belongs to, should be uuid.
41374           required: true
41375           type: string
41376           example: __GROUP-UUID__
41377         - name: resource-uuid
41378           in: path
41379           description: Unique ID of a license resource.
41380           required: true
41381           type: string
41382           example: __RESOURCE-UUID__
41383         - name: body
41384           in: body
41385           description: license object that needs to be created or updated.
41386           required: true
41387           schema:
41388             $ref: "#/patchDefinitions/license"
41389     delete:
41390       tags:
41391         - Network
41392       summary: delete an existing license
41393       description: delete an existing license
41394       operationId: deleteNetworkGenericVnfsGenericVnfLicensesLicense
41395       consumes:
41396         - application/json
41397         - application/xml
41398       produces:
41399         - application/json
41400         - application/xml
41401       responses:
41402         "default":
41403           description: Response codes found in [response codes](https://wiki.onap.org/).
41404       parameters:
41405         - name: vnf-id
41406           in: path
41407           description: Unique id of VNF.  This is unique across the graph.
41408           required: true
41409           type: string
41410           example: __VNF-ID__
41411         - name: group-uuid
41412           in: path
41413           description: Unique ID for the license group the resource belongs to, should be uuid.
41414           required: true
41415           type: string
41416           example: __GROUP-UUID__
41417         - name: resource-uuid
41418           in: path
41419           description: Unique ID of a license resource.
41420           required: true
41421           type: string
41422           example: __RESOURCE-UUID__
41423         - name: resource-version
41424           in: query
41425           description: resource-version for concurrency
41426           required: true
41427           type: string
41428   /network/generic-vnfs/generic-vnf/{vnf-id}/licenses:
41429     get:
41430       tags:
41431         - Network
41432       summary: returns licenses
41433       description: returns licenses
41434       operationId: getNetworkGenericVnfsGenericVnfLicenses
41435       produces:
41436         - application/json
41437         - application/xml
41438       responses:
41439         "200":
41440           description: successful operation
41441           schema:
41442               $ref: "#/getDefinitions/licenses"
41443         "default":
41444           description: Response codes found in [response codes](https://wiki.onap.org/).
41445       parameters:
41446         - name: vnf-id
41447           in: path
41448           description: Unique id of VNF.  This is unique across the graph.
41449           required: true
41450           type: string
41451           example: __VNF-ID__
41452         - name: vnf-name
41453           in: query
41454           description: Name of VNF.
41455           required: false
41456           type: string
41457         - name: vnf-name2
41458           in: query
41459           description: Alternate name of VNF.
41460           required: false
41461           type: string
41462         - name: vnf-type
41463           in: query
41464           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.
41465           required: false
41466           type: string
41467         - name: service-id
41468           in: query
41469           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41470           required: false
41471           type: string
41472         - name: regional-resource-zone
41473           in: query
41474           description: Regional way of organizing pservers, source of truth should define values
41475           required: false
41476           type: string
41477         - name: prov-status
41478           in: query
41479           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41480           required: false
41481           type: string
41482         - name: heat-stack-id
41483           in: query
41484           description: Heat stack id corresponding to this instance, managed by MSO
41485           required: false
41486           type: string
41487         - name: in-maint
41488           in: query
41489           required: false
41490           type: boolean
41491         - name: is-closed-loop-disabled
41492           in: query
41493           required: false
41494           type: boolean
41495         - name: model-invariant-id
41496           in: query
41497           description: the ASDC model id for this resource or service model.
41498           required: false
41499           type: string
41500         - name: model-version-id
41501           in: query
41502           description: the ASDC model version for this resource or service model.
41503           required: false
41504           type: string
41505         - name: widget-model-id
41506           in: query
41507           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41508           required: false
41509           type: string
41510         - name: widget-model-version
41511           in: query
41512           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41513           required: false
41514           type: string
41515         - name: nf-type
41516           in: query
41517           description: Generic description of the type of NF
41518           required: false
41519           type: string
41520         - name: nf-function
41521           in: query
41522           description: English description of Network function that the specific VNF deployment is providing
41523           required: false
41524           type: string
41525         - name: nf-role
41526           in: query
41527           description: role in the network that this model will be providing
41528           required: false
41529           type: string
41530         - name: nf-naming-code
41531           in: query
41532           description: string assigned to this model used for naming purposes
41533           required: false
41534           type: string
41535   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship:
41536     put:
41537       tags:
41538         - Network
41539       summary: see node definition for valid relationships
41540       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
41541       consumes:
41542         - application/json
41543         - application/xml
41544       produces:
41545         - application/json
41546         - application/xml
41547       responses:
41548         "default":
41549           description: Response codes found in [response codes](https://wiki.onap.org/).
41550       parameters:
41551         - name: vnf-id
41552           in: path
41553           description: Unique id of VNF.  This is unique across the graph.
41554           required: true
41555           type: string
41556           example: __VNF-ID__
41557         - name: group-uuid
41558           in: path
41559           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41560           required: true
41561           type: string
41562           example: __GROUP-UUID__
41563         - name: resource-uuid
41564           in: path
41565           description: Unique ID of an entitlement resource.
41566           required: true
41567           type: string
41568           example: __RESOURCE-UUID__
41569         - name: body
41570           in: body
41571           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
41572           required: true
41573           schema:
41574             $ref: "#/definitions/relationship"
41575     delete:
41576       tags:
41577         - Network
41578       summary: delete an existing relationship
41579       description: delete an existing relationship
41580       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlementRelationshipListRelationship
41581       consumes:
41582         - application/json
41583         - application/xml
41584       produces:
41585         - application/json
41586         - application/xml
41587       responses:
41588         "default":
41589           description: Response codes found in [response codes](https://wiki.onap.org/).
41590       parameters:
41591         - name: vnf-id
41592           in: path
41593           description: Unique id of VNF.  This is unique across the graph.
41594           required: true
41595           type: string
41596           example: __VNF-ID__
41597         - name: group-uuid
41598           in: path
41599           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41600           required: true
41601           type: string
41602           example: __GROUP-UUID__
41603         - name: resource-uuid
41604           in: path
41605           description: Unique ID of an entitlement resource.
41606           required: true
41607           type: string
41608           example: __RESOURCE-UUID__
41609   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}:
41610     get:
41611       tags:
41612         - Network
41613       summary: returns entitlement
41614       description: returns entitlement
41615       operationId: getNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41616       produces:
41617         - application/json
41618         - application/xml
41619       responses:
41620         "200":
41621           description: successful operation
41622           schema:
41623               $ref: "#/getDefinitions/entitlement"
41624         "default":
41625           description: Response codes found in [response codes](https://wiki.onap.org/).
41626       parameters:
41627         - name: vnf-id
41628           in: path
41629           description: Unique id of VNF.  This is unique across the graph.
41630           required: true
41631           type: string
41632           example: __VNF-ID__
41633         - name: group-uuid
41634           in: path
41635           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41636           required: true
41637           type: string
41638           example: __GROUP-UUID__
41639         - name: resource-uuid
41640           in: path
41641           description: Unique ID of an entitlement resource.
41642           required: true
41643           type: string
41644           example: __RESOURCE-UUID__
41645         - name: vnf-name
41646           in: query
41647           description: Name of VNF.
41648           required: false
41649           type: string
41650         - name: vnf-name2
41651           in: query
41652           description: Alternate name of VNF.
41653           required: false
41654           type: string
41655         - name: vnf-type
41656           in: query
41657           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.
41658           required: false
41659           type: string
41660         - name: service-id
41661           in: query
41662           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41663           required: false
41664           type: string
41665         - name: regional-resource-zone
41666           in: query
41667           description: Regional way of organizing pservers, source of truth should define values
41668           required: false
41669           type: string
41670         - name: prov-status
41671           in: query
41672           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41673           required: false
41674           type: string
41675         - name: heat-stack-id
41676           in: query
41677           description: Heat stack id corresponding to this instance, managed by MSO
41678           required: false
41679           type: string
41680         - name: in-maint
41681           in: query
41682           required: false
41683           type: boolean
41684         - name: is-closed-loop-disabled
41685           in: query
41686           required: false
41687           type: boolean
41688         - name: model-invariant-id
41689           in: query
41690           description: the ASDC model id for this resource or service model.
41691           required: false
41692           type: string
41693         - name: model-version-id
41694           in: query
41695           description: the ASDC model version for this resource or service model.
41696           required: false
41697           type: string
41698         - name: widget-model-id
41699           in: query
41700           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41701           required: false
41702           type: string
41703         - name: widget-model-version
41704           in: query
41705           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41706           required: false
41707           type: string
41708         - name: nf-type
41709           in: query
41710           description: Generic description of the type of NF
41711           required: false
41712           type: string
41713         - name: nf-function
41714           in: query
41715           description: English description of Network function that the specific VNF deployment is providing
41716           required: false
41717           type: string
41718         - name: nf-role
41719           in: query
41720           description: role in the network that this model will be providing
41721           required: false
41722           type: string
41723         - name: nf-naming-code
41724           in: query
41725           description: string assigned to this model used for naming purposes
41726           required: false
41727           type: string
41728     put:
41729       tags:
41730         - Network
41731       summary: create or update an existing entitlement
41732       description: |
41733         Create or update an existing entitlement.
41734         #
41735         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
41736       operationId: createOrUpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41737       consumes:
41738         - application/json
41739         - application/xml
41740       produces:
41741         - application/json
41742         - application/xml
41743       responses:
41744         "default":
41745           description: Response codes found in [response codes](https://wiki.onap.org/).
41746       parameters:
41747         - name: vnf-id
41748           in: path
41749           description: Unique id of VNF.  This is unique across the graph.
41750           required: true
41751           type: string
41752           example: __VNF-ID__
41753         - name: group-uuid
41754           in: path
41755           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41756           required: true
41757           type: string
41758           example: __GROUP-UUID__
41759         - name: resource-uuid
41760           in: path
41761           description: Unique ID of an entitlement resource.
41762           required: true
41763           type: string
41764           example: __RESOURCE-UUID__
41765         - name: body
41766           in: body
41767           description: entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)
41768           required: true
41769           schema:
41770             $ref: "#/definitions/entitlement"
41771     patch:
41772       tags:
41773         - Network
41774       summary: update an existing entitlement
41775       description: |
41776         Update an existing entitlement
41777         #
41778         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
41779         The PUT operation will entirely replace an existing object.
41780         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
41781         #
41782         Other differences between PUT and PATCH are:
41783         #
41784         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
41785         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
41786         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
41787       operationId: UpdateNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41788       consumes:
41789         - application/json
41790         - application/xml
41791       produces:
41792         - application/json
41793         - application/xml
41794       responses:
41795         "default":
41796           description: Response codes found in [response codes](https://wiki.onap.org/).
41797       parameters:
41798         - name: vnf-id
41799           in: path
41800           description: Unique id of VNF.  This is unique across the graph.
41801           required: true
41802           type: string
41803           example: __VNF-ID__
41804         - name: group-uuid
41805           in: path
41806           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41807           required: true
41808           type: string
41809           example: __GROUP-UUID__
41810         - name: resource-uuid
41811           in: path
41812           description: Unique ID of an entitlement resource.
41813           required: true
41814           type: string
41815           example: __RESOURCE-UUID__
41816         - name: body
41817           in: body
41818           description: entitlement object that needs to be created or updated.
41819           required: true
41820           schema:
41821             $ref: "#/patchDefinitions/entitlement"
41822     delete:
41823       tags:
41824         - Network
41825       summary: delete an existing entitlement
41826       description: delete an existing entitlement
41827       operationId: deleteNetworkGenericVnfsGenericVnfEntitlementsEntitlement
41828       consumes:
41829         - application/json
41830         - application/xml
41831       produces:
41832         - application/json
41833         - application/xml
41834       responses:
41835         "default":
41836           description: Response codes found in [response codes](https://wiki.onap.org/).
41837       parameters:
41838         - name: vnf-id
41839           in: path
41840           description: Unique id of VNF.  This is unique across the graph.
41841           required: true
41842           type: string
41843           example: __VNF-ID__
41844         - name: group-uuid
41845           in: path
41846           description: Unique ID for the entitlement group the resource comes from, should be uuid.
41847           required: true
41848           type: string
41849           example: __GROUP-UUID__
41850         - name: resource-uuid
41851           in: path
41852           description: Unique ID of an entitlement resource.
41853           required: true
41854           type: string
41855           example: __RESOURCE-UUID__
41856         - name: resource-version
41857           in: query
41858           description: resource-version for concurrency
41859           required: true
41860           type: string
41861   /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements:
41862     get:
41863       tags:
41864         - Network
41865       summary: returns entitlements
41866       description: returns entitlements
41867       operationId: getNetworkGenericVnfsGenericVnfEntitlements
41868       produces:
41869         - application/json
41870         - application/xml
41871       responses:
41872         "200":
41873           description: successful operation
41874           schema:
41875               $ref: "#/getDefinitions/entitlements"
41876         "default":
41877           description: Response codes found in [response codes](https://wiki.onap.org/).
41878       parameters:
41879         - name: vnf-id
41880           in: path
41881           description: Unique id of VNF.  This is unique across the graph.
41882           required: true
41883           type: string
41884           example: __VNF-ID__
41885         - name: vnf-name
41886           in: query
41887           description: Name of VNF.
41888           required: false
41889           type: string
41890         - name: vnf-name2
41891           in: query
41892           description: Alternate name of VNF.
41893           required: false
41894           type: string
41895         - name: vnf-type
41896           in: query
41897           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.
41898           required: false
41899           type: string
41900         - name: service-id
41901           in: query
41902           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
41903           required: false
41904           type: string
41905         - name: regional-resource-zone
41906           in: query
41907           description: Regional way of organizing pservers, source of truth should define values
41908           required: false
41909           type: string
41910         - name: prov-status
41911           in: query
41912           description: Trigger for operational monitoring of this resource by Service Assurance systems.
41913           required: false
41914           type: string
41915         - name: heat-stack-id
41916           in: query
41917           description: Heat stack id corresponding to this instance, managed by MSO
41918           required: false
41919           type: string
41920         - name: in-maint
41921           in: query
41922           required: false
41923           type: boolean
41924         - name: is-closed-loop-disabled
41925           in: query
41926           required: false
41927           type: boolean
41928         - name: model-invariant-id
41929           in: query
41930           description: the ASDC model id for this resource or service model.
41931           required: false
41932           type: string
41933         - name: model-version-id
41934           in: query
41935           description: the ASDC model version for this resource or service model.
41936           required: false
41937           type: string
41938         - name: widget-model-id
41939           in: query
41940           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
41941           required: false
41942           type: string
41943         - name: widget-model-version
41944           in: query
41945           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
41946           required: false
41947           type: string
41948         - name: nf-type
41949           in: query
41950           description: Generic description of the type of NF
41951           required: false
41952           type: string
41953         - name: nf-function
41954           in: query
41955           description: English description of Network function that the specific VNF deployment is providing
41956           required: false
41957           type: string
41958         - name: nf-role
41959           in: query
41960           description: role in the network that this model will be providing
41961           required: false
41962           type: string
41963         - name: nf-naming-code
41964           in: query
41965           description: string assigned to this model used for naming purposes
41966           required: false
41967           type: string
41968   /network/generic-vnfs/generic-vnf/{vnf-id}:
41969     get:
41970       tags:
41971         - Network
41972       summary: returns generic-vnf
41973       description: returns generic-vnf
41974       operationId: getNetworkGenericVnfsGenericVnf
41975       produces:
41976         - application/json
41977         - application/xml
41978       responses:
41979         "200":
41980           description: successful operation
41981           schema:
41982               $ref: "#/getDefinitions/generic-vnf"
41983         "default":
41984           description: Response codes found in [response codes](https://wiki.onap.org/).
41985       parameters:
41986         - name: vnf-id
41987           in: path
41988           description: Unique id of VNF.  This is unique across the graph.
41989           required: true
41990           type: string
41991           example: __VNF-ID__
41992         - name: vnf-name
41993           in: query
41994           description: Name of VNF.
41995           required: false
41996           type: string
41997         - name: vnf-name2
41998           in: query
41999           description: Alternate name of VNF.
42000           required: false
42001           type: string
42002         - name: vnf-type
42003           in: query
42004           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.
42005           required: false
42006           type: string
42007         - name: service-id
42008           in: query
42009           description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
42010           required: false
42011           type: string
42012         - name: regional-resource-zone
42013           in: query
42014           description: Regional way of organizing pservers, source of truth should define values
42015           required: false
42016           type: string
42017         - name: prov-status
42018           in: query
42019           description: Trigger for operational monitoring of this resource by Service Assurance systems.
42020           required: false
42021           type: string
42022         - name: heat-stack-id
42023           in: query
42024           description: Heat stack id corresponding to this instance, managed by MSO
42025           required: false
42026           type: string
42027         - name: in-maint
42028           in: query
42029           required: false
42030           type: boolean
42031         - name: is-closed-loop-disabled
42032           in: query
42033           required: false
42034           type: boolean
42035         - name: model-invariant-id
42036           in: query
42037           description: the ASDC model id for this resource or service model.
42038           required: false
42039           type: string
42040         - name: model-version-id
42041           in: query
42042           description: the ASDC model version for this resource or service model.
42043           required: false
42044           type: string
42045         - name: widget-model-id
42046           in: query
42047           description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
42048           required: false
42049           type: string
42050         - name: widget-model-version
42051           in: query
42052           description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
42053           required: false
42054           type: string
42055         - name: nf-type
42056           in: query
42057           description: Generic description of the type of NF
42058           required: false
42059           type: string
42060         - name: nf-function
42061           in: query
42062           description: English description of Network function that the specific VNF deployment is providing
42063           required: false
42064           type: string
42065         - name: nf-role
42066           in: query
42067           description: role in the network that this model will be providing
42068           required: false
42069           type: string
42070         - name: nf-naming-code
42071           in: query
42072           description: string assigned to this model used for naming purposes
42073           required: false
42074           type: string
42075     put:
42076       tags:
42077         - Network
42078       summary: create or update an existing generic-vnf
42079       description: |
42080         Create or update an existing generic-vnf.
42081         #
42082         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42083       operationId: createOrUpdateNetworkGenericVnfsGenericVnf
42084       consumes:
42085         - application/json
42086         - application/xml
42087       produces:
42088         - application/json
42089         - application/xml
42090       responses:
42091         "default":
42092           description: Response codes found in [response codes](https://wiki.onap.org/).
42093       parameters:
42094         - name: vnf-id
42095           in: path
42096           description: Unique id of VNF.  This is unique across the graph.
42097           required: true
42098           type: string
42099           example: __VNF-ID__
42100         - name: body
42101           in: body
42102           description: generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)
42103           required: true
42104           schema:
42105             $ref: "#/definitions/generic-vnf"
42106     patch:
42107       tags:
42108         - Network
42109       summary: update an existing generic-vnf
42110       description: |
42111         Update an existing generic-vnf
42112         #
42113         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42114         The PUT operation will entirely replace an existing object.
42115         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42116         #
42117         Other differences between PUT and PATCH are:
42118         #
42119         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42120         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42121         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42122       operationId: UpdateNetworkGenericVnfsGenericVnf
42123       consumes:
42124         - application/json
42125         - application/xml
42126       produces:
42127         - application/json
42128         - application/xml
42129       responses:
42130         "default":
42131           description: Response codes found in [response codes](https://wiki.onap.org/).
42132       parameters:
42133         - name: vnf-id
42134           in: path
42135           description: Unique id of VNF.  This is unique across the graph.
42136           required: true
42137           type: string
42138           example: __VNF-ID__
42139         - name: body
42140           in: body
42141           description: generic-vnf object that needs to be created or updated.
42142           required: true
42143           schema:
42144             $ref: "#/patchDefinitions/generic-vnf"
42145     delete:
42146       tags:
42147         - Network
42148       summary: delete an existing generic-vnf
42149       description: delete an existing generic-vnf
42150       operationId: deleteNetworkGenericVnfsGenericVnf
42151       consumes:
42152         - application/json
42153         - application/xml
42154       produces:
42155         - application/json
42156         - application/xml
42157       responses:
42158         "default":
42159           description: Response codes found in [response codes](https://wiki.onap.org/).
42160       parameters:
42161         - name: vnf-id
42162           in: path
42163           description: Unique id of VNF.  This is unique across the graph.
42164           required: true
42165           type: string
42166           example: __VNF-ID__
42167         - name: resource-version
42168           in: query
42169           description: resource-version for concurrency
42170           required: true
42171           type: string
42172   /network/generic-vnfs:
42173     get:
42174       tags:
42175         - Network
42176       summary: returns generic-vnfs
42177       description: returns generic-vnfs
42178       operationId: getNetworkGenericVnfs
42179       produces:
42180         - application/json
42181         - application/xml
42182       responses:
42183         "200":
42184           description: successful operation
42185           schema:
42186               $ref: "#/getDefinitions/generic-vnfs"
42187         "default":
42188           description: Response codes found in [response codes](https://wiki.onap.org/).
42189   /network/lag-links/lag-link/{link-name}/relationship-list/relationship:
42190     put:
42191       tags:
42192         - Network
42193       summary: see node definition for valid relationships
42194       operationId: createOrUpdateNetworkLagLinksLagLinkRelationshipListRelationship
42195       consumes:
42196         - application/json
42197         - application/xml
42198       produces:
42199         - application/json
42200         - application/xml
42201       responses:
42202         "default":
42203           description: Response codes found in [response codes](https://wiki.onap.org/).
42204       parameters:
42205         - name: link-name
42206           in: path
42207           description: Alphabetical concatenation of lag-interface names
42208           required: true
42209           type: string
42210           example: __LINK-NAME__
42211         - name: body
42212           in: body
42213           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
42214           required: true
42215           schema:
42216             $ref: "#/definitions/relationship"
42217     delete:
42218       tags:
42219         - Network
42220       summary: delete an existing relationship
42221       description: delete an existing relationship
42222       operationId: deleteNetworkLagLinksLagLinkRelationshipListRelationship
42223       consumes:
42224         - application/json
42225         - application/xml
42226       produces:
42227         - application/json
42228         - application/xml
42229       responses:
42230         "default":
42231           description: Response codes found in [response codes](https://wiki.onap.org/).
42232       parameters:
42233         - name: link-name
42234           in: path
42235           description: Alphabetical concatenation of lag-interface names
42236           required: true
42237           type: string
42238           example: __LINK-NAME__
42239   /network/lag-links/lag-link/{link-name}:
42240     get:
42241       tags:
42242         - Network
42243       summary: returns lag-link
42244       description: returns lag-link
42245       operationId: getNetworkLagLinksLagLink
42246       produces:
42247         - application/json
42248         - application/xml
42249       responses:
42250         "200":
42251           description: successful operation
42252           schema:
42253               $ref: "#/getDefinitions/lag-link"
42254         "default":
42255           description: Response codes found in [response codes](https://wiki.onap.org/).
42256       parameters:
42257         - name: link-name
42258           in: path
42259           description: Alphabetical concatenation of lag-interface names
42260           required: true
42261           type: string
42262           example: __LINK-NAME__
42263     put:
42264       tags:
42265         - Network
42266       summary: create or update an existing lag-link
42267       description: |
42268         Create or update an existing lag-link.
42269         #
42270         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42271       operationId: createOrUpdateNetworkLagLinksLagLink
42272       consumes:
42273         - application/json
42274         - application/xml
42275       produces:
42276         - application/json
42277         - application/xml
42278       responses:
42279         "default":
42280           description: Response codes found in [response codes](https://wiki.onap.org/).
42281       parameters:
42282         - name: link-name
42283           in: path
42284           description: Alphabetical concatenation of lag-interface names
42285           required: true
42286           type: string
42287           example: __LINK-NAME__
42288         - name: body
42289           in: body
42290           description: lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)
42291           required: true
42292           schema:
42293             $ref: "#/definitions/lag-link"
42294     patch:
42295       tags:
42296         - Network
42297       summary: update an existing lag-link
42298       description: |
42299         Update an existing lag-link
42300         #
42301         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42302         The PUT operation will entirely replace an existing object.
42303         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42304         #
42305         Other differences between PUT and PATCH are:
42306         #
42307         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42308         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42309         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42310       operationId: UpdateNetworkLagLinksLagLink
42311       consumes:
42312         - application/json
42313         - application/xml
42314       produces:
42315         - application/json
42316         - application/xml
42317       responses:
42318         "default":
42319           description: Response codes found in [response codes](https://wiki.onap.org/).
42320       parameters:
42321         - name: link-name
42322           in: path
42323           description: Alphabetical concatenation of lag-interface names
42324           required: true
42325           type: string
42326           example: __LINK-NAME__
42327         - name: body
42328           in: body
42329           description: lag-link object that needs to be created or updated.
42330           required: true
42331           schema:
42332             $ref: "#/patchDefinitions/lag-link"
42333     delete:
42334       tags:
42335         - Network
42336       summary: delete an existing lag-link
42337       description: delete an existing lag-link
42338       operationId: deleteNetworkLagLinksLagLink
42339       consumes:
42340         - application/json
42341         - application/xml
42342       produces:
42343         - application/json
42344         - application/xml
42345       responses:
42346         "default":
42347           description: Response codes found in [response codes](https://wiki.onap.org/).
42348       parameters:
42349         - name: link-name
42350           in: path
42351           description: Alphabetical concatenation of lag-interface names
42352           required: true
42353           type: string
42354           example: __LINK-NAME__
42355         - name: resource-version
42356           in: query
42357           description: resource-version for concurrency
42358           required: true
42359           type: string
42360   /network/lag-links:
42361     get:
42362       tags:
42363         - Network
42364       summary: returns lag-links
42365       description: returns lag-links
42366       operationId: getNetworkLagLinks
42367       produces:
42368         - application/json
42369         - application/xml
42370       responses:
42371         "200":
42372           description: successful operation
42373           schema:
42374               $ref: "#/getDefinitions/lag-links"
42375         "default":
42376           description: Response codes found in [response codes](https://wiki.onap.org/).
42377   /network/newvces/newvce/{vnf-id2}/relationship-list/relationship:
42378     put:
42379       tags:
42380         - Network
42381       summary: see node definition for valid relationships
42382       operationId: createOrUpdateNetworkNewvcesNewvceRelationshipListRelationship
42383       consumes:
42384         - application/json
42385         - application/xml
42386       produces:
42387         - application/json
42388         - application/xml
42389       responses:
42390         "default":
42391           description: Response codes found in [response codes](https://wiki.onap.org/).
42392       parameters:
42393         - name: vnf-id2
42394           in: path
42395           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42396           required: true
42397           type: string
42398           example: __VNF-ID2__
42399         - name: body
42400           in: body
42401           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
42402           required: true
42403           schema:
42404             $ref: "#/definitions/relationship"
42405     delete:
42406       tags:
42407         - Network
42408       summary: delete an existing relationship
42409       description: delete an existing relationship
42410       operationId: deleteNetworkNewvcesNewvceRelationshipListRelationship
42411       consumes:
42412         - application/json
42413         - application/xml
42414       produces:
42415         - application/json
42416         - application/xml
42417       responses:
42418         "default":
42419           description: Response codes found in [response codes](https://wiki.onap.org/).
42420       parameters:
42421         - name: vnf-id2
42422           in: path
42423           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42424           required: true
42425           type: string
42426           example: __VNF-ID2__
42427   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
42428     put:
42429       tags:
42430         - Network
42431       summary: see node definition for valid relationships
42432       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42433       consumes:
42434         - application/json
42435         - application/xml
42436       produces:
42437         - application/json
42438         - application/xml
42439       responses:
42440         "default":
42441           description: Response codes found in [response codes](https://wiki.onap.org/).
42442       parameters:
42443         - name: vnf-id2
42444           in: path
42445           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42446           required: true
42447           type: string
42448           example: __VNF-ID2__
42449         - name: interface-name
42450           in: path
42451           description: Name given to the interface
42452           required: true
42453           type: string
42454           example: __INTERFACE-NAME__
42455         - name: vlan-interface
42456           in: path
42457           description: String that identifies the interface
42458           required: true
42459           type: string
42460           example: __VLAN-INTERFACE__
42461         - name: body
42462           in: body
42463           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
42464           required: true
42465           schema:
42466             $ref: "#/definitions/relationship"
42467     delete:
42468       tags:
42469         - Network
42470       summary: delete an existing relationship
42471       description: delete an existing relationship
42472       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
42473       consumes:
42474         - application/json
42475         - application/xml
42476       produces:
42477         - application/json
42478         - application/xml
42479       responses:
42480         "default":
42481           description: Response codes found in [response codes](https://wiki.onap.org/).
42482       parameters:
42483         - name: vnf-id2
42484           in: path
42485           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42486           required: true
42487           type: string
42488           example: __VNF-ID2__
42489         - name: interface-name
42490           in: path
42491           description: Name given to the interface
42492           required: true
42493           type: string
42494           example: __INTERFACE-NAME__
42495         - name: vlan-interface
42496           in: path
42497           description: String that identifies the interface
42498           required: true
42499           type: string
42500           example: __VLAN-INTERFACE__
42501   /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:
42502     put:
42503       tags:
42504         - Network
42505       summary: see node definition for valid relationships
42506       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42507       consumes:
42508         - application/json
42509         - application/xml
42510       produces:
42511         - application/json
42512         - application/xml
42513       responses:
42514         "default":
42515           description: Response codes found in [response codes](https://wiki.onap.org/).
42516       parameters:
42517         - name: vnf-id2
42518           in: path
42519           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42520           required: true
42521           type: string
42522           example: __VNF-ID2__
42523         - name: interface-name
42524           in: path
42525           description: Name given to the interface
42526           required: true
42527           type: string
42528           example: __INTERFACE-NAME__
42529         - name: vlan-interface
42530           in: path
42531           description: String that identifies the interface
42532           required: true
42533           type: string
42534           example: __VLAN-INTERFACE__
42535         - name: l3-interface-ipv4-address
42536           in: path
42537           description: IP address
42538           required: true
42539           type: string
42540           example: __L3-INTERFACE-IPV4-ADDRESS__
42541         - name: body
42542           in: body
42543           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42544           required: true
42545           schema:
42546             $ref: "#/definitions/relationship"
42547     delete:
42548       tags:
42549         - Network
42550       summary: delete an existing relationship
42551       description: delete an existing relationship
42552       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
42553       consumes:
42554         - application/json
42555         - application/xml
42556       produces:
42557         - application/json
42558         - application/xml
42559       responses:
42560         "default":
42561           description: Response codes found in [response codes](https://wiki.onap.org/).
42562       parameters:
42563         - name: vnf-id2
42564           in: path
42565           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42566           required: true
42567           type: string
42568           example: __VNF-ID2__
42569         - name: interface-name
42570           in: path
42571           description: Name given to the interface
42572           required: true
42573           type: string
42574           example: __INTERFACE-NAME__
42575         - name: vlan-interface
42576           in: path
42577           description: String that identifies the interface
42578           required: true
42579           type: string
42580           example: __VLAN-INTERFACE__
42581         - name: l3-interface-ipv4-address
42582           in: path
42583           description: IP address
42584           required: true
42585           type: string
42586           example: __L3-INTERFACE-IPV4-ADDRESS__
42587   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
42588     get:
42589       tags:
42590         - Network
42591       summary: returns l3-interface-ipv4-address-list
42592       description: returns l3-interface-ipv4-address-list
42593       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42594       produces:
42595         - application/json
42596         - application/xml
42597       responses:
42598         "200":
42599           description: successful operation
42600           schema:
42601               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
42602         "default":
42603           description: Response codes found in [response codes](https://wiki.onap.org/).
42604       parameters:
42605         - name: vnf-id2
42606           in: path
42607           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42608           required: true
42609           type: string
42610           example: __VNF-ID2__
42611         - name: interface-name
42612           in: path
42613           description: Name given to the interface
42614           required: true
42615           type: string
42616           example: __INTERFACE-NAME__
42617         - name: vlan-interface
42618           in: path
42619           description: String that identifies the interface
42620           required: true
42621           type: string
42622           example: __VLAN-INTERFACE__
42623         - name: l3-interface-ipv4-address
42624           in: path
42625           description: IP address
42626           required: true
42627           type: string
42628           example: __L3-INTERFACE-IPV4-ADDRESS__
42629         - name: vnf-name
42630           in: query
42631           description: Name of VNF.
42632           required: false
42633           type: string
42634         - name: vnf-name2
42635           in: query
42636           description: Alternate name of VNF.
42637           required: false
42638           type: string
42639         - name: vnf-type
42640           in: query
42641           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.
42642           required: false
42643           type: string
42644         - name: prov-status
42645           in: query
42646           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
42647           required: false
42648           type: string
42649         - name: heat-stack-id
42650           in: query
42651           description: Heat stack id corresponding to this instance, managed by MSO
42652           required: false
42653           type: string
42654         - name: interface-id
42655           in: query
42656           description: ID of interface
42657           required: false
42658           type: string
42659         - name: macaddr
42660           in: query
42661           description: MAC address for the interface
42662           required: false
42663           type: string
42664         - name: network-name
42665           in: query
42666           description: Name of the network
42667           required: false
42668           type: string
42669         - name: vlan-id-inner
42670           in: query
42671           description: Inner VLAN tag
42672           required: false
42673           type: integer
42674           format: int64
42675         - name: vpn-key
42676           in: query
42677           description: This indicates the customers VPN ID associated with this vlan
42678           required: false
42679           type: string
42680         - name: vlan-id-inner
42681           in: query
42682           description: Inner VLAN tag
42683           required: false
42684           type: integer
42685           format: int64
42686         - name: neutron-network-id
42687           in: query
42688           description: Neutron network id of the interface that address belongs to
42689           required: false
42690           type: string
42691         - name: neutron-subnet-id
42692           in: query
42693           description: Neutron id of subnet that address belongs to
42694           required: false
42695           type: string
42696     put:
42697       tags:
42698         - Network
42699       summary: create or update an existing l3-interface-ipv4-address-list
42700       description: |
42701         Create or update an existing l3-interface-ipv4-address-list.
42702         #
42703         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
42704       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42705       consumes:
42706         - application/json
42707         - application/xml
42708       produces:
42709         - application/json
42710         - application/xml
42711       responses:
42712         "default":
42713           description: Response codes found in [response codes](https://wiki.onap.org/).
42714       parameters:
42715         - name: vnf-id2
42716           in: path
42717           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42718           required: true
42719           type: string
42720           example: __VNF-ID2__
42721         - name: interface-name
42722           in: path
42723           description: Name given to the interface
42724           required: true
42725           type: string
42726           example: __INTERFACE-NAME__
42727         - name: vlan-interface
42728           in: path
42729           description: String that identifies the interface
42730           required: true
42731           type: string
42732           example: __VLAN-INTERFACE__
42733         - name: l3-interface-ipv4-address
42734           in: path
42735           description: IP address
42736           required: true
42737           type: string
42738           example: __L3-INTERFACE-IPV4-ADDRESS__
42739         - name: body
42740           in: body
42741           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
42742           required: true
42743           schema:
42744             $ref: "#/definitions/l3-interface-ipv4-address-list"
42745     patch:
42746       tags:
42747         - Network
42748       summary: update an existing l3-interface-ipv4-address-list
42749       description: |
42750         Update an existing l3-interface-ipv4-address-list
42751         #
42752         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
42753         The PUT operation will entirely replace an existing object.
42754         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
42755         #
42756         Other differences between PUT and PATCH are:
42757         #
42758         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
42759         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
42760         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
42761       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42762       consumes:
42763         - application/json
42764         - application/xml
42765       produces:
42766         - application/json
42767         - application/xml
42768       responses:
42769         "default":
42770           description: Response codes found in [response codes](https://wiki.onap.org/).
42771       parameters:
42772         - name: vnf-id2
42773           in: path
42774           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42775           required: true
42776           type: string
42777           example: __VNF-ID2__
42778         - name: interface-name
42779           in: path
42780           description: Name given to the interface
42781           required: true
42782           type: string
42783           example: __INTERFACE-NAME__
42784         - name: vlan-interface
42785           in: path
42786           description: String that identifies the interface
42787           required: true
42788           type: string
42789           example: __VLAN-INTERFACE__
42790         - name: l3-interface-ipv4-address
42791           in: path
42792           description: IP address
42793           required: true
42794           type: string
42795           example: __L3-INTERFACE-IPV4-ADDRESS__
42796         - name: body
42797           in: body
42798           description: l3-interface-ipv4-address-list object that needs to be created or updated.
42799           required: true
42800           schema:
42801             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
42802     delete:
42803       tags:
42804         - Network
42805       summary: delete an existing l3-interface-ipv4-address-list
42806       description: delete an existing l3-interface-ipv4-address-list
42807       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
42808       consumes:
42809         - application/json
42810         - application/xml
42811       produces:
42812         - application/json
42813         - application/xml
42814       responses:
42815         "default":
42816           description: Response codes found in [response codes](https://wiki.onap.org/).
42817       parameters:
42818         - name: vnf-id2
42819           in: path
42820           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42821           required: true
42822           type: string
42823           example: __VNF-ID2__
42824         - name: interface-name
42825           in: path
42826           description: Name given to the interface
42827           required: true
42828           type: string
42829           example: __INTERFACE-NAME__
42830         - name: vlan-interface
42831           in: path
42832           description: String that identifies the interface
42833           required: true
42834           type: string
42835           example: __VLAN-INTERFACE__
42836         - name: l3-interface-ipv4-address
42837           in: path
42838           description: IP address
42839           required: true
42840           type: string
42841           example: __L3-INTERFACE-IPV4-ADDRESS__
42842         - name: resource-version
42843           in: query
42844           description: resource-version for concurrency
42845           required: true
42846           type: string
42847   /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:
42848     put:
42849       tags:
42850         - Network
42851       summary: see node definition for valid relationships
42852       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42853       consumes:
42854         - application/json
42855         - application/xml
42856       produces:
42857         - application/json
42858         - application/xml
42859       responses:
42860         "default":
42861           description: Response codes found in [response codes](https://wiki.onap.org/).
42862       parameters:
42863         - name: vnf-id2
42864           in: path
42865           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42866           required: true
42867           type: string
42868           example: __VNF-ID2__
42869         - name: interface-name
42870           in: path
42871           description: Name given to the interface
42872           required: true
42873           type: string
42874           example: __INTERFACE-NAME__
42875         - name: vlan-interface
42876           in: path
42877           description: String that identifies the interface
42878           required: true
42879           type: string
42880           example: __VLAN-INTERFACE__
42881         - name: l3-interface-ipv6-address
42882           in: path
42883           description: IP address
42884           required: true
42885           type: string
42886           example: __L3-INTERFACE-IPV6-ADDRESS__
42887         - name: body
42888           in: body
42889           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
42890           required: true
42891           schema:
42892             $ref: "#/definitions/relationship"
42893     delete:
42894       tags:
42895         - Network
42896       summary: delete an existing relationship
42897       description: delete an existing relationship
42898       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
42899       consumes:
42900         - application/json
42901         - application/xml
42902       produces:
42903         - application/json
42904         - application/xml
42905       responses:
42906         "default":
42907           description: Response codes found in [response codes](https://wiki.onap.org/).
42908       parameters:
42909         - name: vnf-id2
42910           in: path
42911           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42912           required: true
42913           type: string
42914           example: __VNF-ID2__
42915         - name: interface-name
42916           in: path
42917           description: Name given to the interface
42918           required: true
42919           type: string
42920           example: __INTERFACE-NAME__
42921         - name: vlan-interface
42922           in: path
42923           description: String that identifies the interface
42924           required: true
42925           type: string
42926           example: __VLAN-INTERFACE__
42927         - name: l3-interface-ipv6-address
42928           in: path
42929           description: IP address
42930           required: true
42931           type: string
42932           example: __L3-INTERFACE-IPV6-ADDRESS__
42933   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
42934     get:
42935       tags:
42936         - Network
42937       summary: returns l3-interface-ipv6-address-list
42938       description: returns l3-interface-ipv6-address-list
42939       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
42940       produces:
42941         - application/json
42942         - application/xml
42943       responses:
42944         "200":
42945           description: successful operation
42946           schema:
42947               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
42948         "default":
42949           description: Response codes found in [response codes](https://wiki.onap.org/).
42950       parameters:
42951         - name: vnf-id2
42952           in: path
42953           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
42954           required: true
42955           type: string
42956           example: __VNF-ID2__
42957         - name: interface-name
42958           in: path
42959           description: Name given to the interface
42960           required: true
42961           type: string
42962           example: __INTERFACE-NAME__
42963         - name: vlan-interface
42964           in: path
42965           description: String that identifies the interface
42966           required: true
42967           type: string
42968           example: __VLAN-INTERFACE__
42969         - name: l3-interface-ipv6-address
42970           in: path
42971           description: IP address
42972           required: true
42973           type: string
42974           example: __L3-INTERFACE-IPV6-ADDRESS__
42975         - name: vnf-name
42976           in: query
42977           description: Name of VNF.
42978           required: false
42979           type: string
42980         - name: vnf-name2
42981           in: query
42982           description: Alternate name of VNF.
42983           required: false
42984           type: string
42985         - name: vnf-type
42986           in: query
42987           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.
42988           required: false
42989           type: string
42990         - name: prov-status
42991           in: query
42992           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
42993           required: false
42994           type: string
42995         - name: heat-stack-id
42996           in: query
42997           description: Heat stack id corresponding to this instance, managed by MSO
42998           required: false
42999           type: string
43000         - name: interface-id
43001           in: query
43002           description: ID of interface
43003           required: false
43004           type: string
43005         - name: macaddr
43006           in: query
43007           description: MAC address for the interface
43008           required: false
43009           type: string
43010         - name: network-name
43011           in: query
43012           description: Name of the network
43013           required: false
43014           type: string
43015         - name: vlan-id-inner
43016           in: query
43017           description: Inner VLAN tag
43018           required: false
43019           type: integer
43020           format: int64
43021         - name: vpn-key
43022           in: query
43023           description: This indicates the customers VPN ID associated with this vlan
43024           required: false
43025           type: string
43026         - name: vlan-id-inner
43027           in: query
43028           description: Inner VLAN tag
43029           required: false
43030           type: integer
43031           format: int64
43032         - name: neutron-network-id
43033           in: query
43034           description: Neutron network id of the interface that address belongs to
43035           required: false
43036           type: string
43037         - name: neutron-subnet-id
43038           in: query
43039           description: Neutron id of subnet that address belongs to
43040           required: false
43041           type: string
43042     put:
43043       tags:
43044         - Network
43045       summary: create or update an existing l3-interface-ipv6-address-list
43046       description: |
43047         Create or update an existing l3-interface-ipv6-address-list.
43048         #
43049         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43050       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43051       consumes:
43052         - application/json
43053         - application/xml
43054       produces:
43055         - application/json
43056         - application/xml
43057       responses:
43058         "default":
43059           description: Response codes found in [response codes](https://wiki.onap.org/).
43060       parameters:
43061         - name: vnf-id2
43062           in: path
43063           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43064           required: true
43065           type: string
43066           example: __VNF-ID2__
43067         - name: interface-name
43068           in: path
43069           description: Name given to the interface
43070           required: true
43071           type: string
43072           example: __INTERFACE-NAME__
43073         - name: vlan-interface
43074           in: path
43075           description: String that identifies the interface
43076           required: true
43077           type: string
43078           example: __VLAN-INTERFACE__
43079         - name: l3-interface-ipv6-address
43080           in: path
43081           description: IP address
43082           required: true
43083           type: string
43084           example: __L3-INTERFACE-IPV6-ADDRESS__
43085         - name: body
43086           in: body
43087           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
43088           required: true
43089           schema:
43090             $ref: "#/definitions/l3-interface-ipv6-address-list"
43091     patch:
43092       tags:
43093         - Network
43094       summary: update an existing l3-interface-ipv6-address-list
43095       description: |
43096         Update an existing l3-interface-ipv6-address-list
43097         #
43098         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43099         The PUT operation will entirely replace an existing object.
43100         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43101         #
43102         Other differences between PUT and PATCH are:
43103         #
43104         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43105         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43106         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43107       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43108       consumes:
43109         - application/json
43110         - application/xml
43111       produces:
43112         - application/json
43113         - application/xml
43114       responses:
43115         "default":
43116           description: Response codes found in [response codes](https://wiki.onap.org/).
43117       parameters:
43118         - name: vnf-id2
43119           in: path
43120           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43121           required: true
43122           type: string
43123           example: __VNF-ID2__
43124         - name: interface-name
43125           in: path
43126           description: Name given to the interface
43127           required: true
43128           type: string
43129           example: __INTERFACE-NAME__
43130         - name: vlan-interface
43131           in: path
43132           description: String that identifies the interface
43133           required: true
43134           type: string
43135           example: __VLAN-INTERFACE__
43136         - name: l3-interface-ipv6-address
43137           in: path
43138           description: IP address
43139           required: true
43140           type: string
43141           example: __L3-INTERFACE-IPV6-ADDRESS__
43142         - name: body
43143           in: body
43144           description: l3-interface-ipv6-address-list object that needs to be created or updated.
43145           required: true
43146           schema:
43147             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
43148     delete:
43149       tags:
43150         - Network
43151       summary: delete an existing l3-interface-ipv6-address-list
43152       description: delete an existing l3-interface-ipv6-address-list
43153       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
43154       consumes:
43155         - application/json
43156         - application/xml
43157       produces:
43158         - application/json
43159         - application/xml
43160       responses:
43161         "default":
43162           description: Response codes found in [response codes](https://wiki.onap.org/).
43163       parameters:
43164         - name: vnf-id2
43165           in: path
43166           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43167           required: true
43168           type: string
43169           example: __VNF-ID2__
43170         - name: interface-name
43171           in: path
43172           description: Name given to the interface
43173           required: true
43174           type: string
43175           example: __INTERFACE-NAME__
43176         - name: vlan-interface
43177           in: path
43178           description: String that identifies the interface
43179           required: true
43180           type: string
43181           example: __VLAN-INTERFACE__
43182         - name: l3-interface-ipv6-address
43183           in: path
43184           description: IP address
43185           required: true
43186           type: string
43187           example: __L3-INTERFACE-IPV6-ADDRESS__
43188         - name: resource-version
43189           in: query
43190           description: resource-version for concurrency
43191           required: true
43192           type: string
43193   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
43194     get:
43195       tags:
43196         - Network
43197       summary: returns vlan
43198       description: returns vlan
43199       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43200       produces:
43201         - application/json
43202         - application/xml
43203       responses:
43204         "200":
43205           description: successful operation
43206           schema:
43207               $ref: "#/getDefinitions/vlan"
43208         "default":
43209           description: Response codes found in [response codes](https://wiki.onap.org/).
43210       parameters:
43211         - name: vnf-id2
43212           in: path
43213           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43214           required: true
43215           type: string
43216           example: __VNF-ID2__
43217         - name: interface-name
43218           in: path
43219           description: Name given to the interface
43220           required: true
43221           type: string
43222           example: __INTERFACE-NAME__
43223         - name: vlan-interface
43224           in: path
43225           description: String that identifies the interface
43226           required: true
43227           type: string
43228           example: __VLAN-INTERFACE__
43229         - name: vnf-name
43230           in: query
43231           description: Name of VNF.
43232           required: false
43233           type: string
43234         - name: vnf-name2
43235           in: query
43236           description: Alternate name of VNF.
43237           required: false
43238           type: string
43239         - name: vnf-type
43240           in: query
43241           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.
43242           required: false
43243           type: string
43244         - name: prov-status
43245           in: query
43246           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43247           required: false
43248           type: string
43249         - name: heat-stack-id
43250           in: query
43251           description: Heat stack id corresponding to this instance, managed by MSO
43252           required: false
43253           type: string
43254         - name: interface-id
43255           in: query
43256           description: ID of interface
43257           required: false
43258           type: string
43259         - name: macaddr
43260           in: query
43261           description: MAC address for the interface
43262           required: false
43263           type: string
43264         - name: network-name
43265           in: query
43266           description: Name of the network
43267           required: false
43268           type: string
43269         - name: vlan-id-inner
43270           in: query
43271           description: Inner VLAN tag
43272           required: false
43273           type: integer
43274           format: int64
43275         - name: vpn-key
43276           in: query
43277           description: This indicates the customers VPN ID associated with this vlan
43278           required: false
43279           type: string
43280     put:
43281       tags:
43282         - Network
43283       summary: create or update an existing vlan
43284       description: |
43285         Create or update an existing vlan.
43286         #
43287         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43288       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43289       consumes:
43290         - application/json
43291         - application/xml
43292       produces:
43293         - application/json
43294         - application/xml
43295       responses:
43296         "default":
43297           description: Response codes found in [response codes](https://wiki.onap.org/).
43298       parameters:
43299         - name: vnf-id2
43300           in: path
43301           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43302           required: true
43303           type: string
43304           example: __VNF-ID2__
43305         - name: interface-name
43306           in: path
43307           description: Name given to the interface
43308           required: true
43309           type: string
43310           example: __INTERFACE-NAME__
43311         - name: vlan-interface
43312           in: path
43313           description: String that identifies the interface
43314           required: true
43315           type: string
43316           example: __VLAN-INTERFACE__
43317         - name: body
43318           in: body
43319           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)
43320           required: true
43321           schema:
43322             $ref: "#/definitions/vlan"
43323     patch:
43324       tags:
43325         - Network
43326       summary: update an existing vlan
43327       description: |
43328         Update an existing vlan
43329         #
43330         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43331         The PUT operation will entirely replace an existing object.
43332         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43333         #
43334         Other differences between PUT and PATCH are:
43335         #
43336         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43337         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43338         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43339       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
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: vnf-id2
43351           in: path
43352           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43353           required: true
43354           type: string
43355           example: __VNF-ID2__
43356         - name: interface-name
43357           in: path
43358           description: Name given to the interface
43359           required: true
43360           type: string
43361           example: __INTERFACE-NAME__
43362         - name: vlan-interface
43363           in: path
43364           description: String that identifies the interface
43365           required: true
43366           type: string
43367           example: __VLAN-INTERFACE__
43368         - name: body
43369           in: body
43370           description: vlan object that needs to be created or updated.
43371           required: true
43372           schema:
43373             $ref: "#/patchDefinitions/vlan"
43374     delete:
43375       tags:
43376         - Network
43377       summary: delete an existing vlan
43378       description: delete an existing vlan
43379       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan
43380       consumes:
43381         - application/json
43382         - application/xml
43383       produces:
43384         - application/json
43385         - application/xml
43386       responses:
43387         "default":
43388           description: Response codes found in [response codes](https://wiki.onap.org/).
43389       parameters:
43390         - name: vnf-id2
43391           in: path
43392           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43393           required: true
43394           type: string
43395           example: __VNF-ID2__
43396         - name: interface-name
43397           in: path
43398           description: Name given to the interface
43399           required: true
43400           type: string
43401           example: __INTERFACE-NAME__
43402         - name: vlan-interface
43403           in: path
43404           description: String that identifies the interface
43405           required: true
43406           type: string
43407           example: __VLAN-INTERFACE__
43408         - name: resource-version
43409           in: query
43410           description: resource-version for concurrency
43411           required: true
43412           type: string
43413   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans:
43414     get:
43415       tags:
43416         - Network
43417       summary: returns vlans
43418       description: returns vlans
43419       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceVlans
43420       produces:
43421         - application/json
43422         - application/xml
43423       responses:
43424         "200":
43425           description: successful operation
43426           schema:
43427               $ref: "#/getDefinitions/vlans"
43428         "default":
43429           description: Response codes found in [response codes](https://wiki.onap.org/).
43430       parameters:
43431         - name: vnf-id2
43432           in: path
43433           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43434           required: true
43435           type: string
43436           example: __VNF-ID2__
43437         - name: interface-name
43438           in: path
43439           description: Name given to the interface
43440           required: true
43441           type: string
43442           example: __INTERFACE-NAME__
43443         - name: vnf-name
43444           in: query
43445           description: Name of VNF.
43446           required: false
43447           type: string
43448         - name: vnf-name2
43449           in: query
43450           description: Alternate name of VNF.
43451           required: false
43452           type: string
43453         - name: vnf-type
43454           in: query
43455           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.
43456           required: false
43457           type: string
43458         - name: prov-status
43459           in: query
43460           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43461           required: false
43462           type: string
43463         - name: heat-stack-id
43464           in: query
43465           description: Heat stack id corresponding to this instance, managed by MSO
43466           required: false
43467           type: string
43468         - name: interface-id
43469           in: query
43470           description: ID of interface
43471           required: false
43472           type: string
43473         - name: macaddr
43474           in: query
43475           description: MAC address for the interface
43476           required: false
43477           type: string
43478         - name: network-name
43479           in: query
43480           description: Name of the network
43481           required: false
43482           type: string
43483   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship:
43484     put:
43485       tags:
43486         - Network
43487       summary: see node definition for valid relationships
43488       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43489       consumes:
43490         - application/json
43491         - application/xml
43492       produces:
43493         - application/json
43494         - application/xml
43495       responses:
43496         "default":
43497           description: Response codes found in [response codes](https://wiki.onap.org/).
43498       parameters:
43499         - name: vnf-id2
43500           in: path
43501           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43502           required: true
43503           type: string
43504           example: __VNF-ID2__
43505         - name: interface-name
43506           in: path
43507           description: Name given to the interface
43508           required: true
43509           type: string
43510           example: __INTERFACE-NAME__
43511         - name: pci-id
43512           in: path
43513           description: PCI ID used to identify the sriov-vf
43514           required: true
43515           type: string
43516           example: __PCI-ID__
43517         - name: body
43518           in: body
43519           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
43520           required: true
43521           schema:
43522             $ref: "#/definitions/relationship"
43523     delete:
43524       tags:
43525         - Network
43526       summary: delete an existing relationship
43527       description: delete an existing relationship
43528       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
43529       consumes:
43530         - application/json
43531         - application/xml
43532       produces:
43533         - application/json
43534         - application/xml
43535       responses:
43536         "default":
43537           description: Response codes found in [response codes](https://wiki.onap.org/).
43538       parameters:
43539         - name: vnf-id2
43540           in: path
43541           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43542           required: true
43543           type: string
43544           example: __VNF-ID2__
43545         - name: interface-name
43546           in: path
43547           description: Name given to the interface
43548           required: true
43549           type: string
43550           example: __INTERFACE-NAME__
43551         - name: pci-id
43552           in: path
43553           description: PCI ID used to identify the sriov-vf
43554           required: true
43555           type: string
43556           example: __PCI-ID__
43557   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
43558     get:
43559       tags:
43560         - Network
43561       summary: returns sriov-vf
43562       description: returns sriov-vf
43563       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43564       produces:
43565         - application/json
43566         - application/xml
43567       responses:
43568         "200":
43569           description: successful operation
43570           schema:
43571               $ref: "#/getDefinitions/sriov-vf"
43572         "default":
43573           description: Response codes found in [response codes](https://wiki.onap.org/).
43574       parameters:
43575         - name: vnf-id2
43576           in: path
43577           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43578           required: true
43579           type: string
43580           example: __VNF-ID2__
43581         - name: interface-name
43582           in: path
43583           description: Name given to the interface
43584           required: true
43585           type: string
43586           example: __INTERFACE-NAME__
43587         - name: pci-id
43588           in: path
43589           description: PCI ID used to identify the sriov-vf
43590           required: true
43591           type: string
43592           example: __PCI-ID__
43593         - name: vnf-name
43594           in: query
43595           description: Name of VNF.
43596           required: false
43597           type: string
43598         - name: vnf-name2
43599           in: query
43600           description: Alternate name of VNF.
43601           required: false
43602           type: string
43603         - name: vnf-type
43604           in: query
43605           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.
43606           required: false
43607           type: string
43608         - name: prov-status
43609           in: query
43610           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43611           required: false
43612           type: string
43613         - name: heat-stack-id
43614           in: query
43615           description: Heat stack id corresponding to this instance, managed by MSO
43616           required: false
43617           type: string
43618         - name: interface-id
43619           in: query
43620           description: ID of interface
43621           required: false
43622           type: string
43623         - name: macaddr
43624           in: query
43625           description: MAC address for the interface
43626           required: false
43627           type: string
43628         - name: network-name
43629           in: query
43630           description: Name of the network
43631           required: false
43632           type: string
43633         - name: vf-vlan-filter
43634           in: query
43635           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
43636           required: false
43637           type: string
43638         - name: vf-mac-filter
43639           in: query
43640           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
43641           required: false
43642           type: string
43643         - name: vf-vlan-strip
43644           in: query
43645           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
43646           required: false
43647           type: boolean
43648         - name: neutron-network-id
43649           in: query
43650           description: Neutron network id of the interface
43651           required: false
43652           type: string
43653     put:
43654       tags:
43655         - Network
43656       summary: create or update an existing sriov-vf
43657       description: |
43658         Create or update an existing sriov-vf.
43659         #
43660         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
43661       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43662       consumes:
43663         - application/json
43664         - application/xml
43665       produces:
43666         - application/json
43667         - application/xml
43668       responses:
43669         "default":
43670           description: Response codes found in [response codes](https://wiki.onap.org/).
43671       parameters:
43672         - name: vnf-id2
43673           in: path
43674           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43675           required: true
43676           type: string
43677           example: __VNF-ID2__
43678         - name: interface-name
43679           in: path
43680           description: Name given to the interface
43681           required: true
43682           type: string
43683           example: __INTERFACE-NAME__
43684         - name: pci-id
43685           in: path
43686           description: PCI ID used to identify the sriov-vf
43687           required: true
43688           type: string
43689           example: __PCI-ID__
43690         - name: body
43691           in: body
43692           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)
43693           required: true
43694           schema:
43695             $ref: "#/definitions/sriov-vf"
43696     patch:
43697       tags:
43698         - Network
43699       summary: update an existing sriov-vf
43700       description: |
43701         Update an existing sriov-vf
43702         #
43703         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
43704         The PUT operation will entirely replace an existing object.
43705         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
43706         #
43707         Other differences between PUT and PATCH are:
43708         #
43709         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
43710         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
43711         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
43712       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43713       consumes:
43714         - application/json
43715         - application/xml
43716       produces:
43717         - application/json
43718         - application/xml
43719       responses:
43720         "default":
43721           description: Response codes found in [response codes](https://wiki.onap.org/).
43722       parameters:
43723         - name: vnf-id2
43724           in: path
43725           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43726           required: true
43727           type: string
43728           example: __VNF-ID2__
43729         - name: interface-name
43730           in: path
43731           description: Name given to the interface
43732           required: true
43733           type: string
43734           example: __INTERFACE-NAME__
43735         - name: pci-id
43736           in: path
43737           description: PCI ID used to identify the sriov-vf
43738           required: true
43739           type: string
43740           example: __PCI-ID__
43741         - name: body
43742           in: body
43743           description: sriov-vf object that needs to be created or updated.
43744           required: true
43745           schema:
43746             $ref: "#/patchDefinitions/sriov-vf"
43747     delete:
43748       tags:
43749         - Network
43750       summary: delete an existing sriov-vf
43751       description: delete an existing sriov-vf
43752       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf
43753       consumes:
43754         - application/json
43755         - application/xml
43756       produces:
43757         - application/json
43758         - application/xml
43759       responses:
43760         "default":
43761           description: Response codes found in [response codes](https://wiki.onap.org/).
43762       parameters:
43763         - name: vnf-id2
43764           in: path
43765           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43766           required: true
43767           type: string
43768           example: __VNF-ID2__
43769         - name: interface-name
43770           in: path
43771           description: Name given to the interface
43772           required: true
43773           type: string
43774           example: __INTERFACE-NAME__
43775         - name: pci-id
43776           in: path
43777           description: PCI ID used to identify the sriov-vf
43778           required: true
43779           type: string
43780           example: __PCI-ID__
43781         - name: resource-version
43782           in: query
43783           description: resource-version for concurrency
43784           required: true
43785           type: string
43786   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
43787     get:
43788       tags:
43789         - Network
43790       summary: returns sriov-vfs
43791       description: returns sriov-vfs
43792       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceSriovVfs
43793       produces:
43794         - application/json
43795         - application/xml
43796       responses:
43797         "200":
43798           description: successful operation
43799           schema:
43800               $ref: "#/getDefinitions/sriov-vfs"
43801         "default":
43802           description: Response codes found in [response codes](https://wiki.onap.org/).
43803       parameters:
43804         - name: vnf-id2
43805           in: path
43806           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43807           required: true
43808           type: string
43809           example: __VNF-ID2__
43810         - name: interface-name
43811           in: path
43812           description: Name given to the interface
43813           required: true
43814           type: string
43815           example: __INTERFACE-NAME__
43816         - name: vnf-name
43817           in: query
43818           description: Name of VNF.
43819           required: false
43820           type: string
43821         - name: vnf-name2
43822           in: query
43823           description: Alternate name of VNF.
43824           required: false
43825           type: string
43826         - name: vnf-type
43827           in: query
43828           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.
43829           required: false
43830           type: string
43831         - name: prov-status
43832           in: query
43833           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
43834           required: false
43835           type: string
43836         - name: heat-stack-id
43837           in: query
43838           description: Heat stack id corresponding to this instance, managed by MSO
43839           required: false
43840           type: string
43841         - name: interface-id
43842           in: query
43843           description: ID of interface
43844           required: false
43845           type: string
43846         - name: macaddr
43847           in: query
43848           description: MAC address for the interface
43849           required: false
43850           type: string
43851         - name: network-name
43852           in: query
43853           description: Name of the network
43854           required: false
43855           type: string
43856   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
43857     put:
43858       tags:
43859         - Network
43860       summary: see node definition for valid relationships
43861       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
43862       consumes:
43863         - application/json
43864         - application/xml
43865       produces:
43866         - application/json
43867         - application/xml
43868       responses:
43869         "default":
43870           description: Response codes found in [response codes](https://wiki.onap.org/).
43871       parameters:
43872         - name: vnf-id2
43873           in: path
43874           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43875           required: true
43876           type: string
43877           example: __VNF-ID2__
43878         - name: interface-name
43879           in: path
43880           description: Name given to the interface
43881           required: true
43882           type: string
43883           example: __INTERFACE-NAME__
43884         - name: body
43885           in: body
43886           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
43887           required: true
43888           schema:
43889             $ref: "#/definitions/relationship"
43890     delete:
43891       tags:
43892         - Network
43893       summary: delete an existing relationship
43894       description: delete an existing relationship
43895       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceRelationshipListRelationship
43896       consumes:
43897         - application/json
43898         - application/xml
43899       produces:
43900         - application/json
43901         - application/xml
43902       responses:
43903         "default":
43904           description: Response codes found in [response codes](https://wiki.onap.org/).
43905       parameters:
43906         - name: vnf-id2
43907           in: path
43908           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43909           required: true
43910           type: string
43911           example: __VNF-ID2__
43912         - name: interface-name
43913           in: path
43914           description: Name given to the interface
43915           required: true
43916           type: string
43917           example: __INTERFACE-NAME__
43918   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship:
43919     put:
43920       tags:
43921         - Network
43922       summary: see node definition for valid relationships
43923       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43924       consumes:
43925         - application/json
43926         - application/xml
43927       produces:
43928         - application/json
43929         - application/xml
43930       responses:
43931         "default":
43932           description: Response codes found in [response codes](https://wiki.onap.org/).
43933       parameters:
43934         - name: vnf-id2
43935           in: path
43936           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43937           required: true
43938           type: string
43939           example: __VNF-ID2__
43940         - name: interface-name
43941           in: path
43942           description: Name given to the interface
43943           required: true
43944           type: string
43945           example: __INTERFACE-NAME__
43946         - name: l3-interface-ipv4-address
43947           in: path
43948           description: IP address
43949           required: true
43950           type: string
43951           example: __L3-INTERFACE-IPV4-ADDRESS__
43952         - name: body
43953           in: body
43954           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
43955           required: true
43956           schema:
43957             $ref: "#/definitions/relationship"
43958     delete:
43959       tags:
43960         - Network
43961       summary: delete an existing relationship
43962       description: delete an existing relationship
43963       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
43964       consumes:
43965         - application/json
43966         - application/xml
43967       produces:
43968         - application/json
43969         - application/xml
43970       responses:
43971         "default":
43972           description: Response codes found in [response codes](https://wiki.onap.org/).
43973       parameters:
43974         - name: vnf-id2
43975           in: path
43976           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
43977           required: true
43978           type: string
43979           example: __VNF-ID2__
43980         - name: interface-name
43981           in: path
43982           description: Name given to the interface
43983           required: true
43984           type: string
43985           example: __INTERFACE-NAME__
43986         - name: l3-interface-ipv4-address
43987           in: path
43988           description: IP address
43989           required: true
43990           type: string
43991           example: __L3-INTERFACE-IPV4-ADDRESS__
43992   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}:
43993     get:
43994       tags:
43995         - Network
43996       summary: returns l3-interface-ipv4-address-list
43997       description: returns l3-interface-ipv4-address-list
43998       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
43999       produces:
44000         - application/json
44001         - application/xml
44002       responses:
44003         "200":
44004           description: successful operation
44005           schema:
44006               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
44007         "default":
44008           description: Response codes found in [response codes](https://wiki.onap.org/).
44009       parameters:
44010         - name: vnf-id2
44011           in: path
44012           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44013           required: true
44014           type: string
44015           example: __VNF-ID2__
44016         - name: interface-name
44017           in: path
44018           description: Name given to the interface
44019           required: true
44020           type: string
44021           example: __INTERFACE-NAME__
44022         - name: l3-interface-ipv4-address
44023           in: path
44024           description: IP address
44025           required: true
44026           type: string
44027           example: __L3-INTERFACE-IPV4-ADDRESS__
44028         - name: vnf-name
44029           in: query
44030           description: Name of VNF.
44031           required: false
44032           type: string
44033         - name: vnf-name2
44034           in: query
44035           description: Alternate name of VNF.
44036           required: false
44037           type: string
44038         - name: vnf-type
44039           in: query
44040           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.
44041           required: false
44042           type: string
44043         - name: prov-status
44044           in: query
44045           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44046           required: false
44047           type: string
44048         - name: heat-stack-id
44049           in: query
44050           description: Heat stack id corresponding to this instance, managed by MSO
44051           required: false
44052           type: string
44053         - name: interface-id
44054           in: query
44055           description: ID of interface
44056           required: false
44057           type: string
44058         - name: macaddr
44059           in: query
44060           description: MAC address for the interface
44061           required: false
44062           type: string
44063         - name: network-name
44064           in: query
44065           description: Name of the network
44066           required: false
44067           type: string
44068         - name: vlan-id-inner
44069           in: query
44070           description: Inner VLAN tag
44071           required: false
44072           type: integer
44073           format: int64
44074         - name: neutron-network-id
44075           in: query
44076           description: Neutron network id of the interface that address belongs to
44077           required: false
44078           type: string
44079         - name: neutron-subnet-id
44080           in: query
44081           description: Neutron id of subnet that address belongs to
44082           required: false
44083           type: string
44084     put:
44085       tags:
44086         - Network
44087       summary: create or update an existing l3-interface-ipv4-address-list
44088       description: |
44089         Create or update an existing l3-interface-ipv4-address-list.
44090         #
44091         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44092       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44093       consumes:
44094         - application/json
44095         - application/xml
44096       produces:
44097         - application/json
44098         - application/xml
44099       responses:
44100         "default":
44101           description: Response codes found in [response codes](https://wiki.onap.org/).
44102       parameters:
44103         - name: vnf-id2
44104           in: path
44105           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44106           required: true
44107           type: string
44108           example: __VNF-ID2__
44109         - name: interface-name
44110           in: path
44111           description: Name given to the interface
44112           required: true
44113           type: string
44114           example: __INTERFACE-NAME__
44115         - name: l3-interface-ipv4-address
44116           in: path
44117           description: IP address
44118           required: true
44119           type: string
44120           example: __L3-INTERFACE-IPV4-ADDRESS__
44121         - name: body
44122           in: body
44123           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
44124           required: true
44125           schema:
44126             $ref: "#/definitions/l3-interface-ipv4-address-list"
44127     patch:
44128       tags:
44129         - Network
44130       summary: update an existing l3-interface-ipv4-address-list
44131       description: |
44132         Update an existing l3-interface-ipv4-address-list
44133         #
44134         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44135         The PUT operation will entirely replace an existing object.
44136         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44137         #
44138         Other differences between PUT and PATCH are:
44139         #
44140         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44141         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44142         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44143       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44144       consumes:
44145         - application/json
44146         - application/xml
44147       produces:
44148         - application/json
44149         - application/xml
44150       responses:
44151         "default":
44152           description: Response codes found in [response codes](https://wiki.onap.org/).
44153       parameters:
44154         - name: vnf-id2
44155           in: path
44156           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44157           required: true
44158           type: string
44159           example: __VNF-ID2__
44160         - name: interface-name
44161           in: path
44162           description: Name given to the interface
44163           required: true
44164           type: string
44165           example: __INTERFACE-NAME__
44166         - name: l3-interface-ipv4-address
44167           in: path
44168           description: IP address
44169           required: true
44170           type: string
44171           example: __L3-INTERFACE-IPV4-ADDRESS__
44172         - name: body
44173           in: body
44174           description: l3-interface-ipv4-address-list object that needs to be created or updated.
44175           required: true
44176           schema:
44177             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
44178     delete:
44179       tags:
44180         - Network
44181       summary: delete an existing l3-interface-ipv4-address-list
44182       description: delete an existing l3-interface-ipv4-address-list
44183       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList
44184       consumes:
44185         - application/json
44186         - application/xml
44187       produces:
44188         - application/json
44189         - application/xml
44190       responses:
44191         "default":
44192           description: Response codes found in [response codes](https://wiki.onap.org/).
44193       parameters:
44194         - name: vnf-id2
44195           in: path
44196           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44197           required: true
44198           type: string
44199           example: __VNF-ID2__
44200         - name: interface-name
44201           in: path
44202           description: Name given to the interface
44203           required: true
44204           type: string
44205           example: __INTERFACE-NAME__
44206         - name: l3-interface-ipv4-address
44207           in: path
44208           description: IP address
44209           required: true
44210           type: string
44211           example: __L3-INTERFACE-IPV4-ADDRESS__
44212         - name: resource-version
44213           in: query
44214           description: resource-version for concurrency
44215           required: true
44216           type: string
44217   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship:
44218     put:
44219       tags:
44220         - Network
44221       summary: see node definition for valid relationships
44222       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
44223       consumes:
44224         - application/json
44225         - application/xml
44226       produces:
44227         - application/json
44228         - application/xml
44229       responses:
44230         "default":
44231           description: Response codes found in [response codes](https://wiki.onap.org/).
44232       parameters:
44233         - name: vnf-id2
44234           in: path
44235           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44236           required: true
44237           type: string
44238           example: __VNF-ID2__
44239         - name: interface-name
44240           in: path
44241           description: Name given to the interface
44242           required: true
44243           type: string
44244           example: __INTERFACE-NAME__
44245         - name: l3-interface-ipv6-address
44246           in: path
44247           description: IP address
44248           required: true
44249           type: string
44250           example: __L3-INTERFACE-IPV6-ADDRESS__
44251         - name: body
44252           in: body
44253           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
44254           required: true
44255           schema:
44256             $ref: "#/definitions/relationship"
44257     delete:
44258       tags:
44259         - Network
44260       summary: delete an existing relationship
44261       description: delete an existing relationship
44262       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
44263       consumes:
44264         - application/json
44265         - application/xml
44266       produces:
44267         - application/json
44268         - application/xml
44269       responses:
44270         "default":
44271           description: Response codes found in [response codes](https://wiki.onap.org/).
44272       parameters:
44273         - name: vnf-id2
44274           in: path
44275           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44276           required: true
44277           type: string
44278           example: __VNF-ID2__
44279         - name: interface-name
44280           in: path
44281           description: Name given to the interface
44282           required: true
44283           type: string
44284           example: __INTERFACE-NAME__
44285         - name: l3-interface-ipv6-address
44286           in: path
44287           description: IP address
44288           required: true
44289           type: string
44290           example: __L3-INTERFACE-IPV6-ADDRESS__
44291   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}:
44292     get:
44293       tags:
44294         - Network
44295       summary: returns l3-interface-ipv6-address-list
44296       description: returns l3-interface-ipv6-address-list
44297       operationId: getNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44298       produces:
44299         - application/json
44300         - application/xml
44301       responses:
44302         "200":
44303           description: successful operation
44304           schema:
44305               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
44306         "default":
44307           description: Response codes found in [response codes](https://wiki.onap.org/).
44308       parameters:
44309         - name: vnf-id2
44310           in: path
44311           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44312           required: true
44313           type: string
44314           example: __VNF-ID2__
44315         - name: interface-name
44316           in: path
44317           description: Name given to the interface
44318           required: true
44319           type: string
44320           example: __INTERFACE-NAME__
44321         - name: l3-interface-ipv6-address
44322           in: path
44323           description: IP address
44324           required: true
44325           type: string
44326           example: __L3-INTERFACE-IPV6-ADDRESS__
44327         - name: vnf-name
44328           in: query
44329           description: Name of VNF.
44330           required: false
44331           type: string
44332         - name: vnf-name2
44333           in: query
44334           description: Alternate name of VNF.
44335           required: false
44336           type: string
44337         - name: vnf-type
44338           in: query
44339           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.
44340           required: false
44341           type: string
44342         - name: prov-status
44343           in: query
44344           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44345           required: false
44346           type: string
44347         - name: heat-stack-id
44348           in: query
44349           description: Heat stack id corresponding to this instance, managed by MSO
44350           required: false
44351           type: string
44352         - name: interface-id
44353           in: query
44354           description: ID of interface
44355           required: false
44356           type: string
44357         - name: macaddr
44358           in: query
44359           description: MAC address for the interface
44360           required: false
44361           type: string
44362         - name: network-name
44363           in: query
44364           description: Name of the network
44365           required: false
44366           type: string
44367         - name: vlan-id-inner
44368           in: query
44369           description: Inner VLAN tag
44370           required: false
44371           type: integer
44372           format: int64
44373         - name: neutron-network-id
44374           in: query
44375           description: Neutron network id of the interface that address belongs to
44376           required: false
44377           type: string
44378         - name: neutron-subnet-id
44379           in: query
44380           description: Neutron id of subnet that address belongs to
44381           required: false
44382           type: string
44383     put:
44384       tags:
44385         - Network
44386       summary: create or update an existing l3-interface-ipv6-address-list
44387       description: |
44388         Create or update an existing l3-interface-ipv6-address-list.
44389         #
44390         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44391       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44392       consumes:
44393         - application/json
44394         - application/xml
44395       produces:
44396         - application/json
44397         - application/xml
44398       responses:
44399         "default":
44400           description: Response codes found in [response codes](https://wiki.onap.org/).
44401       parameters:
44402         - name: vnf-id2
44403           in: path
44404           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44405           required: true
44406           type: string
44407           example: __VNF-ID2__
44408         - name: interface-name
44409           in: path
44410           description: Name given to the interface
44411           required: true
44412           type: string
44413           example: __INTERFACE-NAME__
44414         - name: l3-interface-ipv6-address
44415           in: path
44416           description: IP address
44417           required: true
44418           type: string
44419           example: __L3-INTERFACE-IPV6-ADDRESS__
44420         - name: body
44421           in: body
44422           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
44423           required: true
44424           schema:
44425             $ref: "#/definitions/l3-interface-ipv6-address-list"
44426     patch:
44427       tags:
44428         - Network
44429       summary: update an existing l3-interface-ipv6-address-list
44430       description: |
44431         Update an existing l3-interface-ipv6-address-list
44432         #
44433         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44434         The PUT operation will entirely replace an existing object.
44435         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44436         #
44437         Other differences between PUT and PATCH are:
44438         #
44439         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44440         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44441         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44442       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44443       consumes:
44444         - application/json
44445         - application/xml
44446       produces:
44447         - application/json
44448         - application/xml
44449       responses:
44450         "default":
44451           description: Response codes found in [response codes](https://wiki.onap.org/).
44452       parameters:
44453         - name: vnf-id2
44454           in: path
44455           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44456           required: true
44457           type: string
44458           example: __VNF-ID2__
44459         - name: interface-name
44460           in: path
44461           description: Name given to the interface
44462           required: true
44463           type: string
44464           example: __INTERFACE-NAME__
44465         - name: l3-interface-ipv6-address
44466           in: path
44467           description: IP address
44468           required: true
44469           type: string
44470           example: __L3-INTERFACE-IPV6-ADDRESS__
44471         - name: body
44472           in: body
44473           description: l3-interface-ipv6-address-list object that needs to be created or updated.
44474           required: true
44475           schema:
44476             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
44477     delete:
44478       tags:
44479         - Network
44480       summary: delete an existing l3-interface-ipv6-address-list
44481       description: delete an existing l3-interface-ipv6-address-list
44482       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList
44483       consumes:
44484         - application/json
44485         - application/xml
44486       produces:
44487         - application/json
44488         - application/xml
44489       responses:
44490         "default":
44491           description: Response codes found in [response codes](https://wiki.onap.org/).
44492       parameters:
44493         - name: vnf-id2
44494           in: path
44495           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44496           required: true
44497           type: string
44498           example: __VNF-ID2__
44499         - name: interface-name
44500           in: path
44501           description: Name given to the interface
44502           required: true
44503           type: string
44504           example: __INTERFACE-NAME__
44505         - name: l3-interface-ipv6-address
44506           in: path
44507           description: IP address
44508           required: true
44509           type: string
44510           example: __L3-INTERFACE-IPV6-ADDRESS__
44511         - name: resource-version
44512           in: query
44513           description: resource-version for concurrency
44514           required: true
44515           type: string
44516   /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}:
44517     get:
44518       tags:
44519         - Network
44520       summary: returns l-interface
44521       description: returns l-interface
44522       operationId: getNetworkNewvcesNewvceLInterfacesLInterface
44523       produces:
44524         - application/json
44525         - application/xml
44526       responses:
44527         "200":
44528           description: successful operation
44529           schema:
44530               $ref: "#/getDefinitions/l-interface"
44531         "default":
44532           description: Response codes found in [response codes](https://wiki.onap.org/).
44533       parameters:
44534         - name: vnf-id2
44535           in: path
44536           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44537           required: true
44538           type: string
44539           example: __VNF-ID2__
44540         - name: interface-name
44541           in: path
44542           description: Name given to the interface
44543           required: true
44544           type: string
44545           example: __INTERFACE-NAME__
44546         - name: vnf-name
44547           in: query
44548           description: Name of VNF.
44549           required: false
44550           type: string
44551         - name: vnf-name2
44552           in: query
44553           description: Alternate name of VNF.
44554           required: false
44555           type: string
44556         - name: vnf-type
44557           in: query
44558           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.
44559           required: false
44560           type: string
44561         - name: prov-status
44562           in: query
44563           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44564           required: false
44565           type: string
44566         - name: heat-stack-id
44567           in: query
44568           description: Heat stack id corresponding to this instance, managed by MSO
44569           required: false
44570           type: string
44571         - name: interface-id
44572           in: query
44573           description: ID of interface
44574           required: false
44575           type: string
44576         - name: macaddr
44577           in: query
44578           description: MAC address for the interface
44579           required: false
44580           type: string
44581         - name: network-name
44582           in: query
44583           description: Name of the network
44584           required: false
44585           type: string
44586     put:
44587       tags:
44588         - Network
44589       summary: create or update an existing l-interface
44590       description: |
44591         Create or update an existing l-interface.
44592         #
44593         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44594       operationId: createOrUpdateNetworkNewvcesNewvceLInterfacesLInterface
44595       consumes:
44596         - application/json
44597         - application/xml
44598       produces:
44599         - application/json
44600         - application/xml
44601       responses:
44602         "default":
44603           description: Response codes found in [response codes](https://wiki.onap.org/).
44604       parameters:
44605         - name: vnf-id2
44606           in: path
44607           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44608           required: true
44609           type: string
44610           example: __VNF-ID2__
44611         - name: interface-name
44612           in: path
44613           description: Name given to the interface
44614           required: true
44615           type: string
44616           example: __INTERFACE-NAME__
44617         - name: body
44618           in: body
44619           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)
44620           required: true
44621           schema:
44622             $ref: "#/definitions/l-interface"
44623     patch:
44624       tags:
44625         - Network
44626       summary: update an existing l-interface
44627       description: |
44628         Update an existing l-interface
44629         #
44630         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44631         The PUT operation will entirely replace an existing object.
44632         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44633         #
44634         Other differences between PUT and PATCH are:
44635         #
44636         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44637         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44638         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44639       operationId: UpdateNetworkNewvcesNewvceLInterfacesLInterface
44640       consumes:
44641         - application/json
44642         - application/xml
44643       produces:
44644         - application/json
44645         - application/xml
44646       responses:
44647         "default":
44648           description: Response codes found in [response codes](https://wiki.onap.org/).
44649       parameters:
44650         - name: vnf-id2
44651           in: path
44652           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44653           required: true
44654           type: string
44655           example: __VNF-ID2__
44656         - name: interface-name
44657           in: path
44658           description: Name given to the interface
44659           required: true
44660           type: string
44661           example: __INTERFACE-NAME__
44662         - name: body
44663           in: body
44664           description: l-interface object that needs to be created or updated.
44665           required: true
44666           schema:
44667             $ref: "#/patchDefinitions/l-interface"
44668     delete:
44669       tags:
44670         - Network
44671       summary: delete an existing l-interface
44672       description: delete an existing l-interface
44673       operationId: deleteNetworkNewvcesNewvceLInterfacesLInterface
44674       consumes:
44675         - application/json
44676         - application/xml
44677       produces:
44678         - application/json
44679         - application/xml
44680       responses:
44681         "default":
44682           description: Response codes found in [response codes](https://wiki.onap.org/).
44683       parameters:
44684         - name: vnf-id2
44685           in: path
44686           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44687           required: true
44688           type: string
44689           example: __VNF-ID2__
44690         - name: interface-name
44691           in: path
44692           description: Name given to the interface
44693           required: true
44694           type: string
44695           example: __INTERFACE-NAME__
44696         - name: resource-version
44697           in: query
44698           description: resource-version for concurrency
44699           required: true
44700           type: string
44701   /network/newvces/newvce/{vnf-id2}/l-interfaces:
44702     get:
44703       tags:
44704         - Network
44705       summary: returns l-interfaces
44706       description: returns l-interfaces
44707       operationId: getNetworkNewvcesNewvceLInterfaces
44708       produces:
44709         - application/json
44710         - application/xml
44711       responses:
44712         "200":
44713           description: successful operation
44714           schema:
44715               $ref: "#/getDefinitions/l-interfaces"
44716         "default":
44717           description: Response codes found in [response codes](https://wiki.onap.org/).
44718       parameters:
44719         - name: vnf-id2
44720           in: path
44721           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44722           required: true
44723           type: string
44724           example: __VNF-ID2__
44725         - name: vnf-name
44726           in: query
44727           description: Name of VNF.
44728           required: false
44729           type: string
44730         - name: vnf-name2
44731           in: query
44732           description: Alternate name of VNF.
44733           required: false
44734           type: string
44735         - name: vnf-type
44736           in: query
44737           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.
44738           required: false
44739           type: string
44740         - name: prov-status
44741           in: query
44742           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44743           required: false
44744           type: string
44745         - name: heat-stack-id
44746           in: query
44747           description: Heat stack id corresponding to this instance, managed by MSO
44748           required: false
44749           type: string
44750   /network/newvces/newvce/{vnf-id2}:
44751     get:
44752       tags:
44753         - Network
44754       summary: returns newvce
44755       description: returns newvce
44756       operationId: getNetworkNewvcesNewvce
44757       produces:
44758         - application/json
44759         - application/xml
44760       responses:
44761         "200":
44762           description: successful operation
44763           schema:
44764               $ref: "#/getDefinitions/newvce"
44765         "default":
44766           description: Response codes found in [response codes](https://wiki.onap.org/).
44767       parameters:
44768         - name: vnf-id2
44769           in: path
44770           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44771           required: true
44772           type: string
44773           example: __VNF-ID2__
44774         - name: vnf-name
44775           in: query
44776           description: Name of VNF.
44777           required: false
44778           type: string
44779         - name: vnf-name2
44780           in: query
44781           description: Alternate name of VNF.
44782           required: false
44783           type: string
44784         - name: vnf-type
44785           in: query
44786           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.
44787           required: false
44788           type: string
44789         - name: prov-status
44790           in: query
44791           description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
44792           required: false
44793           type: string
44794         - name: heat-stack-id
44795           in: query
44796           description: Heat stack id corresponding to this instance, managed by MSO
44797           required: false
44798           type: string
44799     put:
44800       tags:
44801         - Network
44802       summary: create or update an existing newvce
44803       description: |
44804         Create or update an existing newvce.
44805         #
44806         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
44807       operationId: createOrUpdateNetworkNewvcesNewvce
44808       consumes:
44809         - application/json
44810         - application/xml
44811       produces:
44812         - application/json
44813         - application/xml
44814       responses:
44815         "default":
44816           description: Response codes found in [response codes](https://wiki.onap.org/).
44817       parameters:
44818         - name: vnf-id2
44819           in: path
44820           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44821           required: true
44822           type: string
44823           example: __VNF-ID2__
44824         - name: body
44825           in: body
44826           description: newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)
44827           required: true
44828           schema:
44829             $ref: "#/definitions/newvce"
44830     patch:
44831       tags:
44832         - Network
44833       summary: update an existing newvce
44834       description: |
44835         Update an existing newvce
44836         #
44837         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
44838         The PUT operation will entirely replace an existing object.
44839         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
44840         #
44841         Other differences between PUT and PATCH are:
44842         #
44843         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
44844         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
44845         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
44846       operationId: UpdateNetworkNewvcesNewvce
44847       consumes:
44848         - application/json
44849         - application/xml
44850       produces:
44851         - application/json
44852         - application/xml
44853       responses:
44854         "default":
44855           description: Response codes found in [response codes](https://wiki.onap.org/).
44856       parameters:
44857         - name: vnf-id2
44858           in: path
44859           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44860           required: true
44861           type: string
44862           example: __VNF-ID2__
44863         - name: body
44864           in: body
44865           description: newvce object that needs to be created or updated.
44866           required: true
44867           schema:
44868             $ref: "#/patchDefinitions/newvce"
44869     delete:
44870       tags:
44871         - Network
44872       summary: delete an existing newvce
44873       description: delete an existing newvce
44874       operationId: deleteNetworkNewvcesNewvce
44875       consumes:
44876         - application/json
44877         - application/xml
44878       produces:
44879         - application/json
44880         - application/xml
44881       responses:
44882         "default":
44883           description: Response codes found in [response codes](https://wiki.onap.org/).
44884       parameters:
44885         - name: vnf-id2
44886           in: path
44887           description: Unique id of VNF, can't use same attribute name right now until we promote this new object
44888           required: true
44889           type: string
44890           example: __VNF-ID2__
44891         - name: resource-version
44892           in: query
44893           description: resource-version for concurrency
44894           required: true
44895           type: string
44896   /network/newvces:
44897     get:
44898       tags:
44899         - Network
44900       summary: returns newvces
44901       description: returns newvces
44902       operationId: getNetworkNewvces
44903       produces:
44904         - application/json
44905         - application/xml
44906       responses:
44907         "200":
44908           description: successful operation
44909           schema:
44910               $ref: "#/getDefinitions/newvces"
44911         "default":
44912           description: Response codes found in [response codes](https://wiki.onap.org/).
44913   /network/pnfs/pnf/{pnf-name}/relationship-list/relationship:
44914     put:
44915       tags:
44916         - Network
44917       summary: see node definition for valid relationships
44918       operationId: createOrUpdateNetworkPnfsPnfRelationshipListRelationship
44919       consumes:
44920         - application/json
44921         - application/xml
44922       produces:
44923         - application/json
44924         - application/xml
44925       responses:
44926         "default":
44927           description: Response codes found in [response codes](https://wiki.onap.org/).
44928       parameters:
44929         - name: pnf-name
44930           in: path
44931           description: unique name of Physical Network Function.
44932           required: true
44933           type: string
44934           example: __PNF-NAME__
44935         - name: body
44936           in: body
44937           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
44938           required: true
44939           schema:
44940             $ref: "#/definitions/relationship"
44941     delete:
44942       tags:
44943         - Network
44944       summary: delete an existing relationship
44945       description: delete an existing relationship
44946       operationId: deleteNetworkPnfsPnfRelationshipListRelationship
44947       consumes:
44948         - application/json
44949         - application/xml
44950       produces:
44951         - application/json
44952         - application/xml
44953       responses:
44954         "default":
44955           description: Response codes found in [response codes](https://wiki.onap.org/).
44956       parameters:
44957         - name: pnf-name
44958           in: path
44959           description: unique name of Physical Network Function.
44960           required: true
44961           type: string
44962           example: __PNF-NAME__
44963   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship:
44964     put:
44965       tags:
44966         - Network
44967       summary: see node definition for valid relationships
44968       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
44969       consumes:
44970         - application/json
44971         - application/xml
44972       produces:
44973         - application/json
44974         - application/xml
44975       responses:
44976         "default":
44977           description: Response codes found in [response codes](https://wiki.onap.org/).
44978       parameters:
44979         - name: pnf-name
44980           in: path
44981           description: unique name of Physical Network Function.
44982           required: true
44983           type: string
44984           example: __PNF-NAME__
44985         - name: interface-name
44986           in: path
44987           description: Name that identifies the physical interface
44988           required: true
44989           type: string
44990           example: __INTERFACE-NAME__
44991         - name: body
44992           in: body
44993           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
44994           required: true
44995           schema:
44996             $ref: "#/definitions/relationship"
44997     delete:
44998       tags:
44999         - Network
45000       summary: delete an existing relationship
45001       description: delete an existing relationship
45002       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceRelationshipListRelationship
45003       consumes:
45004         - application/json
45005         - application/xml
45006       produces:
45007         - application/json
45008         - application/xml
45009       responses:
45010         "default":
45011           description: Response codes found in [response codes](https://wiki.onap.org/).
45012       parameters:
45013         - name: pnf-name
45014           in: path
45015           description: unique name of Physical Network Function.
45016           required: true
45017           type: string
45018           example: __PNF-NAME__
45019         - name: interface-name
45020           in: path
45021           description: Name that identifies the physical interface
45022           required: true
45023           type: string
45024           example: __INTERFACE-NAME__
45025   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship:
45026     put:
45027       tags:
45028         - Network
45029       summary: see node definition for valid relationships
45030       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45031       consumes:
45032         - application/json
45033         - application/xml
45034       produces:
45035         - application/json
45036         - application/xml
45037       responses:
45038         "default":
45039           description: Response codes found in [response codes](https://wiki.onap.org/).
45040       parameters:
45041         - name: pnf-name
45042           in: path
45043           description: unique name of Physical Network Function.
45044           required: true
45045           type: string
45046           example: __PNF-NAME__
45047         - name: interface-name
45048           in: path
45049           description: Name that identifies the physical interface
45050           required: true
45051           type: string
45052           example: __INTERFACE-NAME__
45053         - name: pf-pci-id
45054           in: path
45055           description: Identifier for the sriov-pf
45056           required: true
45057           type: string
45058           example: __PF-PCI-ID__
45059         - name: body
45060           in: body
45061           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45062           required: true
45063           schema:
45064             $ref: "#/definitions/relationship"
45065     delete:
45066       tags:
45067         - Network
45068       summary: delete an existing relationship
45069       description: delete an existing relationship
45070       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPfRelationshipListRelationship
45071       consumes:
45072         - application/json
45073         - application/xml
45074       produces:
45075         - application/json
45076         - application/xml
45077       responses:
45078         "default":
45079           description: Response codes found in [response codes](https://wiki.onap.org/).
45080       parameters:
45081         - name: pnf-name
45082           in: path
45083           description: unique name of Physical Network Function.
45084           required: true
45085           type: string
45086           example: __PNF-NAME__
45087         - name: interface-name
45088           in: path
45089           description: Name that identifies the physical interface
45090           required: true
45091           type: string
45092           example: __INTERFACE-NAME__
45093         - name: pf-pci-id
45094           in: path
45095           description: Identifier for the sriov-pf
45096           required: true
45097           type: string
45098           example: __PF-PCI-ID__
45099   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}:
45100     get:
45101       tags:
45102         - Network
45103       summary: returns sriov-pf
45104       description: returns sriov-pf
45105       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45106       produces:
45107         - application/json
45108         - application/xml
45109       responses:
45110         "200":
45111           description: successful operation
45112           schema:
45113               $ref: "#/getDefinitions/sriov-pf"
45114         "default":
45115           description: Response codes found in [response codes](https://wiki.onap.org/).
45116       parameters:
45117         - name: pnf-name
45118           in: path
45119           description: unique name of Physical Network Function.
45120           required: true
45121           type: string
45122           example: __PNF-NAME__
45123         - name: interface-name
45124           in: path
45125           description: Name that identifies the physical interface
45126           required: true
45127           type: string
45128           example: __INTERFACE-NAME__
45129         - name: pf-pci-id
45130           in: path
45131           description: Identifier for the sriov-pf
45132           required: true
45133           type: string
45134           example: __PF-PCI-ID__
45135         - name: inv-status
45136           in: query
45137           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45138           required: false
45139           type: string
45140         - name: prov-status
45141           in: query
45142           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45143           required: false
45144           type: string
45145     put:
45146       tags:
45147         - Network
45148       summary: create or update an existing sriov-pf
45149       description: |
45150         Create or update an existing sriov-pf.
45151         #
45152         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45153       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45154       consumes:
45155         - application/json
45156         - application/xml
45157       produces:
45158         - application/json
45159         - application/xml
45160       responses:
45161         "default":
45162           description: Response codes found in [response codes](https://wiki.onap.org/).
45163       parameters:
45164         - name: pnf-name
45165           in: path
45166           description: unique name of Physical Network Function.
45167           required: true
45168           type: string
45169           example: __PNF-NAME__
45170         - name: interface-name
45171           in: path
45172           description: Name that identifies the physical interface
45173           required: true
45174           type: string
45175           example: __INTERFACE-NAME__
45176         - name: pf-pci-id
45177           in: path
45178           description: Identifier for the sriov-pf
45179           required: true
45180           type: string
45181           example: __PF-PCI-ID__
45182         - name: body
45183           in: body
45184           description: sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)
45185           required: true
45186           schema:
45187             $ref: "#/definitions/sriov-pf"
45188     patch:
45189       tags:
45190         - Network
45191       summary: update an existing sriov-pf
45192       description: |
45193         Update an existing sriov-pf
45194         #
45195         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45196         The PUT operation will entirely replace an existing object.
45197         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45198         #
45199         Other differences between PUT and PATCH are:
45200         #
45201         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45202         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45203         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45204       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45205       consumes:
45206         - application/json
45207         - application/xml
45208       produces:
45209         - application/json
45210         - application/xml
45211       responses:
45212         "default":
45213           description: Response codes found in [response codes](https://wiki.onap.org/).
45214       parameters:
45215         - name: pnf-name
45216           in: path
45217           description: unique name of Physical Network Function.
45218           required: true
45219           type: string
45220           example: __PNF-NAME__
45221         - name: interface-name
45222           in: path
45223           description: Name that identifies the physical interface
45224           required: true
45225           type: string
45226           example: __INTERFACE-NAME__
45227         - name: pf-pci-id
45228           in: path
45229           description: Identifier for the sriov-pf
45230           required: true
45231           type: string
45232           example: __PF-PCI-ID__
45233         - name: body
45234           in: body
45235           description: sriov-pf object that needs to be created or updated.
45236           required: true
45237           schema:
45238             $ref: "#/patchDefinitions/sriov-pf"
45239     delete:
45240       tags:
45241         - Network
45242       summary: delete an existing sriov-pf
45243       description: delete an existing sriov-pf
45244       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf
45245       consumes:
45246         - application/json
45247         - application/xml
45248       produces:
45249         - application/json
45250         - application/xml
45251       responses:
45252         "default":
45253           description: Response codes found in [response codes](https://wiki.onap.org/).
45254       parameters:
45255         - name: pnf-name
45256           in: path
45257           description: unique name of Physical Network Function.
45258           required: true
45259           type: string
45260           example: __PNF-NAME__
45261         - name: interface-name
45262           in: path
45263           description: Name that identifies the physical interface
45264           required: true
45265           type: string
45266           example: __INTERFACE-NAME__
45267         - name: pf-pci-id
45268           in: path
45269           description: Identifier for the sriov-pf
45270           required: true
45271           type: string
45272           example: __PF-PCI-ID__
45273         - name: resource-version
45274           in: query
45275           description: resource-version for concurrency
45276           required: true
45277           type: string
45278   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs:
45279     get:
45280       tags:
45281         - Network
45282       summary: returns sriov-pfs
45283       description: returns sriov-pfs
45284       operationId: getNetworkPnfsPnfPInterfacesPInterfaceSriovPfs
45285       produces:
45286         - application/json
45287         - application/xml
45288       responses:
45289         "200":
45290           description: successful operation
45291           schema:
45292               $ref: "#/getDefinitions/sriov-pfs"
45293         "default":
45294           description: Response codes found in [response codes](https://wiki.onap.org/).
45295       parameters:
45296         - name: pnf-name
45297           in: path
45298           description: unique name of Physical Network Function.
45299           required: true
45300           type: string
45301           example: __PNF-NAME__
45302         - name: interface-name
45303           in: path
45304           description: Name that identifies the physical interface
45305           required: true
45306           type: string
45307           example: __INTERFACE-NAME__
45308         - name: inv-status
45309           in: query
45310           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45311           required: false
45312           type: string
45313         - name: prov-status
45314           in: query
45315           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45316           required: false
45317           type: string
45318   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
45319     put:
45320       tags:
45321         - Network
45322       summary: see node definition for valid relationships
45323       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
45324       consumes:
45325         - application/json
45326         - application/xml
45327       produces:
45328         - application/json
45329         - application/xml
45330       responses:
45331         "default":
45332           description: Response codes found in [response codes](https://wiki.onap.org/).
45333       parameters:
45334         - name: pnf-name
45335           in: path
45336           description: unique name of Physical Network Function.
45337           required: true
45338           type: string
45339           example: __PNF-NAME__
45340         - name: interface-name
45341           in: path
45342           description: Name that identifies the physical interface
45343           required: true
45344           type: string
45345           example: __INTERFACE-NAME__
45346         - name: interface-name
45347           in: path
45348           description: Name given to the interface
45349           required: true
45350           type: string
45351           example: __INTERFACE-NAME__
45352         - name: vlan-interface
45353           in: path
45354           description: String that identifies the interface
45355           required: true
45356           type: string
45357           example: __VLAN-INTERFACE__
45358         - name: body
45359           in: body
45360           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
45361           required: true
45362           schema:
45363             $ref: "#/definitions/relationship"
45364     delete:
45365       tags:
45366         - Network
45367       summary: delete an existing relationship
45368       description: delete an existing relationship
45369       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
45370       consumes:
45371         - application/json
45372         - application/xml
45373       produces:
45374         - application/json
45375         - application/xml
45376       responses:
45377         "default":
45378           description: Response codes found in [response codes](https://wiki.onap.org/).
45379       parameters:
45380         - name: pnf-name
45381           in: path
45382           description: unique name of Physical Network Function.
45383           required: true
45384           type: string
45385           example: __PNF-NAME__
45386         - name: interface-name
45387           in: path
45388           description: Name that identifies the physical interface
45389           required: true
45390           type: string
45391           example: __INTERFACE-NAME__
45392         - name: interface-name
45393           in: path
45394           description: Name given to the interface
45395           required: true
45396           type: string
45397           example: __INTERFACE-NAME__
45398         - name: vlan-interface
45399           in: path
45400           description: String that identifies the interface
45401           required: true
45402           type: string
45403           example: __VLAN-INTERFACE__
45404   /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:
45405     put:
45406       tags:
45407         - Network
45408       summary: see node definition for valid relationships
45409       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
45410       consumes:
45411         - application/json
45412         - application/xml
45413       produces:
45414         - application/json
45415         - application/xml
45416       responses:
45417         "default":
45418           description: Response codes found in [response codes](https://wiki.onap.org/).
45419       parameters:
45420         - name: pnf-name
45421           in: path
45422           description: unique name of Physical Network Function.
45423           required: true
45424           type: string
45425           example: __PNF-NAME__
45426         - name: interface-name
45427           in: path
45428           description: Name that identifies the physical interface
45429           required: true
45430           type: string
45431           example: __INTERFACE-NAME__
45432         - name: interface-name
45433           in: path
45434           description: Name given to the interface
45435           required: true
45436           type: string
45437           example: __INTERFACE-NAME__
45438         - name: vlan-interface
45439           in: path
45440           description: String that identifies the interface
45441           required: true
45442           type: string
45443           example: __VLAN-INTERFACE__
45444         - name: l3-interface-ipv4-address
45445           in: path
45446           description: IP address
45447           required: true
45448           type: string
45449           example: __L3-INTERFACE-IPV4-ADDRESS__
45450         - name: body
45451           in: body
45452           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
45453           required: true
45454           schema:
45455             $ref: "#/definitions/relationship"
45456     delete:
45457       tags:
45458         - Network
45459       summary: delete an existing relationship
45460       description: delete an existing relationship
45461       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
45462       consumes:
45463         - application/json
45464         - application/xml
45465       produces:
45466         - application/json
45467         - application/xml
45468       responses:
45469         "default":
45470           description: Response codes found in [response codes](https://wiki.onap.org/).
45471       parameters:
45472         - name: pnf-name
45473           in: path
45474           description: unique name of Physical Network Function.
45475           required: true
45476           type: string
45477           example: __PNF-NAME__
45478         - name: interface-name
45479           in: path
45480           description: Name that identifies the physical interface
45481           required: true
45482           type: string
45483           example: __INTERFACE-NAME__
45484         - name: interface-name
45485           in: path
45486           description: Name given to the interface
45487           required: true
45488           type: string
45489           example: __INTERFACE-NAME__
45490         - name: vlan-interface
45491           in: path
45492           description: String that identifies the interface
45493           required: true
45494           type: string
45495           example: __VLAN-INTERFACE__
45496         - name: l3-interface-ipv4-address
45497           in: path
45498           description: IP address
45499           required: true
45500           type: string
45501           example: __L3-INTERFACE-IPV4-ADDRESS__
45502   /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}:
45503     get:
45504       tags:
45505         - Network
45506       summary: returns l3-interface-ipv4-address-list
45507       description: returns l3-interface-ipv4-address-list
45508       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45509       produces:
45510         - application/json
45511         - application/xml
45512       responses:
45513         "200":
45514           description: successful operation
45515           schema:
45516               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
45517         "default":
45518           description: Response codes found in [response codes](https://wiki.onap.org/).
45519       parameters:
45520         - name: pnf-name
45521           in: path
45522           description: unique name of Physical Network Function.
45523           required: true
45524           type: string
45525           example: __PNF-NAME__
45526         - name: interface-name
45527           in: path
45528           description: Name that identifies the physical interface
45529           required: true
45530           type: string
45531           example: __INTERFACE-NAME__
45532         - name: interface-name
45533           in: path
45534           description: Name given to the interface
45535           required: true
45536           type: string
45537           example: __INTERFACE-NAME__
45538         - name: vlan-interface
45539           in: path
45540           description: String that identifies the interface
45541           required: true
45542           type: string
45543           example: __VLAN-INTERFACE__
45544         - name: l3-interface-ipv4-address
45545           in: path
45546           description: IP address
45547           required: true
45548           type: string
45549           example: __L3-INTERFACE-IPV4-ADDRESS__
45550         - name: inv-status
45551           in: query
45552           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45553           required: false
45554           type: string
45555         - name: prov-status
45556           in: query
45557           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45558           required: false
45559           type: string
45560         - name: interface-id
45561           in: query
45562           description: ID of interface
45563           required: false
45564           type: string
45565         - name: macaddr
45566           in: query
45567           description: MAC address for the interface
45568           required: false
45569           type: string
45570         - name: network-name
45571           in: query
45572           description: Name of the network
45573           required: false
45574           type: string
45575         - name: vlan-id-inner
45576           in: query
45577           description: Inner VLAN tag
45578           required: false
45579           type: integer
45580           format: int64
45581         - name: vpn-key
45582           in: query
45583           description: This indicates the customers VPN ID associated with this vlan
45584           required: false
45585           type: string
45586         - name: vlan-id-inner
45587           in: query
45588           description: Inner VLAN tag
45589           required: false
45590           type: integer
45591           format: int64
45592         - name: neutron-network-id
45593           in: query
45594           description: Neutron network id of the interface that address belongs to
45595           required: false
45596           type: string
45597         - name: neutron-subnet-id
45598           in: query
45599           description: Neutron id of subnet that address belongs to
45600           required: false
45601           type: string
45602     put:
45603       tags:
45604         - Network
45605       summary: create or update an existing l3-interface-ipv4-address-list
45606       description: |
45607         Create or update an existing l3-interface-ipv4-address-list.
45608         #
45609         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45610       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45611       consumes:
45612         - application/json
45613         - application/xml
45614       produces:
45615         - application/json
45616         - application/xml
45617       responses:
45618         "default":
45619           description: Response codes found in [response codes](https://wiki.onap.org/).
45620       parameters:
45621         - name: pnf-name
45622           in: path
45623           description: unique name of Physical Network Function.
45624           required: true
45625           type: string
45626           example: __PNF-NAME__
45627         - name: interface-name
45628           in: path
45629           description: Name that identifies the physical interface
45630           required: true
45631           type: string
45632           example: __INTERFACE-NAME__
45633         - name: interface-name
45634           in: path
45635           description: Name given to the interface
45636           required: true
45637           type: string
45638           example: __INTERFACE-NAME__
45639         - name: vlan-interface
45640           in: path
45641           description: String that identifies the interface
45642           required: true
45643           type: string
45644           example: __VLAN-INTERFACE__
45645         - name: l3-interface-ipv4-address
45646           in: path
45647           description: IP address
45648           required: true
45649           type: string
45650           example: __L3-INTERFACE-IPV4-ADDRESS__
45651         - name: body
45652           in: body
45653           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
45654           required: true
45655           schema:
45656             $ref: "#/definitions/l3-interface-ipv4-address-list"
45657     patch:
45658       tags:
45659         - Network
45660       summary: update an existing l3-interface-ipv4-address-list
45661       description: |
45662         Update an existing l3-interface-ipv4-address-list
45663         #
45664         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
45665         The PUT operation will entirely replace an existing object.
45666         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
45667         #
45668         Other differences between PUT and PATCH are:
45669         #
45670         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
45671         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
45672         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
45673       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45674       consumes:
45675         - application/json
45676         - application/xml
45677       produces:
45678         - application/json
45679         - application/xml
45680       responses:
45681         "default":
45682           description: Response codes found in [response codes](https://wiki.onap.org/).
45683       parameters:
45684         - name: pnf-name
45685           in: path
45686           description: unique name of Physical Network Function.
45687           required: true
45688           type: string
45689           example: __PNF-NAME__
45690         - name: interface-name
45691           in: path
45692           description: Name that identifies the physical interface
45693           required: true
45694           type: string
45695           example: __INTERFACE-NAME__
45696         - name: interface-name
45697           in: path
45698           description: Name given to the interface
45699           required: true
45700           type: string
45701           example: __INTERFACE-NAME__
45702         - name: vlan-interface
45703           in: path
45704           description: String that identifies the interface
45705           required: true
45706           type: string
45707           example: __VLAN-INTERFACE__
45708         - name: l3-interface-ipv4-address
45709           in: path
45710           description: IP address
45711           required: true
45712           type: string
45713           example: __L3-INTERFACE-IPV4-ADDRESS__
45714         - name: body
45715           in: body
45716           description: l3-interface-ipv4-address-list object that needs to be created or updated.
45717           required: true
45718           schema:
45719             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
45720     delete:
45721       tags:
45722         - Network
45723       summary: delete an existing l3-interface-ipv4-address-list
45724       description: delete an existing l3-interface-ipv4-address-list
45725       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
45726       consumes:
45727         - application/json
45728         - application/xml
45729       produces:
45730         - application/json
45731         - application/xml
45732       responses:
45733         "default":
45734           description: Response codes found in [response codes](https://wiki.onap.org/).
45735       parameters:
45736         - name: pnf-name
45737           in: path
45738           description: unique name of Physical Network Function.
45739           required: true
45740           type: string
45741           example: __PNF-NAME__
45742         - name: interface-name
45743           in: path
45744           description: Name that identifies the physical interface
45745           required: true
45746           type: string
45747           example: __INTERFACE-NAME__
45748         - name: interface-name
45749           in: path
45750           description: Name given to the interface
45751           required: true
45752           type: string
45753           example: __INTERFACE-NAME__
45754         - name: vlan-interface
45755           in: path
45756           description: String that identifies the interface
45757           required: true
45758           type: string
45759           example: __VLAN-INTERFACE__
45760         - name: l3-interface-ipv4-address
45761           in: path
45762           description: IP address
45763           required: true
45764           type: string
45765           example: __L3-INTERFACE-IPV4-ADDRESS__
45766         - name: resource-version
45767           in: query
45768           description: resource-version for concurrency
45769           required: true
45770           type: string
45771   /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:
45772     put:
45773       tags:
45774         - Network
45775       summary: see node definition for valid relationships
45776       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
45777       consumes:
45778         - application/json
45779         - application/xml
45780       produces:
45781         - application/json
45782         - application/xml
45783       responses:
45784         "default":
45785           description: Response codes found in [response codes](https://wiki.onap.org/).
45786       parameters:
45787         - name: pnf-name
45788           in: path
45789           description: unique name of Physical Network Function.
45790           required: true
45791           type: string
45792           example: __PNF-NAME__
45793         - name: interface-name
45794           in: path
45795           description: Name that identifies the physical interface
45796           required: true
45797           type: string
45798           example: __INTERFACE-NAME__
45799         - name: interface-name
45800           in: path
45801           description: Name given to the interface
45802           required: true
45803           type: string
45804           example: __INTERFACE-NAME__
45805         - name: vlan-interface
45806           in: path
45807           description: String that identifies the interface
45808           required: true
45809           type: string
45810           example: __VLAN-INTERFACE__
45811         - name: l3-interface-ipv6-address
45812           in: path
45813           description: IP address
45814           required: true
45815           type: string
45816           example: __L3-INTERFACE-IPV6-ADDRESS__
45817         - name: body
45818           in: body
45819           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
45820           required: true
45821           schema:
45822             $ref: "#/definitions/relationship"
45823     delete:
45824       tags:
45825         - Network
45826       summary: delete an existing relationship
45827       description: delete an existing relationship
45828       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
45829       consumes:
45830         - application/json
45831         - application/xml
45832       produces:
45833         - application/json
45834         - application/xml
45835       responses:
45836         "default":
45837           description: Response codes found in [response codes](https://wiki.onap.org/).
45838       parameters:
45839         - name: pnf-name
45840           in: path
45841           description: unique name of Physical Network Function.
45842           required: true
45843           type: string
45844           example: __PNF-NAME__
45845         - name: interface-name
45846           in: path
45847           description: Name that identifies the physical interface
45848           required: true
45849           type: string
45850           example: __INTERFACE-NAME__
45851         - name: interface-name
45852           in: path
45853           description: Name given to the interface
45854           required: true
45855           type: string
45856           example: __INTERFACE-NAME__
45857         - name: vlan-interface
45858           in: path
45859           description: String that identifies the interface
45860           required: true
45861           type: string
45862           example: __VLAN-INTERFACE__
45863         - name: l3-interface-ipv6-address
45864           in: path
45865           description: IP address
45866           required: true
45867           type: string
45868           example: __L3-INTERFACE-IPV6-ADDRESS__
45869   /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}:
45870     get:
45871       tags:
45872         - Network
45873       summary: returns l3-interface-ipv6-address-list
45874       description: returns l3-interface-ipv6-address-list
45875       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45876       produces:
45877         - application/json
45878         - application/xml
45879       responses:
45880         "200":
45881           description: successful operation
45882           schema:
45883               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
45884         "default":
45885           description: Response codes found in [response codes](https://wiki.onap.org/).
45886       parameters:
45887         - name: pnf-name
45888           in: path
45889           description: unique name of Physical Network Function.
45890           required: true
45891           type: string
45892           example: __PNF-NAME__
45893         - name: interface-name
45894           in: path
45895           description: Name that identifies the physical interface
45896           required: true
45897           type: string
45898           example: __INTERFACE-NAME__
45899         - name: interface-name
45900           in: path
45901           description: Name given to the interface
45902           required: true
45903           type: string
45904           example: __INTERFACE-NAME__
45905         - name: vlan-interface
45906           in: path
45907           description: String that identifies the interface
45908           required: true
45909           type: string
45910           example: __VLAN-INTERFACE__
45911         - name: l3-interface-ipv6-address
45912           in: path
45913           description: IP address
45914           required: true
45915           type: string
45916           example: __L3-INTERFACE-IPV6-ADDRESS__
45917         - name: inv-status
45918           in: query
45919           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
45920           required: false
45921           type: string
45922         - name: prov-status
45923           in: query
45924           description: Trigger for operational monitoring of this resource by Service Assurance systems.
45925           required: false
45926           type: string
45927         - name: interface-id
45928           in: query
45929           description: ID of interface
45930           required: false
45931           type: string
45932         - name: macaddr
45933           in: query
45934           description: MAC address for the interface
45935           required: false
45936           type: string
45937         - name: network-name
45938           in: query
45939           description: Name of the network
45940           required: false
45941           type: string
45942         - name: vlan-id-inner
45943           in: query
45944           description: Inner VLAN tag
45945           required: false
45946           type: integer
45947           format: int64
45948         - name: vpn-key
45949           in: query
45950           description: This indicates the customers VPN ID associated with this vlan
45951           required: false
45952           type: string
45953         - name: vlan-id-inner
45954           in: query
45955           description: Inner VLAN tag
45956           required: false
45957           type: integer
45958           format: int64
45959         - name: neutron-network-id
45960           in: query
45961           description: Neutron network id of the interface that address belongs to
45962           required: false
45963           type: string
45964         - name: neutron-subnet-id
45965           in: query
45966           description: Neutron id of subnet that address belongs to
45967           required: false
45968           type: string
45969     put:
45970       tags:
45971         - Network
45972       summary: create or update an existing l3-interface-ipv6-address-list
45973       description: |
45974         Create or update an existing l3-interface-ipv6-address-list.
45975         #
45976         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
45977       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
45978       consumes:
45979         - application/json
45980         - application/xml
45981       produces:
45982         - application/json
45983         - application/xml
45984       responses:
45985         "default":
45986           description: Response codes found in [response codes](https://wiki.onap.org/).
45987       parameters:
45988         - name: pnf-name
45989           in: path
45990           description: unique name of Physical Network Function.
45991           required: true
45992           type: string
45993           example: __PNF-NAME__
45994         - name: interface-name
45995           in: path
45996           description: Name that identifies the physical interface
45997           required: true
45998           type: string
45999           example: __INTERFACE-NAME__
46000         - name: interface-name
46001           in: path
46002           description: Name given to the interface
46003           required: true
46004           type: string
46005           example: __INTERFACE-NAME__
46006         - name: vlan-interface
46007           in: path
46008           description: String that identifies the interface
46009           required: true
46010           type: string
46011           example: __VLAN-INTERFACE__
46012         - name: l3-interface-ipv6-address
46013           in: path
46014           description: IP address
46015           required: true
46016           type: string
46017           example: __L3-INTERFACE-IPV6-ADDRESS__
46018         - name: body
46019           in: body
46020           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
46021           required: true
46022           schema:
46023             $ref: "#/definitions/l3-interface-ipv6-address-list"
46024     patch:
46025       tags:
46026         - Network
46027       summary: update an existing l3-interface-ipv6-address-list
46028       description: |
46029         Update an existing l3-interface-ipv6-address-list
46030         #
46031         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46032         The PUT operation will entirely replace an existing object.
46033         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46034         #
46035         Other differences between PUT and PATCH are:
46036         #
46037         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46038         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46039         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46040       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46041       consumes:
46042         - application/json
46043         - application/xml
46044       produces:
46045         - application/json
46046         - application/xml
46047       responses:
46048         "default":
46049           description: Response codes found in [response codes](https://wiki.onap.org/).
46050       parameters:
46051         - name: pnf-name
46052           in: path
46053           description: unique name of Physical Network Function.
46054           required: true
46055           type: string
46056           example: __PNF-NAME__
46057         - name: interface-name
46058           in: path
46059           description: Name that identifies the physical interface
46060           required: true
46061           type: string
46062           example: __INTERFACE-NAME__
46063         - name: interface-name
46064           in: path
46065           description: Name given to the interface
46066           required: true
46067           type: string
46068           example: __INTERFACE-NAME__
46069         - name: vlan-interface
46070           in: path
46071           description: String that identifies the interface
46072           required: true
46073           type: string
46074           example: __VLAN-INTERFACE__
46075         - name: l3-interface-ipv6-address
46076           in: path
46077           description: IP address
46078           required: true
46079           type: string
46080           example: __L3-INTERFACE-IPV6-ADDRESS__
46081         - name: body
46082           in: body
46083           description: l3-interface-ipv6-address-list object that needs to be created or updated.
46084           required: true
46085           schema:
46086             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
46087     delete:
46088       tags:
46089         - Network
46090       summary: delete an existing l3-interface-ipv6-address-list
46091       description: delete an existing l3-interface-ipv6-address-list
46092       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
46093       consumes:
46094         - application/json
46095         - application/xml
46096       produces:
46097         - application/json
46098         - application/xml
46099       responses:
46100         "default":
46101           description: Response codes found in [response codes](https://wiki.onap.org/).
46102       parameters:
46103         - name: pnf-name
46104           in: path
46105           description: unique name of Physical Network Function.
46106           required: true
46107           type: string
46108           example: __PNF-NAME__
46109         - name: interface-name
46110           in: path
46111           description: Name that identifies the physical interface
46112           required: true
46113           type: string
46114           example: __INTERFACE-NAME__
46115         - name: interface-name
46116           in: path
46117           description: Name given to the interface
46118           required: true
46119           type: string
46120           example: __INTERFACE-NAME__
46121         - name: vlan-interface
46122           in: path
46123           description: String that identifies the interface
46124           required: true
46125           type: string
46126           example: __VLAN-INTERFACE__
46127         - name: l3-interface-ipv6-address
46128           in: path
46129           description: IP address
46130           required: true
46131           type: string
46132           example: __L3-INTERFACE-IPV6-ADDRESS__
46133         - name: resource-version
46134           in: query
46135           description: resource-version for concurrency
46136           required: true
46137           type: string
46138   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
46139     get:
46140       tags:
46141         - Network
46142       summary: returns vlan
46143       description: returns vlan
46144       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46145       produces:
46146         - application/json
46147         - application/xml
46148       responses:
46149         "200":
46150           description: successful operation
46151           schema:
46152               $ref: "#/getDefinitions/vlan"
46153         "default":
46154           description: Response codes found in [response codes](https://wiki.onap.org/).
46155       parameters:
46156         - name: pnf-name
46157           in: path
46158           description: unique name of Physical Network Function.
46159           required: true
46160           type: string
46161           example: __PNF-NAME__
46162         - name: interface-name
46163           in: path
46164           description: Name that identifies the physical interface
46165           required: true
46166           type: string
46167           example: __INTERFACE-NAME__
46168         - name: interface-name
46169           in: path
46170           description: Name given to the interface
46171           required: true
46172           type: string
46173           example: __INTERFACE-NAME__
46174         - name: vlan-interface
46175           in: path
46176           description: String that identifies the interface
46177           required: true
46178           type: string
46179           example: __VLAN-INTERFACE__
46180         - name: inv-status
46181           in: query
46182           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46183           required: false
46184           type: string
46185         - name: prov-status
46186           in: query
46187           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46188           required: false
46189           type: string
46190         - name: interface-id
46191           in: query
46192           description: ID of interface
46193           required: false
46194           type: string
46195         - name: macaddr
46196           in: query
46197           description: MAC address for the interface
46198           required: false
46199           type: string
46200         - name: network-name
46201           in: query
46202           description: Name of the network
46203           required: false
46204           type: string
46205         - name: vlan-id-inner
46206           in: query
46207           description: Inner VLAN tag
46208           required: false
46209           type: integer
46210           format: int64
46211         - name: vpn-key
46212           in: query
46213           description: This indicates the customers VPN ID associated with this vlan
46214           required: false
46215           type: string
46216     put:
46217       tags:
46218         - Network
46219       summary: create or update an existing vlan
46220       description: |
46221         Create or update an existing vlan.
46222         #
46223         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46224       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46225       consumes:
46226         - application/json
46227         - application/xml
46228       produces:
46229         - application/json
46230         - application/xml
46231       responses:
46232         "default":
46233           description: Response codes found in [response codes](https://wiki.onap.org/).
46234       parameters:
46235         - name: pnf-name
46236           in: path
46237           description: unique name of Physical Network Function.
46238           required: true
46239           type: string
46240           example: __PNF-NAME__
46241         - name: interface-name
46242           in: path
46243           description: Name that identifies the physical interface
46244           required: true
46245           type: string
46246           example: __INTERFACE-NAME__
46247         - name: interface-name
46248           in: path
46249           description: Name given to the interface
46250           required: true
46251           type: string
46252           example: __INTERFACE-NAME__
46253         - name: vlan-interface
46254           in: path
46255           description: String that identifies the interface
46256           required: true
46257           type: string
46258           example: __VLAN-INTERFACE__
46259         - name: body
46260           in: body
46261           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)
46262           required: true
46263           schema:
46264             $ref: "#/definitions/vlan"
46265     patch:
46266       tags:
46267         - Network
46268       summary: update an existing vlan
46269       description: |
46270         Update an existing vlan
46271         #
46272         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46273         The PUT operation will entirely replace an existing object.
46274         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46275         #
46276         Other differences between PUT and PATCH are:
46277         #
46278         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46279         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46280         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46281       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46282       consumes:
46283         - application/json
46284         - application/xml
46285       produces:
46286         - application/json
46287         - application/xml
46288       responses:
46289         "default":
46290           description: Response codes found in [response codes](https://wiki.onap.org/).
46291       parameters:
46292         - name: pnf-name
46293           in: path
46294           description: unique name of Physical Network Function.
46295           required: true
46296           type: string
46297           example: __PNF-NAME__
46298         - name: interface-name
46299           in: path
46300           description: Name that identifies the physical interface
46301           required: true
46302           type: string
46303           example: __INTERFACE-NAME__
46304         - name: interface-name
46305           in: path
46306           description: Name given to the interface
46307           required: true
46308           type: string
46309           example: __INTERFACE-NAME__
46310         - name: vlan-interface
46311           in: path
46312           description: String that identifies the interface
46313           required: true
46314           type: string
46315           example: __VLAN-INTERFACE__
46316         - name: body
46317           in: body
46318           description: vlan object that needs to be created or updated.
46319           required: true
46320           schema:
46321             $ref: "#/patchDefinitions/vlan"
46322     delete:
46323       tags:
46324         - Network
46325       summary: delete an existing vlan
46326       description: delete an existing vlan
46327       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan
46328       consumes:
46329         - application/json
46330         - application/xml
46331       produces:
46332         - application/json
46333         - application/xml
46334       responses:
46335         "default":
46336           description: Response codes found in [response codes](https://wiki.onap.org/).
46337       parameters:
46338         - name: pnf-name
46339           in: path
46340           description: unique name of Physical Network Function.
46341           required: true
46342           type: string
46343           example: __PNF-NAME__
46344         - name: interface-name
46345           in: path
46346           description: Name that identifies the physical interface
46347           required: true
46348           type: string
46349           example: __INTERFACE-NAME__
46350         - name: interface-name
46351           in: path
46352           description: Name given to the interface
46353           required: true
46354           type: string
46355           example: __INTERFACE-NAME__
46356         - name: vlan-interface
46357           in: path
46358           description: String that identifies the interface
46359           required: true
46360           type: string
46361           example: __VLAN-INTERFACE__
46362         - name: resource-version
46363           in: query
46364           description: resource-version for concurrency
46365           required: true
46366           type: string
46367   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
46368     get:
46369       tags:
46370         - Network
46371       summary: returns vlans
46372       description: returns vlans
46373       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlans
46374       produces:
46375         - application/json
46376         - application/xml
46377       responses:
46378         "200":
46379           description: successful operation
46380           schema:
46381               $ref: "#/getDefinitions/vlans"
46382         "default":
46383           description: Response codes found in [response codes](https://wiki.onap.org/).
46384       parameters:
46385         - name: pnf-name
46386           in: path
46387           description: unique name of Physical Network Function.
46388           required: true
46389           type: string
46390           example: __PNF-NAME__
46391         - name: interface-name
46392           in: path
46393           description: Name that identifies the physical interface
46394           required: true
46395           type: string
46396           example: __INTERFACE-NAME__
46397         - name: interface-name
46398           in: path
46399           description: Name given to the interface
46400           required: true
46401           type: string
46402           example: __INTERFACE-NAME__
46403         - name: inv-status
46404           in: query
46405           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46406           required: false
46407           type: string
46408         - name: prov-status
46409           in: query
46410           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46411           required: false
46412           type: string
46413         - name: interface-id
46414           in: query
46415           description: ID of interface
46416           required: false
46417           type: string
46418         - name: macaddr
46419           in: query
46420           description: MAC address for the interface
46421           required: false
46422           type: string
46423         - name: network-name
46424           in: query
46425           description: Name of the network
46426           required: false
46427           type: string
46428   /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:
46429     put:
46430       tags:
46431         - Network
46432       summary: see node definition for valid relationships
46433       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
46434       consumes:
46435         - application/json
46436         - application/xml
46437       produces:
46438         - application/json
46439         - application/xml
46440       responses:
46441         "default":
46442           description: Response codes found in [response codes](https://wiki.onap.org/).
46443       parameters:
46444         - name: pnf-name
46445           in: path
46446           description: unique name of Physical Network Function.
46447           required: true
46448           type: string
46449           example: __PNF-NAME__
46450         - name: interface-name
46451           in: path
46452           description: Name that identifies the physical interface
46453           required: true
46454           type: string
46455           example: __INTERFACE-NAME__
46456         - name: interface-name
46457           in: path
46458           description: Name given to the interface
46459           required: true
46460           type: string
46461           example: __INTERFACE-NAME__
46462         - name: pci-id
46463           in: path
46464           description: PCI ID used to identify the sriov-vf
46465           required: true
46466           type: string
46467           example: __PCI-ID__
46468         - name: body
46469           in: body
46470           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
46471           required: true
46472           schema:
46473             $ref: "#/definitions/relationship"
46474     delete:
46475       tags:
46476         - Network
46477       summary: delete an existing relationship
46478       description: delete an existing relationship
46479       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
46480       consumes:
46481         - application/json
46482         - application/xml
46483       produces:
46484         - application/json
46485         - application/xml
46486       responses:
46487         "default":
46488           description: Response codes found in [response codes](https://wiki.onap.org/).
46489       parameters:
46490         - name: pnf-name
46491           in: path
46492           description: unique name of Physical Network Function.
46493           required: true
46494           type: string
46495           example: __PNF-NAME__
46496         - name: interface-name
46497           in: path
46498           description: Name that identifies the physical interface
46499           required: true
46500           type: string
46501           example: __INTERFACE-NAME__
46502         - name: interface-name
46503           in: path
46504           description: Name given to the interface
46505           required: true
46506           type: string
46507           example: __INTERFACE-NAME__
46508         - name: pci-id
46509           in: path
46510           description: PCI ID used to identify the sriov-vf
46511           required: true
46512           type: string
46513           example: __PCI-ID__
46514   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
46515     get:
46516       tags:
46517         - Network
46518       summary: returns sriov-vf
46519       description: returns sriov-vf
46520       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46521       produces:
46522         - application/json
46523         - application/xml
46524       responses:
46525         "200":
46526           description: successful operation
46527           schema:
46528               $ref: "#/getDefinitions/sriov-vf"
46529         "default":
46530           description: Response codes found in [response codes](https://wiki.onap.org/).
46531       parameters:
46532         - name: pnf-name
46533           in: path
46534           description: unique name of Physical Network Function.
46535           required: true
46536           type: string
46537           example: __PNF-NAME__
46538         - name: interface-name
46539           in: path
46540           description: Name that identifies the physical interface
46541           required: true
46542           type: string
46543           example: __INTERFACE-NAME__
46544         - name: interface-name
46545           in: path
46546           description: Name given to the interface
46547           required: true
46548           type: string
46549           example: __INTERFACE-NAME__
46550         - name: pci-id
46551           in: path
46552           description: PCI ID used to identify the sriov-vf
46553           required: true
46554           type: string
46555           example: __PCI-ID__
46556         - name: inv-status
46557           in: query
46558           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46559           required: false
46560           type: string
46561         - name: prov-status
46562           in: query
46563           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46564           required: false
46565           type: string
46566         - name: interface-id
46567           in: query
46568           description: ID of interface
46569           required: false
46570           type: string
46571         - name: macaddr
46572           in: query
46573           description: MAC address for the interface
46574           required: false
46575           type: string
46576         - name: network-name
46577           in: query
46578           description: Name of the network
46579           required: false
46580           type: string
46581         - name: vf-vlan-filter
46582           in: query
46583           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
46584           required: false
46585           type: string
46586         - name: vf-mac-filter
46587           in: query
46588           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
46589           required: false
46590           type: string
46591         - name: vf-vlan-strip
46592           in: query
46593           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
46594           required: false
46595           type: boolean
46596         - name: neutron-network-id
46597           in: query
46598           description: Neutron network id of the interface
46599           required: false
46600           type: string
46601     put:
46602       tags:
46603         - Network
46604       summary: create or update an existing sriov-vf
46605       description: |
46606         Create or update an existing sriov-vf.
46607         #
46608         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
46609       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46610       consumes:
46611         - application/json
46612         - application/xml
46613       produces:
46614         - application/json
46615         - application/xml
46616       responses:
46617         "default":
46618           description: Response codes found in [response codes](https://wiki.onap.org/).
46619       parameters:
46620         - name: pnf-name
46621           in: path
46622           description: unique name of Physical Network Function.
46623           required: true
46624           type: string
46625           example: __PNF-NAME__
46626         - name: interface-name
46627           in: path
46628           description: Name that identifies the physical interface
46629           required: true
46630           type: string
46631           example: __INTERFACE-NAME__
46632         - name: interface-name
46633           in: path
46634           description: Name given to the interface
46635           required: true
46636           type: string
46637           example: __INTERFACE-NAME__
46638         - name: pci-id
46639           in: path
46640           description: PCI ID used to identify the sriov-vf
46641           required: true
46642           type: string
46643           example: __PCI-ID__
46644         - name: body
46645           in: body
46646           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
46647           required: true
46648           schema:
46649             $ref: "#/definitions/sriov-vf"
46650     patch:
46651       tags:
46652         - Network
46653       summary: update an existing sriov-vf
46654       description: |
46655         Update an existing sriov-vf
46656         #
46657         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
46658         The PUT operation will entirely replace an existing object.
46659         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
46660         #
46661         Other differences between PUT and PATCH are:
46662         #
46663         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
46664         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
46665         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
46666       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46667       consumes:
46668         - application/json
46669         - application/xml
46670       produces:
46671         - application/json
46672         - application/xml
46673       responses:
46674         "default":
46675           description: Response codes found in [response codes](https://wiki.onap.org/).
46676       parameters:
46677         - name: pnf-name
46678           in: path
46679           description: unique name of Physical Network Function.
46680           required: true
46681           type: string
46682           example: __PNF-NAME__
46683         - name: interface-name
46684           in: path
46685           description: Name that identifies the physical interface
46686           required: true
46687           type: string
46688           example: __INTERFACE-NAME__
46689         - name: interface-name
46690           in: path
46691           description: Name given to the interface
46692           required: true
46693           type: string
46694           example: __INTERFACE-NAME__
46695         - name: pci-id
46696           in: path
46697           description: PCI ID used to identify the sriov-vf
46698           required: true
46699           type: string
46700           example: __PCI-ID__
46701         - name: body
46702           in: body
46703           description: sriov-vf object that needs to be created or updated.
46704           required: true
46705           schema:
46706             $ref: "#/patchDefinitions/sriov-vf"
46707     delete:
46708       tags:
46709         - Network
46710       summary: delete an existing sriov-vf
46711       description: delete an existing sriov-vf
46712       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf
46713       consumes:
46714         - application/json
46715         - application/xml
46716       produces:
46717         - application/json
46718         - application/xml
46719       responses:
46720         "default":
46721           description: Response codes found in [response codes](https://wiki.onap.org/).
46722       parameters:
46723         - name: pnf-name
46724           in: path
46725           description: unique name of Physical Network Function.
46726           required: true
46727           type: string
46728           example: __PNF-NAME__
46729         - name: interface-name
46730           in: path
46731           description: Name that identifies the physical interface
46732           required: true
46733           type: string
46734           example: __INTERFACE-NAME__
46735         - name: interface-name
46736           in: path
46737           description: Name given to the interface
46738           required: true
46739           type: string
46740           example: __INTERFACE-NAME__
46741         - name: pci-id
46742           in: path
46743           description: PCI ID used to identify the sriov-vf
46744           required: true
46745           type: string
46746           example: __PCI-ID__
46747         - name: resource-version
46748           in: query
46749           description: resource-version for concurrency
46750           required: true
46751           type: string
46752   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
46753     get:
46754       tags:
46755         - Network
46756       summary: returns sriov-vfs
46757       description: returns sriov-vfs
46758       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfs
46759       produces:
46760         - application/json
46761         - application/xml
46762       responses:
46763         "200":
46764           description: successful operation
46765           schema:
46766               $ref: "#/getDefinitions/sriov-vfs"
46767         "default":
46768           description: Response codes found in [response codes](https://wiki.onap.org/).
46769       parameters:
46770         - name: pnf-name
46771           in: path
46772           description: unique name of Physical Network Function.
46773           required: true
46774           type: string
46775           example: __PNF-NAME__
46776         - name: interface-name
46777           in: path
46778           description: Name that identifies the physical interface
46779           required: true
46780           type: string
46781           example: __INTERFACE-NAME__
46782         - name: interface-name
46783           in: path
46784           description: Name given to the interface
46785           required: true
46786           type: string
46787           example: __INTERFACE-NAME__
46788         - name: inv-status
46789           in: query
46790           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
46791           required: false
46792           type: string
46793         - name: prov-status
46794           in: query
46795           description: Trigger for operational monitoring of this resource by Service Assurance systems.
46796           required: false
46797           type: string
46798         - name: interface-id
46799           in: query
46800           description: ID of interface
46801           required: false
46802           type: string
46803         - name: macaddr
46804           in: query
46805           description: MAC address for the interface
46806           required: false
46807           type: string
46808         - name: network-name
46809           in: query
46810           description: Name of the network
46811           required: false
46812           type: string
46813   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
46814     put:
46815       tags:
46816         - Network
46817       summary: see node definition for valid relationships
46818       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
46819       consumes:
46820         - application/json
46821         - application/xml
46822       produces:
46823         - application/json
46824         - application/xml
46825       responses:
46826         "default":
46827           description: Response codes found in [response codes](https://wiki.onap.org/).
46828       parameters:
46829         - name: pnf-name
46830           in: path
46831           description: unique name of Physical Network Function.
46832           required: true
46833           type: string
46834           example: __PNF-NAME__
46835         - name: interface-name
46836           in: path
46837           description: Name that identifies the physical interface
46838           required: true
46839           type: string
46840           example: __INTERFACE-NAME__
46841         - name: interface-name
46842           in: path
46843           description: Name given to the interface
46844           required: true
46845           type: string
46846           example: __INTERFACE-NAME__
46847         - name: body
46848           in: body
46849           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
46850           required: true
46851           schema:
46852             $ref: "#/definitions/relationship"
46853     delete:
46854       tags:
46855         - Network
46856       summary: delete an existing relationship
46857       description: delete an existing relationship
46858       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceRelationshipListRelationship
46859       consumes:
46860         - application/json
46861         - application/xml
46862       produces:
46863         - application/json
46864         - application/xml
46865       responses:
46866         "default":
46867           description: Response codes found in [response codes](https://wiki.onap.org/).
46868       parameters:
46869         - name: pnf-name
46870           in: path
46871           description: unique name of Physical Network Function.
46872           required: true
46873           type: string
46874           example: __PNF-NAME__
46875         - name: interface-name
46876           in: path
46877           description: Name that identifies the physical interface
46878           required: true
46879           type: string
46880           example: __INTERFACE-NAME__
46881         - name: interface-name
46882           in: path
46883           description: Name given to the interface
46884           required: true
46885           type: string
46886           example: __INTERFACE-NAME__
46887   /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:
46888     put:
46889       tags:
46890         - Network
46891       summary: see node definition for valid relationships
46892       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46893       consumes:
46894         - application/json
46895         - application/xml
46896       produces:
46897         - application/json
46898         - application/xml
46899       responses:
46900         "default":
46901           description: Response codes found in [response codes](https://wiki.onap.org/).
46902       parameters:
46903         - name: pnf-name
46904           in: path
46905           description: unique name of Physical Network Function.
46906           required: true
46907           type: string
46908           example: __PNF-NAME__
46909         - name: interface-name
46910           in: path
46911           description: Name that identifies the physical interface
46912           required: true
46913           type: string
46914           example: __INTERFACE-NAME__
46915         - name: interface-name
46916           in: path
46917           description: Name given to the interface
46918           required: true
46919           type: string
46920           example: __INTERFACE-NAME__
46921         - name: l3-interface-ipv4-address
46922           in: path
46923           description: IP address
46924           required: true
46925           type: string
46926           example: __L3-INTERFACE-IPV4-ADDRESS__
46927         - name: body
46928           in: body
46929           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
46930           required: true
46931           schema:
46932             $ref: "#/definitions/relationship"
46933     delete:
46934       tags:
46935         - Network
46936       summary: delete an existing relationship
46937       description: delete an existing relationship
46938       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
46939       consumes:
46940         - application/json
46941         - application/xml
46942       produces:
46943         - application/json
46944         - application/xml
46945       responses:
46946         "default":
46947           description: Response codes found in [response codes](https://wiki.onap.org/).
46948       parameters:
46949         - name: pnf-name
46950           in: path
46951           description: unique name of Physical Network Function.
46952           required: true
46953           type: string
46954           example: __PNF-NAME__
46955         - name: interface-name
46956           in: path
46957           description: Name that identifies the physical interface
46958           required: true
46959           type: string
46960           example: __INTERFACE-NAME__
46961         - name: interface-name
46962           in: path
46963           description: Name given to the interface
46964           required: true
46965           type: string
46966           example: __INTERFACE-NAME__
46967         - name: l3-interface-ipv4-address
46968           in: path
46969           description: IP address
46970           required: true
46971           type: string
46972           example: __L3-INTERFACE-IPV4-ADDRESS__
46973   /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}:
46974     get:
46975       tags:
46976         - Network
46977       summary: returns l3-interface-ipv4-address-list
46978       description: returns l3-interface-ipv4-address-list
46979       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
46980       produces:
46981         - application/json
46982         - application/xml
46983       responses:
46984         "200":
46985           description: successful operation
46986           schema:
46987               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
46988         "default":
46989           description: Response codes found in [response codes](https://wiki.onap.org/).
46990       parameters:
46991         - name: pnf-name
46992           in: path
46993           description: unique name of Physical Network Function.
46994           required: true
46995           type: string
46996           example: __PNF-NAME__
46997         - name: interface-name
46998           in: path
46999           description: Name that identifies the physical interface
47000           required: true
47001           type: string
47002           example: __INTERFACE-NAME__
47003         - name: interface-name
47004           in: path
47005           description: Name given to the interface
47006           required: true
47007           type: string
47008           example: __INTERFACE-NAME__
47009         - name: l3-interface-ipv4-address
47010           in: path
47011           description: IP address
47012           required: true
47013           type: string
47014           example: __L3-INTERFACE-IPV4-ADDRESS__
47015         - name: inv-status
47016           in: query
47017           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47018           required: false
47019           type: string
47020         - name: prov-status
47021           in: query
47022           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47023           required: false
47024           type: string
47025         - name: interface-id
47026           in: query
47027           description: ID of interface
47028           required: false
47029           type: string
47030         - name: macaddr
47031           in: query
47032           description: MAC address for the interface
47033           required: false
47034           type: string
47035         - name: network-name
47036           in: query
47037           description: Name of the network
47038           required: false
47039           type: string
47040         - name: vlan-id-inner
47041           in: query
47042           description: Inner VLAN tag
47043           required: false
47044           type: integer
47045           format: int64
47046         - name: neutron-network-id
47047           in: query
47048           description: Neutron network id of the interface that address belongs to
47049           required: false
47050           type: string
47051         - name: neutron-subnet-id
47052           in: query
47053           description: Neutron id of subnet that address belongs to
47054           required: false
47055           type: string
47056     put:
47057       tags:
47058         - Network
47059       summary: create or update an existing l3-interface-ipv4-address-list
47060       description: |
47061         Create or update an existing l3-interface-ipv4-address-list.
47062         #
47063         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47064       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47065       consumes:
47066         - application/json
47067         - application/xml
47068       produces:
47069         - application/json
47070         - application/xml
47071       responses:
47072         "default":
47073           description: Response codes found in [response codes](https://wiki.onap.org/).
47074       parameters:
47075         - name: pnf-name
47076           in: path
47077           description: unique name of Physical Network Function.
47078           required: true
47079           type: string
47080           example: __PNF-NAME__
47081         - name: interface-name
47082           in: path
47083           description: Name that identifies the physical interface
47084           required: true
47085           type: string
47086           example: __INTERFACE-NAME__
47087         - name: interface-name
47088           in: path
47089           description: Name given to the interface
47090           required: true
47091           type: string
47092           example: __INTERFACE-NAME__
47093         - name: l3-interface-ipv4-address
47094           in: path
47095           description: IP address
47096           required: true
47097           type: string
47098           example: __L3-INTERFACE-IPV4-ADDRESS__
47099         - name: body
47100           in: body
47101           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
47102           required: true
47103           schema:
47104             $ref: "#/definitions/l3-interface-ipv4-address-list"
47105     patch:
47106       tags:
47107         - Network
47108       summary: update an existing l3-interface-ipv4-address-list
47109       description: |
47110         Update an existing l3-interface-ipv4-address-list
47111         #
47112         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47113         The PUT operation will entirely replace an existing object.
47114         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47115         #
47116         Other differences between PUT and PATCH are:
47117         #
47118         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47119         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47120         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47121       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47122       consumes:
47123         - application/json
47124         - application/xml
47125       produces:
47126         - application/json
47127         - application/xml
47128       responses:
47129         "default":
47130           description: Response codes found in [response codes](https://wiki.onap.org/).
47131       parameters:
47132         - name: pnf-name
47133           in: path
47134           description: unique name of Physical Network Function.
47135           required: true
47136           type: string
47137           example: __PNF-NAME__
47138         - name: interface-name
47139           in: path
47140           description: Name that identifies the physical interface
47141           required: true
47142           type: string
47143           example: __INTERFACE-NAME__
47144         - name: interface-name
47145           in: path
47146           description: Name given to the interface
47147           required: true
47148           type: string
47149           example: __INTERFACE-NAME__
47150         - name: l3-interface-ipv4-address
47151           in: path
47152           description: IP address
47153           required: true
47154           type: string
47155           example: __L3-INTERFACE-IPV4-ADDRESS__
47156         - name: body
47157           in: body
47158           description: l3-interface-ipv4-address-list object that needs to be created or updated.
47159           required: true
47160           schema:
47161             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
47162     delete:
47163       tags:
47164         - Network
47165       summary: delete an existing l3-interface-ipv4-address-list
47166       description: delete an existing l3-interface-ipv4-address-list
47167       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
47168       consumes:
47169         - application/json
47170         - application/xml
47171       produces:
47172         - application/json
47173         - application/xml
47174       responses:
47175         "default":
47176           description: Response codes found in [response codes](https://wiki.onap.org/).
47177       parameters:
47178         - name: pnf-name
47179           in: path
47180           description: unique name of Physical Network Function.
47181           required: true
47182           type: string
47183           example: __PNF-NAME__
47184         - name: interface-name
47185           in: path
47186           description: Name that identifies the physical interface
47187           required: true
47188           type: string
47189           example: __INTERFACE-NAME__
47190         - name: interface-name
47191           in: path
47192           description: Name given to the interface
47193           required: true
47194           type: string
47195           example: __INTERFACE-NAME__
47196         - name: l3-interface-ipv4-address
47197           in: path
47198           description: IP address
47199           required: true
47200           type: string
47201           example: __L3-INTERFACE-IPV4-ADDRESS__
47202         - name: resource-version
47203           in: query
47204           description: resource-version for concurrency
47205           required: true
47206           type: string
47207   /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:
47208     put:
47209       tags:
47210         - Network
47211       summary: see node definition for valid relationships
47212       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
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: interface-name
47230           in: path
47231           description: Name that identifies the physical interface
47232           required: true
47233           type: string
47234           example: __INTERFACE-NAME__
47235         - name: interface-name
47236           in: path
47237           description: Name given to the interface
47238           required: true
47239           type: string
47240           example: __INTERFACE-NAME__
47241         - name: l3-interface-ipv6-address
47242           in: path
47243           description: IP address
47244           required: true
47245           type: string
47246           example: __L3-INTERFACE-IPV6-ADDRESS__
47247         - name: body
47248           in: body
47249           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
47250           required: true
47251           schema:
47252             $ref: "#/definitions/relationship"
47253     delete:
47254       tags:
47255         - Network
47256       summary: delete an existing relationship
47257       description: delete an existing relationship
47258       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
47259       consumes:
47260         - application/json
47261         - application/xml
47262       produces:
47263         - application/json
47264         - application/xml
47265       responses:
47266         "default":
47267           description: Response codes found in [response codes](https://wiki.onap.org/).
47268       parameters:
47269         - name: pnf-name
47270           in: path
47271           description: unique name of Physical Network Function.
47272           required: true
47273           type: string
47274           example: __PNF-NAME__
47275         - name: interface-name
47276           in: path
47277           description: Name that identifies the physical interface
47278           required: true
47279           type: string
47280           example: __INTERFACE-NAME__
47281         - name: interface-name
47282           in: path
47283           description: Name given to the interface
47284           required: true
47285           type: string
47286           example: __INTERFACE-NAME__
47287         - name: l3-interface-ipv6-address
47288           in: path
47289           description: IP address
47290           required: true
47291           type: string
47292           example: __L3-INTERFACE-IPV6-ADDRESS__
47293   /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}:
47294     get:
47295       tags:
47296         - Network
47297       summary: returns l3-interface-ipv6-address-list
47298       description: returns l3-interface-ipv6-address-list
47299       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47300       produces:
47301         - application/json
47302         - application/xml
47303       responses:
47304         "200":
47305           description: successful operation
47306           schema:
47307               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
47308         "default":
47309           description: Response codes found in [response codes](https://wiki.onap.org/).
47310       parameters:
47311         - name: pnf-name
47312           in: path
47313           description: unique name of Physical Network Function.
47314           required: true
47315           type: string
47316           example: __PNF-NAME__
47317         - name: interface-name
47318           in: path
47319           description: Name that identifies the physical interface
47320           required: true
47321           type: string
47322           example: __INTERFACE-NAME__
47323         - name: interface-name
47324           in: path
47325           description: Name given to the interface
47326           required: true
47327           type: string
47328           example: __INTERFACE-NAME__
47329         - name: l3-interface-ipv6-address
47330           in: path
47331           description: IP address
47332           required: true
47333           type: string
47334           example: __L3-INTERFACE-IPV6-ADDRESS__
47335         - name: inv-status
47336           in: query
47337           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47338           required: false
47339           type: string
47340         - name: prov-status
47341           in: query
47342           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47343           required: false
47344           type: string
47345         - name: interface-id
47346           in: query
47347           description: ID of interface
47348           required: false
47349           type: string
47350         - name: macaddr
47351           in: query
47352           description: MAC address for the interface
47353           required: false
47354           type: string
47355         - name: network-name
47356           in: query
47357           description: Name of the network
47358           required: false
47359           type: string
47360         - name: vlan-id-inner
47361           in: query
47362           description: Inner VLAN tag
47363           required: false
47364           type: integer
47365           format: int64
47366         - name: neutron-network-id
47367           in: query
47368           description: Neutron network id of the interface that address belongs to
47369           required: false
47370           type: string
47371         - name: neutron-subnet-id
47372           in: query
47373           description: Neutron id of subnet that address belongs to
47374           required: false
47375           type: string
47376     put:
47377       tags:
47378         - Network
47379       summary: create or update an existing l3-interface-ipv6-address-list
47380       description: |
47381         Create or update an existing l3-interface-ipv6-address-list.
47382         #
47383         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47384       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47385       consumes:
47386         - application/json
47387         - application/xml
47388       produces:
47389         - application/json
47390         - application/xml
47391       responses:
47392         "default":
47393           description: Response codes found in [response codes](https://wiki.onap.org/).
47394       parameters:
47395         - name: pnf-name
47396           in: path
47397           description: unique name of Physical Network Function.
47398           required: true
47399           type: string
47400           example: __PNF-NAME__
47401         - name: interface-name
47402           in: path
47403           description: Name that identifies the physical interface
47404           required: true
47405           type: string
47406           example: __INTERFACE-NAME__
47407         - name: interface-name
47408           in: path
47409           description: Name given to the interface
47410           required: true
47411           type: string
47412           example: __INTERFACE-NAME__
47413         - name: l3-interface-ipv6-address
47414           in: path
47415           description: IP address
47416           required: true
47417           type: string
47418           example: __L3-INTERFACE-IPV6-ADDRESS__
47419         - name: body
47420           in: body
47421           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
47422           required: true
47423           schema:
47424             $ref: "#/definitions/l3-interface-ipv6-address-list"
47425     patch:
47426       tags:
47427         - Network
47428       summary: update an existing l3-interface-ipv6-address-list
47429       description: |
47430         Update an existing l3-interface-ipv6-address-list
47431         #
47432         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47433         The PUT operation will entirely replace an existing object.
47434         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47435         #
47436         Other differences between PUT and PATCH are:
47437         #
47438         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47439         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47440         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47441       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47442       consumes:
47443         - application/json
47444         - application/xml
47445       produces:
47446         - application/json
47447         - application/xml
47448       responses:
47449         "default":
47450           description: Response codes found in [response codes](https://wiki.onap.org/).
47451       parameters:
47452         - name: pnf-name
47453           in: path
47454           description: unique name of Physical Network Function.
47455           required: true
47456           type: string
47457           example: __PNF-NAME__
47458         - name: interface-name
47459           in: path
47460           description: Name that identifies the physical interface
47461           required: true
47462           type: string
47463           example: __INTERFACE-NAME__
47464         - name: interface-name
47465           in: path
47466           description: Name given to the interface
47467           required: true
47468           type: string
47469           example: __INTERFACE-NAME__
47470         - name: l3-interface-ipv6-address
47471           in: path
47472           description: IP address
47473           required: true
47474           type: string
47475           example: __L3-INTERFACE-IPV6-ADDRESS__
47476         - name: body
47477           in: body
47478           description: l3-interface-ipv6-address-list object that needs to be created or updated.
47479           required: true
47480           schema:
47481             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
47482     delete:
47483       tags:
47484         - Network
47485       summary: delete an existing l3-interface-ipv6-address-list
47486       description: delete an existing l3-interface-ipv6-address-list
47487       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
47488       consumes:
47489         - application/json
47490         - application/xml
47491       produces:
47492         - application/json
47493         - application/xml
47494       responses:
47495         "default":
47496           description: Response codes found in [response codes](https://wiki.onap.org/).
47497       parameters:
47498         - name: pnf-name
47499           in: path
47500           description: unique name of Physical Network Function.
47501           required: true
47502           type: string
47503           example: __PNF-NAME__
47504         - name: interface-name
47505           in: path
47506           description: Name that identifies the physical interface
47507           required: true
47508           type: string
47509           example: __INTERFACE-NAME__
47510         - name: interface-name
47511           in: path
47512           description: Name given to the interface
47513           required: true
47514           type: string
47515           example: __INTERFACE-NAME__
47516         - name: l3-interface-ipv6-address
47517           in: path
47518           description: IP address
47519           required: true
47520           type: string
47521           example: __L3-INTERFACE-IPV6-ADDRESS__
47522         - name: resource-version
47523           in: query
47524           description: resource-version for concurrency
47525           required: true
47526           type: string
47527   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
47528     get:
47529       tags:
47530         - Network
47531       summary: returns l-interface
47532       description: returns l-interface
47533       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47534       produces:
47535         - application/json
47536         - application/xml
47537       responses:
47538         "200":
47539           description: successful operation
47540           schema:
47541               $ref: "#/getDefinitions/l-interface"
47542         "default":
47543           description: Response codes found in [response codes](https://wiki.onap.org/).
47544       parameters:
47545         - name: pnf-name
47546           in: path
47547           description: unique name of Physical Network Function.
47548           required: true
47549           type: string
47550           example: __PNF-NAME__
47551         - name: interface-name
47552           in: path
47553           description: Name that identifies the physical interface
47554           required: true
47555           type: string
47556           example: __INTERFACE-NAME__
47557         - name: interface-name
47558           in: path
47559           description: Name given to the interface
47560           required: true
47561           type: string
47562           example: __INTERFACE-NAME__
47563         - name: inv-status
47564           in: query
47565           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47566           required: false
47567           type: string
47568         - name: prov-status
47569           in: query
47570           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47571           required: false
47572           type: string
47573         - name: interface-id
47574           in: query
47575           description: ID of interface
47576           required: false
47577           type: string
47578         - name: macaddr
47579           in: query
47580           description: MAC address for the interface
47581           required: false
47582           type: string
47583         - name: network-name
47584           in: query
47585           description: Name of the network
47586           required: false
47587           type: string
47588     put:
47589       tags:
47590         - Network
47591       summary: create or update an existing l-interface
47592       description: |
47593         Create or update an existing l-interface.
47594         #
47595         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47596       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47597       consumes:
47598         - application/json
47599         - application/xml
47600       produces:
47601         - application/json
47602         - application/xml
47603       responses:
47604         "default":
47605           description: Response codes found in [response codes](https://wiki.onap.org/).
47606       parameters:
47607         - name: pnf-name
47608           in: path
47609           description: unique name of Physical Network Function.
47610           required: true
47611           type: string
47612           example: __PNF-NAME__
47613         - name: interface-name
47614           in: path
47615           description: Name that identifies the physical interface
47616           required: true
47617           type: string
47618           example: __INTERFACE-NAME__
47619         - name: interface-name
47620           in: path
47621           description: Name given to the interface
47622           required: true
47623           type: string
47624           example: __INTERFACE-NAME__
47625         - name: body
47626           in: body
47627           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)
47628           required: true
47629           schema:
47630             $ref: "#/definitions/l-interface"
47631     patch:
47632       tags:
47633         - Network
47634       summary: update an existing l-interface
47635       description: |
47636         Update an existing l-interface
47637         #
47638         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47639         The PUT operation will entirely replace an existing object.
47640         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47641         #
47642         Other differences between PUT and PATCH are:
47643         #
47644         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47645         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47646         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47647       operationId: UpdateNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47648       consumes:
47649         - application/json
47650         - application/xml
47651       produces:
47652         - application/json
47653         - application/xml
47654       responses:
47655         "default":
47656           description: Response codes found in [response codes](https://wiki.onap.org/).
47657       parameters:
47658         - name: pnf-name
47659           in: path
47660           description: unique name of Physical Network Function.
47661           required: true
47662           type: string
47663           example: __PNF-NAME__
47664         - name: interface-name
47665           in: path
47666           description: Name that identifies the physical interface
47667           required: true
47668           type: string
47669           example: __INTERFACE-NAME__
47670         - name: interface-name
47671           in: path
47672           description: Name given to the interface
47673           required: true
47674           type: string
47675           example: __INTERFACE-NAME__
47676         - name: body
47677           in: body
47678           description: l-interface object that needs to be created or updated.
47679           required: true
47680           schema:
47681             $ref: "#/patchDefinitions/l-interface"
47682     delete:
47683       tags:
47684         - Network
47685       summary: delete an existing l-interface
47686       description: delete an existing l-interface
47687       operationId: deleteNetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface
47688       consumes:
47689         - application/json
47690         - application/xml
47691       produces:
47692         - application/json
47693         - application/xml
47694       responses:
47695         "default":
47696           description: Response codes found in [response codes](https://wiki.onap.org/).
47697       parameters:
47698         - name: pnf-name
47699           in: path
47700           description: unique name of Physical Network Function.
47701           required: true
47702           type: string
47703           example: __PNF-NAME__
47704         - name: interface-name
47705           in: path
47706           description: Name that identifies the physical interface
47707           required: true
47708           type: string
47709           example: __INTERFACE-NAME__
47710         - name: interface-name
47711           in: path
47712           description: Name given to the interface
47713           required: true
47714           type: string
47715           example: __INTERFACE-NAME__
47716         - name: resource-version
47717           in: query
47718           description: resource-version for concurrency
47719           required: true
47720           type: string
47721   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces:
47722     get:
47723       tags:
47724         - Network
47725       summary: returns l-interfaces
47726       description: returns l-interfaces
47727       operationId: getNetworkPnfsPnfPInterfacesPInterfaceLInterfaces
47728       produces:
47729         - application/json
47730         - application/xml
47731       responses:
47732         "200":
47733           description: successful operation
47734           schema:
47735               $ref: "#/getDefinitions/l-interfaces"
47736         "default":
47737           description: Response codes found in [response codes](https://wiki.onap.org/).
47738       parameters:
47739         - name: pnf-name
47740           in: path
47741           description: unique name of Physical Network Function.
47742           required: true
47743           type: string
47744           example: __PNF-NAME__
47745         - name: interface-name
47746           in: path
47747           description: Name that identifies the physical interface
47748           required: true
47749           type: string
47750           example: __INTERFACE-NAME__
47751         - name: inv-status
47752           in: query
47753           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47754           required: false
47755           type: string
47756         - name: prov-status
47757           in: query
47758           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47759           required: false
47760           type: string
47761   /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}:
47762     get:
47763       tags:
47764         - Network
47765       summary: returns p-interface
47766       description: returns p-interface
47767       operationId: getNetworkPnfsPnfPInterfacesPInterface
47768       produces:
47769         - application/json
47770         - application/xml
47771       responses:
47772         "200":
47773           description: successful operation
47774           schema:
47775               $ref: "#/getDefinitions/p-interface"
47776         "default":
47777           description: Response codes found in [response codes](https://wiki.onap.org/).
47778       parameters:
47779         - name: pnf-name
47780           in: path
47781           description: unique name of Physical Network Function.
47782           required: true
47783           type: string
47784           example: __PNF-NAME__
47785         - name: interface-name
47786           in: path
47787           description: Name that identifies the physical interface
47788           required: true
47789           type: string
47790           example: __INTERFACE-NAME__
47791         - name: inv-status
47792           in: query
47793           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47794           required: false
47795           type: string
47796         - name: prov-status
47797           in: query
47798           description: Trigger for operational monitoring of this resource by Service Assurance systems.
47799           required: false
47800           type: string
47801     put:
47802       tags:
47803         - Network
47804       summary: create or update an existing p-interface
47805       description: |
47806         Create or update an existing p-interface.
47807         #
47808         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
47809       operationId: createOrUpdateNetworkPnfsPnfPInterfacesPInterface
47810       consumes:
47811         - application/json
47812         - application/xml
47813       produces:
47814         - application/json
47815         - application/xml
47816       responses:
47817         "default":
47818           description: Response codes found in [response codes](https://wiki.onap.org/).
47819       parameters:
47820         - name: pnf-name
47821           in: path
47822           description: unique name of Physical Network Function.
47823           required: true
47824           type: string
47825           example: __PNF-NAME__
47826         - name: interface-name
47827           in: path
47828           description: Name that identifies the physical interface
47829           required: true
47830           type: string
47831           example: __INTERFACE-NAME__
47832         - name: body
47833           in: body
47834           description: p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)
47835           required: true
47836           schema:
47837             $ref: "#/definitions/p-interface"
47838     patch:
47839       tags:
47840         - Network
47841       summary: update an existing p-interface
47842       description: |
47843         Update an existing p-interface
47844         #
47845         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
47846         The PUT operation will entirely replace an existing object.
47847         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
47848         #
47849         Other differences between PUT and PATCH are:
47850         #
47851         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
47852         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
47853         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
47854       operationId: UpdateNetworkPnfsPnfPInterfacesPInterface
47855       consumes:
47856         - application/json
47857         - application/xml
47858       produces:
47859         - application/json
47860         - application/xml
47861       responses:
47862         "default":
47863           description: Response codes found in [response codes](https://wiki.onap.org/).
47864       parameters:
47865         - name: pnf-name
47866           in: path
47867           description: unique name of Physical Network Function.
47868           required: true
47869           type: string
47870           example: __PNF-NAME__
47871         - name: interface-name
47872           in: path
47873           description: Name that identifies the physical interface
47874           required: true
47875           type: string
47876           example: __INTERFACE-NAME__
47877         - name: body
47878           in: body
47879           description: p-interface object that needs to be created or updated.
47880           required: true
47881           schema:
47882             $ref: "#/patchDefinitions/p-interface"
47883     delete:
47884       tags:
47885         - Network
47886       summary: delete an existing p-interface
47887       description: delete an existing p-interface
47888       operationId: deleteNetworkPnfsPnfPInterfacesPInterface
47889       consumes:
47890         - application/json
47891         - application/xml
47892       produces:
47893         - application/json
47894         - application/xml
47895       responses:
47896         "default":
47897           description: Response codes found in [response codes](https://wiki.onap.org/).
47898       parameters:
47899         - name: pnf-name
47900           in: path
47901           description: unique name of Physical Network Function.
47902           required: true
47903           type: string
47904           example: __PNF-NAME__
47905         - name: interface-name
47906           in: path
47907           description: Name that identifies the physical interface
47908           required: true
47909           type: string
47910           example: __INTERFACE-NAME__
47911         - name: resource-version
47912           in: query
47913           description: resource-version for concurrency
47914           required: true
47915           type: string
47916   /network/pnfs/pnf/{pnf-name}/p-interfaces:
47917     get:
47918       tags:
47919         - Network
47920       summary: returns p-interfaces
47921       description: returns p-interfaces
47922       operationId: getNetworkPnfsPnfPInterfaces
47923       produces:
47924         - application/json
47925         - application/xml
47926       responses:
47927         "200":
47928           description: successful operation
47929           schema:
47930               $ref: "#/getDefinitions/p-interfaces"
47931         "default":
47932           description: Response codes found in [response codes](https://wiki.onap.org/).
47933       parameters:
47934         - name: pnf-name
47935           in: path
47936           description: unique name of Physical Network Function.
47937           required: true
47938           type: string
47939           example: __PNF-NAME__
47940         - name: inv-status
47941           in: query
47942           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
47943           required: false
47944           type: string
47945   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship:
47946     put:
47947       tags:
47948         - Network
47949       summary: see node definition for valid relationships
47950       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
47951       consumes:
47952         - application/json
47953         - application/xml
47954       produces:
47955         - application/json
47956         - application/xml
47957       responses:
47958         "default":
47959           description: Response codes found in [response codes](https://wiki.onap.org/).
47960       parameters:
47961         - name: pnf-name
47962           in: path
47963           description: unique name of Physical Network Function.
47964           required: true
47965           type: string
47966           example: __PNF-NAME__
47967         - name: interface-name
47968           in: path
47969           description: Name that identifies the link aggregate interface
47970           required: true
47971           type: string
47972           example: __INTERFACE-NAME__
47973         - name: body
47974           in: body
47975           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
47976           required: true
47977           schema:
47978             $ref: "#/definitions/relationship"
47979     delete:
47980       tags:
47981         - Network
47982       summary: delete an existing relationship
47983       description: delete an existing relationship
47984       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceRelationshipListRelationship
47985       consumes:
47986         - application/json
47987         - application/xml
47988       produces:
47989         - application/json
47990         - application/xml
47991       responses:
47992         "default":
47993           description: Response codes found in [response codes](https://wiki.onap.org/).
47994       parameters:
47995         - name: pnf-name
47996           in: path
47997           description: unique name of Physical Network Function.
47998           required: true
47999           type: string
48000           example: __PNF-NAME__
48001         - name: interface-name
48002           in: path
48003           description: Name that identifies the link aggregate interface
48004           required: true
48005           type: string
48006           example: __INTERFACE-NAME__
48007   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship:
48008     put:
48009       tags:
48010         - Network
48011       summary: see node definition for valid relationships
48012       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
48013       consumes:
48014         - application/json
48015         - application/xml
48016       produces:
48017         - application/json
48018         - application/xml
48019       responses:
48020         "default":
48021           description: Response codes found in [response codes](https://wiki.onap.org/).
48022       parameters:
48023         - name: pnf-name
48024           in: path
48025           description: unique name of Physical Network Function.
48026           required: true
48027           type: string
48028           example: __PNF-NAME__
48029         - name: interface-name
48030           in: path
48031           description: Name that identifies the link aggregate interface
48032           required: true
48033           type: string
48034           example: __INTERFACE-NAME__
48035         - name: interface-name
48036           in: path
48037           description: Name given to the interface
48038           required: true
48039           type: string
48040           example: __INTERFACE-NAME__
48041         - name: vlan-interface
48042           in: path
48043           description: String that identifies the interface
48044           required: true
48045           type: string
48046           example: __VLAN-INTERFACE__
48047         - name: body
48048           in: body
48049           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
48050           required: true
48051           schema:
48052             $ref: "#/definitions/relationship"
48053     delete:
48054       tags:
48055         - Network
48056       summary: delete an existing relationship
48057       description: delete an existing relationship
48058       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanRelationshipListRelationship
48059       consumes:
48060         - application/json
48061         - application/xml
48062       produces:
48063         - application/json
48064         - application/xml
48065       responses:
48066         "default":
48067           description: Response codes found in [response codes](https://wiki.onap.org/).
48068       parameters:
48069         - name: pnf-name
48070           in: path
48071           description: unique name of Physical Network Function.
48072           required: true
48073           type: string
48074           example: __PNF-NAME__
48075         - name: interface-name
48076           in: path
48077           description: Name that identifies the link aggregate interface
48078           required: true
48079           type: string
48080           example: __INTERFACE-NAME__
48081         - name: interface-name
48082           in: path
48083           description: Name given to the interface
48084           required: true
48085           type: string
48086           example: __INTERFACE-NAME__
48087         - name: vlan-interface
48088           in: path
48089           description: String that identifies the interface
48090           required: true
48091           type: string
48092           example: __VLAN-INTERFACE__
48093   /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:
48094     put:
48095       tags:
48096         - Network
48097       summary: see node definition for valid relationships
48098       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48099       consumes:
48100         - application/json
48101         - application/xml
48102       produces:
48103         - application/json
48104         - application/xml
48105       responses:
48106         "default":
48107           description: Response codes found in [response codes](https://wiki.onap.org/).
48108       parameters:
48109         - name: pnf-name
48110           in: path
48111           description: unique name of Physical Network Function.
48112           required: true
48113           type: string
48114           example: __PNF-NAME__
48115         - name: interface-name
48116           in: path
48117           description: Name that identifies the link aggregate interface
48118           required: true
48119           type: string
48120           example: __INTERFACE-NAME__
48121         - name: interface-name
48122           in: path
48123           description: Name given to the interface
48124           required: true
48125           type: string
48126           example: __INTERFACE-NAME__
48127         - name: vlan-interface
48128           in: path
48129           description: String that identifies the interface
48130           required: true
48131           type: string
48132           example: __VLAN-INTERFACE__
48133         - name: l3-interface-ipv4-address
48134           in: path
48135           description: IP address
48136           required: true
48137           type: string
48138           example: __L3-INTERFACE-IPV4-ADDRESS__
48139         - name: body
48140           in: body
48141           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
48142           required: true
48143           schema:
48144             $ref: "#/definitions/relationship"
48145     delete:
48146       tags:
48147         - Network
48148       summary: delete an existing relationship
48149       description: delete an existing relationship
48150       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressListRelationshipListRelationship
48151       consumes:
48152         - application/json
48153         - application/xml
48154       produces:
48155         - application/json
48156         - application/xml
48157       responses:
48158         "default":
48159           description: Response codes found in [response codes](https://wiki.onap.org/).
48160       parameters:
48161         - name: pnf-name
48162           in: path
48163           description: unique name of Physical Network Function.
48164           required: true
48165           type: string
48166           example: __PNF-NAME__
48167         - name: interface-name
48168           in: path
48169           description: Name that identifies the link aggregate interface
48170           required: true
48171           type: string
48172           example: __INTERFACE-NAME__
48173         - name: interface-name
48174           in: path
48175           description: Name given to the interface
48176           required: true
48177           type: string
48178           example: __INTERFACE-NAME__
48179         - name: vlan-interface
48180           in: path
48181           description: String that identifies the interface
48182           required: true
48183           type: string
48184           example: __VLAN-INTERFACE__
48185         - name: l3-interface-ipv4-address
48186           in: path
48187           description: IP address
48188           required: true
48189           type: string
48190           example: __L3-INTERFACE-IPV4-ADDRESS__
48191   /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}:
48192     get:
48193       tags:
48194         - Network
48195       summary: returns l3-interface-ipv4-address-list
48196       description: returns l3-interface-ipv4-address-list
48197       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48198       produces:
48199         - application/json
48200         - application/xml
48201       responses:
48202         "200":
48203           description: successful operation
48204           schema:
48205               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
48206         "default":
48207           description: Response codes found in [response codes](https://wiki.onap.org/).
48208       parameters:
48209         - name: pnf-name
48210           in: path
48211           description: unique name of Physical Network Function.
48212           required: true
48213           type: string
48214           example: __PNF-NAME__
48215         - name: interface-name
48216           in: path
48217           description: Name that identifies the link aggregate interface
48218           required: true
48219           type: string
48220           example: __INTERFACE-NAME__
48221         - name: interface-name
48222           in: path
48223           description: Name given to the interface
48224           required: true
48225           type: string
48226           example: __INTERFACE-NAME__
48227         - name: vlan-interface
48228           in: path
48229           description: String that identifies the interface
48230           required: true
48231           type: string
48232           example: __VLAN-INTERFACE__
48233         - name: l3-interface-ipv4-address
48234           in: path
48235           description: IP address
48236           required: true
48237           type: string
48238           example: __L3-INTERFACE-IPV4-ADDRESS__
48239         - name: inv-status
48240           in: query
48241           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48242           required: false
48243           type: string
48244         - name: interface-id
48245           in: query
48246           description: ID of interface
48247           required: false
48248           type: string
48249         - name: interface-role
48250           in: query
48251           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48252           required: false
48253           type: string
48254         - name: interface-id
48255           in: query
48256           description: ID of interface
48257           required: false
48258           type: string
48259         - name: macaddr
48260           in: query
48261           description: MAC address for the interface
48262           required: false
48263           type: string
48264         - name: network-name
48265           in: query
48266           description: Name of the network
48267           required: false
48268           type: string
48269         - name: vlan-id-inner
48270           in: query
48271           description: Inner VLAN tag
48272           required: false
48273           type: integer
48274           format: int64
48275         - name: vpn-key
48276           in: query
48277           description: This indicates the customers VPN ID associated with this vlan
48278           required: false
48279           type: string
48280         - name: vlan-id-inner
48281           in: query
48282           description: Inner VLAN tag
48283           required: false
48284           type: integer
48285           format: int64
48286         - name: neutron-network-id
48287           in: query
48288           description: Neutron network id of the interface that address belongs to
48289           required: false
48290           type: string
48291         - name: neutron-subnet-id
48292           in: query
48293           description: Neutron id of subnet that address belongs to
48294           required: false
48295           type: string
48296     put:
48297       tags:
48298         - Network
48299       summary: create or update an existing l3-interface-ipv4-address-list
48300       description: |
48301         Create or update an existing l3-interface-ipv4-address-list.
48302         #
48303         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48304       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48305       consumes:
48306         - application/json
48307         - application/xml
48308       produces:
48309         - application/json
48310         - application/xml
48311       responses:
48312         "default":
48313           description: Response codes found in [response codes](https://wiki.onap.org/).
48314       parameters:
48315         - name: pnf-name
48316           in: path
48317           description: unique name of Physical Network Function.
48318           required: true
48319           type: string
48320           example: __PNF-NAME__
48321         - name: interface-name
48322           in: path
48323           description: Name that identifies the link aggregate interface
48324           required: true
48325           type: string
48326           example: __INTERFACE-NAME__
48327         - name: interface-name
48328           in: path
48329           description: Name given to the interface
48330           required: true
48331           type: string
48332           example: __INTERFACE-NAME__
48333         - name: vlan-interface
48334           in: path
48335           description: String that identifies the interface
48336           required: true
48337           type: string
48338           example: __VLAN-INTERFACE__
48339         - name: l3-interface-ipv4-address
48340           in: path
48341           description: IP address
48342           required: true
48343           type: string
48344           example: __L3-INTERFACE-IPV4-ADDRESS__
48345         - name: body
48346           in: body
48347           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)
48348           required: true
48349           schema:
48350             $ref: "#/definitions/l3-interface-ipv4-address-list"
48351     patch:
48352       tags:
48353         - Network
48354       summary: update an existing l3-interface-ipv4-address-list
48355       description: |
48356         Update an existing l3-interface-ipv4-address-list
48357         #
48358         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48359         The PUT operation will entirely replace an existing object.
48360         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48361         #
48362         Other differences between PUT and PATCH are:
48363         #
48364         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48365         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48366         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48367       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48368       consumes:
48369         - application/json
48370         - application/xml
48371       produces:
48372         - application/json
48373         - application/xml
48374       responses:
48375         "default":
48376           description: Response codes found in [response codes](https://wiki.onap.org/).
48377       parameters:
48378         - name: pnf-name
48379           in: path
48380           description: unique name of Physical Network Function.
48381           required: true
48382           type: string
48383           example: __PNF-NAME__
48384         - name: interface-name
48385           in: path
48386           description: Name that identifies the link aggregate interface
48387           required: true
48388           type: string
48389           example: __INTERFACE-NAME__
48390         - name: interface-name
48391           in: path
48392           description: Name given to the interface
48393           required: true
48394           type: string
48395           example: __INTERFACE-NAME__
48396         - name: vlan-interface
48397           in: path
48398           description: String that identifies the interface
48399           required: true
48400           type: string
48401           example: __VLAN-INTERFACE__
48402         - name: l3-interface-ipv4-address
48403           in: path
48404           description: IP address
48405           required: true
48406           type: string
48407           example: __L3-INTERFACE-IPV4-ADDRESS__
48408         - name: body
48409           in: body
48410           description: l3-interface-ipv4-address-list object that needs to be created or updated.
48411           required: true
48412           schema:
48413             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
48414     delete:
48415       tags:
48416         - Network
48417       summary: delete an existing l3-interface-ipv4-address-list
48418       description: delete an existing l3-interface-ipv4-address-list
48419       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList
48420       consumes:
48421         - application/json
48422         - application/xml
48423       produces:
48424         - application/json
48425         - application/xml
48426       responses:
48427         "default":
48428           description: Response codes found in [response codes](https://wiki.onap.org/).
48429       parameters:
48430         - name: pnf-name
48431           in: path
48432           description: unique name of Physical Network Function.
48433           required: true
48434           type: string
48435           example: __PNF-NAME__
48436         - name: interface-name
48437           in: path
48438           description: Name that identifies the link aggregate interface
48439           required: true
48440           type: string
48441           example: __INTERFACE-NAME__
48442         - name: interface-name
48443           in: path
48444           description: Name given to the interface
48445           required: true
48446           type: string
48447           example: __INTERFACE-NAME__
48448         - name: vlan-interface
48449           in: path
48450           description: String that identifies the interface
48451           required: true
48452           type: string
48453           example: __VLAN-INTERFACE__
48454         - name: l3-interface-ipv4-address
48455           in: path
48456           description: IP address
48457           required: true
48458           type: string
48459           example: __L3-INTERFACE-IPV4-ADDRESS__
48460         - name: resource-version
48461           in: query
48462           description: resource-version for concurrency
48463           required: true
48464           type: string
48465   /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:
48466     put:
48467       tags:
48468         - Network
48469       summary: see node definition for valid relationships
48470       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
48471       consumes:
48472         - application/json
48473         - application/xml
48474       produces:
48475         - application/json
48476         - application/xml
48477       responses:
48478         "default":
48479           description: Response codes found in [response codes](https://wiki.onap.org/).
48480       parameters:
48481         - name: pnf-name
48482           in: path
48483           description: unique name of Physical Network Function.
48484           required: true
48485           type: string
48486           example: __PNF-NAME__
48487         - name: interface-name
48488           in: path
48489           description: Name that identifies the link aggregate interface
48490           required: true
48491           type: string
48492           example: __INTERFACE-NAME__
48493         - name: interface-name
48494           in: path
48495           description: Name given to the interface
48496           required: true
48497           type: string
48498           example: __INTERFACE-NAME__
48499         - name: vlan-interface
48500           in: path
48501           description: String that identifies the interface
48502           required: true
48503           type: string
48504           example: __VLAN-INTERFACE__
48505         - name: l3-interface-ipv6-address
48506           in: path
48507           description: IP address
48508           required: true
48509           type: string
48510           example: __L3-INTERFACE-IPV6-ADDRESS__
48511         - name: body
48512           in: body
48513           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
48514           required: true
48515           schema:
48516             $ref: "#/definitions/relationship"
48517     delete:
48518       tags:
48519         - Network
48520       summary: delete an existing relationship
48521       description: delete an existing relationship
48522       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressListRelationshipListRelationship
48523       consumes:
48524         - application/json
48525         - application/xml
48526       produces:
48527         - application/json
48528         - application/xml
48529       responses:
48530         "default":
48531           description: Response codes found in [response codes](https://wiki.onap.org/).
48532       parameters:
48533         - name: pnf-name
48534           in: path
48535           description: unique name of Physical Network Function.
48536           required: true
48537           type: string
48538           example: __PNF-NAME__
48539         - name: interface-name
48540           in: path
48541           description: Name that identifies the link aggregate interface
48542           required: true
48543           type: string
48544           example: __INTERFACE-NAME__
48545         - name: interface-name
48546           in: path
48547           description: Name given to the interface
48548           required: true
48549           type: string
48550           example: __INTERFACE-NAME__
48551         - name: vlan-interface
48552           in: path
48553           description: String that identifies the interface
48554           required: true
48555           type: string
48556           example: __VLAN-INTERFACE__
48557         - name: l3-interface-ipv6-address
48558           in: path
48559           description: IP address
48560           required: true
48561           type: string
48562           example: __L3-INTERFACE-IPV6-ADDRESS__
48563   /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}:
48564     get:
48565       tags:
48566         - Network
48567       summary: returns l3-interface-ipv6-address-list
48568       description: returns l3-interface-ipv6-address-list
48569       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48570       produces:
48571         - application/json
48572         - application/xml
48573       responses:
48574         "200":
48575           description: successful operation
48576           schema:
48577               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
48578         "default":
48579           description: Response codes found in [response codes](https://wiki.onap.org/).
48580       parameters:
48581         - name: pnf-name
48582           in: path
48583           description: unique name of Physical Network Function.
48584           required: true
48585           type: string
48586           example: __PNF-NAME__
48587         - name: interface-name
48588           in: path
48589           description: Name that identifies the link aggregate interface
48590           required: true
48591           type: string
48592           example: __INTERFACE-NAME__
48593         - name: interface-name
48594           in: path
48595           description: Name given to the interface
48596           required: true
48597           type: string
48598           example: __INTERFACE-NAME__
48599         - name: vlan-interface
48600           in: path
48601           description: String that identifies the interface
48602           required: true
48603           type: string
48604           example: __VLAN-INTERFACE__
48605         - name: l3-interface-ipv6-address
48606           in: path
48607           description: IP address
48608           required: true
48609           type: string
48610           example: __L3-INTERFACE-IPV6-ADDRESS__
48611         - name: inv-status
48612           in: query
48613           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48614           required: false
48615           type: string
48616         - name: interface-id
48617           in: query
48618           description: ID of interface
48619           required: false
48620           type: string
48621         - name: interface-role
48622           in: query
48623           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48624           required: false
48625           type: string
48626         - name: interface-id
48627           in: query
48628           description: ID of interface
48629           required: false
48630           type: string
48631         - name: macaddr
48632           in: query
48633           description: MAC address for the interface
48634           required: false
48635           type: string
48636         - name: network-name
48637           in: query
48638           description: Name of the network
48639           required: false
48640           type: string
48641         - name: vlan-id-inner
48642           in: query
48643           description: Inner VLAN tag
48644           required: false
48645           type: integer
48646           format: int64
48647         - name: vpn-key
48648           in: query
48649           description: This indicates the customers VPN ID associated with this vlan
48650           required: false
48651           type: string
48652         - name: vlan-id-inner
48653           in: query
48654           description: Inner VLAN tag
48655           required: false
48656           type: integer
48657           format: int64
48658         - name: neutron-network-id
48659           in: query
48660           description: Neutron network id of the interface that address belongs to
48661           required: false
48662           type: string
48663         - name: neutron-subnet-id
48664           in: query
48665           description: Neutron id of subnet that address belongs to
48666           required: false
48667           type: string
48668     put:
48669       tags:
48670         - Network
48671       summary: create or update an existing l3-interface-ipv6-address-list
48672       description: |
48673         Create or update an existing l3-interface-ipv6-address-list.
48674         #
48675         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48676       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48677       consumes:
48678         - application/json
48679         - application/xml
48680       produces:
48681         - application/json
48682         - application/xml
48683       responses:
48684         "default":
48685           description: Response codes found in [response codes](https://wiki.onap.org/).
48686       parameters:
48687         - name: pnf-name
48688           in: path
48689           description: unique name of Physical Network Function.
48690           required: true
48691           type: string
48692           example: __PNF-NAME__
48693         - name: interface-name
48694           in: path
48695           description: Name that identifies the link aggregate interface
48696           required: true
48697           type: string
48698           example: __INTERFACE-NAME__
48699         - name: interface-name
48700           in: path
48701           description: Name given to the interface
48702           required: true
48703           type: string
48704           example: __INTERFACE-NAME__
48705         - name: vlan-interface
48706           in: path
48707           description: String that identifies the interface
48708           required: true
48709           type: string
48710           example: __VLAN-INTERFACE__
48711         - name: l3-interface-ipv6-address
48712           in: path
48713           description: IP address
48714           required: true
48715           type: string
48716           example: __L3-INTERFACE-IPV6-ADDRESS__
48717         - name: body
48718           in: body
48719           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)
48720           required: true
48721           schema:
48722             $ref: "#/definitions/l3-interface-ipv6-address-list"
48723     patch:
48724       tags:
48725         - Network
48726       summary: update an existing l3-interface-ipv6-address-list
48727       description: |
48728         Update an existing l3-interface-ipv6-address-list
48729         #
48730         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48731         The PUT operation will entirely replace an existing object.
48732         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48733         #
48734         Other differences between PUT and PATCH are:
48735         #
48736         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48737         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48738         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48739       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48740       consumes:
48741         - application/json
48742         - application/xml
48743       produces:
48744         - application/json
48745         - application/xml
48746       responses:
48747         "default":
48748           description: Response codes found in [response codes](https://wiki.onap.org/).
48749       parameters:
48750         - name: pnf-name
48751           in: path
48752           description: unique name of Physical Network Function.
48753           required: true
48754           type: string
48755           example: __PNF-NAME__
48756         - name: interface-name
48757           in: path
48758           description: Name that identifies the link aggregate interface
48759           required: true
48760           type: string
48761           example: __INTERFACE-NAME__
48762         - name: interface-name
48763           in: path
48764           description: Name given to the interface
48765           required: true
48766           type: string
48767           example: __INTERFACE-NAME__
48768         - name: vlan-interface
48769           in: path
48770           description: String that identifies the interface
48771           required: true
48772           type: string
48773           example: __VLAN-INTERFACE__
48774         - name: l3-interface-ipv6-address
48775           in: path
48776           description: IP address
48777           required: true
48778           type: string
48779           example: __L3-INTERFACE-IPV6-ADDRESS__
48780         - name: body
48781           in: body
48782           description: l3-interface-ipv6-address-list object that needs to be created or updated.
48783           required: true
48784           schema:
48785             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
48786     delete:
48787       tags:
48788         - Network
48789       summary: delete an existing l3-interface-ipv6-address-list
48790       description: delete an existing l3-interface-ipv6-address-list
48791       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList
48792       consumes:
48793         - application/json
48794         - application/xml
48795       produces:
48796         - application/json
48797         - application/xml
48798       responses:
48799         "default":
48800           description: Response codes found in [response codes](https://wiki.onap.org/).
48801       parameters:
48802         - name: pnf-name
48803           in: path
48804           description: unique name of Physical Network Function.
48805           required: true
48806           type: string
48807           example: __PNF-NAME__
48808         - name: interface-name
48809           in: path
48810           description: Name that identifies the link aggregate interface
48811           required: true
48812           type: string
48813           example: __INTERFACE-NAME__
48814         - name: interface-name
48815           in: path
48816           description: Name given to the interface
48817           required: true
48818           type: string
48819           example: __INTERFACE-NAME__
48820         - name: vlan-interface
48821           in: path
48822           description: String that identifies the interface
48823           required: true
48824           type: string
48825           example: __VLAN-INTERFACE__
48826         - name: l3-interface-ipv6-address
48827           in: path
48828           description: IP address
48829           required: true
48830           type: string
48831           example: __L3-INTERFACE-IPV6-ADDRESS__
48832         - name: resource-version
48833           in: query
48834           description: resource-version for concurrency
48835           required: true
48836           type: string
48837   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}:
48838     get:
48839       tags:
48840         - Network
48841       summary: returns vlan
48842       description: returns vlan
48843       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48844       produces:
48845         - application/json
48846         - application/xml
48847       responses:
48848         "200":
48849           description: successful operation
48850           schema:
48851               $ref: "#/getDefinitions/vlan"
48852         "default":
48853           description: Response codes found in [response codes](https://wiki.onap.org/).
48854       parameters:
48855         - name: pnf-name
48856           in: path
48857           description: unique name of Physical Network Function.
48858           required: true
48859           type: string
48860           example: __PNF-NAME__
48861         - name: interface-name
48862           in: path
48863           description: Name that identifies the link aggregate interface
48864           required: true
48865           type: string
48866           example: __INTERFACE-NAME__
48867         - name: interface-name
48868           in: path
48869           description: Name given to the interface
48870           required: true
48871           type: string
48872           example: __INTERFACE-NAME__
48873         - name: vlan-interface
48874           in: path
48875           description: String that identifies the interface
48876           required: true
48877           type: string
48878           example: __VLAN-INTERFACE__
48879         - name: inv-status
48880           in: query
48881           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
48882           required: false
48883           type: string
48884         - name: interface-id
48885           in: query
48886           description: ID of interface
48887           required: false
48888           type: string
48889         - name: interface-role
48890           in: query
48891           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
48892           required: false
48893           type: string
48894         - name: interface-id
48895           in: query
48896           description: ID of interface
48897           required: false
48898           type: string
48899         - name: macaddr
48900           in: query
48901           description: MAC address for the interface
48902           required: false
48903           type: string
48904         - name: network-name
48905           in: query
48906           description: Name of the network
48907           required: false
48908           type: string
48909         - name: vlan-id-inner
48910           in: query
48911           description: Inner VLAN tag
48912           required: false
48913           type: integer
48914           format: int64
48915         - name: vpn-key
48916           in: query
48917           description: This indicates the customers VPN ID associated with this vlan
48918           required: false
48919           type: string
48920     put:
48921       tags:
48922         - Network
48923       summary: create or update an existing vlan
48924       description: |
48925         Create or update an existing vlan.
48926         #
48927         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
48928       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48929       consumes:
48930         - application/json
48931         - application/xml
48932       produces:
48933         - application/json
48934         - application/xml
48935       responses:
48936         "default":
48937           description: Response codes found in [response codes](https://wiki.onap.org/).
48938       parameters:
48939         - name: pnf-name
48940           in: path
48941           description: unique name of Physical Network Function.
48942           required: true
48943           type: string
48944           example: __PNF-NAME__
48945         - name: interface-name
48946           in: path
48947           description: Name that identifies the link aggregate interface
48948           required: true
48949           type: string
48950           example: __INTERFACE-NAME__
48951         - name: interface-name
48952           in: path
48953           description: Name given to the interface
48954           required: true
48955           type: string
48956           example: __INTERFACE-NAME__
48957         - name: vlan-interface
48958           in: path
48959           description: String that identifies the interface
48960           required: true
48961           type: string
48962           example: __VLAN-INTERFACE__
48963         - name: body
48964           in: body
48965           description: vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)
48966           required: true
48967           schema:
48968             $ref: "#/definitions/vlan"
48969     patch:
48970       tags:
48971         - Network
48972       summary: update an existing vlan
48973       description: |
48974         Update an existing vlan
48975         #
48976         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
48977         The PUT operation will entirely replace an existing object.
48978         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
48979         #
48980         Other differences between PUT and PATCH are:
48981         #
48982         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
48983         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
48984         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
48985       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
48986       consumes:
48987         - application/json
48988         - application/xml
48989       produces:
48990         - application/json
48991         - application/xml
48992       responses:
48993         "default":
48994           description: Response codes found in [response codes](https://wiki.onap.org/).
48995       parameters:
48996         - name: pnf-name
48997           in: path
48998           description: unique name of Physical Network Function.
48999           required: true
49000           type: string
49001           example: __PNF-NAME__
49002         - name: interface-name
49003           in: path
49004           description: Name that identifies the link aggregate interface
49005           required: true
49006           type: string
49007           example: __INTERFACE-NAME__
49008         - name: interface-name
49009           in: path
49010           description: Name given to the interface
49011           required: true
49012           type: string
49013           example: __INTERFACE-NAME__
49014         - name: vlan-interface
49015           in: path
49016           description: String that identifies the interface
49017           required: true
49018           type: string
49019           example: __VLAN-INTERFACE__
49020         - name: body
49021           in: body
49022           description: vlan object that needs to be created or updated.
49023           required: true
49024           schema:
49025             $ref: "#/patchDefinitions/vlan"
49026     delete:
49027       tags:
49028         - Network
49029       summary: delete an existing vlan
49030       description: delete an existing vlan
49031       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan
49032       consumes:
49033         - application/json
49034         - application/xml
49035       produces:
49036         - application/json
49037         - application/xml
49038       responses:
49039         "default":
49040           description: Response codes found in [response codes](https://wiki.onap.org/).
49041       parameters:
49042         - name: pnf-name
49043           in: path
49044           description: unique name of Physical Network Function.
49045           required: true
49046           type: string
49047           example: __PNF-NAME__
49048         - name: interface-name
49049           in: path
49050           description: Name that identifies the link aggregate interface
49051           required: true
49052           type: string
49053           example: __INTERFACE-NAME__
49054         - name: interface-name
49055           in: path
49056           description: Name given to the interface
49057           required: true
49058           type: string
49059           example: __INTERFACE-NAME__
49060         - name: vlan-interface
49061           in: path
49062           description: String that identifies the interface
49063           required: true
49064           type: string
49065           example: __VLAN-INTERFACE__
49066         - name: resource-version
49067           in: query
49068           description: resource-version for concurrency
49069           required: true
49070           type: string
49071   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans:
49072     get:
49073       tags:
49074         - Network
49075       summary: returns vlans
49076       description: returns vlans
49077       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlans
49078       produces:
49079         - application/json
49080         - application/xml
49081       responses:
49082         "200":
49083           description: successful operation
49084           schema:
49085               $ref: "#/getDefinitions/vlans"
49086         "default":
49087           description: Response codes found in [response codes](https://wiki.onap.org/).
49088       parameters:
49089         - name: pnf-name
49090           in: path
49091           description: unique name of Physical Network Function.
49092           required: true
49093           type: string
49094           example: __PNF-NAME__
49095         - name: interface-name
49096           in: path
49097           description: Name that identifies the link aggregate interface
49098           required: true
49099           type: string
49100           example: __INTERFACE-NAME__
49101         - name: interface-name
49102           in: path
49103           description: Name given to the interface
49104           required: true
49105           type: string
49106           example: __INTERFACE-NAME__
49107         - name: inv-status
49108           in: query
49109           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49110           required: false
49111           type: string
49112         - name: interface-id
49113           in: query
49114           description: ID of interface
49115           required: false
49116           type: string
49117         - name: interface-role
49118           in: query
49119           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49120           required: false
49121           type: string
49122         - name: interface-id
49123           in: query
49124           description: ID of interface
49125           required: false
49126           type: string
49127         - name: macaddr
49128           in: query
49129           description: MAC address for the interface
49130           required: false
49131           type: string
49132         - name: network-name
49133           in: query
49134           description: Name of the network
49135           required: false
49136           type: string
49137   /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:
49138     put:
49139       tags:
49140         - Network
49141       summary: see node definition for valid relationships
49142       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
49143       consumes:
49144         - application/json
49145         - application/xml
49146       produces:
49147         - application/json
49148         - application/xml
49149       responses:
49150         "default":
49151           description: Response codes found in [response codes](https://wiki.onap.org/).
49152       parameters:
49153         - name: pnf-name
49154           in: path
49155           description: unique name of Physical Network Function.
49156           required: true
49157           type: string
49158           example: __PNF-NAME__
49159         - name: interface-name
49160           in: path
49161           description: Name that identifies the link aggregate interface
49162           required: true
49163           type: string
49164           example: __INTERFACE-NAME__
49165         - name: interface-name
49166           in: path
49167           description: Name given to the interface
49168           required: true
49169           type: string
49170           example: __INTERFACE-NAME__
49171         - name: pci-id
49172           in: path
49173           description: PCI ID used to identify the sriov-vf
49174           required: true
49175           type: string
49176           example: __PCI-ID__
49177         - name: body
49178           in: body
49179           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
49180           required: true
49181           schema:
49182             $ref: "#/definitions/relationship"
49183     delete:
49184       tags:
49185         - Network
49186       summary: delete an existing relationship
49187       description: delete an existing relationship
49188       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVfRelationshipListRelationship
49189       consumes:
49190         - application/json
49191         - application/xml
49192       produces:
49193         - application/json
49194         - application/xml
49195       responses:
49196         "default":
49197           description: Response codes found in [response codes](https://wiki.onap.org/).
49198       parameters:
49199         - name: pnf-name
49200           in: path
49201           description: unique name of Physical Network Function.
49202           required: true
49203           type: string
49204           example: __PNF-NAME__
49205         - name: interface-name
49206           in: path
49207           description: Name that identifies the link aggregate interface
49208           required: true
49209           type: string
49210           example: __INTERFACE-NAME__
49211         - name: interface-name
49212           in: path
49213           description: Name given to the interface
49214           required: true
49215           type: string
49216           example: __INTERFACE-NAME__
49217         - name: pci-id
49218           in: path
49219           description: PCI ID used to identify the sriov-vf
49220           required: true
49221           type: string
49222           example: __PCI-ID__
49223   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}:
49224     get:
49225       tags:
49226         - Network
49227       summary: returns sriov-vf
49228       description: returns sriov-vf
49229       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49230       produces:
49231         - application/json
49232         - application/xml
49233       responses:
49234         "200":
49235           description: successful operation
49236           schema:
49237               $ref: "#/getDefinitions/sriov-vf"
49238         "default":
49239           description: Response codes found in [response codes](https://wiki.onap.org/).
49240       parameters:
49241         - name: pnf-name
49242           in: path
49243           description: unique name of Physical Network Function.
49244           required: true
49245           type: string
49246           example: __PNF-NAME__
49247         - name: interface-name
49248           in: path
49249           description: Name that identifies the link aggregate interface
49250           required: true
49251           type: string
49252           example: __INTERFACE-NAME__
49253         - name: interface-name
49254           in: path
49255           description: Name given to the interface
49256           required: true
49257           type: string
49258           example: __INTERFACE-NAME__
49259         - name: pci-id
49260           in: path
49261           description: PCI ID used to identify the sriov-vf
49262           required: true
49263           type: string
49264           example: __PCI-ID__
49265         - name: inv-status
49266           in: query
49267           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49268           required: false
49269           type: string
49270         - name: interface-id
49271           in: query
49272           description: ID of interface
49273           required: false
49274           type: string
49275         - name: interface-role
49276           in: query
49277           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49278           required: false
49279           type: string
49280         - name: interface-id
49281           in: query
49282           description: ID of interface
49283           required: false
49284           type: string
49285         - name: macaddr
49286           in: query
49287           description: MAC address for the interface
49288           required: false
49289           type: string
49290         - name: network-name
49291           in: query
49292           description: Name of the network
49293           required: false
49294           type: string
49295         - name: vf-vlan-filter
49296           in: query
49297           description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
49298           required: false
49299           type: string
49300         - name: vf-mac-filter
49301           in: query
49302           description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
49303           required: false
49304           type: string
49305         - name: vf-vlan-strip
49306           in: query
49307           description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
49308           required: false
49309           type: boolean
49310         - name: neutron-network-id
49311           in: query
49312           description: Neutron network id of the interface
49313           required: false
49314           type: string
49315     put:
49316       tags:
49317         - Network
49318       summary: create or update an existing sriov-vf
49319       description: |
49320         Create or update an existing sriov-vf.
49321         #
49322         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49323       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49324       consumes:
49325         - application/json
49326         - application/xml
49327       produces:
49328         - application/json
49329         - application/xml
49330       responses:
49331         "default":
49332           description: Response codes found in [response codes](https://wiki.onap.org/).
49333       parameters:
49334         - name: pnf-name
49335           in: path
49336           description: unique name of Physical Network Function.
49337           required: true
49338           type: string
49339           example: __PNF-NAME__
49340         - name: interface-name
49341           in: path
49342           description: Name that identifies the link aggregate interface
49343           required: true
49344           type: string
49345           example: __INTERFACE-NAME__
49346         - name: interface-name
49347           in: path
49348           description: Name given to the interface
49349           required: true
49350           type: string
49351           example: __INTERFACE-NAME__
49352         - name: pci-id
49353           in: path
49354           description: PCI ID used to identify the sriov-vf
49355           required: true
49356           type: string
49357           example: __PCI-ID__
49358         - name: body
49359           in: body
49360           description: sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)
49361           required: true
49362           schema:
49363             $ref: "#/definitions/sriov-vf"
49364     patch:
49365       tags:
49366         - Network
49367       summary: update an existing sriov-vf
49368       description: |
49369         Update an existing sriov-vf
49370         #
49371         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49372         The PUT operation will entirely replace an existing object.
49373         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49374         #
49375         Other differences between PUT and PATCH are:
49376         #
49377         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49378         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49379         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49380       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49381       consumes:
49382         - application/json
49383         - application/xml
49384       produces:
49385         - application/json
49386         - application/xml
49387       responses:
49388         "default":
49389           description: Response codes found in [response codes](https://wiki.onap.org/).
49390       parameters:
49391         - name: pnf-name
49392           in: path
49393           description: unique name of Physical Network Function.
49394           required: true
49395           type: string
49396           example: __PNF-NAME__
49397         - name: interface-name
49398           in: path
49399           description: Name that identifies the link aggregate interface
49400           required: true
49401           type: string
49402           example: __INTERFACE-NAME__
49403         - name: interface-name
49404           in: path
49405           description: Name given to the interface
49406           required: true
49407           type: string
49408           example: __INTERFACE-NAME__
49409         - name: pci-id
49410           in: path
49411           description: PCI ID used to identify the sriov-vf
49412           required: true
49413           type: string
49414           example: __PCI-ID__
49415         - name: body
49416           in: body
49417           description: sriov-vf object that needs to be created or updated.
49418           required: true
49419           schema:
49420             $ref: "#/patchDefinitions/sriov-vf"
49421     delete:
49422       tags:
49423         - Network
49424       summary: delete an existing sriov-vf
49425       description: delete an existing sriov-vf
49426       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf
49427       consumes:
49428         - application/json
49429         - application/xml
49430       produces:
49431         - application/json
49432         - application/xml
49433       responses:
49434         "default":
49435           description: Response codes found in [response codes](https://wiki.onap.org/).
49436       parameters:
49437         - name: pnf-name
49438           in: path
49439           description: unique name of Physical Network Function.
49440           required: true
49441           type: string
49442           example: __PNF-NAME__
49443         - name: interface-name
49444           in: path
49445           description: Name that identifies the link aggregate interface
49446           required: true
49447           type: string
49448           example: __INTERFACE-NAME__
49449         - name: interface-name
49450           in: path
49451           description: Name given to the interface
49452           required: true
49453           type: string
49454           example: __INTERFACE-NAME__
49455         - name: pci-id
49456           in: path
49457           description: PCI ID used to identify the sriov-vf
49458           required: true
49459           type: string
49460           example: __PCI-ID__
49461         - name: resource-version
49462           in: query
49463           description: resource-version for concurrency
49464           required: true
49465           type: string
49466   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs:
49467     get:
49468       tags:
49469         - Network
49470       summary: returns sriov-vfs
49471       description: returns sriov-vfs
49472       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfs
49473       produces:
49474         - application/json
49475         - application/xml
49476       responses:
49477         "200":
49478           description: successful operation
49479           schema:
49480               $ref: "#/getDefinitions/sriov-vfs"
49481         "default":
49482           description: Response codes found in [response codes](https://wiki.onap.org/).
49483       parameters:
49484         - name: pnf-name
49485           in: path
49486           description: unique name of Physical Network Function.
49487           required: true
49488           type: string
49489           example: __PNF-NAME__
49490         - name: interface-name
49491           in: path
49492           description: Name that identifies the link aggregate interface
49493           required: true
49494           type: string
49495           example: __INTERFACE-NAME__
49496         - name: interface-name
49497           in: path
49498           description: Name given to the interface
49499           required: true
49500           type: string
49501           example: __INTERFACE-NAME__
49502         - name: inv-status
49503           in: query
49504           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49505           required: false
49506           type: string
49507         - name: interface-id
49508           in: query
49509           description: ID of interface
49510           required: false
49511           type: string
49512         - name: interface-role
49513           in: query
49514           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49515           required: false
49516           type: string
49517         - name: interface-id
49518           in: query
49519           description: ID of interface
49520           required: false
49521           type: string
49522         - name: macaddr
49523           in: query
49524           description: MAC address for the interface
49525           required: false
49526           type: string
49527         - name: network-name
49528           in: query
49529           description: Name of the network
49530           required: false
49531           type: string
49532   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship:
49533     put:
49534       tags:
49535         - Network
49536       summary: see node definition for valid relationships
49537       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
49538       consumes:
49539         - application/json
49540         - application/xml
49541       produces:
49542         - application/json
49543         - application/xml
49544       responses:
49545         "default":
49546           description: Response codes found in [response codes](https://wiki.onap.org/).
49547       parameters:
49548         - name: pnf-name
49549           in: path
49550           description: unique name of Physical Network Function.
49551           required: true
49552           type: string
49553           example: __PNF-NAME__
49554         - name: interface-name
49555           in: path
49556           description: Name that identifies the link aggregate interface
49557           required: true
49558           type: string
49559           example: __INTERFACE-NAME__
49560         - name: interface-name
49561           in: path
49562           description: Name given to the interface
49563           required: true
49564           type: string
49565           example: __INTERFACE-NAME__
49566         - name: body
49567           in: body
49568           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
49569           required: true
49570           schema:
49571             $ref: "#/definitions/relationship"
49572     delete:
49573       tags:
49574         - Network
49575       summary: delete an existing relationship
49576       description: delete an existing relationship
49577       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceRelationshipListRelationship
49578       consumes:
49579         - application/json
49580         - application/xml
49581       produces:
49582         - application/json
49583         - application/xml
49584       responses:
49585         "default":
49586           description: Response codes found in [response codes](https://wiki.onap.org/).
49587       parameters:
49588         - name: pnf-name
49589           in: path
49590           description: unique name of Physical Network Function.
49591           required: true
49592           type: string
49593           example: __PNF-NAME__
49594         - name: interface-name
49595           in: path
49596           description: Name that identifies the link aggregate interface
49597           required: true
49598           type: string
49599           example: __INTERFACE-NAME__
49600         - name: interface-name
49601           in: path
49602           description: Name given to the interface
49603           required: true
49604           type: string
49605           example: __INTERFACE-NAME__
49606   /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:
49607     put:
49608       tags:
49609         - Network
49610       summary: see node definition for valid relationships
49611       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
49612       consumes:
49613         - application/json
49614         - application/xml
49615       produces:
49616         - application/json
49617         - application/xml
49618       responses:
49619         "default":
49620           description: Response codes found in [response codes](https://wiki.onap.org/).
49621       parameters:
49622         - name: pnf-name
49623           in: path
49624           description: unique name of Physical Network Function.
49625           required: true
49626           type: string
49627           example: __PNF-NAME__
49628         - name: interface-name
49629           in: path
49630           description: Name that identifies the link aggregate interface
49631           required: true
49632           type: string
49633           example: __INTERFACE-NAME__
49634         - name: interface-name
49635           in: path
49636           description: Name given to the interface
49637           required: true
49638           type: string
49639           example: __INTERFACE-NAME__
49640         - name: l3-interface-ipv4-address
49641           in: path
49642           description: IP address
49643           required: true
49644           type: string
49645           example: __L3-INTERFACE-IPV4-ADDRESS__
49646         - name: body
49647           in: body
49648           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
49649           required: true
49650           schema:
49651             $ref: "#/definitions/relationship"
49652     delete:
49653       tags:
49654         - Network
49655       summary: delete an existing relationship
49656       description: delete an existing relationship
49657       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressListRelationshipListRelationship
49658       consumes:
49659         - application/json
49660         - application/xml
49661       produces:
49662         - application/json
49663         - application/xml
49664       responses:
49665         "default":
49666           description: Response codes found in [response codes](https://wiki.onap.org/).
49667       parameters:
49668         - name: pnf-name
49669           in: path
49670           description: unique name of Physical Network Function.
49671           required: true
49672           type: string
49673           example: __PNF-NAME__
49674         - name: interface-name
49675           in: path
49676           description: Name that identifies the link aggregate interface
49677           required: true
49678           type: string
49679           example: __INTERFACE-NAME__
49680         - name: interface-name
49681           in: path
49682           description: Name given to the interface
49683           required: true
49684           type: string
49685           example: __INTERFACE-NAME__
49686         - name: l3-interface-ipv4-address
49687           in: path
49688           description: IP address
49689           required: true
49690           type: string
49691           example: __L3-INTERFACE-IPV4-ADDRESS__
49692   /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}:
49693     get:
49694       tags:
49695         - Network
49696       summary: returns l3-interface-ipv4-address-list
49697       description: returns l3-interface-ipv4-address-list
49698       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49699       produces:
49700         - application/json
49701         - application/xml
49702       responses:
49703         "200":
49704           description: successful operation
49705           schema:
49706               $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
49707         "default":
49708           description: Response codes found in [response codes](https://wiki.onap.org/).
49709       parameters:
49710         - name: pnf-name
49711           in: path
49712           description: unique name of Physical Network Function.
49713           required: true
49714           type: string
49715           example: __PNF-NAME__
49716         - name: interface-name
49717           in: path
49718           description: Name that identifies the link aggregate interface
49719           required: true
49720           type: string
49721           example: __INTERFACE-NAME__
49722         - name: interface-name
49723           in: path
49724           description: Name given to the interface
49725           required: true
49726           type: string
49727           example: __INTERFACE-NAME__
49728         - name: l3-interface-ipv4-address
49729           in: path
49730           description: IP address
49731           required: true
49732           type: string
49733           example: __L3-INTERFACE-IPV4-ADDRESS__
49734         - name: inv-status
49735           in: query
49736           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
49737           required: false
49738           type: string
49739         - name: interface-id
49740           in: query
49741           description: ID of interface
49742           required: false
49743           type: string
49744         - name: interface-role
49745           in: query
49746           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
49747           required: false
49748           type: string
49749         - name: interface-id
49750           in: query
49751           description: ID of interface
49752           required: false
49753           type: string
49754         - name: macaddr
49755           in: query
49756           description: MAC address for the interface
49757           required: false
49758           type: string
49759         - name: network-name
49760           in: query
49761           description: Name of the network
49762           required: false
49763           type: string
49764         - name: vlan-id-inner
49765           in: query
49766           description: Inner VLAN tag
49767           required: false
49768           type: integer
49769           format: int64
49770         - name: neutron-network-id
49771           in: query
49772           description: Neutron network id of the interface that address belongs to
49773           required: false
49774           type: string
49775         - name: neutron-subnet-id
49776           in: query
49777           description: Neutron id of subnet that address belongs to
49778           required: false
49779           type: string
49780     put:
49781       tags:
49782         - Network
49783       summary: create or update an existing l3-interface-ipv4-address-list
49784       description: |
49785         Create or update an existing l3-interface-ipv4-address-list.
49786         #
49787         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
49788       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49789       consumes:
49790         - application/json
49791         - application/xml
49792       produces:
49793         - application/json
49794         - application/xml
49795       responses:
49796         "default":
49797           description: Response codes found in [response codes](https://wiki.onap.org/).
49798       parameters:
49799         - name: pnf-name
49800           in: path
49801           description: unique name of Physical Network Function.
49802           required: true
49803           type: string
49804           example: __PNF-NAME__
49805         - name: interface-name
49806           in: path
49807           description: Name that identifies the link aggregate interface
49808           required: true
49809           type: string
49810           example: __INTERFACE-NAME__
49811         - name: interface-name
49812           in: path
49813           description: Name given to the interface
49814           required: true
49815           type: string
49816           example: __INTERFACE-NAME__
49817         - name: l3-interface-ipv4-address
49818           in: path
49819           description: IP address
49820           required: true
49821           type: string
49822           example: __L3-INTERFACE-IPV4-ADDRESS__
49823         - name: body
49824           in: body
49825           description: l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)
49826           required: true
49827           schema:
49828             $ref: "#/definitions/l3-interface-ipv4-address-list"
49829     patch:
49830       tags:
49831         - Network
49832       summary: update an existing l3-interface-ipv4-address-list
49833       description: |
49834         Update an existing l3-interface-ipv4-address-list
49835         #
49836         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
49837         The PUT operation will entirely replace an existing object.
49838         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
49839         #
49840         Other differences between PUT and PATCH are:
49841         #
49842         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
49843         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
49844         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
49845       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49846       consumes:
49847         - application/json
49848         - application/xml
49849       produces:
49850         - application/json
49851         - application/xml
49852       responses:
49853         "default":
49854           description: Response codes found in [response codes](https://wiki.onap.org/).
49855       parameters:
49856         - name: pnf-name
49857           in: path
49858           description: unique name of Physical Network Function.
49859           required: true
49860           type: string
49861           example: __PNF-NAME__
49862         - name: interface-name
49863           in: path
49864           description: Name that identifies the link aggregate interface
49865           required: true
49866           type: string
49867           example: __INTERFACE-NAME__
49868         - name: interface-name
49869           in: path
49870           description: Name given to the interface
49871           required: true
49872           type: string
49873           example: __INTERFACE-NAME__
49874         - name: l3-interface-ipv4-address
49875           in: path
49876           description: IP address
49877           required: true
49878           type: string
49879           example: __L3-INTERFACE-IPV4-ADDRESS__
49880         - name: body
49881           in: body
49882           description: l3-interface-ipv4-address-list object that needs to be created or updated.
49883           required: true
49884           schema:
49885             $ref: "#/patchDefinitions/l3-interface-ipv4-address-list"
49886     delete:
49887       tags:
49888         - Network
49889       summary: delete an existing l3-interface-ipv4-address-list
49890       description: delete an existing l3-interface-ipv4-address-list
49891       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList
49892       consumes:
49893         - application/json
49894         - application/xml
49895       produces:
49896         - application/json
49897         - application/xml
49898       responses:
49899         "default":
49900           description: Response codes found in [response codes](https://wiki.onap.org/).
49901       parameters:
49902         - name: pnf-name
49903           in: path
49904           description: unique name of Physical Network Function.
49905           required: true
49906           type: string
49907           example: __PNF-NAME__
49908         - name: interface-name
49909           in: path
49910           description: Name that identifies the link aggregate interface
49911           required: true
49912           type: string
49913           example: __INTERFACE-NAME__
49914         - name: interface-name
49915           in: path
49916           description: Name given to the interface
49917           required: true
49918           type: string
49919           example: __INTERFACE-NAME__
49920         - name: l3-interface-ipv4-address
49921           in: path
49922           description: IP address
49923           required: true
49924           type: string
49925           example: __L3-INTERFACE-IPV4-ADDRESS__
49926         - name: resource-version
49927           in: query
49928           description: resource-version for concurrency
49929           required: true
49930           type: string
49931   /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:
49932     put:
49933       tags:
49934         - Network
49935       summary: see node definition for valid relationships
49936       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
49937       consumes:
49938         - application/json
49939         - application/xml
49940       produces:
49941         - application/json
49942         - application/xml
49943       responses:
49944         "default":
49945           description: Response codes found in [response codes](https://wiki.onap.org/).
49946       parameters:
49947         - name: pnf-name
49948           in: path
49949           description: unique name of Physical Network Function.
49950           required: true
49951           type: string
49952           example: __PNF-NAME__
49953         - name: interface-name
49954           in: path
49955           description: Name that identifies the link aggregate interface
49956           required: true
49957           type: string
49958           example: __INTERFACE-NAME__
49959         - name: interface-name
49960           in: path
49961           description: Name given to the interface
49962           required: true
49963           type: string
49964           example: __INTERFACE-NAME__
49965         - name: l3-interface-ipv6-address
49966           in: path
49967           description: IP address
49968           required: true
49969           type: string
49970           example: __L3-INTERFACE-IPV6-ADDRESS__
49971         - name: body
49972           in: body
49973           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
49974           required: true
49975           schema:
49976             $ref: "#/definitions/relationship"
49977     delete:
49978       tags:
49979         - Network
49980       summary: delete an existing relationship
49981       description: delete an existing relationship
49982       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressListRelationshipListRelationship
49983       consumes:
49984         - application/json
49985         - application/xml
49986       produces:
49987         - application/json
49988         - application/xml
49989       responses:
49990         "default":
49991           description: Response codes found in [response codes](https://wiki.onap.org/).
49992       parameters:
49993         - name: pnf-name
49994           in: path
49995           description: unique name of Physical Network Function.
49996           required: true
49997           type: string
49998           example: __PNF-NAME__
49999         - name: interface-name
50000           in: path
50001           description: Name that identifies the link aggregate interface
50002           required: true
50003           type: string
50004           example: __INTERFACE-NAME__
50005         - name: interface-name
50006           in: path
50007           description: Name given to the interface
50008           required: true
50009           type: string
50010           example: __INTERFACE-NAME__
50011         - name: l3-interface-ipv6-address
50012           in: path
50013           description: IP address
50014           required: true
50015           type: string
50016           example: __L3-INTERFACE-IPV6-ADDRESS__
50017   /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}:
50018     get:
50019       tags:
50020         - Network
50021       summary: returns l3-interface-ipv6-address-list
50022       description: returns l3-interface-ipv6-address-list
50023       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50024       produces:
50025         - application/json
50026         - application/xml
50027       responses:
50028         "200":
50029           description: successful operation
50030           schema:
50031               $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
50032         "default":
50033           description: Response codes found in [response codes](https://wiki.onap.org/).
50034       parameters:
50035         - name: pnf-name
50036           in: path
50037           description: unique name of Physical Network Function.
50038           required: true
50039           type: string
50040           example: __PNF-NAME__
50041         - name: interface-name
50042           in: path
50043           description: Name that identifies the link aggregate interface
50044           required: true
50045           type: string
50046           example: __INTERFACE-NAME__
50047         - name: interface-name
50048           in: path
50049           description: Name given to the interface
50050           required: true
50051           type: string
50052           example: __INTERFACE-NAME__
50053         - name: l3-interface-ipv6-address
50054           in: path
50055           description: IP address
50056           required: true
50057           type: string
50058           example: __L3-INTERFACE-IPV6-ADDRESS__
50059         - name: inv-status
50060           in: query
50061           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50062           required: false
50063           type: string
50064         - name: interface-id
50065           in: query
50066           description: ID of interface
50067           required: false
50068           type: string
50069         - name: interface-role
50070           in: query
50071           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50072           required: false
50073           type: string
50074         - name: interface-id
50075           in: query
50076           description: ID of interface
50077           required: false
50078           type: string
50079         - name: macaddr
50080           in: query
50081           description: MAC address for the interface
50082           required: false
50083           type: string
50084         - name: network-name
50085           in: query
50086           description: Name of the network
50087           required: false
50088           type: string
50089         - name: vlan-id-inner
50090           in: query
50091           description: Inner VLAN tag
50092           required: false
50093           type: integer
50094           format: int64
50095         - name: neutron-network-id
50096           in: query
50097           description: Neutron network id of the interface that address belongs to
50098           required: false
50099           type: string
50100         - name: neutron-subnet-id
50101           in: query
50102           description: Neutron id of subnet that address belongs to
50103           required: false
50104           type: string
50105     put:
50106       tags:
50107         - Network
50108       summary: create or update an existing l3-interface-ipv6-address-list
50109       description: |
50110         Create or update an existing l3-interface-ipv6-address-list.
50111         #
50112         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50113       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50114       consumes:
50115         - application/json
50116         - application/xml
50117       produces:
50118         - application/json
50119         - application/xml
50120       responses:
50121         "default":
50122           description: Response codes found in [response codes](https://wiki.onap.org/).
50123       parameters:
50124         - name: pnf-name
50125           in: path
50126           description: unique name of Physical Network Function.
50127           required: true
50128           type: string
50129           example: __PNF-NAME__
50130         - name: interface-name
50131           in: path
50132           description: Name that identifies the link aggregate interface
50133           required: true
50134           type: string
50135           example: __INTERFACE-NAME__
50136         - name: interface-name
50137           in: path
50138           description: Name given to the interface
50139           required: true
50140           type: string
50141           example: __INTERFACE-NAME__
50142         - name: l3-interface-ipv6-address
50143           in: path
50144           description: IP address
50145           required: true
50146           type: string
50147           example: __L3-INTERFACE-IPV6-ADDRESS__
50148         - name: body
50149           in: body
50150           description: l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)
50151           required: true
50152           schema:
50153             $ref: "#/definitions/l3-interface-ipv6-address-list"
50154     patch:
50155       tags:
50156         - Network
50157       summary: update an existing l3-interface-ipv6-address-list
50158       description: |
50159         Update an existing l3-interface-ipv6-address-list
50160         #
50161         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50162         The PUT operation will entirely replace an existing object.
50163         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50164         #
50165         Other differences between PUT and PATCH are:
50166         #
50167         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50168         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50169         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50170       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50171       consumes:
50172         - application/json
50173         - application/xml
50174       produces:
50175         - application/json
50176         - application/xml
50177       responses:
50178         "default":
50179           description: Response codes found in [response codes](https://wiki.onap.org/).
50180       parameters:
50181         - name: pnf-name
50182           in: path
50183           description: unique name of Physical Network Function.
50184           required: true
50185           type: string
50186           example: __PNF-NAME__
50187         - name: interface-name
50188           in: path
50189           description: Name that identifies the link aggregate interface
50190           required: true
50191           type: string
50192           example: __INTERFACE-NAME__
50193         - name: interface-name
50194           in: path
50195           description: Name given to the interface
50196           required: true
50197           type: string
50198           example: __INTERFACE-NAME__
50199         - name: l3-interface-ipv6-address
50200           in: path
50201           description: IP address
50202           required: true
50203           type: string
50204           example: __L3-INTERFACE-IPV6-ADDRESS__
50205         - name: body
50206           in: body
50207           description: l3-interface-ipv6-address-list object that needs to be created or updated.
50208           required: true
50209           schema:
50210             $ref: "#/patchDefinitions/l3-interface-ipv6-address-list"
50211     delete:
50212       tags:
50213         - Network
50214       summary: delete an existing l3-interface-ipv6-address-list
50215       description: delete an existing l3-interface-ipv6-address-list
50216       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList
50217       consumes:
50218         - application/json
50219         - application/xml
50220       produces:
50221         - application/json
50222         - application/xml
50223       responses:
50224         "default":
50225           description: Response codes found in [response codes](https://wiki.onap.org/).
50226       parameters:
50227         - name: pnf-name
50228           in: path
50229           description: unique name of Physical Network Function.
50230           required: true
50231           type: string
50232           example: __PNF-NAME__
50233         - name: interface-name
50234           in: path
50235           description: Name that identifies the link aggregate interface
50236           required: true
50237           type: string
50238           example: __INTERFACE-NAME__
50239         - name: interface-name
50240           in: path
50241           description: Name given to the interface
50242           required: true
50243           type: string
50244           example: __INTERFACE-NAME__
50245         - name: l3-interface-ipv6-address
50246           in: path
50247           description: IP address
50248           required: true
50249           type: string
50250           example: __L3-INTERFACE-IPV6-ADDRESS__
50251         - name: resource-version
50252           in: query
50253           description: resource-version for concurrency
50254           required: true
50255           type: string
50256   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}:
50257     get:
50258       tags:
50259         - Network
50260       summary: returns l-interface
50261       description: returns l-interface
50262       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50263       produces:
50264         - application/json
50265         - application/xml
50266       responses:
50267         "200":
50268           description: successful operation
50269           schema:
50270               $ref: "#/getDefinitions/l-interface"
50271         "default":
50272           description: Response codes found in [response codes](https://wiki.onap.org/).
50273       parameters:
50274         - name: pnf-name
50275           in: path
50276           description: unique name of Physical Network Function.
50277           required: true
50278           type: string
50279           example: __PNF-NAME__
50280         - name: interface-name
50281           in: path
50282           description: Name that identifies the link aggregate interface
50283           required: true
50284           type: string
50285           example: __INTERFACE-NAME__
50286         - name: interface-name
50287           in: path
50288           description: Name given to the interface
50289           required: true
50290           type: string
50291           example: __INTERFACE-NAME__
50292         - name: inv-status
50293           in: query
50294           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50295           required: false
50296           type: string
50297         - name: interface-id
50298           in: query
50299           description: ID of interface
50300           required: false
50301           type: string
50302         - name: interface-role
50303           in: query
50304           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50305           required: false
50306           type: string
50307         - name: interface-id
50308           in: query
50309           description: ID of interface
50310           required: false
50311           type: string
50312         - name: macaddr
50313           in: query
50314           description: MAC address for the interface
50315           required: false
50316           type: string
50317         - name: network-name
50318           in: query
50319           description: Name of the network
50320           required: false
50321           type: string
50322     put:
50323       tags:
50324         - Network
50325       summary: create or update an existing l-interface
50326       description: |
50327         Create or update an existing l-interface.
50328         #
50329         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50330       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50331       consumes:
50332         - application/json
50333         - application/xml
50334       produces:
50335         - application/json
50336         - application/xml
50337       responses:
50338         "default":
50339           description: Response codes found in [response codes](https://wiki.onap.org/).
50340       parameters:
50341         - name: pnf-name
50342           in: path
50343           description: unique name of Physical Network Function.
50344           required: true
50345           type: string
50346           example: __PNF-NAME__
50347         - name: interface-name
50348           in: path
50349           description: Name that identifies the link aggregate interface
50350           required: true
50351           type: string
50352           example: __INTERFACE-NAME__
50353         - name: interface-name
50354           in: path
50355           description: Name given to the interface
50356           required: true
50357           type: string
50358           example: __INTERFACE-NAME__
50359         - name: body
50360           in: body
50361           description: l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)
50362           required: true
50363           schema:
50364             $ref: "#/definitions/l-interface"
50365     patch:
50366       tags:
50367         - Network
50368       summary: update an existing l-interface
50369       description: |
50370         Update an existing l-interface
50371         #
50372         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50373         The PUT operation will entirely replace an existing object.
50374         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50375         #
50376         Other differences between PUT and PATCH are:
50377         #
50378         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50379         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50380         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50381       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50382       consumes:
50383         - application/json
50384         - application/xml
50385       produces:
50386         - application/json
50387         - application/xml
50388       responses:
50389         "default":
50390           description: Response codes found in [response codes](https://wiki.onap.org/).
50391       parameters:
50392         - name: pnf-name
50393           in: path
50394           description: unique name of Physical Network Function.
50395           required: true
50396           type: string
50397           example: __PNF-NAME__
50398         - name: interface-name
50399           in: path
50400           description: Name that identifies the link aggregate interface
50401           required: true
50402           type: string
50403           example: __INTERFACE-NAME__
50404         - name: interface-name
50405           in: path
50406           description: Name given to the interface
50407           required: true
50408           type: string
50409           example: __INTERFACE-NAME__
50410         - name: body
50411           in: body
50412           description: l-interface object that needs to be created or updated.
50413           required: true
50414           schema:
50415             $ref: "#/patchDefinitions/l-interface"
50416     delete:
50417       tags:
50418         - Network
50419       summary: delete an existing l-interface
50420       description: delete an existing l-interface
50421       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface
50422       consumes:
50423         - application/json
50424         - application/xml
50425       produces:
50426         - application/json
50427         - application/xml
50428       responses:
50429         "default":
50430           description: Response codes found in [response codes](https://wiki.onap.org/).
50431       parameters:
50432         - name: pnf-name
50433           in: path
50434           description: unique name of Physical Network Function.
50435           required: true
50436           type: string
50437           example: __PNF-NAME__
50438         - name: interface-name
50439           in: path
50440           description: Name that identifies the link aggregate interface
50441           required: true
50442           type: string
50443           example: __INTERFACE-NAME__
50444         - name: interface-name
50445           in: path
50446           description: Name given to the interface
50447           required: true
50448           type: string
50449           example: __INTERFACE-NAME__
50450         - name: resource-version
50451           in: query
50452           description: resource-version for concurrency
50453           required: true
50454           type: string
50455   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces:
50456     get:
50457       tags:
50458         - Network
50459       summary: returns l-interfaces
50460       description: returns l-interfaces
50461       operationId: getNetworkPnfsPnfLagInterfacesLagInterfaceLInterfaces
50462       produces:
50463         - application/json
50464         - application/xml
50465       responses:
50466         "200":
50467           description: successful operation
50468           schema:
50469               $ref: "#/getDefinitions/l-interfaces"
50470         "default":
50471           description: Response codes found in [response codes](https://wiki.onap.org/).
50472       parameters:
50473         - name: pnf-name
50474           in: path
50475           description: unique name of Physical Network Function.
50476           required: true
50477           type: string
50478           example: __PNF-NAME__
50479         - name: interface-name
50480           in: path
50481           description: Name that identifies the link aggregate interface
50482           required: true
50483           type: string
50484           example: __INTERFACE-NAME__
50485         - name: inv-status
50486           in: query
50487           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50488           required: false
50489           type: string
50490         - name: interface-id
50491           in: query
50492           description: ID of interface
50493           required: false
50494           type: string
50495         - name: interface-role
50496           in: query
50497           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50498           required: false
50499           type: string
50500   /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}:
50501     get:
50502       tags:
50503         - Network
50504       summary: returns lag-interface
50505       description: returns lag-interface
50506       operationId: getNetworkPnfsPnfLagInterfacesLagInterface
50507       produces:
50508         - application/json
50509         - application/xml
50510       responses:
50511         "200":
50512           description: successful operation
50513           schema:
50514               $ref: "#/getDefinitions/lag-interface"
50515         "default":
50516           description: Response codes found in [response codes](https://wiki.onap.org/).
50517       parameters:
50518         - name: pnf-name
50519           in: path
50520           description: unique name of Physical Network Function.
50521           required: true
50522           type: string
50523           example: __PNF-NAME__
50524         - name: interface-name
50525           in: path
50526           description: Name that identifies the link aggregate interface
50527           required: true
50528           type: string
50529           example: __INTERFACE-NAME__
50530         - name: inv-status
50531           in: query
50532           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50533           required: false
50534           type: string
50535         - name: interface-id
50536           in: query
50537           description: ID of interface
50538           required: false
50539           type: string
50540         - name: interface-role
50541           in: query
50542           description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
50543           required: false
50544           type: string
50545     put:
50546       tags:
50547         - Network
50548       summary: create or update an existing lag-interface
50549       description: |
50550         Create or update an existing lag-interface.
50551         #
50552         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50553       operationId: createOrUpdateNetworkPnfsPnfLagInterfacesLagInterface
50554       consumes:
50555         - application/json
50556         - application/xml
50557       produces:
50558         - application/json
50559         - application/xml
50560       responses:
50561         "default":
50562           description: Response codes found in [response codes](https://wiki.onap.org/).
50563       parameters:
50564         - name: pnf-name
50565           in: path
50566           description: unique name of Physical Network Function.
50567           required: true
50568           type: string
50569           example: __PNF-NAME__
50570         - name: interface-name
50571           in: path
50572           description: Name that identifies the link aggregate interface
50573           required: true
50574           type: string
50575           example: __INTERFACE-NAME__
50576         - name: body
50577           in: body
50578           description: lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)
50579           required: true
50580           schema:
50581             $ref: "#/definitions/lag-interface"
50582     patch:
50583       tags:
50584         - Network
50585       summary: update an existing lag-interface
50586       description: |
50587         Update an existing lag-interface
50588         #
50589         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50590         The PUT operation will entirely replace an existing object.
50591         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50592         #
50593         Other differences between PUT and PATCH are:
50594         #
50595         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50596         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50597         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50598       operationId: UpdateNetworkPnfsPnfLagInterfacesLagInterface
50599       consumes:
50600         - application/json
50601         - application/xml
50602       produces:
50603         - application/json
50604         - application/xml
50605       responses:
50606         "default":
50607           description: Response codes found in [response codes](https://wiki.onap.org/).
50608       parameters:
50609         - name: pnf-name
50610           in: path
50611           description: unique name of Physical Network Function.
50612           required: true
50613           type: string
50614           example: __PNF-NAME__
50615         - name: interface-name
50616           in: path
50617           description: Name that identifies the link aggregate interface
50618           required: true
50619           type: string
50620           example: __INTERFACE-NAME__
50621         - name: body
50622           in: body
50623           description: lag-interface object that needs to be created or updated.
50624           required: true
50625           schema:
50626             $ref: "#/patchDefinitions/lag-interface"
50627     delete:
50628       tags:
50629         - Network
50630       summary: delete an existing lag-interface
50631       description: delete an existing lag-interface
50632       operationId: deleteNetworkPnfsPnfLagInterfacesLagInterface
50633       consumes:
50634         - application/json
50635         - application/xml
50636       produces:
50637         - application/json
50638         - application/xml
50639       responses:
50640         "default":
50641           description: Response codes found in [response codes](https://wiki.onap.org/).
50642       parameters:
50643         - name: pnf-name
50644           in: path
50645           description: unique name of Physical Network Function.
50646           required: true
50647           type: string
50648           example: __PNF-NAME__
50649         - name: interface-name
50650           in: path
50651           description: Name that identifies the link aggregate interface
50652           required: true
50653           type: string
50654           example: __INTERFACE-NAME__
50655         - name: resource-version
50656           in: query
50657           description: resource-version for concurrency
50658           required: true
50659           type: string
50660   /network/pnfs/pnf/{pnf-name}/lag-interfaces:
50661     get:
50662       tags:
50663         - Network
50664       summary: returns lag-interfaces
50665       description: returns lag-interfaces
50666       operationId: getNetworkPnfsPnfLagInterfaces
50667       produces:
50668         - application/json
50669         - application/xml
50670       responses:
50671         "200":
50672           description: successful operation
50673           schema:
50674               $ref: "#/getDefinitions/lag-interfaces"
50675         "default":
50676           description: Response codes found in [response codes](https://wiki.onap.org/).
50677       parameters:
50678         - name: pnf-name
50679           in: path
50680           description: unique name of Physical Network Function.
50681           required: true
50682           type: string
50683           example: __PNF-NAME__
50684         - name: inv-status
50685           in: query
50686           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50687           required: false
50688           type: string
50689   /network/pnfs/pnf/{pnf-name}:
50690     get:
50691       tags:
50692         - Network
50693       summary: returns pnf
50694       description: returns pnf
50695       operationId: getNetworkPnfsPnf
50696       produces:
50697         - application/json
50698         - application/xml
50699       responses:
50700         "200":
50701           description: successful operation
50702           schema:
50703               $ref: "#/getDefinitions/pnf"
50704         "default":
50705           description: Response codes found in [response codes](https://wiki.onap.org/).
50706       parameters:
50707         - name: pnf-name
50708           in: path
50709           description: unique name of Physical Network Function.
50710           required: true
50711           type: string
50712           example: __PNF-NAME__
50713         - name: inv-status
50714           in: query
50715           description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
50716           required: false
50717           type: string
50718     put:
50719       tags:
50720         - Network
50721       summary: create or update an existing pnf
50722       description: |
50723         Create or update an existing pnf.
50724         #
50725         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50726       operationId: createOrUpdateNetworkPnfsPnf
50727       consumes:
50728         - application/json
50729         - application/xml
50730       produces:
50731         - application/json
50732         - application/xml
50733       responses:
50734         "default":
50735           description: Response codes found in [response codes](https://wiki.onap.org/).
50736       parameters:
50737         - name: pnf-name
50738           in: path
50739           description: unique name of Physical Network Function.
50740           required: true
50741           type: string
50742           example: __PNF-NAME__
50743         - name: body
50744           in: body
50745           description: pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)
50746           required: true
50747           schema:
50748             $ref: "#/definitions/pnf"
50749     patch:
50750       tags:
50751         - Network
50752       summary: update an existing pnf
50753       description: |
50754         Update an existing pnf
50755         #
50756         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50757         The PUT operation will entirely replace an existing object.
50758         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50759         #
50760         Other differences between PUT and PATCH are:
50761         #
50762         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50763         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50764         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50765       operationId: UpdateNetworkPnfsPnf
50766       consumes:
50767         - application/json
50768         - application/xml
50769       produces:
50770         - application/json
50771         - application/xml
50772       responses:
50773         "default":
50774           description: Response codes found in [response codes](https://wiki.onap.org/).
50775       parameters:
50776         - name: pnf-name
50777           in: path
50778           description: unique name of Physical Network Function.
50779           required: true
50780           type: string
50781           example: __PNF-NAME__
50782         - name: body
50783           in: body
50784           description: pnf object that needs to be created or updated.
50785           required: true
50786           schema:
50787             $ref: "#/patchDefinitions/pnf"
50788     delete:
50789       tags:
50790         - Network
50791       summary: delete an existing pnf
50792       description: delete an existing pnf
50793       operationId: deleteNetworkPnfsPnf
50794       consumes:
50795         - application/json
50796         - application/xml
50797       produces:
50798         - application/json
50799         - application/xml
50800       responses:
50801         "default":
50802           description: Response codes found in [response codes](https://wiki.onap.org/).
50803       parameters:
50804         - name: pnf-name
50805           in: path
50806           description: unique name of Physical Network Function.
50807           required: true
50808           type: string
50809           example: __PNF-NAME__
50810         - name: resource-version
50811           in: query
50812           description: resource-version for concurrency
50813           required: true
50814           type: string
50815   /network/pnfs:
50816     get:
50817       tags:
50818         - Network
50819       summary: returns pnfs
50820       description: returns pnfs
50821       operationId: getNetworkPnfs
50822       produces:
50823         - application/json
50824         - application/xml
50825       responses:
50826         "200":
50827           description: successful operation
50828           schema:
50829               $ref: "#/getDefinitions/pnfs"
50830         "default":
50831           description: Response codes found in [response codes](https://wiki.onap.org/).
50832   /network/physical-links/physical-link/{link-name}/relationship-list/relationship:
50833     put:
50834       tags:
50835         - Network
50836       summary: see node definition for valid relationships
50837       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
50838       consumes:
50839         - application/json
50840         - application/xml
50841       produces:
50842         - application/json
50843         - application/xml
50844       responses:
50845         "default":
50846           description: Response codes found in [response codes](https://wiki.onap.org/).
50847       parameters:
50848         - name: link-name
50849           in: path
50850           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50851           required: true
50852           type: string
50853           example: __LINK-NAME__
50854         - name: body
50855           in: body
50856           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
50857           required: true
50858           schema:
50859             $ref: "#/definitions/relationship"
50860     delete:
50861       tags:
50862         - Network
50863       summary: delete an existing relationship
50864       description: delete an existing relationship
50865       operationId: deleteNetworkPhysicalLinksPhysicalLinkRelationshipListRelationship
50866       consumes:
50867         - application/json
50868         - application/xml
50869       produces:
50870         - application/json
50871         - application/xml
50872       responses:
50873         "default":
50874           description: Response codes found in [response codes](https://wiki.onap.org/).
50875       parameters:
50876         - name: link-name
50877           in: path
50878           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50879           required: true
50880           type: string
50881           example: __LINK-NAME__
50882   /network/physical-links/physical-link/{link-name}:
50883     get:
50884       tags:
50885         - Network
50886       summary: returns physical-link
50887       description: returns physical-link
50888       operationId: getNetworkPhysicalLinksPhysicalLink
50889       produces:
50890         - application/json
50891         - application/xml
50892       responses:
50893         "200":
50894           description: successful operation
50895           schema:
50896               $ref: "#/getDefinitions/physical-link"
50897         "default":
50898           description: Response codes found in [response codes](https://wiki.onap.org/).
50899       parameters:
50900         - name: link-name
50901           in: path
50902           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50903           required: true
50904           type: string
50905           example: __LINK-NAME__
50906         - name: circuit-id
50907           in: query
50908           description: Circuit it
50909           required: false
50910           type: string
50911     put:
50912       tags:
50913         - Network
50914       summary: create or update an existing physical-link
50915       description: |
50916         Create or update an existing physical-link.
50917         #
50918         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
50919       operationId: createOrUpdateNetworkPhysicalLinksPhysicalLink
50920       consumes:
50921         - application/json
50922         - application/xml
50923       produces:
50924         - application/json
50925         - application/xml
50926       responses:
50927         "default":
50928           description: Response codes found in [response codes](https://wiki.onap.org/).
50929       parameters:
50930         - name: link-name
50931           in: path
50932           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50933           required: true
50934           type: string
50935           example: __LINK-NAME__
50936         - name: body
50937           in: body
50938           description: physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)
50939           required: true
50940           schema:
50941             $ref: "#/definitions/physical-link"
50942     patch:
50943       tags:
50944         - Network
50945       summary: update an existing physical-link
50946       description: |
50947         Update an existing physical-link
50948         #
50949         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
50950         The PUT operation will entirely replace an existing object.
50951         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
50952         #
50953         Other differences between PUT and PATCH are:
50954         #
50955         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
50956         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
50957         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
50958       operationId: UpdateNetworkPhysicalLinksPhysicalLink
50959       consumes:
50960         - application/json
50961         - application/xml
50962       produces:
50963         - application/json
50964         - application/xml
50965       responses:
50966         "default":
50967           description: Response codes found in [response codes](https://wiki.onap.org/).
50968       parameters:
50969         - name: link-name
50970           in: path
50971           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
50972           required: true
50973           type: string
50974           example: __LINK-NAME__
50975         - name: body
50976           in: body
50977           description: physical-link object that needs to be created or updated.
50978           required: true
50979           schema:
50980             $ref: "#/patchDefinitions/physical-link"
50981     delete:
50982       tags:
50983         - Network
50984       summary: delete an existing physical-link
50985       description: delete an existing physical-link
50986       operationId: deleteNetworkPhysicalLinksPhysicalLink
50987       consumes:
50988         - application/json
50989         - application/xml
50990       produces:
50991         - application/json
50992         - application/xml
50993       responses:
50994         "default":
50995           description: Response codes found in [response codes](https://wiki.onap.org/).
50996       parameters:
50997         - name: link-name
50998           in: path
50999           description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
51000           required: true
51001           type: string
51002           example: __LINK-NAME__
51003         - name: resource-version
51004           in: query
51005           description: resource-version for concurrency
51006           required: true
51007           type: string
51008   /network/physical-links:
51009     get:
51010       tags:
51011         - Network
51012       summary: returns physical-links
51013       description: returns physical-links
51014       operationId: getNetworkPhysicalLinks
51015       produces:
51016         - application/json
51017         - application/xml
51018       responses:
51019         "200":
51020           description: successful operation
51021           schema:
51022               $ref: "#/getDefinitions/physical-links"
51023         "default":
51024           description: Response codes found in [response codes](https://wiki.onap.org/).
51025   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship:
51026     put:
51027       tags:
51028         - Network
51029       summary: see node definition for valid relationships
51030       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
51031       consumes:
51032         - application/json
51033         - application/xml
51034       produces:
51035         - application/json
51036         - application/xml
51037       responses:
51038         "default":
51039           description: Response codes found in [response codes](https://wiki.onap.org/).
51040       parameters:
51041         - name: ipsec-configuration-id
51042           in: path
51043           description: UUID of this configuration
51044           required: true
51045           type: string
51046           example: __IPSEC-CONFIGURATION-ID__
51047         - name: body
51048           in: body
51049           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
51050           required: true
51051           schema:
51052             $ref: "#/definitions/relationship"
51053     delete:
51054       tags:
51055         - Network
51056       summary: delete an existing relationship
51057       description: delete an existing relationship
51058       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationRelationshipListRelationship
51059       consumes:
51060         - application/json
51061         - application/xml
51062       produces:
51063         - application/json
51064         - application/xml
51065       responses:
51066         "default":
51067           description: Response codes found in [response codes](https://wiki.onap.org/).
51068       parameters:
51069         - name: ipsec-configuration-id
51070           in: path
51071           description: UUID of this configuration
51072           required: true
51073           type: string
51074           example: __IPSEC-CONFIGURATION-ID__
51075   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship:
51076     put:
51077       tags:
51078         - Network
51079       summary: see node definition for valid relationships
51080       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51081       consumes:
51082         - application/json
51083         - application/xml
51084       produces:
51085         - application/json
51086         - application/xml
51087       responses:
51088         "default":
51089           description: Response codes found in [response codes](https://wiki.onap.org/).
51090       parameters:
51091         - name: ipsec-configuration-id
51092           in: path
51093           description: UUID of this configuration
51094           required: true
51095           type: string
51096           example: __IPSEC-CONFIGURATION-ID__
51097         - name: vig-address-type
51098           in: path
51099           description: indicates whether the VIG is for AVPN or INTERNET
51100           required: true
51101           type: string
51102           example: __VIG-ADDRESS-TYPE__
51103         - name: body
51104           in: body
51105           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51106           required: true
51107           schema:
51108             $ref: "#/definitions/relationship"
51109     delete:
51110       tags:
51111         - Network
51112       summary: delete an existing relationship
51113       description: delete an existing relationship
51114       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServerRelationshipListRelationship
51115       consumes:
51116         - application/json
51117         - application/xml
51118       produces:
51119         - application/json
51120         - application/xml
51121       responses:
51122         "default":
51123           description: Response codes found in [response codes](https://wiki.onap.org/).
51124       parameters:
51125         - name: ipsec-configuration-id
51126           in: path
51127           description: UUID of this configuration
51128           required: true
51129           type: string
51130           example: __IPSEC-CONFIGURATION-ID__
51131         - name: vig-address-type
51132           in: path
51133           description: indicates whether the VIG is for AVPN or INTERNET
51134           required: true
51135           type: string
51136           example: __VIG-ADDRESS-TYPE__
51137   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}:
51138     get:
51139       tags:
51140         - Network
51141       summary: returns vig-server
51142       description: returns vig-server
51143       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51144       produces:
51145         - application/json
51146         - application/xml
51147       responses:
51148         "200":
51149           description: successful operation
51150           schema:
51151               $ref: "#/getDefinitions/vig-server"
51152         "default":
51153           description: Response codes found in [response codes](https://wiki.onap.org/).
51154       parameters:
51155         - name: ipsec-configuration-id
51156           in: path
51157           description: UUID of this configuration
51158           required: true
51159           type: string
51160           example: __IPSEC-CONFIGURATION-ID__
51161         - name: vig-address-type
51162           in: path
51163           description: indicates whether the VIG is for AVPN or INTERNET
51164           required: true
51165           type: string
51166           example: __VIG-ADDRESS-TYPE__
51167     put:
51168       tags:
51169         - Network
51170       summary: create or update an existing vig-server
51171       description: |
51172         Create or update an existing vig-server.
51173         #
51174         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51175       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51176       consumes:
51177         - application/json
51178         - application/xml
51179       produces:
51180         - application/json
51181         - application/xml
51182       responses:
51183         "default":
51184           description: Response codes found in [response codes](https://wiki.onap.org/).
51185       parameters:
51186         - name: ipsec-configuration-id
51187           in: path
51188           description: UUID of this configuration
51189           required: true
51190           type: string
51191           example: __IPSEC-CONFIGURATION-ID__
51192         - name: vig-address-type
51193           in: path
51194           description: indicates whether the VIG is for AVPN or INTERNET
51195           required: true
51196           type: string
51197           example: __VIG-ADDRESS-TYPE__
51198         - name: body
51199           in: body
51200           description: vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)
51201           required: true
51202           schema:
51203             $ref: "#/definitions/vig-server"
51204     patch:
51205       tags:
51206         - Network
51207       summary: update an existing vig-server
51208       description: |
51209         Update an existing vig-server
51210         #
51211         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51212         The PUT operation will entirely replace an existing object.
51213         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51214         #
51215         Other differences between PUT and PATCH are:
51216         #
51217         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51218         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51219         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51220       operationId: UpdateNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51221       consumes:
51222         - application/json
51223         - application/xml
51224       produces:
51225         - application/json
51226         - application/xml
51227       responses:
51228         "default":
51229           description: Response codes found in [response codes](https://wiki.onap.org/).
51230       parameters:
51231         - name: ipsec-configuration-id
51232           in: path
51233           description: UUID of this configuration
51234           required: true
51235           type: string
51236           example: __IPSEC-CONFIGURATION-ID__
51237         - name: vig-address-type
51238           in: path
51239           description: indicates whether the VIG is for AVPN or INTERNET
51240           required: true
51241           type: string
51242           example: __VIG-ADDRESS-TYPE__
51243         - name: body
51244           in: body
51245           description: vig-server object that needs to be created or updated.
51246           required: true
51247           schema:
51248             $ref: "#/patchDefinitions/vig-server"
51249     delete:
51250       tags:
51251         - Network
51252       summary: delete an existing vig-server
51253       description: delete an existing vig-server
51254       operationId: deleteNetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer
51255       consumes:
51256         - application/json
51257         - application/xml
51258       produces:
51259         - application/json
51260         - application/xml
51261       responses:
51262         "default":
51263           description: Response codes found in [response codes](https://wiki.onap.org/).
51264       parameters:
51265         - name: ipsec-configuration-id
51266           in: path
51267           description: UUID of this configuration
51268           required: true
51269           type: string
51270           example: __IPSEC-CONFIGURATION-ID__
51271         - name: vig-address-type
51272           in: path
51273           description: indicates whether the VIG is for AVPN or INTERNET
51274           required: true
51275           type: string
51276           example: __VIG-ADDRESS-TYPE__
51277         - name: resource-version
51278           in: query
51279           description: resource-version for concurrency
51280           required: true
51281           type: string
51282   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers:
51283     get:
51284       tags:
51285         - Network
51286       summary: returns vig-servers
51287       description: returns vig-servers
51288       operationId: getNetworkIpsecConfigurationsIpsecConfigurationVigServers
51289       produces:
51290         - application/json
51291         - application/xml
51292       responses:
51293         "200":
51294           description: successful operation
51295           schema:
51296               $ref: "#/getDefinitions/vig-servers"
51297         "default":
51298           description: Response codes found in [response codes](https://wiki.onap.org/).
51299       parameters:
51300         - name: ipsec-configuration-id
51301           in: path
51302           description: UUID of this configuration
51303           required: true
51304           type: string
51305           example: __IPSEC-CONFIGURATION-ID__
51306   /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}:
51307     get:
51308       tags:
51309         - Network
51310       summary: returns ipsec-configuration
51311       description: returns ipsec-configuration
51312       operationId: getNetworkIpsecConfigurationsIpsecConfiguration
51313       produces:
51314         - application/json
51315         - application/xml
51316       responses:
51317         "200":
51318           description: successful operation
51319           schema:
51320               $ref: "#/getDefinitions/ipsec-configuration"
51321         "default":
51322           description: Response codes found in [response codes](https://wiki.onap.org/).
51323       parameters:
51324         - name: ipsec-configuration-id
51325           in: path
51326           description: UUID of this configuration
51327           required: true
51328           type: string
51329           example: __IPSEC-CONFIGURATION-ID__
51330     put:
51331       tags:
51332         - Network
51333       summary: create or update an existing ipsec-configuration
51334       description: |
51335         Create or update an existing ipsec-configuration.
51336         #
51337         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51338       operationId: createOrUpdateNetworkIpsecConfigurationsIpsecConfiguration
51339       consumes:
51340         - application/json
51341         - application/xml
51342       produces:
51343         - application/json
51344         - application/xml
51345       responses:
51346         "default":
51347           description: Response codes found in [response codes](https://wiki.onap.org/).
51348       parameters:
51349         - name: ipsec-configuration-id
51350           in: path
51351           description: UUID of this configuration
51352           required: true
51353           type: string
51354           example: __IPSEC-CONFIGURATION-ID__
51355         - name: body
51356           in: body
51357           description: ipsec-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)
51358           required: true
51359           schema:
51360             $ref: "#/definitions/ipsec-configuration"
51361     patch:
51362       tags:
51363         - Network
51364       summary: update an existing ipsec-configuration
51365       description: |
51366         Update an existing ipsec-configuration
51367         #
51368         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51369         The PUT operation will entirely replace an existing object.
51370         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51371         #
51372         Other differences between PUT and PATCH are:
51373         #
51374         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51375         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51376         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51377       operationId: UpdateNetworkIpsecConfigurationsIpsecConfiguration
51378       consumes:
51379         - application/json
51380         - application/xml
51381       produces:
51382         - application/json
51383         - application/xml
51384       responses:
51385         "default":
51386           description: Response codes found in [response codes](https://wiki.onap.org/).
51387       parameters:
51388         - name: ipsec-configuration-id
51389           in: path
51390           description: UUID of this configuration
51391           required: true
51392           type: string
51393           example: __IPSEC-CONFIGURATION-ID__
51394         - name: body
51395           in: body
51396           description: ipsec-configuration object that needs to be created or updated.
51397           required: true
51398           schema:
51399             $ref: "#/patchDefinitions/ipsec-configuration"
51400     delete:
51401       tags:
51402         - Network
51403       summary: delete an existing ipsec-configuration
51404       description: delete an existing ipsec-configuration
51405       operationId: deleteNetworkIpsecConfigurationsIpsecConfiguration
51406       consumes:
51407         - application/json
51408         - application/xml
51409       produces:
51410         - application/json
51411         - application/xml
51412       responses:
51413         "default":
51414           description: Response codes found in [response codes](https://wiki.onap.org/).
51415       parameters:
51416         - name: ipsec-configuration-id
51417           in: path
51418           description: UUID of this configuration
51419           required: true
51420           type: string
51421           example: __IPSEC-CONFIGURATION-ID__
51422         - name: resource-version
51423           in: query
51424           description: resource-version for concurrency
51425           required: true
51426           type: string
51427   /network/ipsec-configurations:
51428     get:
51429       tags:
51430         - Network
51431       summary: returns ipsec-configurations
51432       description: returns ipsec-configurations
51433       operationId: getNetworkIpsecConfigurations
51434       produces:
51435         - application/json
51436         - application/xml
51437       responses:
51438         "200":
51439           description: successful operation
51440           schema:
51441               $ref: "#/getDefinitions/ipsec-configurations"
51442         "default":
51443           description: Response codes found in [response codes](https://wiki.onap.org/).
51444   /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship:
51445     put:
51446       tags:
51447         - Network
51448       summary: see node definition for valid relationships
51449       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
51450       consumes:
51451         - application/json
51452         - application/xml
51453       produces:
51454         - application/json
51455         - application/xml
51456       responses:
51457         "default":
51458           description: Response codes found in [response codes](https://wiki.onap.org/).
51459       parameters:
51460         - name: route-table-reference-id
51461           in: path
51462           description: Route Table Reference id, UUID assigned to this instance.
51463           required: true
51464           type: string
51465           example: __ROUTE-TABLE-REFERENCE-ID__
51466         - name: body
51467           in: body
51468           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
51469           required: true
51470           schema:
51471             $ref: "#/definitions/relationship"
51472     delete:
51473       tags:
51474         - Network
51475       summary: delete an existing relationship
51476       description: delete an existing relationship
51477       operationId: deleteNetworkRouteTableReferencesRouteTableReferenceRelationshipListRelationship
51478       consumes:
51479         - application/json
51480         - application/xml
51481       produces:
51482         - application/json
51483         - application/xml
51484       responses:
51485         "default":
51486           description: Response codes found in [response codes](https://wiki.onap.org/).
51487       parameters:
51488         - name: route-table-reference-id
51489           in: path
51490           description: Route Table Reference id, UUID assigned to this instance.
51491           required: true
51492           type: string
51493           example: __ROUTE-TABLE-REFERENCE-ID__
51494   /network/route-table-references/route-table-reference/{route-table-reference-id}:
51495     get:
51496       tags:
51497         - Network
51498       summary: returns route-table-reference
51499       description: returns route-table-reference
51500       operationId: getNetworkRouteTableReferencesRouteTableReference
51501       produces:
51502         - application/json
51503         - application/xml
51504       responses:
51505         "200":
51506           description: successful operation
51507           schema:
51508               $ref: "#/getDefinitions/route-table-reference"
51509         "default":
51510           description: Response codes found in [response codes](https://wiki.onap.org/).
51511       parameters:
51512         - name: route-table-reference-id
51513           in: path
51514           description: Route Table Reference id, UUID assigned to this instance.
51515           required: true
51516           type: string
51517           example: __ROUTE-TABLE-REFERENCE-ID__
51518         - name: route-table-reference-fqdn
51519           in: query
51520           description: FQDN entry in the route table.
51521           required: false
51522           type: string
51523     put:
51524       tags:
51525         - Network
51526       summary: create or update an existing route-table-reference
51527       description: |
51528         Create or update an existing route-table-reference.
51529         #
51530         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51531       operationId: createOrUpdateNetworkRouteTableReferencesRouteTableReference
51532       consumes:
51533         - application/json
51534         - application/xml
51535       produces:
51536         - application/json
51537         - application/xml
51538       responses:
51539         "default":
51540           description: Response codes found in [response codes](https://wiki.onap.org/).
51541       parameters:
51542         - name: route-table-reference-id
51543           in: path
51544           description: Route Table Reference id, UUID assigned to this instance.
51545           required: true
51546           type: string
51547           example: __ROUTE-TABLE-REFERENCE-ID__
51548         - name: body
51549           in: body
51550           description: route-table-reference object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)
51551           required: true
51552           schema:
51553             $ref: "#/definitions/route-table-reference"
51554     patch:
51555       tags:
51556         - Network
51557       summary: update an existing route-table-reference
51558       description: |
51559         Update an existing route-table-reference
51560         #
51561         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51562         The PUT operation will entirely replace an existing object.
51563         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51564         #
51565         Other differences between PUT and PATCH are:
51566         #
51567         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51568         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51569         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51570       operationId: UpdateNetworkRouteTableReferencesRouteTableReference
51571       consumes:
51572         - application/json
51573         - application/xml
51574       produces:
51575         - application/json
51576         - application/xml
51577       responses:
51578         "default":
51579           description: Response codes found in [response codes](https://wiki.onap.org/).
51580       parameters:
51581         - name: route-table-reference-id
51582           in: path
51583           description: Route Table Reference id, UUID assigned to this instance.
51584           required: true
51585           type: string
51586           example: __ROUTE-TABLE-REFERENCE-ID__
51587         - name: body
51588           in: body
51589           description: route-table-reference object that needs to be created or updated.
51590           required: true
51591           schema:
51592             $ref: "#/patchDefinitions/route-table-reference"
51593     delete:
51594       tags:
51595         - Network
51596       summary: delete an existing route-table-reference
51597       description: delete an existing route-table-reference
51598       operationId: deleteNetworkRouteTableReferencesRouteTableReference
51599       consumes:
51600         - application/json
51601         - application/xml
51602       produces:
51603         - application/json
51604         - application/xml
51605       responses:
51606         "default":
51607           description: Response codes found in [response codes](https://wiki.onap.org/).
51608       parameters:
51609         - name: route-table-reference-id
51610           in: path
51611           description: Route Table Reference id, UUID assigned to this instance.
51612           required: true
51613           type: string
51614           example: __ROUTE-TABLE-REFERENCE-ID__
51615         - name: resource-version
51616           in: query
51617           description: resource-version for concurrency
51618           required: true
51619           type: string
51620   /network/route-table-references:
51621     get:
51622       tags:
51623         - Network
51624       summary: returns route-table-references
51625       description: returns route-table-references
51626       operationId: getNetworkRouteTableReferences
51627       produces:
51628         - application/json
51629         - application/xml
51630       responses:
51631         "200":
51632           description: successful operation
51633           schema:
51634               $ref: "#/getDefinitions/route-table-references"
51635         "default":
51636           description: Response codes found in [response codes](https://wiki.onap.org/).
51637   /network/instance-groups/instance-group/{id}/relationship-list/relationship:
51638     put:
51639       tags:
51640         - Network
51641       summary: see node definition for valid relationships
51642       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
51643       consumes:
51644         - application/json
51645         - application/xml
51646       produces:
51647         - application/json
51648         - application/xml
51649       responses:
51650         "default":
51651           description: Response codes found in [response codes](https://wiki.onap.org/).
51652       parameters:
51653         - name: id
51654           in: path
51655           description: Instance Group ID, UUID assigned to this instance.
51656           required: true
51657           type: string
51658           example: __ID__
51659         - name: body
51660           in: body
51661           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
51662           required: true
51663           schema:
51664             $ref: "#/definitions/relationship"
51665     delete:
51666       tags:
51667         - Network
51668       summary: delete an existing relationship
51669       description: delete an existing relationship
51670       operationId: deleteNetworkInstanceGroupsInstanceGroupRelationshipListRelationship
51671       consumes:
51672         - application/json
51673         - application/xml
51674       produces:
51675         - application/json
51676         - application/xml
51677       responses:
51678         "default":
51679           description: Response codes found in [response codes](https://wiki.onap.org/).
51680       parameters:
51681         - name: id
51682           in: path
51683           description: Instance Group ID, UUID assigned to this instance.
51684           required: true
51685           type: string
51686           example: __ID__
51687   /network/instance-groups/instance-group/{id}:
51688     get:
51689       tags:
51690         - Network
51691       summary: returns instance-group
51692       description: returns instance-group
51693       operationId: getNetworkInstanceGroupsInstanceGroup
51694       produces:
51695         - application/json
51696         - application/xml
51697       responses:
51698         "200":
51699           description: successful operation
51700           schema:
51701               $ref: "#/getDefinitions/instance-group"
51702         "default":
51703           description: Response codes found in [response codes](https://wiki.onap.org/).
51704       parameters:
51705         - name: id
51706           in: path
51707           description: Instance Group ID, UUID assigned to this instance.
51708           required: true
51709           type: string
51710           example: __ID__
51711         - name: description
51712           in: query
51713           description: Descriptive text to help identify the usage of this instance-group
51714           required: false
51715           type: string
51716         - name: type
51717           in: query
51718           description: Only valid value today is lower case ha for high availability
51719           required: false
51720           type: string
51721         - name: sub-type
51722           in: query
51723           description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
51724           required: false
51725           type: string
51726     put:
51727       tags:
51728         - Network
51729       summary: create or update an existing instance-group
51730       description: |
51731         Create or update an existing instance-group.
51732         #
51733         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51734       operationId: createOrUpdateNetworkInstanceGroupsInstanceGroup
51735       consumes:
51736         - application/json
51737         - application/xml
51738       produces:
51739         - application/json
51740         - application/xml
51741       responses:
51742         "default":
51743           description: Response codes found in [response codes](https://wiki.onap.org/).
51744       parameters:
51745         - name: id
51746           in: path
51747           description: Instance Group ID, UUID assigned to this instance.
51748           required: true
51749           type: string
51750           example: __ID__
51751         - name: body
51752           in: body
51753           description: instance-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)
51754           required: true
51755           schema:
51756             $ref: "#/definitions/instance-group"
51757     patch:
51758       tags:
51759         - Network
51760       summary: update an existing instance-group
51761       description: |
51762         Update an existing instance-group
51763         #
51764         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51765         The PUT operation will entirely replace an existing object.
51766         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51767         #
51768         Other differences between PUT and PATCH are:
51769         #
51770         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51771         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51772         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51773       operationId: UpdateNetworkInstanceGroupsInstanceGroup
51774       consumes:
51775         - application/json
51776         - application/xml
51777       produces:
51778         - application/json
51779         - application/xml
51780       responses:
51781         "default":
51782           description: Response codes found in [response codes](https://wiki.onap.org/).
51783       parameters:
51784         - name: id
51785           in: path
51786           description: Instance Group ID, UUID assigned to this instance.
51787           required: true
51788           type: string
51789           example: __ID__
51790         - name: body
51791           in: body
51792           description: instance-group object that needs to be created or updated.
51793           required: true
51794           schema:
51795             $ref: "#/patchDefinitions/instance-group"
51796     delete:
51797       tags:
51798         - Network
51799       summary: delete an existing instance-group
51800       description: delete an existing instance-group
51801       operationId: deleteNetworkInstanceGroupsInstanceGroup
51802       consumes:
51803         - application/json
51804         - application/xml
51805       produces:
51806         - application/json
51807         - application/xml
51808       responses:
51809         "default":
51810           description: Response codes found in [response codes](https://wiki.onap.org/).
51811       parameters:
51812         - name: id
51813           in: path
51814           description: Instance Group ID, UUID assigned to this instance.
51815           required: true
51816           type: string
51817           example: __ID__
51818         - name: resource-version
51819           in: query
51820           description: resource-version for concurrency
51821           required: true
51822           type: string
51823   /network/instance-groups:
51824     get:
51825       tags:
51826         - Network
51827       summary: returns instance-groups
51828       description: returns instance-groups
51829       operationId: getNetworkInstanceGroups
51830       produces:
51831         - application/json
51832         - application/xml
51833       responses:
51834         "200":
51835           description: successful operation
51836           schema:
51837               $ref: "#/getDefinitions/instance-groups"
51838         "default":
51839           description: Response codes found in [response codes](https://wiki.onap.org/).
51840   /network/zones/zone/{zone-id}/relationship-list/relationship:
51841     put:
51842       tags:
51843         - Network
51844       summary: see node definition for valid relationships
51845       operationId: createOrUpdateNetworkZonesZoneRelationshipListRelationship
51846       consumes:
51847         - application/json
51848         - application/xml
51849       produces:
51850         - application/json
51851         - application/xml
51852       responses:
51853         "default":
51854           description: Response codes found in [response codes](https://wiki.onap.org/).
51855       parameters:
51856         - name: zone-id
51857           in: path
51858           description: Code assigned by AIC to the zone
51859           required: true
51860           type: string
51861           example: __ZONE-ID__
51862         - name: body
51863           in: body
51864           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
51865           required: true
51866           schema:
51867             $ref: "#/definitions/relationship"
51868     delete:
51869       tags:
51870         - Network
51871       summary: delete an existing relationship
51872       description: delete an existing relationship
51873       operationId: deleteNetworkZonesZoneRelationshipListRelationship
51874       consumes:
51875         - application/json
51876         - application/xml
51877       produces:
51878         - application/json
51879         - application/xml
51880       responses:
51881         "default":
51882           description: Response codes found in [response codes](https://wiki.onap.org/).
51883       parameters:
51884         - name: zone-id
51885           in: path
51886           description: Code assigned by AIC to the zone
51887           required: true
51888           type: string
51889           example: __ZONE-ID__
51890   /network/zones/zone/{zone-id}:
51891     get:
51892       tags:
51893         - Network
51894       summary: returns zone
51895       description: returns zone
51896       operationId: getNetworkZonesZone
51897       produces:
51898         - application/json
51899         - application/xml
51900       responses:
51901         "200":
51902           description: successful operation
51903           schema:
51904               $ref: "#/getDefinitions/zone"
51905         "default":
51906           description: Response codes found in [response codes](https://wiki.onap.org/).
51907       parameters:
51908         - name: zone-id
51909           in: path
51910           description: Code assigned by AIC to the zone
51911           required: true
51912           type: string
51913           example: __ZONE-ID__
51914         - name: design-type
51915           in: query
51916           description: Design of zone [Medium/Large?]
51917           required: false
51918           type: string
51919         - name: zone-context
51920           in: query
51921           description: Context of zone [production/test]
51922           required: false
51923           type: string
51924     put:
51925       tags:
51926         - Network
51927       summary: create or update an existing zone
51928       description: |
51929         Create or update an existing zone.
51930         #
51931         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
51932       operationId: createOrUpdateNetworkZonesZone
51933       consumes:
51934         - application/json
51935         - application/xml
51936       produces:
51937         - application/json
51938         - application/xml
51939       responses:
51940         "default":
51941           description: Response codes found in [response codes](https://wiki.onap.org/).
51942       parameters:
51943         - name: zone-id
51944           in: path
51945           description: Code assigned by AIC to the zone
51946           required: true
51947           type: string
51948           example: __ZONE-ID__
51949         - name: body
51950           in: body
51951           description: zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)
51952           required: true
51953           schema:
51954             $ref: "#/definitions/zone"
51955     patch:
51956       tags:
51957         - Network
51958       summary: update an existing zone
51959       description: |
51960         Update an existing zone
51961         #
51962         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
51963         The PUT operation will entirely replace an existing object.
51964         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
51965         #
51966         Other differences between PUT and PATCH are:
51967         #
51968         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
51969         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
51970         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
51971       operationId: UpdateNetworkZonesZone
51972       consumes:
51973         - application/json
51974         - application/xml
51975       produces:
51976         - application/json
51977         - application/xml
51978       responses:
51979         "default":
51980           description: Response codes found in [response codes](https://wiki.onap.org/).
51981       parameters:
51982         - name: zone-id
51983           in: path
51984           description: Code assigned by AIC to the zone
51985           required: true
51986           type: string
51987           example: __ZONE-ID__
51988         - name: body
51989           in: body
51990           description: zone object that needs to be created or updated.
51991           required: true
51992           schema:
51993             $ref: "#/patchDefinitions/zone"
51994     delete:
51995       tags:
51996         - Network
51997       summary: delete an existing zone
51998       description: delete an existing zone
51999       operationId: deleteNetworkZonesZone
52000       consumes:
52001         - application/json
52002         - application/xml
52003       produces:
52004         - application/json
52005         - application/xml
52006       responses:
52007         "default":
52008           description: Response codes found in [response codes](https://wiki.onap.org/).
52009       parameters:
52010         - name: zone-id
52011           in: path
52012           description: Code assigned by AIC to the zone
52013           required: true
52014           type: string
52015           example: __ZONE-ID__
52016         - name: resource-version
52017           in: query
52018           description: resource-version for concurrency
52019           required: true
52020           type: string
52021   /network/zones:
52022     get:
52023       tags:
52024         - Network
52025       summary: returns zones
52026       description: returns zones
52027       operationId: getNetworkZones
52028       produces:
52029         - application/json
52030         - application/xml
52031       responses:
52032         "200":
52033           description: successful operation
52034           schema:
52035               $ref: "#/getDefinitions/zones"
52036         "default":
52037           description: Response codes found in [response codes](https://wiki.onap.org/).
52038   /network/configurations/configuration/{configuration-id}/relationship-list/relationship:
52039     put:
52040       tags:
52041         - Network
52042       summary: see node definition for valid relationships
52043       operationId: createOrUpdateNetworkConfigurationsConfigurationRelationshipListRelationship
52044       consumes:
52045         - application/json
52046         - application/xml
52047       produces:
52048         - application/json
52049         - application/xml
52050       responses:
52051         "default":
52052           description: Response codes found in [response codes](https://wiki.onap.org/).
52053       parameters:
52054         - name: configuration-id
52055           in: path
52056           description: UUID assigned to configuration.
52057           required: true
52058           type: string
52059           example: __CONFIGURATION-ID__
52060         - name: body
52061           in: body
52062           description: relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
52063           required: true
52064           schema:
52065             $ref: "#/definitions/relationship"
52066     delete:
52067       tags:
52068         - Network
52069       summary: delete an existing relationship
52070       description: delete an existing relationship
52071       operationId: deleteNetworkConfigurationsConfigurationRelationshipListRelationship
52072       consumes:
52073         - application/json
52074         - application/xml
52075       produces:
52076         - application/json
52077         - application/xml
52078       responses:
52079         "default":
52080           description: Response codes found in [response codes](https://wiki.onap.org/).
52081       parameters:
52082         - name: configuration-id
52083           in: path
52084           description: UUID assigned to configuration.
52085           required: true
52086           type: string
52087           example: __CONFIGURATION-ID__
52088   /network/configurations/configuration/{configuration-id}/metadata/metadatum/{metaname}:
52089     get:
52090       tags:
52091         - Network
52092       summary: returns metadatum
52093       description: returns metadatum
52094       operationId: getNetworkConfigurationsConfigurationMetadataMetadatum
52095       produces:
52096         - application/json
52097         - application/xml
52098       responses:
52099         "200":
52100           description: successful operation
52101           schema:
52102               $ref: "#/getDefinitions/metadatum"
52103         "default":
52104           description: Response codes found in [response codes](https://wiki.onap.org/).
52105       parameters:
52106         - name: configuration-id
52107           in: path
52108           description: UUID assigned to configuration.
52109           required: true
52110           type: string
52111           example: __CONFIGURATION-ID__
52112         - name: metaname
52113           in: path
52114           required: true
52115           type: string
52116           example: __METANAME__
52117         - name: model-invariant-id
52118           in: query
52119           description: the ASDC model id for this resource or service model.
52120           required: false
52121           type: string
52122         - name: model-version-id
52123           in: query
52124           description: the ASDC model version for this resource or service model.
52125           required: false
52126           type: string
52127     put:
52128       tags:
52129         - Network
52130       summary: create or update an existing metadatum
52131       description: |
52132         Create or update an existing metadatum.
52133         #
52134         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52135       operationId: createOrUpdateNetworkConfigurationsConfigurationMetadataMetadatum
52136       consumes:
52137         - application/json
52138         - application/xml
52139       produces:
52140         - application/json
52141         - application/xml
52142       responses:
52143         "default":
52144           description: Response codes found in [response codes](https://wiki.onap.org/).
52145       parameters:
52146         - name: configuration-id
52147           in: path
52148           description: UUID assigned to configuration.
52149           required: true
52150           type: string
52151           example: __CONFIGURATION-ID__
52152         - name: metaname
52153           in: path
52154           required: true
52155           type: string
52156           example: __METANAME__
52157         - name: body
52158           in: body
52159           description: metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)
52160           required: true
52161           schema:
52162             $ref: "#/definitions/metadatum"
52163     patch:
52164       tags:
52165         - Network
52166       summary: update an existing metadatum
52167       description: |
52168         Update an existing metadatum
52169         #
52170         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52171         The PUT operation will entirely replace an existing object.
52172         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52173         #
52174         Other differences between PUT and PATCH are:
52175         #
52176         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52177         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52178         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52179       operationId: UpdateNetworkConfigurationsConfigurationMetadataMetadatum
52180       consumes:
52181         - application/json
52182         - application/xml
52183       produces:
52184         - application/json
52185         - application/xml
52186       responses:
52187         "default":
52188           description: Response codes found in [response codes](https://wiki.onap.org/).
52189       parameters:
52190         - name: configuration-id
52191           in: path
52192           description: UUID assigned to configuration.
52193           required: true
52194           type: string
52195           example: __CONFIGURATION-ID__
52196         - name: metaname
52197           in: path
52198           required: true
52199           type: string
52200           example: __METANAME__
52201         - name: body
52202           in: body
52203           description: metadatum object that needs to be created or updated.
52204           required: true
52205           schema:
52206             $ref: "#/patchDefinitions/metadatum"
52207     delete:
52208       tags:
52209         - Network
52210       summary: delete an existing metadatum
52211       description: delete an existing metadatum
52212       operationId: deleteNetworkConfigurationsConfigurationMetadataMetadatum
52213       consumes:
52214         - application/json
52215         - application/xml
52216       produces:
52217         - application/json
52218         - application/xml
52219       responses:
52220         "default":
52221           description: Response codes found in [response codes](https://wiki.onap.org/).
52222       parameters:
52223         - name: configuration-id
52224           in: path
52225           description: UUID assigned to configuration.
52226           required: true
52227           type: string
52228           example: __CONFIGURATION-ID__
52229         - name: metaname
52230           in: path
52231           required: true
52232           type: string
52233           example: __METANAME__
52234         - name: resource-version
52235           in: query
52236           description: resource-version for concurrency
52237           required: true
52238           type: string
52239   /network/configurations/configuration/{configuration-id}/metadata:
52240     get:
52241       tags:
52242         - Network
52243       summary: returns metadata
52244       description: returns metadata
52245       operationId: getNetworkConfigurationsConfigurationMetadata
52246       produces:
52247         - application/json
52248         - application/xml
52249       responses:
52250         "200":
52251           description: successful operation
52252           schema:
52253               $ref: "#/getDefinitions/metadata"
52254         "default":
52255           description: Response codes found in [response codes](https://wiki.onap.org/).
52256       parameters:
52257         - name: configuration-id
52258           in: path
52259           description: UUID assigned to configuration.
52260           required: true
52261           type: string
52262           example: __CONFIGURATION-ID__
52263         - name: model-invariant-id
52264           in: query
52265           description: the ASDC model id for this resource or service model.
52266           required: false
52267           type: string
52268         - name: model-version-id
52269           in: query
52270           description: the ASDC model version for this resource or service model.
52271           required: false
52272           type: string
52273   /network/configurations/configuration/{configuration-id}:
52274     get:
52275       tags:
52276         - Network
52277       summary: returns configuration
52278       description: returns configuration
52279       operationId: getNetworkConfigurationsConfiguration
52280       produces:
52281         - application/json
52282         - application/xml
52283       responses:
52284         "200":
52285           description: successful operation
52286           schema:
52287               $ref: "#/getDefinitions/configuration"
52288         "default":
52289           description: Response codes found in [response codes](https://wiki.onap.org/).
52290       parameters:
52291         - name: configuration-id
52292           in: path
52293           description: UUID assigned to configuration.
52294           required: true
52295           type: string
52296           example: __CONFIGURATION-ID__
52297         - name: model-invariant-id
52298           in: query
52299           description: the ASDC model id for this resource or service model.
52300           required: false
52301           type: string
52302         - name: model-version-id
52303           in: query
52304           description: the ASDC model version for this resource or service model.
52305           required: false
52306           type: string
52307     put:
52308       tags:
52309         - Network
52310       summary: create or update an existing configuration
52311       description: |
52312         Create or update an existing configuration.
52313         #
52314         Note! This PUT method has a corresponding PATCH method that can be used to update just a few of the fields of an existing object, rather than a full object replacement.  An example can be found in the [PATCH section] below
52315       operationId: createOrUpdateNetworkConfigurationsConfiguration
52316       consumes:
52317         - application/json
52318         - application/xml
52319       produces:
52320         - application/json
52321         - application/xml
52322       responses:
52323         "default":
52324           description: Response codes found in [response codes](https://wiki.onap.org/).
52325       parameters:
52326         - name: configuration-id
52327           in: path
52328           description: UUID assigned to configuration.
52329           required: true
52330           type: string
52331           example: __CONFIGURATION-ID__
52332         - name: body
52333           in: body
52334           description: configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)
52335           required: true
52336           schema:
52337             $ref: "#/definitions/configuration"
52338     patch:
52339       tags:
52340         - Network
52341       summary: update an existing configuration
52342       description: |
52343         Update an existing configuration
52344         #
52345         Note:  Endpoints that are not devoted to object relationships support both PUT and PATCH operations.
52346         The PUT operation will entirely replace an existing object.
52347         The PATCH operation sends a "description of changes" for an existing object.  The entire set of changes must be applied.  An error result means no change occurs.
52348         #
52349         Other differences between PUT and PATCH are:
52350         #
52351         - For PATCH, you can send any of the values shown in sample REQUEST body.  There are no required values.
52352         - For PATCH, resource-id which is a required REQUEST body element for PUT, must not be sent.
52353         - PATCH cannot be used to update relationship elements; there are dedicated PUT operations for this.
52354       operationId: UpdateNetworkConfigurationsConfiguration
52355       consumes:
52356         - application/json
52357         - application/xml
52358       produces:
52359         - application/json
52360         - application/xml
52361       responses:
52362         "default":
52363           description: Response codes found in [response codes](https://wiki.onap.org/).
52364       parameters:
52365         - name: configuration-id
52366           in: path
52367           description: UUID assigned to configuration.
52368           required: true
52369           type: string
52370           example: __CONFIGURATION-ID__
52371         - name: body
52372           in: body
52373           description: configuration object that needs to be created or updated.
52374           required: true
52375           schema:
52376             $ref: "#/patchDefinitions/configuration"
52377     delete:
52378       tags:
52379         - Network
52380       summary: delete an existing configuration
52381       description: delete an existing configuration
52382       operationId: deleteNetworkConfigurationsConfiguration
52383       consumes:
52384         - application/json
52385         - application/xml
52386       produces:
52387         - application/json
52388         - application/xml
52389       responses:
52390         "default":
52391           description: Response codes found in [response codes](https://wiki.onap.org/).
52392       parameters:
52393         - name: configuration-id
52394           in: path
52395           description: UUID assigned to configuration.
52396           required: true
52397           type: string
52398           example: __CONFIGURATION-ID__
52399         - name: resource-version
52400           in: query
52401           description: resource-version for concurrency
52402           required: true
52403           type: string
52404   /network/configurations:
52405     get:
52406       tags:
52407         - Network
52408       summary: returns configurations
52409       description: returns configurations
52410       operationId: getNetworkConfigurations
52411       produces:
52412         - application/json
52413         - application/xml
52414       responses:
52415         "200":
52416           description: successful operation
52417           schema:
52418               $ref: "#/getDefinitions/configurations"
52419         "default":
52420           description: Response codes found in [response codes](https://wiki.onap.org/).
52421 definitions:
52422   aai-internal:
52423     properties:
52424       property-name:
52425         type: string
52426       property-value:
52427         type: string
52428   action:
52429     properties:
52430       action-type:
52431         type: string
52432       action-data:
52433         type: array
52434         items:
52435           $ref: "#/definitions/action-data"
52436   action-data:
52437     properties:
52438       property-name:
52439         type: string
52440       property-value:
52441         type: string
52442   actions:
52443     description: |
52444       APIs that are more action related than REST (e.g., notify, update).
52445     properties:
52446       update:
52447         type: object
52448         $ref: "#/definitions/update"
52449       notify:
52450         type: object
52451         $ref: "#/definitions/notify"
52452   allotted-resource:
52453     description: |
52454       Represents a slice or partial piece of a resource that gets separately allotted
52455       ###### Related Nodes
52456       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
52457       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
52458       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
52459       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
52460       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
52461       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
52462       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
52463       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
52464       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
52465       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
52466       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
52467       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
52468       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
52469       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
52470     required:
52471     - id
52472     properties:
52473       id:
52474         type: string
52475         description: Allotted Resource id UUID assigned to this instance.
52476       description:
52477         type: string
52478         description: The descriptive information assigned to this allotted resource instance
52479       selflink:
52480         type: string
52481         description: Link back to more information in the controller
52482       model-invariant-id:
52483         type: string
52484         description: the ASDC model id for this resource or service model.
52485       model-version-id:
52486         type: string
52487         description: the ASDC model version for this resource or service model.
52488       persona-model-version:
52489         type: string
52490         description: the ASDC model version for this resource or service model.
52491       resource-version:
52492         type: string
52493         description: Concurrency value
52494       orchestration-status:
52495         type: string
52496         description: Orchestration status
52497       operational-status:
52498         type: string
52499         description: Indicator for whether the resource is considered operational
52500       type:
52501         type: string
52502         description: Generic description of the type of allotted resource.
52503       role:
52504         type: string
52505         description: role in the network that this resource will be providing.
52506       tunnel-xconnects:
52507         type: array
52508         items:
52509           $ref: "#/definitions/tunnel-xconnect"
52510       relationship-list:
52511         type: array
52512         items:
52513           $ref: "#/definitions/relationship"
52514   allotted-resources:
52515     description: |
52516       This object is used to store slices of services being offered
52517     properties:
52518       allotted-resource:
52519         type: array
52520         items:
52521           $ref: "#/definitions/allotted-resource"
52522   availability-zone:
52523     description: |
52524       Availability zone, a collection of compute hosts/pservers
52525       ###### Related Nodes
52526       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52527       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
52528       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52529       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52530       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
52531       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52532       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
52533       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
52534       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
52535     required:
52536     - availability-zone-name
52537     - hypervisor-type
52538     properties:
52539       availability-zone-name:
52540         type: string
52541         description: Name of the availability zone.  Unique across a cloud region
52542       hypervisor-type:
52543         type: string
52544         description: Type of hypervisor.  Source of truth should define valid values.
52545       operational-status:
52546         type: string
52547         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
52548       resource-version:
52549         type: string
52550         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52551       relationship-list:
52552         type: array
52553         items:
52554           $ref: "#/definitions/relationship"
52555   availability-zones:
52556     description: |
52557       Collection of availability zones
52558     properties:
52559       availability-zone:
52560         type: array
52561         items:
52562           $ref: "#/definitions/availability-zone"
52563   az-and-dvs-switches:
52564     properties:
52565       dvs-switches:
52566         type: object
52567         $ref: "#/definitions/dvs-switches"
52568       availability-zone:
52569         type: object
52570         $ref: "#/definitions/availability-zone"
52571   business:
52572     description: |
52573       Namespace for business related constructs
52574     properties:
52575       connectors:
52576         type: array
52577         items:
52578           $ref: "#/definitions/connector"
52579       customers:
52580         type: array
52581         items:
52582           $ref: "#/definitions/customer"
52583       lines-of-business:
52584         type: array
52585         items:
52586           $ref: "#/definitions/line-of-business"
52587       owning-entities:
52588         type: array
52589         items:
52590           $ref: "#/definitions/owning-entity"
52591       platforms:
52592         type: array
52593         items:
52594           $ref: "#/definitions/platform"
52595       projects:
52596         type: array
52597         items:
52598           $ref: "#/definitions/project"
52599   class-of-service:
52600     description: |
52601       ###### Related Nodes
52602       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
52603     required:
52604     - cos
52605     properties:
52606       cos:
52607         type: string
52608         description: unique identifier of probe
52609       probe-id:
52610         type: string
52611         description: identifier of probe
52612       probe-type:
52613         type: string
52614         description: type of probe
52615       resource-version:
52616         type: string
52617         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52618       relationship-list:
52619         type: array
52620         items:
52621           $ref: "#/definitions/relationship"
52622   classes-of-service:
52623     description: |
52624       class-of-service of probe
52625     properties:
52626       class-of-service:
52627         type: array
52628         items:
52629           $ref: "#/definitions/class-of-service"
52630   cloud-infrastructure:
52631     description: |
52632       Namespace for cloud infrastructure.
52633     properties:
52634       complexes:
52635         type: array
52636         items:
52637           $ref: "#/definitions/complex"
52638       cloud-regions:
52639         type: array
52640         items:
52641           $ref: "#/definitions/cloud-region"
52642       network-profiles:
52643         type: array
52644         items:
52645           $ref: "#/definitions/network-profile"
52646       pservers:
52647         type: array
52648         items:
52649           $ref: "#/definitions/pserver"
52650       virtual-data-centers:
52651         type: array
52652         items:
52653           $ref: "#/definitions/virtual-data-center"
52654   cloud-region:
52655     description: |
52656       cloud-region designates an installation of a cloud cluster or region or instantiation.
52657       ###### Related Nodes
52658       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
52659       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52660       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52661       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
52662       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52663       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52664       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52665       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52666       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52667       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52668       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52669       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52670       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52671       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52672       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
52673       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
52674       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
52675       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
52676       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
52677       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
52678     required:
52679     - cloud-owner
52680     - cloud-region-id
52681     - sriov-automation
52682     properties:
52683       cloud-owner:
52684         type: string
52685         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
52686       cloud-region-id:
52687         type: string
52688         description: Identifier used by the vendor for the region. Second part of composite key
52689       cloud-type:
52690         type: string
52691         description: Type of the cloud (e.g., openstack)
52692       owner-defined-type:
52693         type: string
52694         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
52695       cloud-region-version:
52696         type: string
52697         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
52698       identity-url:
52699         type: string
52700         description: URL of the keystone identity service
52701       cloud-zone:
52702         type: string
52703         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52704       complex-name:
52705         type: string
52706         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
52707       sriov-automation:
52708         type: boolean
52709       cloud-extra-info:
52710         type: string
52711         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
52712       cloud-epa-caps:
52713         type: string
52714         description: MultiVIM will discover and expose EPA capabilities.
52715       resource-version:
52716         type: string
52717         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52718       volume-groups:
52719         type: array
52720         items:
52721           $ref: "#/definitions/volume-group"
52722       tenants:
52723         type: array
52724         items:
52725           $ref: "#/definitions/tenant"
52726       flavors:
52727         type: array
52728         items:
52729           $ref: "#/definitions/flavor"
52730       group-assignments:
52731         type: array
52732         items:
52733           $ref: "#/definitions/group-assignment"
52734       snapshots:
52735         type: array
52736         items:
52737           $ref: "#/definitions/snapshot"
52738       images:
52739         type: array
52740         items:
52741           $ref: "#/definitions/image"
52742       dvs-switches:
52743         type: array
52744         items:
52745           $ref: "#/definitions/dvs-switch"
52746       oam-networks:
52747         type: array
52748         items:
52749           $ref: "#/definitions/oam-network"
52750       availability-zones:
52751         type: array
52752         items:
52753           $ref: "#/definitions/availability-zone"
52754       relationship-list:
52755         type: array
52756         items:
52757           $ref: "#/definitions/relationship"
52758       esr-system-info-list:
52759         type: array
52760         items:
52761           $ref: "#/definitions/esr-system-info"
52762       vip-ipv4-address-list:
52763         type: array
52764         items:
52765           $ref: "#/definitions/vip-ipv4-address-list"
52766       vip-ipv6-address-list:
52767         type: array
52768         items:
52769           $ref: "#/definitions/vip-ipv6-address-list"
52770   cloud-regions:
52771     properties:
52772       cloud-region:
52773         type: array
52774         items:
52775           $ref: "#/definitions/cloud-region"
52776   complex:
52777     description: |
52778       Collection of physical locations that can house cloud-regions.
52779       ###### Related Nodes
52780       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
52781       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52782       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52783       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
52784       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52785       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
52786       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52787       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52788       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
52789       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52790       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52791       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
52792       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
52793       - COMPLEX is DELETED when these are DELETED CTAG-POOL
52794     required:
52795     - physical-location-id
52796     - physical-location-type
52797     - street1
52798     - city
52799     - postal-code
52800     - country
52801     - region
52802     properties:
52803       physical-location-id:
52804         type: string
52805         description: Unique identifier for physical location, e.g., CLLI
52806       data-center-code:
52807         type: string
52808         description: Data center code which can be an alternate way to identify a complex
52809       complex-name:
52810         type: string
52811         description: Gamma complex name for LCP instance.
52812       identity-url:
52813         type: string
52814         description: URL of the keystone identity service
52815       resource-version:
52816         type: string
52817         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52818       physical-location-type:
52819         type: string
52820         description: Type, e.g., central office, data center.
52821       street1:
52822         type: string
52823       street2:
52824         type: string
52825       city:
52826         type: string
52827       state:
52828         type: string
52829       postal-code:
52830         type: string
52831       country:
52832         type: string
52833       region:
52834         type: string
52835       latitude:
52836         type: string
52837       longitude:
52838         type: string
52839       elevation:
52840         type: string
52841       lata:
52842         type: string
52843       ctag-pools:
52844         type: array
52845         items:
52846           $ref: "#/definitions/ctag-pool"
52847       relationship-list:
52848         type: array
52849         items:
52850           $ref: "#/definitions/relationship"
52851   complexes:
52852     description: |
52853       Collection of physical locations that can house cloud-regions.
52854     properties:
52855       complex:
52856         type: array
52857         items:
52858           $ref: "#/definitions/complex"
52859   configuration:
52860     description: |
52861       Port Mirror Configuration.
52862       ###### Related Nodes
52863       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
52864       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
52865       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
52866       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52867       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
52868       - CONFIGURATION is DELETED when these are DELETED METADATUM
52869       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
52870     required:
52871     - configuration-id
52872     - configuration-type
52873     - configuration-sub-type
52874     - orchestration-status
52875     - operational-status
52876     - configuration-selflink
52877     - model-customization-id
52878     properties:
52879       configuration-id:
52880         type: string
52881         description: UUID assigned to configuration.
52882       management-option:
52883         type: string
52884         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
52885       configuration-name:
52886         type: string
52887         description: Name of the configuration.
52888       configuration-type:
52889         type: string
52890         description: port-mirroring-configuration.
52891       configuration-sub-type:
52892         type: string
52893         description: vprobe, pprobe.
52894       model-invariant-id:
52895         type: string
52896         description: the ASDC model id for this resource or service model.
52897       model-version-id:
52898         type: string
52899         description: the ASDC model version for this resource or service model.
52900       orchestration-status:
52901         type: string
52902         description: Orchestration status of the configuration.
52903       operational-status:
52904         type: string
52905         description: Indicator for whether the resource is considered operational.
52906       configuration-selflink:
52907         type: string
52908         description: URL to endpoint where AAI can get more details from SDN-GC.
52909       model-customization-id:
52910         type: string
52911         description: id of  the configuration used to customize the resource
52912       resource-version:
52913         type: string
52914         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52915       relationship-list:
52916         type: array
52917         items:
52918           $ref: "#/definitions/relationship"
52919       metadata:
52920         type: array
52921         items:
52922           $ref: "#/definitions/metadatum"
52923   configurations:
52924     description: |
52925       Collection of configurations
52926     properties:
52927       configuration:
52928         type: array
52929         items:
52930           $ref: "#/definitions/configuration"
52931   connector:
52932     description: |
52933       Collection of resource instances used to connect a variety of disparate inventory widgets
52934       ###### Related Nodes
52935       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
52936       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
52937       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
52938       - CONNECTOR is DELETED when these are DELETED METADATUM
52939     required:
52940     - resource-instance-id
52941     properties:
52942       resource-instance-id:
52943         type: string
52944         description: Unique id of resource instance.
52945       resource-version:
52946         type: string
52947         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
52948       model-invariant-id:
52949         type: string
52950         description: the ASDC model id for this resource or service model.
52951       model-version-id:
52952         type: string
52953         description: the ASDC model version for this resource or service model.
52954       persona-model-version:
52955         type: string
52956         description: the ASDC model version for this resource or service model.
52957       widget-model-id:
52958         type: string
52959         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
52960       widget-model-version:
52961         type: string
52962         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
52963       relationship-list:
52964         type: array
52965         items:
52966           $ref: "#/definitions/relationship"
52967       metadata:
52968         type: array
52969         items:
52970           $ref: "#/definitions/metadatum"
52971   connectors:
52972     description: |
52973       Collection of resource instances used to connect a variety of disparate inventory widgets
52974     properties:
52975       connector:
52976         type: array
52977         items:
52978           $ref: "#/definitions/connector"
52979   constrained-element-set:
52980     description: |
52981       This is how we would capture constraints defining allowed sets of elements.
52982       ###### Related Nodes
52983       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
52984       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
52985       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
52986       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
52987     required:
52988     - constrained-element-set-uuid
52989     - constraint-type
52990     - check-type
52991     properties:
52992       constrained-element-set-uuid:
52993         type: string
52994       constraint-type:
52995         type: string
52996       check-type:
52997         type: string
52998       resource-version:
52999         type: string
53000       element-choice-sets:
53001         type: array
53002         items:
53003           $ref: "#/definitions/element-choice-set"
53004       relationship-list:
53005         type: array
53006         items:
53007           $ref: "#/definitions/relationship"
53008   constrained-element-sets:
53009     properties:
53010       constrained-element-set:
53011         type: array
53012         items:
53013           $ref: "#/definitions/constrained-element-set"
53014   ctag-assignment:
53015     description: |
53016       ###### Related Nodes
53017       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
53018       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
53019     required:
53020     - vlan-id-inner
53021     properties:
53022       vlan-id-inner:
53023         type: integer
53024         format: int64
53025         description: id.
53026       resource-version:
53027         type: string
53028         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53029       relationship-list:
53030         type: array
53031         items:
53032           $ref: "#/definitions/relationship"
53033   ctag-assignments:
53034     properties:
53035       ctag-assignment:
53036         type: array
53037         items:
53038           $ref: "#/definitions/ctag-assignment"
53039   ctag-pool:
53040     description: |
53041       A collection of C tags (vlan tags) grouped for a specific purpose.
53042       ###### Related Nodes
53043       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
53044       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53045       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53046       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53047     required:
53048     - target-pe
53049     - availability-zone-name
53050     - ctag-pool-purpose
53051     properties:
53052       target-pe:
53053         type: string
53054         description: The Target provider edge router
53055       availability-zone-name:
53056         type: string
53057         description: Name of the availability zone
53058       ctag-pool-purpose:
53059         type: string
53060         description: Describes what the intended purpose of this pool is.
53061       ctag-values:
53062         type: string
53063         description: Comma separated list of ctags
53064       resource-version:
53065         type: string
53066         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53067       relationship-list:
53068         type: array
53069         items:
53070           $ref: "#/definitions/relationship"
53071   ctag-pools:
53072     properties:
53073       ctag-pool:
53074         type: array
53075         items:
53076           $ref: "#/definitions/ctag-pool"
53077   customer:
53078     description: |
53079       customer identifiers to provide linkage back to BSS information.
53080       ###### Related Nodes
53081       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
53082       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
53083     required:
53084     - global-customer-id
53085     - subscriber-name
53086     - subscriber-type
53087     properties:
53088       global-customer-id:
53089         type: string
53090         description: Global customer id used across ECOMP to uniquely identify customer.
53091       subscriber-name:
53092         type: string
53093         description: Subscriber name, an alternate way to retrieve a customer.
53094       subscriber-type:
53095         type: string
53096         description: Subscriber type, a way to provide VID with only the INFRA customers.
53097       resource-version:
53098         type: string
53099         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53100       service-subscriptions:
53101         type: array
53102         items:
53103           $ref: "#/definitions/service-subscription"
53104       relationship-list:
53105         type: array
53106         items:
53107           $ref: "#/definitions/relationship"
53108   customers:
53109     description: |
53110       Collection of customer identifiers to provide linkage back to BSS information.
53111     properties:
53112       customer:
53113         type: array
53114         items:
53115           $ref: "#/definitions/customer"
53116   cvlan-tag-entry:
53117     required:
53118     - cvlan-tag
53119     properties:
53120       cvlan-tag:
53121         type: integer
53122         format: int64
53123         description: See mis-na-virtualization-platform.yang
53124       resource-version:
53125         type: string
53126         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53127       relationship-list:
53128         type: array
53129         items:
53130           $ref: "#/definitions/relationship"
53131   cvlan-tags:
53132     properties:
53133       cvlan-tag-entry:
53134         type: array
53135         items:
53136           $ref: "#/definitions/cvlan-tag-entry"
53137   dvs-switch:
53138     description: |
53139       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.
53140       ###### Related Nodes
53141       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53142       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
53143     required:
53144     - switch-name
53145     - vcenter-url
53146     properties:
53147       switch-name:
53148         type: string
53149         description: DVS switch name
53150       vcenter-url:
53151         type: string
53152         description: URL used to reach the vcenter
53153       resource-version:
53154         type: string
53155         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53156       relationship-list:
53157         type: array
53158         items:
53159           $ref: "#/definitions/relationship"
53160   dvs-switches:
53161     description: |
53162       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
53163     properties:
53164       dvs-switch:
53165         type: array
53166         items:
53167           $ref: "#/definitions/dvs-switch"
53168   edge-prop-names:
53169     description: |
53170       Internal map to define the properties of an edge and interpret the map EdgeRules
53171     properties:
53172       edgeLabel:
53173         type: string
53174       direction:
53175         type: string
53176       multiplicityRule:
53177         type: string
53178       contains-other-v:
53179         type: string
53180       delete-other-v:
53181         type: string
53182       SVC-INFRA:
53183         type: string
53184       prevent-delete:
53185         type: string
53186   edge-tag-query-request:
53187     properties:
53188       edge-tag:
53189         type: string
53190       result-detail:
53191         type: string
53192       start-node-type:
53193         type: string
53194       start-node-filter:
53195         type: array
53196         items:
53197           $ref: "#/definitions/start-node-filter"
53198       include-node-filter:
53199         type: array
53200         items:
53201           $ref: "#/definitions/include-node-filter"
53202       secondary-filter:
53203         type: array
53204         items:
53205           $ref: "#/definitions/secondary-filter"
53206   edge-tag-query-result:
53207     properties:
53208       tagged-inventory-item-list:
53209         type: array
53210         items:
53211           $ref: "#/definitions/tagged-inventory-item-list"
53212   element-choice-set:
53213     description: |
53214       This is how we would capture constraints defining allowed sets of elements.
53215       ###### Related Nodes
53216       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
53217       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
53218       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
53219     required:
53220     - element-choice-set-uuid
53221     - element-choice-set-name
53222     properties:
53223       element-choice-set-uuid:
53224         type: string
53225       element-choice-set-name:
53226         type: string
53227       cardinality:
53228         type: string
53229       resource-version:
53230         type: string
53231       model-elements:
53232         type: array
53233         items:
53234           $ref: "#/definitions/model-element"
53235       relationship-list:
53236         type: array
53237         items:
53238           $ref: "#/definitions/relationship"
53239   element-choice-sets:
53240     properties:
53241       element-choice-set:
53242         type: array
53243         items:
53244           $ref: "#/definitions/element-choice-set"
53245   entitlement:
53246     description: |
53247       Metadata for entitlement group.
53248       ###### Related Nodes
53249       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53250       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
53251     required:
53252     - group-uuid
53253     - resource-uuid
53254     properties:
53255       group-uuid:
53256         type: string
53257         description: Unique ID for the entitlement group the resource comes from, should be uuid.
53258       resource-uuid:
53259         type: string
53260         description: Unique ID of an entitlement resource.
53261       resource-version:
53262         type: string
53263         description: Concurrency value
53264       relationship-list:
53265         type: array
53266         items:
53267           $ref: "#/definitions/relationship"
53268   entitlements:
53269     description: |
53270       Entitlements, keyed by group-uuid and resource-uuid, related to license management
53271     properties:
53272       entitlement:
53273         type: array
53274         items:
53275           $ref: "#/definitions/entitlement"
53276   esr-ems:
53277     description: |
53278       Persist EMS address information used by EMS driver.
53279       ###### Related Nodes
53280       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
53281       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53282     required:
53283     - ems-id
53284     properties:
53285       ems-id:
53286         type: string
53287         description: Unique ID of EMS.
53288       resource-version:
53289         type: string
53290         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53291       esr-system-info-list:
53292         type: object
53293         $ref: "#/definitions/esr-system-info-list"
53294       relationship-list:
53295         type: object
53296         $ref: "#/definitions/relationship-list"
53297   esr-ems-list:
53298     properties:
53299       esr-ems:
53300         type: array
53301         items:
53302           $ref: "#/definitions/esr-ems"
53303   esr-system-info:
53304     description: |
53305       Persist common address information of external systems.
53306       ###### Related Nodes
53307       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
53308       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
53309       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
53310       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
53311     required:
53312     - esr-system-info-id
53313     - user-name
53314     - password
53315     - system-type
53316     properties:
53317       esr-system-info-id:
53318         type: string
53319         description: Unique ID of esr system info.
53320       system-name:
53321         type: string
53322         description: name of external system.
53323       type:
53324         type: string
53325         description: type of external systems.
53326       vendor:
53327         type: string
53328         description: vendor of external systems.
53329       version:
53330         type: string
53331         description: version of external systems.
53332       service-url:
53333         type: string
53334         description: url used to access external systems.
53335       user-name:
53336         type: string
53337         description: username used to access external systems.
53338       password:
53339         type: string
53340         description: password used to access external systems.
53341       system-type:
53342         type: string
53343         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
53344       protocol:
53345         type: string
53346         description: protocol of third party SDNC, for example netconf/snmp.
53347       ssl-cacert:
53348         type: string
53349         description: ca file content if enabled ssl on auth-url.
53350       ssl-insecure:
53351         type: boolean
53352         description: Whether to verify VIM's certificate.
53353       ip-address:
53354         type: string
53355         description: service IP of ftp server.
53356       port:
53357         type: string
53358         description: service port of ftp server.
53359       cloud-domain:
53360         type: string
53361         description: domain info for authentication.
53362       default-tenant:
53363         type: string
53364         description: default tenant of VIM.
53365       passive:
53366         type: boolean
53367         description: ftp passive mode or not.
53368       remote-path:
53369         type: string
53370         description: resource or performance data file path.
53371       system-status:
53372         type: string
53373         description: the status of external system.
53374       resource-version:
53375         type: string
53376         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53377       relationship-list:
53378         type: array
53379         items:
53380           $ref: "#/definitions/relationship"
53381   esr-system-info-list:
53382     description: |
53383       Collection of persistent block-level external system auth info.
53384     properties:
53385       esr-system-info:
53386         type: array
53387         items:
53388           $ref: "#/definitions/esr-system-info"
53389   esr-thirdparty-sdnc:
53390     description: |
53391       Persist SDNC address information used by ONAP SDNC.
53392       ###### Related Nodes
53393       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
53394       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
53395       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53396     required:
53397     - thirdparty-sdnc-id
53398     properties:
53399       thirdparty-sdnc-id:
53400         type: string
53401         description: Unique ID of SDNC.
53402       location:
53403         type: string
53404         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
53405       product-name:
53406         type: string
53407         description: password used to access SDNC server.
53408       resource-version:
53409         type: string
53410         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53411       esr-system-info-list:
53412         type: object
53413         $ref: "#/definitions/esr-system-info-list"
53414       relationship-list:
53415         type: object
53416         $ref: "#/definitions/relationship-list"
53417   esr-thirdparty-sdnc-list:
53418     properties:
53419       esr-thirdparty-sdnc:
53420         type: array
53421         items:
53422           $ref: "#/definitions/esr-thirdparty-sdnc"
53423   esr-vnfm:
53424     description: |
53425       Persist VNFM address information used by VF-C.
53426       ###### Related Nodes
53427       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
53428       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
53429     required:
53430     - vnfm-id
53431     properties:
53432       vnfm-id:
53433         type: string
53434         description: Unique ID of VNFM.
53435       vim-id:
53436         type: string
53437         description: indecate the VIM to deploy VNF.
53438       certificate-url:
53439         type: string
53440         description: certificate url of VNFM.
53441       resource-version:
53442         type: string
53443         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53444       esr-system-info-list:
53445         type: object
53446         $ref: "#/definitions/esr-system-info-list"
53447       relationship-list:
53448         type: object
53449         $ref: "#/definitions/relationship-list"
53450   esr-vnfm-list:
53451     properties:
53452       esr-vnfm:
53453         type: array
53454         items:
53455           $ref: "#/definitions/esr-vnfm"
53456   evc:
53457     description: |
53458       evc object is an optional child object of the Configuration object.
53459       ###### Related Nodes
53460       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53461     required:
53462     - evc-id
53463     properties:
53464       evc-id:
53465         type: string
53466         description: Unique/key field for the evc object
53467       forwarding-path-topology:
53468         type: string
53469         description: Point-to-Point, Multi-Point
53470       cir-value:
53471         type: string
53472         description: Commited Information Rate
53473       cir-units:
53474         type: string
53475         description: CIR units
53476       connection-diversity-group-id:
53477         type: string
53478         description: Diversity Group ID
53479       service-hours:
53480         type: string
53481         description: formerly Performance Group
53482       esp-evc-circuit-id:
53483         type: string
53484         description: EVC Circuit ID of ESP EVC
53485       esp-evc-cir-value:
53486         type: string
53487         description: Committed Information Rate (For ESP)
53488       esp-evc-cir-units:
53489         type: string
53490         description: CIR units (For ESP)
53491       esp-itu-code:
53492         type: string
53493         description: Identifies ESP
53494       collector-pop-clli:
53495         type: string
53496         description: Collector POP CLLI (from the hostname of the access pnf)
53497       inter-connect-type-ingress:
53498         type: string
53499         description: Interconnect type on ingress side of EVC.
53500       tagmode-access-ingress:
53501         type: string
53502         description: tagode for collector side of EVC
53503       tagmode-access-egress:
53504         type: string
53505         description: tagMode for network side of EVC
53506       relationship-list:
53507         type: array
53508         items:
53509           $ref: "#/definitions/relationship"
53510       resource-version:
53511         type: string
53512         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53513   evcs:
53514     properties:
53515       evc:
53516         type: array
53517         items:
53518           $ref: "#/definitions/evc"
53519   external-system:
53520     description: |
53521       Namespace for external system.
53522     properties:
53523       esr-ems-list:
53524         type: object
53525         $ref: "#/definitions/esr-ems-list"
53526       esr-vnfm-list:
53527         type: object
53528         $ref: "#/definitions/esr-vnfm-list"
53529       esr-thirdparty-sdnc-list:
53530         type: object
53531         $ref: "#/definitions/esr-thirdparty-sdnc-list"
53532   extra-properties:
53533     description: |
53534       Extra properties for inventory item for response list
53535     properties:
53536       extra-property:
53537         type: array
53538         items:
53539           $ref: "#/definitions/extra-property"
53540   extra-property:
53541     properties:
53542       property-name:
53543         type: string
53544       property-value:
53545         type: string
53546   flavor:
53547     description: |
53548       Openstack flavor.
53549       ###### Related Nodes
53550       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53551       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
53552       - FLAVOR cannot be deleted if linked to VSERVER
53553     required:
53554     - flavor-id
53555     - flavor-name
53556     - flavor-selflink
53557     properties:
53558       flavor-id:
53559         type: string
53560         description: Flavor id, expected to be unique across cloud-region.
53561       flavor-name:
53562         type: string
53563         description: Flavor name
53564       flavor-vcpus:
53565         type: integer
53566         format: int32
53567         description: Number of CPUs
53568       flavor-ram:
53569         type: integer
53570         format: int32
53571         description: Amount of memory
53572       flavor-disk:
53573         type: integer
53574         format: int32
53575         description: Disk space
53576       flavor-ephemeral:
53577         type: integer
53578         format: int32
53579         description: Amount of ephemeral disk space
53580       flavor-swap:
53581         type: string
53582         description: amount of swap space allocation
53583       flavor-is-public:
53584         type: boolean
53585         description: whether flavor is available to all users or private to the tenant it was created in.
53586       flavor-selflink:
53587         type: string
53588         description: URL to endpoint where AAI can get more details
53589       flavor-disabled:
53590         type: boolean
53591         description: Boolean as to whether this flavor is no longer enabled
53592       resource-version:
53593         type: string
53594         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53595       relationship-list:
53596         type: array
53597         items:
53598           $ref: "#/definitions/relationship"
53599   flavors:
53600     description: |
53601       Collection of openstack flavors.
53602     properties:
53603       flavor:
53604         type: array
53605         items:
53606           $ref: "#/definitions/flavor"
53607   forwarder:
53608     description: |
53609       Entity describing a sequenced segment of forwarding path
53610       ###### Related Nodes
53611       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53612       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
53613       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53614       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
53615       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
53616       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
53617     required:
53618     - sequence
53619     properties:
53620       sequence:
53621         type: integer
53622         format: int32
53623         description: Unique ID of this segmentation
53624       forwarder-role:
53625         type: string
53626         description: ingress, intermediate, egress
53627       relationship-list:
53628         type: array
53629         items:
53630           $ref: "#/definitions/relationship"
53631       resource-version:
53632         type: string
53633         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53634   forwarder-evc:
53635     description: |
53636       forwarder object is an optional child object of the Configuration object.
53637       ###### Related Nodes
53638       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
53639     required:
53640     - forwarder-evc-id
53641     properties:
53642       forwarder-evc-id:
53643         type: string
53644         description: Key for forwarder-evc object
53645       circuit-id:
53646         type: string
53647         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
53648       ivlan:
53649         type: string
53650         description: Internal VLAN.
53651       svlan:
53652         type: string
53653         description: SVLAN value for ingress of egress forwarder.
53654       cvlan:
53655         type: string
53656         description: CVLAN value for ingress of egress forwarder.
53657       relationship-list:
53658         type: array
53659         items:
53660           $ref: "#/definitions/relationship"
53661       resource-version:
53662         type: string
53663         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53664   forwarder-evcs:
53665     properties:
53666       forwarder-evc:
53667         type: array
53668         items:
53669           $ref: "#/definitions/forwarder-evc"
53670   forwarders:
53671     properties:
53672       forwarder:
53673         type: array
53674         items:
53675           $ref: "#/definitions/forwarder"
53676   forwarding-path:
53677     description: |
53678       Entity that describes the sequenced forwarding path between interfaces of services or resources
53679       ###### Related Nodes
53680       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
53681       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
53682       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
53683       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
53684       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
53685     required:
53686     - forwarding-path-id
53687     - forwarding-path-name
53688     properties:
53689       forwarding-path-id:
53690         type: string
53691         description: Unique ID of this FP
53692       forwarding-path-name:
53693         type: string
53694         description: Name of the FP
53695       relationship-list:
53696         type: array
53697         items:
53698           $ref: "#/definitions/relationship"
53699       resource-version:
53700         type: string
53701         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
53702       selflink:
53703         type: string
53704         description: the self link for this FP
53705       forwarders:
53706         type: array
53707         items:
53708           $ref: "#/definitions/forwarder"
53709   forwarding-paths:
53710     properties:
53711       forwarding-path:
53712         type: array
53713         items:
53714           $ref: "#/definitions/forwarding-path"
53715   generic-vnf:
53716     description: |
53717       General purpose VNF
53718       ###### Related Nodes
53719       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
53720       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
53721       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
53722       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
53723       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
53724       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
53725       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
53726       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
53727       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
53728       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
53729       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
53730       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
53731       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
53732       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
53733       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
53734       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53735       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53736       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53737       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53738       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53739       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53740       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
53741       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
53742       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
53743       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
53744       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
53745       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
53746       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
53747       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
53748     required:
53749     - vnf-id
53750     - vnf-instance-id
53751     - vnf-name
53752     - vnf-type
53753     - vnf-package-name
53754     - vnf-discriptor-name
53755     - job-id
53756     - in-maint
53757     - is-closed-loop-disabled
53758     properties:
53759       vnf-id:
53760         type: string
53761         description: Unique id of VNF.  This is unique across the graph.
53762       vnf-instance-id:
53763         type: string
53764         description: vnf instance id.
53765       vnf-name:
53766         type: string
53767         description: Name of VNF.
53768       vnf-name2:
53769         type: string
53770         description: Alternate name of VNF.
53771       vnf-type:
53772         type: string
53773         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.
53774       service-id:
53775         type: string
53776         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
53777       regional-resource-zone:
53778         type: string
53779         description: Regional way of organizing pservers, source of truth should define values
53780       prov-status:
53781         type: string
53782         description: Trigger for operational monitoring of this resource by Service Assurance systems.
53783       operational-status:
53784         type: string
53785         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
53786       license-key:
53787         type: string
53788         description: OBSOLETE -  do not use
53789       equipment-role:
53790         type: string
53791         description: Client should send valid enumerated value
53792       orchestration-status:
53793         type: string
53794         description: Orchestration status of this VNF, used by MSO.
53795       vnf-package-name:
53796         type: string
53797       vnf-discriptor-name:
53798         type: string
53799         description: vnf discriptor name
53800       job-id:
53801         type: string
53802         description: job id corresponding to vnf
53803       heat-stack-id:
53804         type: string
53805         description: Heat stack id corresponding to this instance, managed by MSO
53806       mso-catalog-key:
53807         type: string
53808         description: Corresponds to the SDN-C catalog id used to configure this VCE
53809       management-option:
53810         type: string
53811         description: identifier of managed by ATT or customer
53812       ipv4-oam-address:
53813         type: string
53814         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
53815       ipv4-loopback0-address:
53816         type: string
53817         description: v4 Loopback0 address
53818       nm-lan-v6-address:
53819         type: string
53820         description: v6 Loopback address
53821       management-v6-address:
53822         type: string
53823         description: v6 management address
53824       vcpu:
53825         type: integer
53826         format: int64
53827         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53828       vcpu-units:
53829         type: string
53830         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
53831       vmemory:
53832         type: integer
53833         format: int64
53834         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
53835       vmemory-units:
53836         type: string
53837         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
53838       vdisk:
53839         type: integer
53840         format: int64
53841         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
53842       vdisk-units:
53843         type: string
53844         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
53845       nshd:
53846         type: integer
53847         format: int64
53848         description: number of associated SHD in vnf.
53849       nvm:
53850         type: integer
53851         format: int64
53852         description: number of vms in vnf.
53853       nnet:
53854         type: integer
53855         format: int64
53856         description: number of network in vnf.
53857       in-maint:
53858         type: boolean
53859       is-closed-loop-disabled:
53860         type: boolean
53861       resource-version:
53862         type: string
53863         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53864       summary-status:
53865         type: string
53866         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
53867       encrypted-access-flag:
53868         type: boolean
53869         description: indicates whether generic-vnf access uses SSH
53870       entitlement-assignment-group-uuid:
53871         type: string
53872         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
53873       entitlement-resource-uuid:
53874         type: string
53875         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
53876       license-assignment-group-uuid:
53877         type: string
53878         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
53879       license-key-uuid:
53880         type: string
53881         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
53882       model-invariant-id:
53883         type: string
53884         description: the ASDC model id for this resource or service model.
53885       model-version-id:
53886         type: string
53887         description: the ASDC model version for this resource or service model.
53888       persona-model-version:
53889         type: string
53890         description: the ASDC model version for this resource or service model.
53891       model-customization-id:
53892         type: string
53893         description: captures the id of all the configuration used to customize the resource for the service.
53894       widget-model-id:
53895         type: string
53896         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
53897       widget-model-version:
53898         type: string
53899         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
53900       as-number:
53901         type: string
53902         description: as-number of the VNF
53903       regional-resource-subzone:
53904         type: string
53905         description: represents sub zone of the rr plane
53906       nf-type:
53907         type: string
53908         description: Generic description of the type of NF
53909       nf-function:
53910         type: string
53911         description: English description of Network function that the specific VNF deployment is providing
53912       nf-role:
53913         type: string
53914         description: role in the network that this model will be providing
53915       nf-naming-code:
53916         type: string
53917         description: string assigned to this model used for naming purposes
53918       selflink:
53919         type: string
53920         description: Path to the controller object.
53921       ipv4-oam-gateway-address:
53922         type: string
53923         description: Gateway address
53924       ipv4-oam-gateway-address-prefix-length:
53925         type: integer
53926         format: int32
53927         description: Prefix length for oam-address
53928       vlan-id-outer:
53929         type: integer
53930         format: int64
53931         description: Temporary location for S-TAG to get to VCE
53932       nm-profile-name:
53933         type: string
53934         description: Network Management profile of this VNF
53935       relationship-list:
53936         type: array
53937         items:
53938           $ref: "#/definitions/relationship"
53939       l-interfaces:
53940         type: array
53941         items:
53942           $ref: "#/definitions/l-interface"
53943       lag-interfaces:
53944         type: array
53945         items:
53946           $ref: "#/definitions/lag-interface"
53947       vf-modules:
53948         type: array
53949         items:
53950           $ref: "#/definitions/vf-module"
53951       licenses:
53952         type: array
53953         items:
53954           $ref: "#/definitions/license"
53955       entitlements:
53956         type: array
53957         items:
53958           $ref: "#/definitions/entitlement"
53959   generic-vnfs:
53960     description: |
53961       Collection of VNFs
53962     properties:
53963       generic-vnf:
53964         type: array
53965         items:
53966           $ref: "#/definitions/generic-vnf"
53967   group-assignment:
53968     description: |
53969       Openstack group-assignment used to store exclusivity groups (EG).
53970       ###### Related Nodes
53971       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
53972       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
53973       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
53974     required:
53975     - group-id
53976     - group-type
53977     - group-name
53978     properties:
53979       group-id:
53980         type: string
53981         description: Group id, expected to be unique across cloud-region.
53982       group-type:
53983         type: string
53984         description: Group type - the type of group this instance refers to
53985       group-name:
53986         type: string
53987         description: Group name - name assigned to the group
53988       group-description:
53989         type: string
53990         description: Group description - description of the group
53991       resource-version:
53992         type: string
53993         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
53994       relationship-list:
53995         type: array
53996         items:
53997           $ref: "#/definitions/relationship"
53998   group-assignments:
53999     description: |
54000       Collection of openstack group assignments
54001     properties:
54002       group-assignment:
54003         type: array
54004         items:
54005           $ref: "#/definitions/group-assignment"
54006   host-route:
54007     description: |
54008       ###### Related Nodes
54009       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
54010     required:
54011     - host-route-id
54012     - route-prefix
54013     - next-hop
54014     properties:
54015       host-route-id:
54016         type: string
54017         description: host-route id
54018       route-prefix:
54019         type: string
54020         description: subnet prefix
54021       next-hop:
54022         type: string
54023         description: Could be ip-address, hostname, or service-instance
54024       next-hop-type:
54025         type: string
54026         description: Should be ip-address, hostname, or service-instance to match next-hop
54027       resource-version:
54028         type: string
54029         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54030       relationship-list:
54031         type: array
54032         items:
54033           $ref: "#/definitions/relationship"
54034   host-routes:
54035     properties:
54036       host-route:
54037         type: array
54038         items:
54039           $ref: "#/definitions/host-route"
54040   image:
54041     description: |
54042       Openstack image.
54043       ###### Related Nodes
54044       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
54045       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54046       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
54047       - IMAGE cannot be deleted if linked to VSERVER
54048       - IMAGE is DELETED when these are DELETED METADATUM
54049     required:
54050     - image-id
54051     - image-name
54052     - image-os-distro
54053     - image-os-version
54054     - image-selflink
54055     properties:
54056       image-id:
54057         type: string
54058         description: Image id, expected to be unique across cloud region
54059       image-name:
54060         type: string
54061         description: Image name
54062       image-architecture:
54063         type: string
54064         description: Operating system architecture.
54065       image-os-distro:
54066         type: string
54067         description: The common name of the operating system distribution in lowercase
54068       image-os-version:
54069         type: string
54070         description: The operating system version as specified by the distributor.
54071       application:
54072         type: string
54073         description: The application that the image instantiates.
54074       application-vendor:
54075         type: string
54076         description: The vendor of the application.
54077       application-version:
54078         type: string
54079         description: The version of the application.
54080       image-selflink:
54081         type: string
54082         description: URL to endpoint where AAI can get more details
54083       resource-version:
54084         type: string
54085         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54086       relationship-list:
54087         type: array
54088         items:
54089           $ref: "#/definitions/relationship"
54090       metadata:
54091         type: array
54092         items:
54093           $ref: "#/definitions/metadatum"
54094   images:
54095     description: |
54096       Collectio of Openstack images.
54097     properties:
54098       image:
54099         type: array
54100         items:
54101           $ref: "#/definitions/image"
54102   include-node-filter:
54103     properties:
54104       include-node-type:
54105         type: string
54106   instance-filter:
54107     description: |
54108       InstanceFilter for performing a named-query or model query
54109   instance-filters:
54110     description: |
54111       InstanceFilters for performing a named-query or model query
54112     properties:
54113       instance-filter:
54114         type: array
54115         items:
54116           $ref: "#/definitions/instance-filter"
54117   instance-group:
54118     description: |
54119       General mechanism for grouping instances
54120       ###### Related Nodes
54121       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54122       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54123       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54124       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54125       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54126       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54127       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54128       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54129       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54130       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54131       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54132       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54133     required:
54134     - instance-group-role
54135     - model-invariant-id
54136     - model-version-id
54137     - id
54138     - description
54139     - type
54140     properties:
54141       instance-group-role:
54142         type: string
54143         description: role of the instance group.
54144       model-invariant-id:
54145         type: string
54146         description: ASDC model id for this resource or service model.
54147       model-version-id:
54148         type: string
54149         description: ASDC model version uid for this resource model.
54150       id:
54151         type: string
54152         description: Instance Group ID, UUID assigned to this instance.
54153       description:
54154         type: string
54155         description: Descriptive text to help identify the usage of this instance-group
54156       type:
54157         type: string
54158         description: Only valid value today is lower case ha for high availability
54159       sub-type:
54160         type: string
54161         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
54162       resource-version:
54163         type: string
54164         description: Concurrency value
54165       relationship-list:
54166         type: array
54167         items:
54168           $ref: "#/definitions/relationship"
54169   instance-groups:
54170     description: |
54171       Collection of openstack route table references
54172     properties:
54173       instance-group:
54174         type: array
54175         items:
54176           $ref: "#/definitions/instance-group"
54177   inventory:
54178     properties:
54179       search:
54180         type: object
54181         $ref: "#/definitions/search"
54182       actions:
54183         type: object
54184         $ref: "#/definitions/actions"
54185       cloud-infrastructure:
54186         type: object
54187         $ref: "#/definitions/cloud-infrastructure"
54188       external-system:
54189         type: object
54190         $ref: "#/definitions/external-system"
54191       business:
54192         type: object
54193         $ref: "#/definitions/business"
54194       service-design-and-creation:
54195         type: object
54196         $ref: "#/definitions/service-design-and-creation"
54197       network:
54198         type: object
54199         $ref: "#/definitions/network"
54200       aai-internal:
54201         type: object
54202         $ref: "#/definitions/aai-internal"
54203       nodes:
54204         type: array
54205         items:
54206           $ref: "#/definitions/aai-internal"
54207   inventory-item:
54208     properties:
54209       inventory-item-type:
54210         type: string
54211       inventory-item-link:
54212         type: string
54213       inventory-item-data:
54214         type: array
54215         items:
54216           $ref: "#/definitions/inventory-item-data"
54217       tagged-inventory-item-list:
54218         type: array
54219         items:
54220           $ref: "#/definitions/tagged-inventory-item-list"
54221   inventory-item-data:
54222     properties:
54223       property-name:
54224         type: string
54225       property-value:
54226         type: string
54227   inventory-response-item:
54228     description: |
54229       Inventory item for response list
54230     properties:
54231       model-name:
54232         type: string
54233       extra-properties:
54234         type: object
54235         $ref: "#/definitions/extra-properties"
54236       inventory-response-items:
54237         type: object
54238         $ref: "#/definitions/inventory-response-items"
54239   inventory-response-items:
54240     description: |
54241       Container for inventory items in response list
54242     properties:
54243       inventory-response-item:
54244         type: array
54245         items:
54246           $ref: "#/definitions/inventory-response-item"
54247   ipsec-configuration:
54248     description: |
54249       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
54250       ###### Related Nodes
54251       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
54252       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
54253       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
54254     required:
54255     - ipsec-configuration-id
54256     properties:
54257       ipsec-configuration-id:
54258         type: string
54259         description: UUID of this configuration
54260       requested-vig-address-type:
54261         type: string
54262         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
54263       requested-encryption-strength:
54264         type: string
54265         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
54266       requested-dmz-type:
54267         type: string
54268         description: ATT can offer a shared DMZ or a DMZ specific to a customer
54269       shared-dmz-network-address:
54270         type: string
54271         description: Network address of shared DMZ
54272       requested-customer-name:
54273         type: string
54274         description: If the DMZ is a custom DMZ, this field will indicate the customer information
54275       ike-version:
54276         type: string
54277         description: can be 1 or 2
54278       ikev1-authentication:
54279         type: string
54280         description: Contains values like md5, sha1, sha256, sha384
54281       ikev1-encryption:
54282         type: string
54283         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54284       ikev1-dh-group:
54285         type: string
54286         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
54287       ikev1-am-group-id:
54288         type: string
54289         description: Group name defined in VIG for clients using aggressive mode
54290       ikev1-am-password:
54291         type: string
54292         description: pre-shared key for the above group name
54293       ikev1-sa-lifetime:
54294         type: string
54295         description: Lifetime for IKEv1 SA
54296       ipsec-authentication:
54297         type: string
54298         description: md5, sha1, sha256, sha384
54299       ipsec-encryption:
54300         type: string
54301         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
54302       ipsec-sa-lifetime:
54303         type: string
54304         description: Life time for IPSec SA
54305       ipsec-pfs:
54306         type: string
54307         description: enable PFS or not
54308       xauth-userid:
54309         type: string
54310         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
54311       xauth-user-password:
54312         type: string
54313         description: Encrypted using the Juniper $9$ algorithm
54314       dpd-interval:
54315         type: string
54316         description: The time between DPD probe
54317       dpd-frequency:
54318         type: string
54319         description: Maximum number of DPD before claiming the tunnel is down
54320       resource-version:
54321         type: string
54322         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54323       relationship-list:
54324         type: array
54325         items:
54326           $ref: "#/definitions/relationship"
54327       vig-servers:
54328         type: array
54329         items:
54330           $ref: "#/definitions/vig-server"
54331   ipsec-configurations:
54332     properties:
54333       ipsec-configuration:
54334         type: array
54335         items:
54336           $ref: "#/definitions/ipsec-configuration"
54337   key-data:
54338     properties:
54339       key-name:
54340         type: string
54341       key-value:
54342         type: string
54343   l-interface:
54344     description: |
54345       Logical interfaces, e.g., a vnic.
54346       ###### Related Nodes
54347       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54348       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54349       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54350       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54351       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54352       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
54353       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
54354       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
54355       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
54356       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54357       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54358       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
54359       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
54360       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54361       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
54362       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
54363     required:
54364     - interface-name
54365     - is-port-mirrored
54366     - in-maint
54367     - is-ip-unnumbered
54368     properties:
54369       interface-name:
54370         type: string
54371         description: Name given to the interface
54372       interface-role:
54373         type: string
54374         description: E.g., CUSTOMER, UPLINK, etc.
54375       v6-wan-link-ip:
54376         type: string
54377         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
54378       selflink:
54379         type: string
54380         description: URL to endpoint where AAI can get more details
54381       interface-id:
54382         type: string
54383         description: ID of interface
54384       macaddr:
54385         type: string
54386         description: MAC address for the interface
54387       network-name:
54388         type: string
54389         description: Name of the network
54390       management-option:
54391         type: string
54392         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
54393       interface-description:
54394         type: string
54395         description: Human friendly text regarding this interface.
54396       is-port-mirrored:
54397         type: boolean
54398       resource-version:
54399         type: string
54400         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54401       in-maint:
54402         type: boolean
54403       prov-status:
54404         type: string
54405         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
54406       is-ip-unnumbered:
54407         type: boolean
54408       allowed-address-pairs:
54409         type: string
54410         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
54411       vlans:
54412         type: array
54413         items:
54414           $ref: "#/definitions/vlan"
54415       sriov-vfs:
54416         type: array
54417         items:
54418           $ref: "#/definitions/sriov-vf"
54419       l-interfaces:
54420         type: array
54421         items:
54422           $ref: "#/definitions/l-interface"
54423       relationship-list:
54424         type: array
54425         items:
54426           $ref: "#/definitions/relationship"
54427       l3-interface-ipv4-address-list:
54428         type: array
54429         items:
54430           $ref: "#/definitions/l3-interface-ipv4-address-list"
54431       l3-interface-ipv6-address-list:
54432         type: array
54433         items:
54434           $ref: "#/definitions/l3-interface-ipv6-address-list"
54435   l-interfaces:
54436     description: |
54437       Collection of logical interfaces.
54438     properties:
54439       l-interface:
54440         type: array
54441         items:
54442           $ref: "#/definitions/l-interface"
54443   l3-interface-ipv4-address-list:
54444     description: |
54445       IPv4 Address Range
54446       ###### Related Nodes
54447       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54448       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54449       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54450       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54451       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54452       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
54453     required:
54454     - l3-interface-ipv4-address
54455     properties:
54456       l3-interface-ipv4-address:
54457         type: string
54458         description: IP address
54459       l3-interface-ipv4-prefix-length:
54460         type: integer
54461         format: int64
54462         description: Prefix length, 32 for single address
54463       vlan-id-inner:
54464         type: integer
54465         format: int64
54466         description: Inner VLAN tag
54467       vlan-id-outer:
54468         type: integer
54469         format: int64
54470         description: Outer VLAN tag
54471       is-floating:
54472         type: boolean
54473         description: Indicator of fixed or floating address
54474       resource-version:
54475         type: string
54476         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54477       neutron-network-id:
54478         type: string
54479         description: Neutron network id of the interface that address belongs to
54480       neutron-subnet-id:
54481         type: string
54482         description: Neutron id of subnet that address belongs to
54483       relationship-list:
54484         type: array
54485         items:
54486           $ref: "#/definitions/relationship"
54487   l3-interface-ipv6-address-list:
54488     description: |
54489       IPv6 Address Range
54490       ###### Related Nodes
54491       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
54492       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54493       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
54494       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
54495       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
54496       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
54497     required:
54498     - l3-interface-ipv6-address
54499     properties:
54500       l3-interface-ipv6-address:
54501         type: string
54502         description: IP address
54503       l3-interface-ipv6-prefix-length:
54504         type: integer
54505         format: int64
54506         description: Prefix length, 128 for single address
54507       vlan-id-inner:
54508         type: integer
54509         format: int64
54510         description: Inner VLAN tag
54511       vlan-id-outer:
54512         type: integer
54513         format: int64
54514         description: Outer VLAN tag
54515       is-floating:
54516         type: boolean
54517         description: Indicator of fixed or floating address
54518       resource-version:
54519         type: string
54520         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54521       neutron-network-id:
54522         type: string
54523         description: Neutron network id of the interface that address belongs to
54524       neutron-subnet-id:
54525         type: string
54526         description: Neutron id of subnet that address belongs to
54527       relationship-list:
54528         type: array
54529         items:
54530           $ref: "#/definitions/relationship"
54531   l3-network:
54532     description: |
54533       Generic network definition
54534       ###### Related Nodes
54535       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
54536       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
54537       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
54538       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54539       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
54540       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54541       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54542       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54543       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54544       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
54545       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54546       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54547       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
54548       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
54549       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
54550       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
54551       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
54552     required:
54553     - network-id
54554     - network-name
54555     - is-bound-to-vpn
54556     - is-provider-network
54557     - is-shared-network
54558     - is-external-network
54559     properties:
54560       network-id:
54561         type: string
54562         description: Network ID, should be uuid. Unique across A&AI.
54563       network-name:
54564         type: string
54565         description: Name of the network, governed by some naming convention..
54566       network-type:
54567         type: string
54568         description: Type of the network - who defines these values?
54569       network-role:
54570         type: string
54571         description: Role the network plans - who defines these values?
54572       network-technology:
54573         type: string
54574         description: Network technology - who defines these values?
54575       neutron-network-id:
54576         type: string
54577         description: Neutron network id of this Interface
54578       is-bound-to-vpn:
54579         type: boolean
54580       service-id:
54581         type: string
54582         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
54583       network-role-instance:
54584         type: integer
54585         format: int64
54586         description: network role instance
54587       resource-version:
54588         type: string
54589         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54590       orchestration-status:
54591         type: string
54592         description: Orchestration status of this VNF, mastered by MSO
54593       heat-stack-id:
54594         type: string
54595         description: Heat stack id corresponding to this instance, managed by MSO
54596       mso-catalog-key:
54597         type: string
54598         description: Corresponds to the SDN-C catalog id used to configure this VCE
54599       contrail-network-fqdn:
54600         type: string
54601         description: Contrail FQDN for the network
54602       model-invariant-id:
54603         type: string
54604         description: the ASDC model id for this resource or service model.
54605       model-version-id:
54606         type: string
54607         description: the ASDC model version for this resource or service model.
54608       persona-model-version:
54609         type: string
54610         description: the ASDC model version for this resource or service model.
54611       model-customization-id:
54612         type: string
54613         description: captures the id of all the configuration used to customize the resource for the service.
54614       widget-model-id:
54615         type: string
54616         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54617       widget-model-version:
54618         type: string
54619         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54620       physical-network-name:
54621         type: string
54622         description: Name associated with the physical network.
54623       is-provider-network:
54624         type: boolean
54625       is-shared-network:
54626         type: boolean
54627       is-external-network:
54628         type: boolean
54629       selflink:
54630         type: string
54631         description: Path to the controller object.
54632       operational-status:
54633         type: string
54634         description: Indicator for whether the resource is considered operational.
54635       subnets:
54636         type: array
54637         items:
54638           $ref: "#/definitions/subnet"
54639       ctag-assignments:
54640         type: array
54641         items:
54642           $ref: "#/definitions/ctag-assignment"
54643       segmentation-assignments:
54644         type: array
54645         items:
54646           $ref: "#/definitions/segmentation-assignment"
54647       relationship-list:
54648         type: array
54649         items:
54650           $ref: "#/definitions/relationship"
54651         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
54652   l3-networks:
54653     properties:
54654       l3-network:
54655         type: array
54656         items:
54657           $ref: "#/definitions/l3-network"
54658   lag-interface:
54659     description: |
54660       Link aggregate interface
54661       ###### Related Nodes
54662       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54663       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54664       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54665       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
54666       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
54667       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
54668       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
54669       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
54670       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
54671       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
54672     required:
54673     - interface-name
54674     - in-maint
54675     properties:
54676       interface-name:
54677         type: string
54678         description: Name that identifies the link aggregate interface
54679       interface-description:
54680         type: string
54681         description: Human friendly text regarding this interface.
54682       resource-version:
54683         type: string
54684         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54685       speed-value:
54686         type: string
54687         description: Captures the numeric part of the speed
54688       speed-units:
54689         type: string
54690         description: Captures the units corresponding to the speed
54691       interface-id:
54692         type: string
54693         description: ID of interface
54694       interface-role:
54695         type: string
54696         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
54697       prov-status:
54698         type: string
54699         description: Trigger for operational monitoring of this resource by Service Assurance systems.
54700       in-maint:
54701         type: boolean
54702       relationship-list:
54703         type: array
54704         items:
54705           $ref: "#/definitions/relationship"
54706       l-interfaces:
54707         type: array
54708         items:
54709           $ref: "#/definitions/l-interface"
54710   lag-interfaces:
54711     description: |
54712       Collection of link aggregate interfaces.
54713     properties:
54714       lag-interface:
54715         type: array
54716         items:
54717           $ref: "#/definitions/lag-interface"
54718   lag-link:
54719     description: |
54720       LAG links can connect lag-interfaces
54721       ###### Related Nodes
54722       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
54723       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54724     required:
54725     - link-name
54726     properties:
54727       link-name:
54728         type: string
54729         description: Alphabetical concatenation of lag-interface names
54730       resource-version:
54731         type: string
54732         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54733       relationship-list:
54734         type: array
54735         items:
54736           $ref: "#/definitions/relationship"
54737   lag-links:
54738     description: |
54739       Collection of link aggregation connections
54740     properties:
54741       lag-link:
54742         type: array
54743         items:
54744           $ref: "#/definitions/lag-link"
54745   license:
54746     description: |
54747       Metadata for license group.
54748       ###### Related Nodes
54749       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
54750       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
54751     required:
54752     - group-uuid
54753     - resource-uuid
54754     properties:
54755       group-uuid:
54756         type: string
54757         description: Unique ID for the license group the resource belongs to, should be uuid.
54758       resource-uuid:
54759         type: string
54760         description: Unique ID of a license resource.
54761       resource-version:
54762         type: string
54763         description: Concurrency value
54764       relationship-list:
54765         type: array
54766         items:
54767           $ref: "#/definitions/relationship"
54768   licenses:
54769     description: |
54770       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
54771     properties:
54772       license:
54773         type: array
54774         items:
54775           $ref: "#/definitions/license"
54776   line-of-business:
54777     description: |
54778       describes a line-of-business
54779       ###### Related Nodes
54780       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
54781     required:
54782     - line-of-business-name
54783     properties:
54784       line-of-business-name:
54785         type: string
54786         description: Name of the line-of-business (product)
54787       resource-version:
54788         type: string
54789         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54790       relationship-list:
54791         type: array
54792         items:
54793           $ref: "#/definitions/relationship"
54794   lines-of-business:
54795     description: |
54796       Collection of lines-of-business
54797     properties:
54798       line-of-business:
54799         type: array
54800         items:
54801           $ref: "#/definitions/line-of-business"
54802   logical-link:
54803     description: |
54804       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
54805       ###### Related Nodes
54806       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
54807       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
54808       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
54809       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54810       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
54811       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
54812       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
54813       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
54814       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54815       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54816       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
54817       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
54818       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
54819       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54820       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
54821     required:
54822     - link-name
54823     - in-maint
54824     - link-type
54825     properties:
54826       link-name:
54827         type: string
54828         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
54829       in-maint:
54830         type: boolean
54831       link-type:
54832         type: string
54833         description: Type of logical link, e.g., evc
54834       speed-value:
54835         type: string
54836         description: Captures the numeric part of the speed
54837       speed-units:
54838         type: string
54839         description: Captures the units corresponding to the speed
54840       ip-version:
54841         type: string
54842         description: v4, v6, or ds for dual stack
54843       routing-protocol:
54844         type: string
54845         description: For example, static or BGP
54846       resource-version:
54847         type: string
54848         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54849       model-invariant-id:
54850         type: string
54851         description: the ASDC model id for this resource or service model.
54852       model-version-id:
54853         type: string
54854         description: the ASDC model version for this resource or service model.
54855       persona-model-version:
54856         type: string
54857         description: the ASDC model version for this resource or service model.
54858       widget-model-id:
54859         type: string
54860         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
54861       widget-model-version:
54862         type: string
54863         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
54864       operational-status:
54865         type: string
54866         description: Indication of operational status of the logical link.
54867       prov-status:
54868         type: string
54869         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
54870       link-role:
54871         type: string
54872         description: Indication of the network use of the logical link.
54873       link-name2:
54874         type: string
54875         description: Alias or alternate name (CLCI or D1 name).
54876       link-id:
54877         type: string
54878         description: UUID of the logical-link, SDNC generates this.
54879       circuit-id:
54880         type: string
54881         description: Circuit id
54882       purpose:
54883         type: string
54884         description: Reason for this entity, role it is playing
54885       relationship-list:
54886         type: array
54887         items:
54888           $ref: "#/definitions/relationship"
54889   logical-links:
54890     description: |
54891       Collection of logical connections
54892     properties:
54893       logical-link:
54894         type: array
54895         items:
54896           $ref: "#/definitions/logical-link"
54897   metadata:
54898     description: |
54899       Collection of metadatum (key/value pairs)
54900     properties:
54901       metadatum:
54902         type: array
54903         items:
54904           $ref: "#/definitions/metadatum"
54905   metadatum:
54906     description: |
54907       Key/value pairs
54908       ###### Related Nodes
54909       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
54910       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
54911       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
54912       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
54913       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
54914     required:
54915     - metaname
54916     - metaval
54917     properties:
54918       metaname:
54919         type: string
54920       metaval:
54921         type: string
54922       resource-version:
54923         type: string
54924         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54925   model:
54926     description: |
54927       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
54928       ###### Related Nodes
54929       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54930       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
54931       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
54932       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
54933       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
54934       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
54935       - MODEL is DELETED when these are DELETED MODEL-VER
54936     required:
54937     - model-invariant-id
54938     - model-type
54939     properties:
54940       model-invariant-id:
54941         type: string
54942         description: Unique identifier corresponding to the main definition of a model in ASDC
54943       model-type:
54944         type: string
54945         description: Type of the model, e.g., service, resource, widget, etc.
54946       resource-version:
54947         type: string
54948         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54949       model-vers:
54950         type: array
54951         items:
54952           $ref: "#/definitions/model-ver"
54953       relationship-list:
54954         type: array
54955         items:
54956           $ref: "#/definitions/relationship"
54957   model-and-named-query-search:
54958     description: |
54959       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
54960     properties:
54961       query-parameters:
54962         type: object
54963         $ref: "#/definitions/query-parameters"
54964       instance-filters:
54965         type: object
54966         $ref: "#/definitions/instance-filters"
54967       secondary-filts:
54968         type: object
54969         $ref: "#/definitions/secondary-filts"
54970       top-node-type:
54971         type: string
54972       secondary-filter-cut-point:
54973         type: string
54974   model-constraint:
54975     description: |
54976       This is how we would capture constraints defining allowed sets of elements.
54977       ###### Related Nodes
54978       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
54979       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
54980       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
54981     required:
54982     - model-constraint-uuid
54983     - constrained-element-set-uuid-to-replace
54984     properties:
54985       model-constraint-uuid:
54986         type: string
54987       constrained-element-set-uuid-to-replace:
54988         type: string
54989       constrained-element-sets:
54990         type: array
54991         items:
54992           $ref: "#/definitions/constrained-element-set"
54993       resource-version:
54994         type: string
54995         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
54996   model-constraints:
54997     properties:
54998       model-constraint:
54999         type: array
55000         items:
55001           $ref: "#/definitions/model-constraint"
55002   model-element:
55003     description: |
55004       Defines how other models combine to make up a higher-level model.
55005       ###### Related Nodes
55006       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
55007       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55008       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55009       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55010       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55011       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55012       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
55013       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
55014     required:
55015     - model-element-uuid
55016     - new-data-del-flag
55017     - cardinality
55018     properties:
55019       model-element-uuid:
55020         type: string
55021       new-data-del-flag:
55022         type: string
55023         description: Indicates whether this element was created as part of instantiation from this model
55024       cardinality:
55025         type: string
55026         description: How many of this type of element are required/allowed
55027       linkage-points:
55028         type: string
55029       resource-version:
55030         type: string
55031         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55032       model-elements:
55033         type: array
55034         items:
55035           $ref: "#/definitions/model-element"
55036         description: Defines how other models combine to make up a higher-level model
55037       model-constraints:
55038         type: array
55039         items:
55040           $ref: "#/definitions/model-constraint"
55041         description: Describes new constraints on this model element that are not part of that model's definition
55042       relationship-list:
55043         type: array
55044         items:
55045           $ref: "#/definitions/relationship"
55046   model-elements:
55047     properties:
55048       model-element:
55049         type: array
55050         items:
55051           $ref: "#/definitions/model-element"
55052   model-ver:
55053     description: |
55054       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
55055       ###### Related Nodes
55056       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
55057       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
55058       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55059       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
55060       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
55061       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
55062     required:
55063     - model-version-id
55064     - model-name
55065     - model-version
55066     properties:
55067       model-version-id:
55068         type: string
55069         description: Unique identifier corresponding to one version of a model in ASDC
55070       model-name:
55071         type: string
55072         description: Name of the model, which can change from version to version.
55073       model-version:
55074         type: string
55075         description: Version
55076       model-description:
55077         type: string
55078         description: Description
55079       resource-version:
55080         type: string
55081         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55082       model-elements:
55083         type: array
55084         items:
55085           $ref: "#/definitions/model-element"
55086       metadata:
55087         type: array
55088         items:
55089           $ref: "#/definitions/metadatum"
55090       relationship-list:
55091         type: array
55092         items:
55093           $ref: "#/definitions/relationship"
55094   model-vers:
55095     properties:
55096       model-ver:
55097         type: array
55098         items:
55099           $ref: "#/definitions/model-ver"
55100   models:
55101     description: |
55102       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
55103     properties:
55104       model:
55105         type: array
55106         items:
55107           $ref: "#/definitions/model"
55108   multicast-configuration:
55109     description: |
55110       ###### Related Nodes
55111       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
55112     required:
55113     - multicast-configuration-id
55114     - multicast-protocol
55115     - rp-type
55116     properties:
55117       multicast-configuration-id:
55118         type: string
55119         description: Unique id of multicast configuration.
55120       multicast-protocol:
55121         type: string
55122         description: protocol of multicast configuration
55123       rp-type:
55124         type: string
55125         description: rp type of multicast configuration
55126       resource-version:
55127         type: string
55128         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55129       relationship-list:
55130         type: array
55131         items:
55132           $ref: "#/definitions/relationship"
55133   multicast-configurations:
55134     description: |
55135       multicast configuration of generic-vnf ip-address
55136     properties:
55137       multicast-configuration:
55138         type: array
55139         items:
55140           $ref: "#/definitions/multicast-configuration"
55141   named-queries:
55142     properties:
55143       named-query:
55144         type: array
55145         items:
55146           $ref: "#/definitions/named-query"
55147   named-query:
55148     description: |
55149       TBD
55150       ###### Related Nodes
55151       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55152       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
55153       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55154       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
55155     required:
55156     - named-query-uuid
55157     - named-query-name
55158     - named-query-version
55159     properties:
55160       named-query-uuid:
55161         type: string
55162       named-query-name:
55163         type: string
55164       named-query-version:
55165         type: string
55166       required-input-param:
55167         type: string
55168       description:
55169         type: string
55170       resource-version:
55171         type: string
55172       named-query-elements:
55173         type: array
55174         items:
55175           $ref: "#/definitions/named-query-element"
55176       relationship-list:
55177         type: array
55178         items:
55179           $ref: "#/definitions/relationship"
55180   named-query-element:
55181     description: |
55182       TBD
55183       ###### Related Nodes
55184       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
55185       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
55186       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55187       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55188       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55189       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
55190       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
55191     required:
55192     - named-query-element-uuid
55193     properties:
55194       named-query-element-uuid:
55195         type: string
55196       property-collect-list:
55197         type: string
55198       resource-version:
55199         type: string
55200       property-limit-desc:
55201         type: string
55202       do-not-output:
55203         type: string
55204       named-query-elements:
55205         type: array
55206         items:
55207           $ref: "#/definitions/named-query-element"
55208       related-lookups:
55209         type: array
55210         items:
55211           $ref: "#/definitions/related-lookup"
55212       property-constraints:
55213         type: array
55214         items:
55215           $ref: "#/definitions/property-constraint"
55216       relationship-list:
55217         type: array
55218         items:
55219           $ref: "#/definitions/relationship"
55220   named-query-elements:
55221     properties:
55222       named-query-element:
55223         type: array
55224         items:
55225           $ref: "#/definitions/named-query-element"
55226   network:
55227     description: |
55228       Namespace for network inventory resources.
55229     properties:
55230       logical-links:
55231         type: array
55232         items:
55233           $ref: "#/definitions/logical-link"
55234       site-pair-sets:
55235         type: array
55236         items:
55237           $ref: "#/definitions/site-pair-set"
55238       vpn-bindings:
55239         type: array
55240         items:
55241           $ref: "#/definitions/vpn-binding"
55242       vpls-pes:
55243         type: array
55244         items:
55245           $ref: "#/definitions/vpls-pe"
55246       multicast-configurations:
55247         type: array
55248         items:
55249           $ref: "#/definitions/multicast-configuration"
55250       vces:
55251         type: array
55252         items:
55253           $ref: "#/definitions/vce"
55254       vnfcs:
55255         type: array
55256         items:
55257           $ref: "#/definitions/vnfc"
55258       l3-networks:
55259         type: array
55260         items:
55261           $ref: "#/definitions/l3-network"
55262       network-policies:
55263         type: array
55264         items:
55265           $ref: "#/definitions/network-policy"
55266       generic-vnfs:
55267         type: array
55268         items:
55269           $ref: "#/definitions/generic-vnf"
55270       lag-links:
55271         type: array
55272         items:
55273           $ref: "#/definitions/lag-link"
55274       newvces:
55275         type: array
55276         items:
55277           $ref: "#/definitions/newvce"
55278       pnfs:
55279         type: array
55280         items:
55281           $ref: "#/definitions/pnf"
55282       physical-links:
55283         type: array
55284         items:
55285           $ref: "#/definitions/physical-link"
55286       ipsec-configurations:
55287         type: array
55288         items:
55289           $ref: "#/definitions/ipsec-configuration"
55290       route-table-references:
55291         type: array
55292         items:
55293           $ref: "#/definitions/route-table-reference"
55294       instance-groups:
55295         type: array
55296         items:
55297           $ref: "#/definitions/instance-group"
55298       zones:
55299         type: array
55300         items:
55301           $ref: "#/definitions/zone"
55302       configurations:
55303         type: array
55304         items:
55305           $ref: "#/definitions/configurations"
55306   network-policies:
55307     properties:
55308       network-policy:
55309         type: array
55310         items:
55311           $ref: "#/definitions/network-policy"
55312   network-policy:
55313     description: |
55314       ###### Related Nodes
55315       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
55316       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
55317     required:
55318     - network-policy-id
55319     properties:
55320       network-policy-id:
55321         type: string
55322         description: UUID representing unique key to this instance
55323       network-policy-fqdn:
55324         type: string
55325         description: Contrail FQDN for the policy
55326       heat-stack-id:
55327         type: string
55328         description: ID for the openStack Heat instance
55329       resource-version:
55330         type: string
55331         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55332       relationship-list:
55333         type: array
55334         items:
55335           $ref: "#/definitions/relationship"
55336   network-profile:
55337     description: |
55338       Network profile populated by SDN-GP for SNMP
55339       ###### Related Nodes
55340       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
55341     required:
55342     - nm-profile-name
55343     properties:
55344       nm-profile-name:
55345         type: string
55346         description: Unique name of network profile.
55347       community-string:
55348         type: string
55349         description: Encrypted SNMP community string
55350       resource-version:
55351         type: string
55352         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55353       relationship-list:
55354         type: array
55355         items:
55356           $ref: "#/definitions/relationship"
55357   network-profiles:
55358     description: |
55359       Collection of network profiles
55360     properties:
55361       network-profile:
55362         type: array
55363         items:
55364           $ref: "#/definitions/network-profile"
55365   newvce:
55366     description: |
55367       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55368       ###### Related Nodes
55369       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
55370       - NEWVCE is DELETED when these are DELETED L-INTERFACE
55371     required:
55372     - vnf-id2
55373     - vnf-name
55374     - vnf-type
55375     properties:
55376       vnf-id2:
55377         type: string
55378         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
55379       vnf-name:
55380         type: string
55381         description: Name of VNF.
55382       vnf-name2:
55383         type: string
55384         description: Alternate name of VNF.
55385       vnf-type:
55386         type: string
55387         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.
55388       prov-status:
55389         type: string
55390         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
55391       operational-status:
55392         type: string
55393         description: Indicator for whether the resource is considered operational
55394       license-key:
55395         type: string
55396         description: OBSOLETE -  do not use
55397       ipv4-oam-address:
55398         type: string
55399         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).
55400       equipment-role:
55401         type: string
55402         description: Client should send valid enumerated value.
55403       resource-version:
55404         type: string
55405         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55406       ipv4-loopback0-address:
55407         type: string
55408         description: v4 Loopback0 address
55409       orchestration-status:
55410         type: string
55411         description: Orchestration status of this VNF, mastered by MSO.
55412       heat-stack-id:
55413         type: string
55414         description: Heat stack id corresponding to this instance, managed by MSO
55415       mso-catalog-key:
55416         type: string
55417         description: Corresponds to the SDN-C catalog id used to configure this VCE
55418       relationship-list:
55419         type: array
55420         items:
55421           $ref: "#/definitions/relationship"
55422       l-interfaces:
55423         type: array
55424         items:
55425           $ref: "#/definitions/l-interface"
55426   newvces:
55427     description: |
55428       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
55429     properties:
55430       newvce:
55431         type: array
55432         items:
55433           $ref: "#/definitions/newvce"
55434   notification-event:
55435     properties:
55436       cambria.partition:
55437         type: string
55438       notification-event-header:
55439         type: object
55440         $ref: "#/definitions/notification-event-header"
55441   notification-event-header:
55442     properties:
55443       id:
55444         type: string
55445       timestamp:
55446         type: string
55447       source-name:
55448         type: string
55449       domain:
55450         type: string
55451       sequence-number:
55452         type: string
55453       severity:
55454         type: string
55455       event-type:
55456         type: string
55457       version:
55458         type: string
55459       action:
55460         type: string
55461       entity-type:
55462         type: string
55463       top-entity-type:
55464         type: string
55465       entity-link:
55466         type: string
55467       status:
55468         type: string
55469   notify:
55470     required:
55471     - event-id
55472     properties:
55473       event-id:
55474         type: string
55475       node-type:
55476         type: string
55477       event-trigger:
55478         type: string
55479       key-data:
55480         type: array
55481         items:
55482           $ref: "#/definitions/key-data"
55483       selflink:
55484         type: string
55485   oam-network:
55486     description: |
55487       OAM network, to be deprecated shortly.  Do not use for new purposes.
55488       ###### Related Nodes
55489       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
55490       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
55491       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
55492     required:
55493     - network-uuid
55494     - network-name
55495     - cvlan-tag
55496     properties:
55497       network-uuid:
55498         type: string
55499         description: UUID of the network. Unique across a cloud-region
55500       network-name:
55501         type: string
55502         description: Name of the network.
55503       cvlan-tag:
55504         type: integer
55505         format: int64
55506         description: cvlan-id
55507       ipv4-oam-gateway-address:
55508         type: string
55509         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55510       ipv4-oam-gateway-address-prefix-length:
55511         type: integer
55512         format: int32
55513         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
55514       resource-version:
55515         type: string
55516         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55517       relationship-list:
55518         type: array
55519         items:
55520           $ref: "#/definitions/relationship"
55521   oam-networks:
55522     description: |
55523       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
55524     properties:
55525       oam-network:
55526         type: array
55527         items:
55528           $ref: "#/definitions/oam-network"
55529   operational-environment:
55530     description: |
55531       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
55532       ###### Related Nodes
55533       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55534       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
55535     required:
55536     - operational-environment-id
55537     - operational-environment-name
55538     - operational-environment-type
55539     - operational-environment-status
55540     - tenant-context
55541     - workload-context
55542     properties:
55543       operational-environment-id:
55544         type: string
55545         description: UUID of an operational environment
55546       operational-environment-name:
55547         type: string
55548         description: Operational Environment name
55549       operational-environment-type:
55550         type: string
55551         description: Operational Environment Type.
55552       operational-environment-status:
55553         type: string
55554         description: Status
55555       tenant-context:
55556         type: string
55557         description: Tenant Context.
55558       workload-context:
55559         type: string
55560         description: Workload Context.
55561       resource-version:
55562         type: string
55563         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55564       relationship-list:
55565         type: array
55566         items:
55567           $ref: "#/definitions/relationship"
55568   operational-environments:
55569     description: |
55570       a logical partition of the cloud which allows to have multiple environments in the production AIC.
55571     properties:
55572       operational-environment:
55573         type: array
55574         items:
55575           $ref: "#/definitions/operational-environment"
55576   overloaded-model:
55577     description: |
55578       Allows for legacy POST of old-style and new-style models
55579     required:
55580     - model-invariant-id
55581     - model-name-version-id
55582     - model-type
55583     - model-name
55584     - model-id
55585     - model-version
55586     properties:
55587       model-invariant-id:
55588         type: string
55589         description: Unique identifier corresponding to the main definition of a model in ASDC
55590       model-name-version-id:
55591         type: string
55592         description: Unique identifier corresponding to one version of a model in ASDC
55593       model-type:
55594         type: string
55595         description: Type of the model, e.g., service, resource, widget, etc.
55596       model-name:
55597         type: string
55598         description: Name of the model, which can change from version to version.
55599       model-id:
55600         type: string
55601         description: Invariant unique ID which does not change from version to version
55602       model-version:
55603         type: string
55604         description: Version
55605       model-description:
55606         type: string
55607         description: Description
55608       resource-version:
55609         type: string
55610         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55611       model-vers:
55612         type: object
55613         $ref: "#/definitions/model-vers"
55614       relationship-list:
55615         type: object
55616         $ref: "#/definitions/relationship-list"
55617   owning-entities:
55618     description: |
55619       Collection of owning-entities
55620     properties:
55621       owning-entity:
55622         type: array
55623         items:
55624           $ref: "#/definitions/owning-entity"
55625   owning-entity:
55626     description: |
55627       describes an owning-entity
55628       ###### Related Nodes
55629       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
55630     required:
55631     - owning-entity-id
55632     - owning-entity-name
55633     properties:
55634       owning-entity-id:
55635         type: string
55636         description: UUID of an owning entity
55637       owning-entity-name:
55638         type: string
55639         description: Owning entity name
55640       resource-version:
55641         type: string
55642         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55643       relationship-list:
55644         type: array
55645         items:
55646           $ref: "#/definitions/relationship"
55647   p-interface:
55648     description: |
55649       Physical interface (e.g., nic)
55650       ###### Related Nodes
55651       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
55652       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55653       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55654       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
55655       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
55656       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
55657       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
55658       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
55659       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
55660       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
55661     required:
55662     - interface-name
55663     - in-maint
55664     properties:
55665       interface-name:
55666         type: string
55667         description: Name that identifies the physical interface
55668       speed-value:
55669         type: string
55670         description: Captures the numeric part of the speed
55671       speed-units:
55672         type: string
55673         description: Captures the units corresponding to the speed
55674       port-description:
55675         type: string
55676         description: Nature of the services and connectivity on this port.
55677       equipment-identifier:
55678         type: string
55679         description: CLEI or other specification for p-interface hardware.
55680       interface-role:
55681         type: string
55682         description: Role specification for p-interface hardware.
55683       interface-type:
55684         type: string
55685         description: Indicates the physical properties of the interface.
55686       prov-status:
55687         type: string
55688         description: Trigger for operational monitoring of this resource by Service Assurance systems.
55689       mac-addresss:
55690         type: string
55691         description: MAC Address of the p-interface.
55692       resource-version:
55693         type: string
55694         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55695       in-maint:
55696         type: boolean
55697       inv-status:
55698         type: string
55699         description: inventory status
55700       relationship-list:
55701         type: array
55702         items:
55703           $ref: "#/definitions/relationship"
55704       sriov-pfs:
55705         type: array
55706         items:
55707           $ref: "#/definitions/sriov-pf"
55708       l-interfaces:
55709         type: array
55710         items:
55711           $ref: "#/definitions/l-interface"
55712   p-interfaces:
55713     description: |
55714       Collection of physical interfaces.
55715     properties:
55716       p-interface:
55717         type: array
55718         items:
55719           $ref: "#/definitions/p-interface"
55720   physical-link:
55721     description: |
55722       Collection of physical connections, typically between p-interfaces
55723       ###### Related Nodes
55724       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
55725     required:
55726     - link-name
55727     properties:
55728       link-name:
55729         type: string
55730         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
55731       speed-value:
55732         type: string
55733         description: Captures the numeric part of the speed
55734       speed-units:
55735         type: string
55736         description: Captures the units corresponding to the speed
55737       circuit-id:
55738         type: string
55739         description: Circuit it
55740       dual-mode:
55741         type: string
55742         description: Dual access mode (e.g., primary, secondary
55743       management-option:
55744         type: string
55745         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
55746       service-provider-name:
55747         type: string
55748         description: Name of the service Provider on this link.
55749       service-provider-bandwidth-up-value:
55750         type: integer
55751         format: int32
55752         description: Upstream Bandwidth value agreed with the service provider
55753       service-provider-bandwidth-up-units:
55754         type: string
55755         description: Units for the upstream BW value
55756       service-provider-bandwidth-down-value:
55757         type: integer
55758         format: int32
55759         description: Downstream Bandwidth value agreed with the service provider
55760       service-provider-bandwidth-down-units:
55761         type: string
55762         description: Units for downstream BW value
55763       resource-version:
55764         type: string
55765         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55766       relationship-list:
55767         type: array
55768         items:
55769           $ref: "#/definitions/relationship"
55770   physical-links:
55771     description: |
55772       Collection of physical connections, typically between p-interfaces
55773     properties:
55774       physical-link:
55775         type: array
55776         items:
55777           $ref: "#/definitions/physical-link"
55778   platform:
55779     description: |
55780       describes a platform
55781       ###### Related Nodes
55782       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
55783     required:
55784     - platform-name
55785     properties:
55786       platform-name:
55787         type: string
55788         description: Name of the platform
55789       resource-version:
55790         type: string
55791         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55792       relationship-list:
55793         type: array
55794         items:
55795           $ref: "#/definitions/relationship"
55796   platforms:
55797     description: |
55798       Collection of platforms
55799     properties:
55800       platform:
55801         type: array
55802         items:
55803           $ref: "#/definitions/platform"
55804   pnf:
55805     description: |
55806       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
55807       ###### Related Nodes
55808       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
55809       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
55810       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
55811       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
55812       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
55813       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
55814       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55815       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
55816       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
55817       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
55818     required:
55819     - pnf-name
55820     - in-maint
55821     properties:
55822       pnf-name:
55823         type: string
55824         description: unique name of Physical Network Function.
55825       pnf-name2:
55826         type: string
55827         description: name of Physical Network Function.
55828       pnf-name2-source:
55829         type: string
55830         description: source of name2
55831       pnf-id:
55832         type: string
55833         description: id of pnf
55834       equip-type:
55835         type: string
55836         description: Equipment type.  Source of truth should define valid values.
55837       equip-vendor:
55838         type: string
55839         description: Equipment vendor.  Source of truth should define valid values.
55840       equip-model:
55841         type: string
55842         description: Equipment model.  Source of truth should define valid values.
55843       management-option:
55844         type: string
55845         description: identifier of managed by ATT or customer
55846       ipaddress-v4-oam:
55847         type: string
55848         description: ipv4-oam-address with new naming convention for IP addresses
55849       sw-version:
55850         type: string
55851         description: sw-version is the version of SW for the hosted application on the PNF.
55852       in-maint:
55853         type: boolean
55854       frame-id:
55855         type: string
55856         description: ID of the physical frame (relay rack) where pnf is installed.
55857       serial-number:
55858         type: string
55859         description: Serial number of the device
55860       ipaddress-v4-loopback-0:
55861         type: string
55862         description: IPV4 Loopback 0 address
55863       ipaddress-v6-loopback-0:
55864         type: string
55865         description: IPV6 Loopback 0 address
55866       ipaddress-v4-aim:
55867         type: string
55868         description: IPV4 AIM address
55869       ipaddress-v6-aim:
55870         type: string
55871         description: IPV6 AIM address
55872       ipaddress-v6-oam:
55873         type: string
55874         description: IPV6 OAM address
55875       inv-status:
55876         type: string
55877         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
55878       resource-version:
55879         type: string
55880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55881       prov-status:
55882         type: string
55883         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
55884       nf-role:
55885         type: string
55886         description: Nf Role is the role performed by this instance in the network.
55887       relationship-list:
55888         type: array
55889         items:
55890           $ref: "#/definitions/relationship"
55891       p-interfaces:
55892         type: array
55893         items:
55894           $ref: "#/definitions/p-interface"
55895       lag-interfaces:
55896         type: array
55897         items:
55898           $ref: "#/definitions/lag-interface"
55899   pnfs:
55900     description: |
55901       Collection of Physical Network Functions.
55902     properties:
55903       pnf:
55904         type: array
55905         items:
55906           $ref: "#/definitions/pnf"
55907   port-group:
55908     description: |
55909       Used to capture the network interfaces of this VCE
55910       ###### Related Nodes
55911       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
55912       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
55913       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
55914     required:
55915     - interface-id
55916     - orchestration-status
55917     properties:
55918       interface-id:
55919         type: string
55920         description: Unique ID of the interface
55921       neutron-network-id:
55922         type: string
55923         description: Neutron network id of this Interface
55924       neutron-network-name:
55925         type: string
55926         description: Neutron network name of this Interface
55927       interface-role:
55928         type: string
55929         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
55930       resource-version:
55931         type: string
55932         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55933       port-group-id:
55934         type: string
55935         description: Unique ID for port group in vmware
55936       port-group-name:
55937         type: string
55938         description: Likely to duplicate value of neutron network name
55939       switch-name:
55940         type: string
55941         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
55942       orchestration-status:
55943         type: string
55944         description: Orchestration status of this VNF, mastered by MSO
55945       heat-stack-id:
55946         type: string
55947         description: Heat stack id corresponding to this instance, managed by MSO
55948       mso-catalog-key:
55949         type: string
55950         description: Corresponds to the SDN-C catalog id used to configure this VCE
55951       cvlan-tags:
55952         type: array
55953         items:
55954           $ref: "#/definitions/cvlan-tag-entry"
55955       relationship-list:
55956         type: array
55957         items:
55958           $ref: "#/definitions/relationship"
55959   port-groups:
55960     properties:
55961       port-group:
55962         type: array
55963         items:
55964           $ref: "#/definitions/port-group"
55965   project:
55966     description: |
55967       describes the project
55968       ###### Related Nodes
55969       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
55970     required:
55971     - project-name
55972     properties:
55973       project-name:
55974         type: string
55975         description: Name of the project deploying a service
55976       resource-version:
55977         type: string
55978         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
55979       relationship-list:
55980         type: array
55981         items:
55982           $ref: "#/definitions/relationship"
55983   projects:
55984     description: |
55985       Collection of projects
55986     properties:
55987       project:
55988         type: array
55989         items:
55990           $ref: "#/definitions/project"
55991   properties:
55992     description: |
55993       Property holder for query properties or instance properties
55994     properties:
55995       property-name:
55996         type: string
55997       property-value:
55998         type: string
55999   property-constraint:
56000     description: |
56001       TBD
56002       ###### Related Nodes
56003       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56004     required:
56005     - property-constraint-uuid
56006     - constraint-type
56007     - property-name
56008     - property-value
56009     properties:
56010       property-constraint-uuid:
56011         type: string
56012       constraint-type:
56013         type: string
56014       property-name:
56015         type: string
56016       property-value:
56017         type: string
56018       resource-version:
56019         type: string
56020   property-constraints:
56021     properties:
56022       property-constraint:
56023         type: array
56024         items:
56025           $ref: "#/definitions/property-constraint"
56026   pserver:
56027     description: |
56028       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
56029       ###### Related Nodes
56030       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
56031       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
56032       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
56033       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
56034       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56035       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
56036       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
56037       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56038       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
56039       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
56040       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
56041       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
56042       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
56043     required:
56044     - hostname
56045     - in-maint
56046     properties:
56047       hostname:
56048         type: string
56049         description: Value from executing hostname on the compute node.
56050       ptnii-equip-name:
56051         type: string
56052         description: PTNII name
56053       number-of-cpus:
56054         type: integer
56055         format: int32
56056         description: Number of cpus
56057       disk-in-gigabytes:
56058         type: integer
56059         format: int32
56060         description: Disk size, in GBs
56061       ram-in-megabytes:
56062         type: integer
56063         format: int32
56064         description: RAM size, in MBs
56065       equip-type:
56066         type: string
56067         description: Equipment type.  Source of truth should define valid values.
56068       equip-vendor:
56069         type: string
56070         description: Equipment vendor.  Source of truth should define valid values.
56071       equip-model:
56072         type: string
56073         description: Equipment model.  Source of truth should define valid values.
56074       fqdn:
56075         type: string
56076         description: Fully-qualified domain name
56077       pserver-selflink:
56078         type: string
56079         description: URL to endpoint where AAI can get more details
56080       ipv4-oam-address:
56081         type: string
56082         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
56083       serial-number:
56084         type: string
56085         description: Serial number, may be queried
56086       ipaddress-v4-loopback-0:
56087         type: string
56088         description: IPV4 Loopback 0 address
56089       ipaddress-v6-loopback-0:
56090         type: string
56091         description: IPV6 Loopback 0 address
56092       ipaddress-v4-aim:
56093         type: string
56094         description: IPV4 AIM address
56095       ipaddress-v6-aim:
56096         type: string
56097         description: IPV6 AIM address
56098       ipaddress-v6-oam:
56099         type: string
56100         description: IPV6 OAM address
56101       inv-status:
56102         type: string
56103         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
56104       pserver-id:
56105         type: string
56106         description: ID of Pserver
56107       internet-topology:
56108         type: string
56109         description: internet topology of Pserver
56110       in-maint:
56111         type: boolean
56112       resource-version:
56113         type: string
56114         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56115       pserver-name2:
56116         type: string
56117         description: alternative pserver name
56118       purpose:
56119         type: string
56120         description: purpose of pserver
56121       prov-status:
56122         type: string
56123         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
56124       management-option:
56125         type: string
56126         description: Indicates who owns and or manages the device.
56127       host-profile:
56128         type: string
56129         description: The host profile that defines the configuration of the pserver.
56130       relationship-list:
56131         type: array
56132         items:
56133           $ref: "#/definitions/relationship"
56134       p-interfaces:
56135         type: array
56136         items:
56137           $ref: "#/definitions/p-interface"
56138       lag-interfaces:
56139         type: array
56140         items:
56141           $ref: "#/definitions/lag-interface"
56142   pservers:
56143     description: |
56144       Collection of compute hosts.
56145     properties:
56146       pserver:
56147         type: array
56148         items:
56149           $ref: "#/definitions/pserver"
56150   query-parameters:
56151     description: |
56152       QueryParameters for performing a named-query or model query
56153     properties:
56154       named-query:
56155         type: object
56156         $ref: "#/definitions/named-query"
56157       overloaded-model:
56158         type: object
56159         $ref: "#/definitions/overloaded-model"
56160   related-lookup:
56161     description: |
56162       TBD
56163       ###### Related Nodes
56164       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
56165     required:
56166     - related-lookup-uuid
56167     - source-node-type
56168     - source-node-property
56169     - target-node-type
56170     - target-node-property
56171     properties:
56172       related-lookup-uuid:
56173         type: string
56174       source-node-type:
56175         type: string
56176       source-node-property:
56177         type: string
56178       target-node-type:
56179         type: string
56180       target-node-property:
56181         type: string
56182       property-collect-list:
56183         type: string
56184       resource-version:
56185         type: string
56186       relationship-list:
56187         type: array
56188         items:
56189           $ref: "#/definitions/relationship"
56190   related-lookups:
56191     properties:
56192       related-lookup:
56193         type: array
56194         items:
56195           $ref: "#/definitions/related-lookup"
56196   related-to-property:
56197     properties:
56198       property-key:
56199         type: string
56200         description: Key part of a key/value pair
56201       property-value:
56202         type: string
56203         description: Value part of a key/value pair
56204   relationship:
56205     properties:
56206       related-to:
56207         type: string
56208         description: A keyword provided by A&AI to indicate type of node.
56209       related-link:
56210         type: string
56211         description: URL to the object in A&AI.
56212       relationship-data:
56213         type: array
56214         items:
56215           $ref: "#/definitions/relationship-data"
56216   relationship-data:
56217     required:
56218     - relationship-key
56219     - relationship-value
56220     properties:
56221       relationship-key:
56222         type: string
56223         description: A keyword provided by A&AI to indicate an attribute.
56224       relationship-value:
56225         type: string
56226         description: Value of the attribute.
56227   relationship-list:
56228     properties:
56229       relationship:
56230         type: array
56231         items:
56232           $ref: "#/definitions/relationship"
56233   reserved-prop-names:
56234     description: |
56235       Internal map to define some reserved properties of a vertex
56236     properties:
56237       last-mod-source-of-truth:
56238         type: string
56239       aai-node-type:
56240         type: string
56241       aai-created-ts:
56242         type: integer
56243         format: int64
56244       aai-unique-key:
56245         type: string
56246       aai-last-mod-ts:
56247         type: integer
56248         format: int64
56249       source-of-truth:
56250         type: string
56251       aai-uri:
56252         type: string
56253   response-list:
56254     description: |
56255       Response container for the results of a named-query or model query
56256     properties:
56257       inventory-response-items:
56258         type: object
56259         $ref: "#/definitions/inventory-response-items"
56260   result-data:
56261     properties:
56262       resource-type:
56263         type: string
56264         description: The specific type of node in the A&AI graph
56265       resource-link:
56266         type: string
56267         description: The URL to the specific resource
56268   route-table-reference:
56269     description: |
56270       Openstack route table reference.
56271       ###### Related Nodes
56272       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
56273     required:
56274     - route-table-reference-id
56275     - route-table-reference-fqdn
56276     properties:
56277       route-table-reference-id:
56278         type: string
56279         description: Route Table Reference id, UUID assigned to this instance.
56280       route-table-reference-fqdn:
56281         type: string
56282         description: FQDN entry in the route table.
56283       resource-version:
56284         type: string
56285         description: Concurrency value
56286       relationship-list:
56287         type: array
56288         items:
56289           $ref: "#/definitions/relationship"
56290   route-table-references:
56291     description: |
56292       Collection of openstack route table references
56293     properties:
56294       route-table-reference:
56295         type: array
56296         items:
56297           $ref: "#/definitions/route-table-reference"
56298   route-target:
56299     description: |
56300       Route target information
56301       ###### Related Nodes
56302       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
56303     required:
56304     - global-route-target
56305     - route-target-role
56306     properties:
56307       global-route-target:
56308         type: string
56309         description: Number used to identify an RT, globally unique in the network
56310       route-target-role:
56311         type: string
56312         description: Role assigned to this route target
56313       resource-version:
56314         type: string
56315         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56316       relationship-list:
56317         type: array
56318         items:
56319           $ref: "#/definitions/relationship"
56320   route-targets:
56321     description: |
56322       Collection of route target information
56323     properties:
56324       route-target:
56325         type: array
56326         items:
56327           $ref: "#/definitions/route-target"
56328   routing-instance:
56329     description: |
56330       ###### Related Nodes
56331       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56332       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56333       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
56334     required:
56335     - routing-instance-id
56336     properties:
56337       routing-instance-id:
56338         type: string
56339         description: Unique id of routing instance
56340       rpm-owner:
56341         type: string
56342         description: rpm owner
56343       resource-version:
56344         type: string
56345         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56346       site-pairs:
56347         type: array
56348         items:
56349           $ref: "#/definitions/site-pair"
56350       relationship-list:
56351         type: array
56352         items:
56353           $ref: "#/definitions/relationship"
56354   routing-instances:
56355     description: |
56356       set of probes related to generic-vnf routing instance
56357     properties:
56358       routing-instance:
56359         type: array
56360         items:
56361           $ref: "#/definitions/routing-instance"
56362   sdn-zone-response:
56363     properties:
56364       oam-networks:
56365         type: object
56366         $ref: "#/definitions/oam-networks"
56367       az-and-dvs-switches:
56368         type: array
56369         items:
56370           $ref: "#/definitions/az-and-dvs-switches"
56371   search:
56372     properties:
56373       edge-tag-query-result:
56374         type: object
56375         $ref: "#/definitions/edge-tag-query-result"
56376       edge-tag-query-request:
56377         type: object
56378         $ref: "#/definitions/edge-tag-query-request"
56379       search-results:
56380         type: object
56381         $ref: "#/definitions/search-results"
56382       sdn-zone-response:
56383         type: object
56384         $ref: "#/definitions/sdn-zone-response"
56385   search-results:
56386     properties:
56387       result-data:
56388         type: array
56389         items:
56390           $ref: "#/definitions/result-data"
56391   secondary-filt:
56392     description: |
56393       SecondaryFilt for performing a named-query or model query
56394   secondary-filter:
56395     properties:
56396       property-name:
56397         type: string
56398       filter-type:
56399         type: string
56400       property-value:
56401         type: string
56402   secondary-filts:
56403     description: |
56404       SecondaryFilts for performing a named-query or model query
56405     properties:
56406       secondary-filt:
56407         type: array
56408         items:
56409           $ref: "#/definitions/secondary-filt"
56410   segmentation-assignment:
56411     description: |
56412       Openstack segmentation assignment.
56413       ###### Related Nodes
56414       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56415     required:
56416     - segmentation-id
56417     properties:
56418       segmentation-id:
56419         type: string
56420         description: Route Table Reference id, UUID assigned to this instance.
56421       resource-version:
56422         type: string
56423         description: Concurrency value
56424       relationship-list:
56425         type: array
56426         items:
56427           $ref: "#/definitions/relationship"
56428   segmentation-assignments:
56429     description: |
56430       Collection of openstack segmentation assignments
56431     properties:
56432       segmentation-assignment:
56433         type: array
56434         items:
56435           $ref: "#/definitions/segmentation-assignment"
56436   service:
56437     description: |
56438       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
56439     required:
56440     - service-id
56441     - service-description
56442     properties:
56443       service-id:
56444         type: string
56445         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56446       service-description:
56447         type: string
56448         description: Description of the service
56449       service-selflink:
56450         type: string
56451         description: URL to endpoint where AAI can get more details
56452       resource-version:
56453         type: string
56454         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56455       service-version:
56456         type: string
56457         description: service version
56458       relationship-list:
56459         type: array
56460         items:
56461           $ref: "#/definitions/relationship"
56462   service-capabilities:
56463     description: |
56464       Collection of service capabilities.
56465     properties:
56466       service-capability:
56467         type: array
56468         items:
56469           $ref: "#/definitions/service-capability"
56470   service-capability:
56471     description: |
56472       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
56473       ###### Related Nodes
56474       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56475       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
56476       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
56477     required:
56478     - service-type
56479     - vnf-type
56480     properties:
56481       service-type:
56482         type: string
56483         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
56484       vnf-type:
56485         type: string
56486         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.
56487       resource-version:
56488         type: string
56489         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56490       relationship-list:
56491         type: array
56492         items:
56493           $ref: "#/definitions/relationship"
56494   service-design-and-creation:
56495     description: |
56496       Namespace for objects managed by ASDC
56497     properties:
56498       vnf-images:
56499         type: array
56500         items:
56501           $ref: "#/definitions/vnf-image"
56502       services:
56503         type: array
56504         items:
56505           $ref: "#/definitions/service"
56506       service-capabilities:
56507         type: array
56508         items:
56509           $ref: "#/definitions/service-capability"
56510       models:
56511         type: array
56512         items:
56513           $ref: "#/definitions/model"
56514       named-queries:
56515         type: array
56516         items:
56517           $ref: "#/definitions/named-query"
56518   service-instance:
56519     description: |
56520       Instance of a service
56521       ###### Related Nodes
56522       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
56523       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
56524       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
56525       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
56526       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
56527       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
56528       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
56529       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
56530       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
56531       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
56532       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
56533       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56534       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
56535       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
56536       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56537       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
56538       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
56539       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56540       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
56541       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
56542       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
56543       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
56544     required:
56545     - service-instance-id
56546     - service-type
56547     - service-role
56548     - created-at
56549     - updated-at
56550     - description
56551     properties:
56552       service-instance-id:
56553         type: string
56554         description: Uniquely identifies this instance of a service
56555       service-instance-name:
56556         type: string
56557         description: This field will store a name assigned to the service-instance.
56558       service-type:
56559         type: string
56560         description: String capturing type of service.
56561       service-role:
56562         type: string
56563         description: String capturing the service role.
56564       environment-context:
56565         type: string
56566         description: This field will store the environment context assigned to the service-instance.
56567       workload-context:
56568         type: string
56569         description: This field will store the workload context assigned to the service-instance.
56570       created-at:
56571         type: string
56572         description: create time of Network Service.
56573       updated-at:
56574         type: string
56575         description: last update of Network Service.
56576       description:
56577         type: string
56578         description: short description for service-instance.
56579       model-invariant-id:
56580         type: string
56581         description: the ASDC model id for this resource or service model.
56582       model-version-id:
56583         type: string
56584         description: the ASDC model version for this resource or service model.
56585       persona-model-version:
56586         type: string
56587         description: the ASDC model version for this resource or service model.
56588       widget-model-id:
56589         type: string
56590         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
56591       widget-model-version:
56592         type: string
56593         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
56594       bandwidth-total:
56595         type: string
56596         description: Indicates the total bandwidth to be used for this service.
56597       bandwidth-up-wan1:
56598         type: string
56599         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
56600       bandwidth-down-wan1:
56601         type: string
56602         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
56603       bandwidth-up-wan2:
56604         type: string
56605         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
56606       bandwidth-down-wan2:
56607         type: string
56608         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
56609       vhn-portal-url:
56610         type: string
56611         description: URL customers will use to access the vHN Portal.
56612       service-instance-location-id:
56613         type: string
56614         description: An identifier that customers assign to the location where this service is being used.
56615       resource-version:
56616         type: string
56617         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56618       selflink:
56619         type: string
56620         description: Path to the controller object.
56621       orchestration-status:
56622         type: string
56623         description: Orchestration status of this service.
56624       relationship-list:
56625         type: array
56626         items:
56627           $ref: "#/definitions/relationship"
56628       metadata:
56629         type: array
56630         items:
56631           $ref: "#/definitions/metadatum"
56632       allotted-resources:
56633         type: array
56634         items:
56635           $ref: "#/definitions/allotted-resource"
56636   service-instances:
56637     description: |
56638       Collection of service instances
56639     properties:
56640       service-instance:
56641         type: array
56642         items:
56643           $ref: "#/definitions/service-instance"
56644   service-subscription:
56645     description: |
56646       Object that group service instances.
56647       ###### Related Nodes
56648       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
56649       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
56650       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
56651       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
56652     required:
56653     - service-type
56654     properties:
56655       service-type:
56656         type: string
56657         description: Value defined by orchestration to identify this service across ECOMP.
56658       temp-ub-sub-account-id:
56659         type: string
56660         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
56661       resource-version:
56662         type: string
56663         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56664       service-instances:
56665         type: array
56666         items:
56667           $ref: "#/definitions/service-instance"
56668       relationship-list:
56669         type: array
56670         items:
56671           $ref: "#/definitions/relationship"
56672   service-subscriptions:
56673     description: |
56674       Collection of objects that group service instances.
56675     properties:
56676       service-subscription:
56677         type: array
56678         items:
56679           $ref: "#/definitions/service-subscription"
56680   services:
56681     description: |
56682       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
56683     properties:
56684       service:
56685         type: array
56686         items:
56687           $ref: "#/definitions/service"
56688   site-pair:
56689     description: |
56690       ###### Related Nodes
56691       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
56692       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
56693       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
56694     required:
56695     - site-pair-id
56696     properties:
56697       site-pair-id:
56698         type: string
56699         description: unique identifier of probe
56700       source-ip:
56701         type: string
56702         description: Prefix address
56703       destination-ip:
56704         type: string
56705         description: Prefix address
56706       ip-version:
56707         type: string
56708         description: ip version, v4, v6
56709       destination-hostname:
56710         type: string
56711         description: Hostname of the destination equipment to which SLAs are measured against.
56712       destination-equip-type:
56713         type: string
56714         description: The type of destinatination equipment. Could be Router, UCPE, etc.
56715       resource-version:
56716         type: string
56717         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56718       classes-of-service:
56719         type: array
56720         items:
56721           $ref: "#/definitions/class-of-service"
56722       relationship-list:
56723         type: array
56724         items:
56725           $ref: "#/definitions/relationship"
56726   site-pair-set:
56727     description: |
56728       Set of instances for probes used to measure service level agreements
56729       ###### Related Nodes
56730       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
56731       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
56732       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
56733     required:
56734     - site-pair-set-id
56735     properties:
56736       site-pair-set-id:
56737         type: string
56738         description: Unique id of site pair set.
56739       resource-version:
56740         type: string
56741         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56742       routing-instances:
56743         type: array
56744         items:
56745           $ref: "#/definitions/routing-instance"
56746       relationship-list:
56747         type: array
56748         items:
56749           $ref: "#/definitions/relationship"
56750   site-pair-sets:
56751     description: |
56752       Collection of sets of instances for probes related to generic-vnf
56753     properties:
56754       site-pair-set:
56755         type: array
56756         items:
56757           $ref: "#/definitions/site-pair-set"
56758   site-pairs:
56759     description: |
56760       probe within a set
56761     properties:
56762       site-pair:
56763         type: array
56764         items:
56765           $ref: "#/definitions/site-pair"
56766   snapshot:
56767     description: |
56768       Openstack snapshot
56769       ###### Related Nodes
56770       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
56771       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
56772     required:
56773     - snapshot-id
56774     properties:
56775       snapshot-id:
56776         type: string
56777         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
56778       snapshot-name:
56779         type: string
56780         description: Snapshot name
56781       snapshot-architecture:
56782         type: string
56783         description: Operating system architecture
56784       snapshot-os-distro:
56785         type: string
56786         description: The common name of the operating system distribution in lowercase
56787       snapshot-os-version:
56788         type: string
56789         description: The operating system version as specified by the distributor.
56790       application:
56791         type: string
56792         description: The application that the image instantiates.
56793       application-vendor:
56794         type: string
56795         description: The vendor of the application.
56796       application-version:
56797         type: string
56798         description: The version of the application.
56799       snapshot-selflink:
56800         type: string
56801         description: URL to endpoint where AAI can get more details
56802       prev-snapshot-id:
56803         type: string
56804         description: This field contains the UUID of the previous snapshot (if any).
56805       resource-version:
56806         type: string
56807         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56808       relationship-list:
56809         type: array
56810         items:
56811           $ref: "#/definitions/relationship"
56812   snapshots:
56813     description: |
56814       Collection of openstack snapshots
56815     properties:
56816       snapshot:
56817         type: array
56818         items:
56819           $ref: "#/definitions/snapshot"
56820   sriov-pf:
56821     description: |
56822       SR-IOV Physical Function
56823       ###### Related Nodes
56824       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
56825       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56826     required:
56827     - pf-pci-id
56828     properties:
56829       pf-pci-id:
56830         type: string
56831         description: Identifier for the sriov-pf
56832       resource-version:
56833         type: string
56834         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56835       relationship-list:
56836         type: array
56837         items:
56838           $ref: "#/definitions/relationship"
56839   sriov-pfs:
56840     description: |
56841       Collection of SR-IOV Physical Functions.
56842     properties:
56843       sriov-pf:
56844         type: array
56845         items:
56846           $ref: "#/definitions/sriov-pf"
56847   sriov-vf:
56848     description: |
56849       SR-IOV Virtual Function (not to be confused with virtual network function)
56850       ###### Related Nodes
56851       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
56852       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
56853     required:
56854     - pci-id
56855     properties:
56856       pci-id:
56857         type: string
56858         description: PCI ID used to identify the sriov-vf
56859       vf-vlan-filter:
56860         type: string
56861         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
56862       vf-mac-filter:
56863         type: string
56864         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
56865       vf-vlan-strip:
56866         type: boolean
56867         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
56868       vf-vlan-anti-spoof-check:
56869         type: boolean
56870         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.
56871       vf-mac-anti-spoof-check:
56872         type: boolean
56873         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.
56874       vf-mirrors:
56875         type: string
56876         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
56877       vf-broadcast-allow:
56878         type: boolean
56879         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
56880       vf-unknown-multicast-allow:
56881         type: boolean
56882         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
56883       vf-unknown-unicast-allow:
56884         type: boolean
56885         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
56886       vf-insert-stag:
56887         type: boolean
56888         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
56889       vf-link-status:
56890         type: string
56891         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
56892       resource-version:
56893         type: string
56894         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56895       neutron-network-id:
56896         type: string
56897         description: Neutron network id of the interface
56898       relationship-list:
56899         type: array
56900         items:
56901           $ref: "#/definitions/relationship"
56902   sriov-vfs:
56903     description: |
56904       Collection of SR-IOV Virtual Functions.
56905     properties:
56906       sriov-vf:
56907         type: array
56908         items:
56909           $ref: "#/definitions/sriov-vf"
56910   start-node-filter:
56911     properties:
56912       property-name:
56913         type: string
56914       property-value:
56915         type: string
56916   subnet:
56917     description: |
56918       ###### Related Nodes
56919       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
56920       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56921       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
56922       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
56923       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56924       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
56925       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
56926       - SUBNET is DELETED when these are DELETED HOST-ROUTE
56927     required:
56928     - subnet-id
56929     - dhcp-enabled
56930     properties:
56931       subnet-id:
56932         type: string
56933         description: Subnet ID, should be UUID.
56934       subnet-name:
56935         type: string
56936         description: Name associated with the subnet.
56937       neutron-subnet-id:
56938         type: string
56939         description: Neutron id of this subnet
56940       gateway-address:
56941         type: string
56942         description: gateway ip address
56943       network-start-address:
56944         type: string
56945         description: network start address
56946       cidr-mask:
56947         type: string
56948         description: cidr mask
56949       ip-version:
56950         type: string
56951         description: ip version
56952       orchestration-status:
56953         type: string
56954         description: Orchestration status of this VNF, mastered by MSO
56955       dhcp-enabled:
56956         type: boolean
56957       dhcp-start:
56958         type: string
56959         description: the start address reserved for use by dhcp
56960       dhcp-end:
56961         type: string
56962         description: the last address reserved for use by dhcp
56963       subnet-role:
56964         type: string
56965         description: role of the subnet, referenced when assigning IPs
56966       ip-assignment-direction:
56967         type: string
56968         description: ip address assignment direction of the subnet
56969       resource-version:
56970         type: string
56971         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
56972       subnet-sequence:
56973         type: integer
56974         format: int32
56975         description: sequence of the subnet
56976       host-routes:
56977         type: array
56978         items:
56979           $ref: "#/definitions/host-route"
56980       relationship-list:
56981         type: array
56982         items:
56983           $ref: "#/definitions/relationship"
56984   subnets:
56985     properties:
56986       subnet:
56987         type: array
56988         items:
56989           $ref: "#/definitions/subnet"
56990   tagged-inventory-item-list:
56991     properties:
56992       inventory-item:
56993         type: array
56994         items:
56995           $ref: "#/definitions/inventory-item"
56996   tenant:
56997     description: |
56998       Openstack tenant
56999       ###### Related Nodes
57000       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57001       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
57002       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
57003       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57004       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
57005       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57006       - TENANT cannot be deleted if linked to VSERVER
57007     required:
57008     - tenant-id
57009     - tenant-name
57010     properties:
57011       tenant-id:
57012         type: string
57013         description: Unique id relative to the cloud-region.
57014       tenant-name:
57015         type: string
57016         description: Readable name of tenant
57017       tenant-context:
57018         type: string
57019         description: This field will store the tenant context.
57020       resource-version:
57021         type: string
57022         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57023       vservers:
57024         type: array
57025         items:
57026           $ref: "#/definitions/vserver"
57027       relationship-list:
57028         type: array
57029         items:
57030           $ref: "#/definitions/relationship"
57031   tenants:
57032     description: |
57033       Collection of openstack tenants.
57034     properties:
57035       tenant:
57036         type: array
57037         items:
57038           $ref: "#/definitions/tenant"
57039   tunnel-xconnect:
57040     description: |
57041       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
57042       ###### Related Nodes
57043       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57044     required:
57045     - id
57046     - bandwidth-up-wan1
57047     - bandwidth-down-wan1
57048     - bandwidth-up-wan2
57049     - bandwidth-down-wan2
57050     properties:
57051       id:
57052         type: string
57053         description: Allotted Resource id UUID assigned to this instance.
57054       bandwidth-up-wan1:
57055         type: string
57056         description: The WAN uplink bandwidth for WAN1
57057       bandwidth-down-wan1:
57058         type: string
57059         description: The WAN downlink bandwidth for WAN1
57060       bandwidth-up-wan2:
57061         type: string
57062         description: The WAN uplink bandwidth for WAN2
57063       bandwidth-down-wan2:
57064         type: string
57065         description: The WAN downlink bandwidth for WAN2
57066       resource-version:
57067         type: string
57068         description: Concurrency value
57069       relationship-list:
57070         type: array
57071         items:
57072           $ref: "#/definitions/relationship"
57073   tunnel-xconnects:
57074     description: |
57075       This object is used to store the specific tunnel cross connect aspects of an allotted resource
57076     properties:
57077       tunnel-xconnect:
57078         type: array
57079         items:
57080           $ref: "#/definitions/tunnel-xconnect"
57081   update:
57082     description: |
57083       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
57084     required:
57085     - update-node-type
57086     properties:
57087       update-node-type:
57088         type: string
57089       update-node-key:
57090         type: array
57091         items:
57092           $ref: "#/definitions/update-node-key"
57093       update-node-uri:
57094         type: string
57095       action:
57096         type: array
57097         items:
57098           $ref: "#/definitions/action"
57099   update-node-key:
57100     properties:
57101       key-name:
57102         type: string
57103       key-value:
57104         type: string
57105   vce:
57106     description: |
57107       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
57108       ###### Related Nodes
57109       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
57110       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
57111       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57112       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57113       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57114       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
57115       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
57116       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
57117     required:
57118     - vnf-id
57119     - vnf-name
57120     - vnf-type
57121     properties:
57122       vnf-id:
57123         type: string
57124         description: Unique id of VNF.  This is unique across the graph.
57125       vnf-name:
57126         type: string
57127         description: Name of VNF.
57128       vnf-name2:
57129         type: string
57130         description: Alternate name of VNF.
57131       vnf-type:
57132         type: string
57133         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.
57134       service-id:
57135         type: string
57136         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
57137       regional-resource-zone:
57138         type: string
57139         description: Regional way of organizing pservers, source of truth should define values
57140       prov-status:
57141         type: string
57142         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57143       operational-status:
57144         type: string
57145         description: Indicator for whether the resource is considered operational
57146       license-key:
57147         type: string
57148         description: OBSOLETE -  do not use
57149       equipment-role:
57150         type: string
57151         description: Network role being played by this VNF
57152       orchestration-status:
57153         type: string
57154         description: Orchestration status of this VNF, mastered by MSO
57155       heat-stack-id:
57156         type: string
57157         description: Heat stack id corresponding to this instance, managed by MSO
57158       mso-catalog-key:
57159         type: string
57160         description: Corresponds to the SDN-C catalog id used to configure this VCE
57161       vpe-id:
57162         type: string
57163         description: Unique ID of VPE connected to this VCE.
57164       v6-vce-wan-address:
57165         type: string
57166         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
57167       ipv4-oam-address:
57168         type: string
57169         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
57170       resource-version:
57171         type: string
57172         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57173       ipv4-loopback0-address:
57174         type: string
57175         description: Loopback0 address
57176       entitlement-resource-uuid:
57177         type: string
57178         description: OBSOLETE -  see child relationships
57179       port-groups:
57180         type: array
57181         items:
57182           $ref: "#/definitions/port-group"
57183       licenses:
57184         type: array
57185         items:
57186           $ref: "#/definitions/license"
57187       entitlements:
57188         type: array
57189         items:
57190           $ref: "#/definitions/entitlement"
57191       relationship-list:
57192         type: array
57193         items:
57194           $ref: "#/definitions/relationship"
57195   vces:
57196     description: |
57197       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
57198     properties:
57199       vce:
57200         type: array
57201         items:
57202           $ref: "#/definitions/vce"
57203   vf-module:
57204     description: |
57205       a deployment unit of VNFCs
57206       ###### Related Nodes
57207       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57208       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
57209       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57210       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57211       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57212       - VF-MODULE cannot be deleted if linked to VNFC
57213     required:
57214     - vf-module-id
57215     - is-base-vf-module
57216     properties:
57217       vf-module-id:
57218         type: string
57219         description: Unique ID of vf-module.
57220       vf-module-name:
57221         type: string
57222         description: Name of vf-module
57223       heat-stack-id:
57224         type: string
57225         description: Heat stack id corresponding to this instance.
57226       orchestration-status:
57227         type: string
57228         description: orchestration status of this vf-module, mastered by MSO
57229       is-base-vf-module:
57230         type: boolean
57231       resource-version:
57232         type: string
57233         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57234       model-invariant-id:
57235         type: string
57236         description: the ASDC model id for this resource or service model.
57237       model-version-id:
57238         type: string
57239         description: the ASDC model version for this resource or service model.
57240       persona-model-version:
57241         type: string
57242         description: the ASDC model version for this resource or service model.
57243       model-customization-id:
57244         type: string
57245         description: captures the id of all the configuration used to customize the resource for the service.
57246       widget-model-id:
57247         type: string
57248         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
57249       widget-model-version:
57250         type: string
57251         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
57252       contrail-service-instance-fqdn:
57253         type: string
57254         description: the Contrail unique ID for a service-instance
57255       module-index:
57256         type: integer
57257         format: int32
57258         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
57259       selflink:
57260         type: string
57261         description: Path to the controller object.
57262       relationship-list:
57263         type: array
57264         items:
57265           $ref: "#/definitions/relationship"
57266   vf-modules:
57267     description: |
57268       Collection of vf-modules, a deployment unit of VNFCs
57269     properties:
57270       vf-module:
57271         type: array
57272         items:
57273           $ref: "#/definitions/vf-module"
57274   vig-server:
57275     description: |
57276       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
57277       ###### Related Nodes
57278       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
57279     required:
57280     - vig-address-type
57281     properties:
57282       vig-address-type:
57283         type: string
57284         description: indicates whether the VIG is for AVPN or INTERNET
57285       ipaddress-v4-vig:
57286         type: string
57287         description: v4 IP of the vig server
57288       ipaddress-v6-vig:
57289         type: string
57290         description: v6 IP of the vig server
57291       resource-version:
57292         type: string
57293         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57294       relationship-list:
57295         type: array
57296         items:
57297           $ref: "#/definitions/relationship"
57298   vig-servers:
57299     properties:
57300       vig-server:
57301         type: array
57302         items:
57303           $ref: "#/definitions/vig-server"
57304   vip-ipv4-address-list:
57305     description: |
57306       IPv4 Address Range
57307       ###### Related Nodes
57308       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57309       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57310       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57311       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
57312     required:
57313     - vip-ipv4-address
57314     properties:
57315       vip-ipv4-address:
57316         type: string
57317         description: IP address
57318       vip-ipv4-prefix-length:
57319         type: integer
57320         format: int64
57321         description: Prefix length, 32 for single address
57322       vlan-id-inner:
57323         type: integer
57324         format: int64
57325         description: Inner VLAN tag
57326       vlan-id-outer:
57327         type: integer
57328         format: int64
57329         description: Outer VLAN tag
57330       is-floating:
57331         type: boolean
57332         description: Indicator of fixed or floating address
57333       resource-version:
57334         type: string
57335         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57336       neutron-network-id:
57337         type: string
57338         description: Neutron network id of the interface that address belongs to
57339       neutron-subnet-id:
57340         type: string
57341         description: Neutron id of subnet that address belongs to
57342       relationship-list:
57343         type: array
57344         items:
57345           $ref: "#/definitions/relationship"
57346   vip-ipv6-address-list:
57347     description: |
57348       IPv6 Address Range
57349       ###### Related Nodes
57350       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57351       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57352       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
57353       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57354     required:
57355     - vip-ipv6-address
57356     properties:
57357       vip-ipv6-address:
57358         type: string
57359         description: IP address
57360       vip-ipv6-prefix-length:
57361         type: integer
57362         format: int64
57363         description: Prefix length, 128 for single address
57364       vlan-id-inner:
57365         type: integer
57366         format: int64
57367         description: Inner VLAN tag
57368       vlan-id-outer:
57369         type: integer
57370         format: int64
57371         description: Outer VLAN tag
57372       is-floating:
57373         type: boolean
57374         description: Indicator of fixed or floating address
57375       resource-version:
57376         type: string
57377         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57378       neutron-network-id:
57379         type: string
57380         description: Neutron network id of the interface that address belongs to
57381       neutron-subnet-id:
57382         type: string
57383         description: Neutron id of subnet that address belongs to
57384       relationship-list:
57385         type: array
57386         items:
57387           $ref: "#/definitions/relationship"
57388   virtual-data-center:
57389     description: |
57390       Virtual organization of cloud infrastructure elements in a data center context
57391       ###### Related Nodes
57392       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57393       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57394       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
57395     required:
57396     - vdc-id
57397     - vdc-name
57398     properties:
57399       vdc-id:
57400         type: string
57401         description: Unique ID of the vdc
57402       vdc-name:
57403         type: string
57404         description: Name of the virtual data center
57405       resource-version:
57406         type: string
57407         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57408       relationship-list:
57409         type: array
57410         items:
57411           $ref: "#/definitions/relationship"
57412   virtual-data-centers:
57413     description: |
57414       Virtual organization of cloud infrastructure elements in a data center context
57415     properties:
57416       virtual-data-center:
57417         type: array
57418         items:
57419           $ref: "#/definitions/virtual-data-center"
57420   vlan:
57421     description: |
57422       Definition of vlan
57423       ###### Related Nodes
57424       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
57425       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
57426       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
57427       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57428       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
57429       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57430       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
57431       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57432       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
57433     required:
57434     - vlan-interface
57435     - in-maint
57436     - is-ip-unnumbered
57437     properties:
57438       vlan-interface:
57439         type: string
57440         description: String that identifies the interface
57441       vlan-id-inner:
57442         type: integer
57443         format: int64
57444         description: Inner VLAN tag
57445       vlan-id-outer:
57446         type: integer
57447         format: int64
57448         description: Outer VLAN tag
57449       resource-version:
57450         type: string
57451         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57452       speed-value:
57453         type: string
57454         description: Captures the numeric part of the speed
57455       speed-units:
57456         type: string
57457         description: Captures the units corresponding to the speed
57458       vlan-description:
57459         type: string
57460         description: Used to describe (the service associated with) the vlan
57461       backdoor-connection:
57462         type: string
57463         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
57464       vpn-key:
57465         type: string
57466         description: This indicates the customers VPN ID associated with this vlan
57467       orchestration-status:
57468         type: string
57469         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
57470       in-maint:
57471         type: boolean
57472       prov-status:
57473         type: string
57474         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
57475       is-ip-unnumbered:
57476         type: boolean
57477       relationship-list:
57478         type: array
57479         items:
57480           $ref: "#/definitions/relationship"
57481       l3-interface-ipv4-address-list:
57482         type: array
57483         items:
57484           $ref: "#/definitions/l3-interface-ipv4-address-list"
57485       l3-interface-ipv6-address-list:
57486         type: array
57487         items:
57488           $ref: "#/definitions/l3-interface-ipv6-address-list"
57489   vlans:
57490     properties:
57491       vlan:
57492         type: array
57493         items:
57494           $ref: "#/definitions/vlan"
57495   vnf:
57496     description: |
57497       Abstract vnf class
57498     required:
57499     - vnf-id
57500     properties:
57501       vnf-id:
57502         type: string
57503         description: Unique id of VNF.  This is unique across the graph.
57504   vnf-image:
57505     description: |
57506       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
57507       ###### Related Nodes
57508       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
57509       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
57510     required:
57511     - vnf-image-uuid
57512     - application
57513     - application-vendor
57514     properties:
57515       vnf-image-uuid:
57516         type: string
57517         description: Unique ID of this asset
57518       application:
57519         type: string
57520         description: The application that the image instantiates.
57521       application-vendor:
57522         type: string
57523         description: The vendor of the application.
57524       application-version:
57525         type: string
57526         description: The version of the application.
57527       selflink:
57528         type: string
57529         description: URL to endpoint where AAI can get more details
57530       resource-version:
57531         type: string
57532         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57533       relationship-list:
57534         type: array
57535         items:
57536           $ref: "#/definitions/relationship"
57537   vnf-images:
57538     description: |
57539       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
57540     properties:
57541       vnf-image:
57542         type: array
57543         items:
57544           $ref: "#/definitions/vnf-image"
57545   vnfc:
57546     description: |
57547       ###### Related Nodes
57548       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
57549       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57550       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
57551       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
57552       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57553       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
57554       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
57555       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
57556       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
57557     required:
57558     - vnfc-name
57559     - nfc-naming-code
57560     - nfc-function
57561     - in-maint
57562     - is-closed-loop-disabled
57563     properties:
57564       vnfc-name:
57565         type: string
57566         description: Unique ID of vnfc.
57567       nfc-naming-code:
57568         type: string
57569         description: Short code that is used in naming instances of the item being modeled
57570       nfc-function:
57571         type: string
57572         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
57573       prov-status:
57574         type: string
57575         description: prov status of this vnfc
57576       orchestration-status:
57577         type: string
57578         description: Orchestration status of this VNF, mastered by APP-C
57579       ipaddress-v4-oam-vip:
57580         type: string
57581         description: Oam V4 vip address of this vnfc
57582       in-maint:
57583         type: boolean
57584       is-closed-loop-disabled:
57585         type: boolean
57586       group-notation:
57587         type: string
57588         description: Group notation of VNFC
57589       model-invariant-id:
57590         type: string
57591         description: the ASDC model id for this resource or service model.
57592       model-version-id:
57593         type: string
57594         description: the ASDC model version for this resource or service model.
57595       resource-version:
57596         type: string
57597         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57598       relationship-list:
57599         type: array
57600         items:
57601           $ref: "#/definitions/relationship"
57602       l3-interface-ipv4-address-list:
57603         type: array
57604         items:
57605           $ref: "#/definitions/l3-interface-ipv4-address-list"
57606       l3-interface-ipv6-address-list:
57607         type: array
57608         items:
57609           $ref: "#/definitions/l3-interface-ipv6-address-list"
57610   vnfcs:
57611     description: |
57612       virtual network components associated with a vserver from application controller.
57613     properties:
57614       vnfc:
57615         type: array
57616         items:
57617           $ref: "#/definitions/vnfc"
57618   volume:
57619     description: |
57620       Ephemeral Block storage volume.
57621       ###### Related Nodes
57622       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
57623     required:
57624     - volume-id
57625     - volume-selflink
57626     properties:
57627       volume-id:
57628         type: string
57629         description: Unique ID of block storage volume relative to the vserver.
57630       volume-selflink:
57631         type: string
57632         description: URL to endpoint where AAI can get more details
57633       resource-version:
57634         type: string
57635         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57636       relationship-list:
57637         type: array
57638         items:
57639           $ref: "#/definitions/relationship"
57640   volume-group:
57641     description: |
57642       Persistent block-level storage.
57643       ###### Related Nodes
57644       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57645       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57646       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57647       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
57648       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
57649     required:
57650     - volume-group-id
57651     - volume-group-name
57652     - vnf-type
57653     properties:
57654       volume-group-id:
57655         type: string
57656         description: Unique ID of volume-group.
57657       volume-group-name:
57658         type: string
57659         description: Name of the volume group.
57660       heat-stack-id:
57661         type: string
57662         description: Heat stack id corresponding to this volume-group
57663       vnf-type:
57664         type: string
57665         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.
57666       orchestration-status:
57667         type: string
57668         description: Orchestration status of this volume-group
57669       model-customization-id:
57670         type: string
57671         description: captures the id of all the configuration used to customize the resource for the service.
57672       vf-module-model-customization-id:
57673         type: string
57674         description: helps relate the volume group to the vf-module whose components will require the volume group
57675       resource-version:
57676         type: string
57677         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57678       relationship-list:
57679         type: array
57680         items:
57681           $ref: "#/definitions/relationship"
57682   volume-groups:
57683     description: |
57684       Collection of persistent block-level storage.
57685     properties:
57686       volume-group:
57687         type: array
57688         items:
57689           $ref: "#/definitions/volume-group"
57690   volumes:
57691     description: |
57692       Collection of ephemeral Block storage volumes.
57693     properties:
57694       volume:
57695         type: array
57696         items:
57697           $ref: "#/definitions/volume"
57698   vpls-pe:
57699     description: |
57700       VPLS Provider Edge routers.
57701       ###### Related Nodes
57702       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57703       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
57704       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57705       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
57706       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
57707     required:
57708     - equipment-name
57709     properties:
57710       equipment-name:
57711         type: string
57712       prov-status:
57713         type: string
57714         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
57715       ipv4-oam-address:
57716         type: string
57717         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).
57718       equipment-role:
57719         type: string
57720         description: Client should send valid enumerated value, e.g., VPLS-PE.
57721       vlan-id-outer:
57722         type: integer
57723         format: int64
57724         description: Temporary location for stag to get to VCE
57725       resource-version:
57726         type: string
57727         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57728       relationship-list:
57729         type: array
57730         items:
57731           $ref: "#/definitions/relationship"
57732       p-interfaces:
57733         type: array
57734         items:
57735           $ref: "#/definitions/p-interface"
57736       lag-interfaces:
57737         type: array
57738         items:
57739           $ref: "#/definitions/lag-interface"
57740   vpls-pes:
57741     description: |
57742       Collection of VPLS Provider Edge routers
57743     properties:
57744       vpls-pe:
57745         type: array
57746         items:
57747           $ref: "#/definitions/vpls-pe"
57748   vpn-binding:
57749     description: |
57750       VPN binding
57751       ###### Related Nodes
57752       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
57753       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57754       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
57755       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
57756       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
57757       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
57758     required:
57759     - vpn-id
57760     - vpn-name
57761     properties:
57762       vpn-id:
57763         type: string
57764         description: VPN ID, globally unique within A&AI
57765       vpn-name:
57766         type: string
57767         description: VPN Name
57768       vpn-platform:
57769         type: string
57770         description: the platform associated with the VPN example AVPN, Mobility
57771       vpn-type:
57772         type: string
57773         description: Type of the vpn, should be taken from enumerated/valid values
57774       vpn-region:
57775         type: string
57776         description: region of customer vpn
57777       customer-vpn-id:
57778         type: string
57779         description: id for this customer vpn
57780       route-distinguisher:
57781         type: string
57782         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
57783       resource-version:
57784         type: string
57785         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57786       route-targets:
57787         type: array
57788         items:
57789           $ref: "#/definitions/route-target"
57790       relationship-list:
57791         type: array
57792         items:
57793           $ref: "#/definitions/relationship"
57794         description: l3-networks relate to vpn-bindings
57795   vpn-bindings:
57796     properties:
57797       vpn-binding:
57798         type: array
57799         items:
57800           $ref: "#/definitions/vpn-binding"
57801   vserver:
57802     description: |
57803       Virtual Servers, aka virtual machine or VM.
57804       ###### Related Nodes
57805       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
57806       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
57807       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
57808       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
57809       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
57810       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
57811       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
57812       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
57813       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
57814       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
57815       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
57816       - VSERVER is DELETED when these are DELETED L-INTERFACE
57817       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
57818     required:
57819     - vserver-id
57820     - vserver-name
57821     - vserver-selflink
57822     - in-maint
57823     - is-closed-loop-disabled
57824     properties:
57825       vserver-id:
57826         type: string
57827         description: Unique identifier for this vserver relative to its tenant
57828       vserver-name:
57829         type: string
57830         description: Name of vserver
57831       vserver-name2:
57832         type: string
57833         description: Alternative name of vserver
57834       prov-status:
57835         type: string
57836         description: Trigger for operational monitoring of this resource by Service Assurance systems.
57837       vserver-selflink:
57838         type: string
57839         description: URL to endpoint where AAI can get more details
57840       in-maint:
57841         type: boolean
57842       is-closed-loop-disabled:
57843         type: boolean
57844       resource-version:
57845         type: string
57846         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
57847       volumes:
57848         type: array
57849         items:
57850           $ref: "#/definitions/volume"
57851       relationship-list:
57852         type: array
57853         items:
57854           $ref: "#/definitions/relationship"
57855       l-interfaces:
57856         type: array
57857         items:
57858           $ref: "#/definitions/l-interface"
57859   vservers:
57860     description: |
57861       Collection of virtual Servers, aka virtual machines or VMs.
57862     properties:
57863       vserver:
57864         type: array
57865         items:
57866           $ref: "#/definitions/vserver"
57867   zone:
57868     description: |
57869       A zone is a grouping of assets in a location homing to the same connections into the CBB
57870       ###### Related Nodes
57871       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57872       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57873       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57874       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57875       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
57876     required:
57877     - zone-id
57878     - zone-name
57879     - design-type
57880     - zone-context
57881     properties:
57882       zone-id:
57883         type: string
57884         description: Code assigned by AIC to the zone
57885       zone-name:
57886         type: string
57887         description: English name associated with the zone
57888       design-type:
57889         type: string
57890         description: Design of zone [Medium/Large?]
57891       zone-context:
57892         type: string
57893         description: Context of zone [production/test]
57894       status:
57895         type: string
57896         description: Status of a zone.
57897       resource-version:
57898         type: string
57899         description: Concurrency value
57900       relationship-list:
57901         type: array
57902         items:
57903           $ref: "#/definitions/relationship"
57904   zones:
57905     description: |
57906       Collection of zones
57907     properties:
57908       zone:
57909         type: array
57910         items:
57911           $ref: "#/definitions/zone"
57912 patchDefinitions:
57913   aai-internal:
57914     properties:
57915       property-name:
57916         type: string
57917       property-value:
57918         type: string
57919   action:
57920     properties:
57921       action-type:
57922         type: string
57923       action-data:
57924         type: array
57925         items:
57926           $ref: "#/patchDefinitions/action-data"
57927   action-data:
57928     properties:
57929       property-name:
57930         type: string
57931       property-value:
57932         type: string
57933   actions:
57934     description: |
57935       APIs that are more action related than REST (e.g., notify, update).
57936     properties:
57937       update:
57938         type: object
57939         $ref: "#/patchDefinitions/update"
57940       notify:
57941         type: object
57942         $ref: "#/patchDefinitions/notify"
57943   allotted-resource:
57944     description: |
57945       Represents a slice or partial piece of a resource that gets separately allotted
57946       ###### Related Nodes
57947       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
57948       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
57949       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
57950       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
57951       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
57952       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
57953       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
57954       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
57955       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
57956       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
57957       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
57958       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
57959       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
57960       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
57961     required:
57962     - id
57963     properties:
57964       id:
57965         type: string
57966         description: Allotted Resource id UUID assigned to this instance.
57967       description:
57968         type: string
57969         description: The descriptive information assigned to this allotted resource instance
57970       selflink:
57971         type: string
57972         description: Link back to more information in the controller
57973       model-invariant-id:
57974         type: string
57975         description: the ASDC model id for this resource or service model.
57976       model-version-id:
57977         type: string
57978         description: the ASDC model version for this resource or service model.
57979       persona-model-version:
57980         type: string
57981         description: the ASDC model version for this resource or service model.
57982   allotted-resources:
57983     description: |
57984       This object is used to store slices of services being offered
57985     properties:
57986       allotted-resource:
57987         type: array
57988         items:
57989           $ref: "#/patchDefinitions/allotted-resource"
57990   availability-zone:
57991     description: |
57992       Availability zone, a collection of compute hosts/pservers
57993       ###### Related Nodes
57994       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
57995       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
57996       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
57997       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57998       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
57999       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58000       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
58001       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58002       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
58003     required:
58004     - availability-zone-name
58005     - hypervisor-type
58006     properties:
58007       availability-zone-name:
58008         type: string
58009         description: Name of the availability zone.  Unique across a cloud region
58010       hypervisor-type:
58011         type: string
58012         description: Type of hypervisor.  Source of truth should define valid values.
58013       operational-status:
58014         type: string
58015         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
58016   availability-zones:
58017     description: |
58018       Collection of availability zones
58019     properties:
58020       availability-zone:
58021         type: array
58022         items:
58023           $ref: "#/patchDefinitions/availability-zone"
58024   az-and-dvs-switches:
58025     properties:
58026       dvs-switches:
58027         type: object
58028         $ref: "#/patchDefinitions/dvs-switches"
58029       availability-zone:
58030         type: object
58031         $ref: "#/patchDefinitions/availability-zone"
58032   business:
58033     description: |
58034       Namespace for business related constructs
58035     properties:
58036       connectors:
58037         type: array
58038         items:
58039           $ref: "#/patchDefinitions/connector"
58040       customers:
58041         type: array
58042         items:
58043           $ref: "#/patchDefinitions/customer"
58044       lines-of-business:
58045         type: array
58046         items:
58047           $ref: "#/patchDefinitions/line-of-business"
58048       owning-entities:
58049         type: array
58050         items:
58051           $ref: "#/patchDefinitions/owning-entity"
58052       platforms:
58053         type: array
58054         items:
58055           $ref: "#/patchDefinitions/platform"
58056       projects:
58057         type: array
58058         items:
58059           $ref: "#/patchDefinitions/project"
58060   class-of-service:
58061     description: |
58062       ###### Related Nodes
58063       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
58064     required:
58065     - cos
58066     properties:
58067       cos:
58068         type: string
58069         description: unique identifier of probe
58070       probe-id:
58071         type: string
58072         description: identifier of probe
58073       probe-type:
58074         type: string
58075         description: type of probe
58076   classes-of-service:
58077     description: |
58078       class-of-service of probe
58079     properties:
58080       class-of-service:
58081         type: array
58082         items:
58083           $ref: "#/patchDefinitions/class-of-service"
58084   cloud-infrastructure:
58085     description: |
58086       Namespace for cloud infrastructure.
58087     properties:
58088       complexes:
58089         type: array
58090         items:
58091           $ref: "#/patchDefinitions/complex"
58092       cloud-regions:
58093         type: array
58094         items:
58095           $ref: "#/patchDefinitions/cloud-region"
58096       network-profiles:
58097         type: array
58098         items:
58099           $ref: "#/patchDefinitions/network-profile"
58100       pservers:
58101         type: array
58102         items:
58103           $ref: "#/patchDefinitions/pserver"
58104       virtual-data-centers:
58105         type: array
58106         items:
58107           $ref: "#/patchDefinitions/virtual-data-center"
58108   cloud-region:
58109     description: |
58110       cloud-region designates an installation of a cloud cluster or region or instantiation.
58111       ###### Related Nodes
58112       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
58113       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58114       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58115       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
58116       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58117       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58118       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58119       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58120       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58121       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58122       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58123       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58124       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58125       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58126       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58127       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
58128       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
58129       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
58130       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
58131       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58132     required:
58133     - cloud-owner
58134     - cloud-region-id
58135     - sriov-automation
58136     properties:
58137       cloud-owner:
58138         type: string
58139         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
58140       cloud-region-id:
58141         type: string
58142         description: Identifier used by the vendor for the region. Second part of composite key
58143       cloud-type:
58144         type: string
58145         description: Type of the cloud (e.g., openstack)
58146       owner-defined-type:
58147         type: string
58148         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
58149       cloud-region-version:
58150         type: string
58151         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
58152       identity-url:
58153         type: string
58154         description: URL of the keystone identity service
58155       cloud-zone:
58156         type: string
58157         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
58158       complex-name:
58159         type: string
58160         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
58161       sriov-automation:
58162         type: boolean
58163       cloud-extra-info:
58164         type: string
58165         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
58166       cloud-epa-caps:
58167         type: string
58168         description: MultiVIM will discover and expose EPA capabilities.
58169   cloud-regions:
58170     properties:
58171       cloud-region:
58172         type: array
58173         items:
58174           $ref: "#/patchDefinitions/cloud-region"
58175   complex:
58176     description: |
58177       Collection of physical locations that can house cloud-regions.
58178       ###### Related Nodes
58179       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58180       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58181       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58182       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58183       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58184       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
58185       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58186       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58187       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58188       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58189       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58190       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
58191       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
58192       - COMPLEX is DELETED when these are DELETED CTAG-POOL
58193     required:
58194     - physical-location-id
58195     - physical-location-type
58196     - street1
58197     - city
58198     - postal-code
58199     - country
58200     - region
58201     properties:
58202       physical-location-id:
58203         type: string
58204         description: Unique identifier for physical location, e.g., CLLI
58205       data-center-code:
58206         type: string
58207         description: Data center code which can be an alternate way to identify a complex
58208       complex-name:
58209         type: string
58210         description: Gamma complex name for LCP instance.
58211       identity-url:
58212         type: string
58213         description: URL of the keystone identity service
58214   complexes:
58215     description: |
58216       Collection of physical locations that can house cloud-regions.
58217     properties:
58218       complex:
58219         type: array
58220         items:
58221           $ref: "#/patchDefinitions/complex"
58222   configuration:
58223     description: |
58224       Port Mirror Configuration.
58225       ###### Related Nodes
58226       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
58227       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
58228       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
58229       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58230       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58231       - CONFIGURATION is DELETED when these are DELETED METADATUM
58232       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
58233     required:
58234     - configuration-id
58235     - configuration-type
58236     - configuration-sub-type
58237     - orchestration-status
58238     - operational-status
58239     - configuration-selflink
58240     - model-customization-id
58241     properties:
58242       configuration-id:
58243         type: string
58244         description: UUID assigned to configuration.
58245       management-option:
58246         type: string
58247         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
58248       configuration-name:
58249         type: string
58250         description: Name of the configuration.
58251       configuration-type:
58252         type: string
58253         description: port-mirroring-configuration.
58254       configuration-sub-type:
58255         type: string
58256         description: vprobe, pprobe.
58257       model-invariant-id:
58258         type: string
58259         description: the ASDC model id for this resource or service model.
58260       model-version-id:
58261         type: string
58262         description: the ASDC model version for this resource or service model.
58263       orchestration-status:
58264         type: string
58265         description: Orchestration status of the configuration.
58266       operational-status:
58267         type: string
58268         description: Indicator for whether the resource is considered operational.
58269       configuration-selflink:
58270         type: string
58271         description: URL to endpoint where AAI can get more details from SDN-GC.
58272       model-customization-id:
58273         type: string
58274         description: id of  the configuration used to customize the resource
58275   configurations:
58276     description: |
58277       Collection of configurations
58278     properties:
58279       configuration:
58280         type: array
58281         items:
58282           $ref: "#/patchDefinitions/configuration"
58283   connector:
58284     description: |
58285       Collection of resource instances used to connect a variety of disparate inventory widgets
58286       ###### Related Nodes
58287       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58288       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
58289       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
58290       - CONNECTOR is DELETED when these are DELETED METADATUM
58291     required:
58292     - resource-instance-id
58293     properties:
58294       resource-instance-id:
58295         type: string
58296         description: Unique id of resource instance.
58297   connectors:
58298     description: |
58299       Collection of resource instances used to connect a variety of disparate inventory widgets
58300     properties:
58301       connector:
58302         type: array
58303         items:
58304           $ref: "#/patchDefinitions/connector"
58305   constrained-element-set:
58306     description: |
58307       This is how we would capture constraints defining allowed sets of elements.
58308       ###### Related Nodes
58309       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
58310       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
58311       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58312       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
58313     required:
58314     - constrained-element-set-uuid
58315     - constraint-type
58316     - check-type
58317     properties:
58318       constrained-element-set-uuid:
58319         type: string
58320       constraint-type:
58321         type: string
58322       check-type:
58323         type: string
58324   constrained-element-sets:
58325     properties:
58326       constrained-element-set:
58327         type: array
58328         items:
58329           $ref: "#/patchDefinitions/constrained-element-set"
58330   ctag-assignment:
58331     description: |
58332       ###### Related Nodes
58333       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
58334       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
58335     required:
58336     - vlan-id-inner
58337     properties:
58338       vlan-id-inner:
58339         type: integer
58340         format: int64
58341         description: id.
58342   ctag-assignments:
58343     properties:
58344       ctag-assignment:
58345         type: array
58346         items:
58347           $ref: "#/patchDefinitions/ctag-assignment"
58348   ctag-pool:
58349     description: |
58350       A collection of C tags (vlan tags) grouped for a specific purpose.
58351       ###### Related Nodes
58352       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
58353       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58354       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58355       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58356     required:
58357     - target-pe
58358     - availability-zone-name
58359     - ctag-pool-purpose
58360     properties:
58361       target-pe:
58362         type: string
58363         description: The Target provider edge router
58364       availability-zone-name:
58365         type: string
58366         description: Name of the availability zone
58367       ctag-pool-purpose:
58368         type: string
58369         description: Describes what the intended purpose of this pool is.
58370       ctag-values:
58371         type: string
58372         description: Comma separated list of ctags
58373   ctag-pools:
58374     properties:
58375       ctag-pool:
58376         type: array
58377         items:
58378           $ref: "#/patchDefinitions/ctag-pool"
58379   customer:
58380     description: |
58381       customer identifiers to provide linkage back to BSS information.
58382       ###### Related Nodes
58383       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
58384       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
58385     required:
58386     - global-customer-id
58387     - subscriber-name
58388     - subscriber-type
58389     properties:
58390       global-customer-id:
58391         type: string
58392         description: Global customer id used across ECOMP to uniquely identify customer.
58393       subscriber-name:
58394         type: string
58395         description: Subscriber name, an alternate way to retrieve a customer.
58396       subscriber-type:
58397         type: string
58398         description: Subscriber type, a way to provide VID with only the INFRA customers.
58399   customers:
58400     description: |
58401       Collection of customer identifiers to provide linkage back to BSS information.
58402     properties:
58403       customer:
58404         type: array
58405         items:
58406           $ref: "#/patchDefinitions/customer"
58407   cvlan-tag-entry:
58408     required:
58409     - cvlan-tag
58410     properties:
58411       cvlan-tag:
58412         type: integer
58413         format: int64
58414         description: See mis-na-virtualization-platform.yang
58415   cvlan-tags:
58416     properties:
58417       cvlan-tag-entry:
58418         type: array
58419         items:
58420           $ref: "#/patchDefinitions/cvlan-tag-entry"
58421   dvs-switch:
58422     description: |
58423       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.
58424       ###### Related Nodes
58425       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58426       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
58427     required:
58428     - switch-name
58429     - vcenter-url
58430     properties:
58431       switch-name:
58432         type: string
58433         description: DVS switch name
58434       vcenter-url:
58435         type: string
58436         description: URL used to reach the vcenter
58437   dvs-switches:
58438     description: |
58439       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
58440     properties:
58441       dvs-switch:
58442         type: array
58443         items:
58444           $ref: "#/patchDefinitions/dvs-switch"
58445   edge-prop-names:
58446     description: |
58447       Internal map to define the properties of an edge and interpret the map EdgeRules
58448     properties:
58449       edgeLabel:
58450         type: string
58451       direction:
58452         type: string
58453       multiplicityRule:
58454         type: string
58455       contains-other-v:
58456         type: string
58457       delete-other-v:
58458         type: string
58459       SVC-INFRA:
58460         type: string
58461       prevent-delete:
58462         type: string
58463   edge-tag-query-request:
58464     properties:
58465       edge-tag:
58466         type: string
58467       result-detail:
58468         type: string
58469       start-node-type:
58470         type: string
58471       start-node-filter:
58472         type: array
58473         items:
58474           $ref: "#/patchDefinitions/start-node-filter"
58475       include-node-filter:
58476         type: array
58477         items:
58478           $ref: "#/patchDefinitions/include-node-filter"
58479       secondary-filter:
58480         type: array
58481         items:
58482           $ref: "#/patchDefinitions/secondary-filter"
58483   edge-tag-query-result:
58484     properties:
58485       tagged-inventory-item-list:
58486         type: array
58487         items:
58488           $ref: "#/patchDefinitions/tagged-inventory-item-list"
58489   element-choice-set:
58490     description: |
58491       This is how we would capture constraints defining allowed sets of elements.
58492       ###### Related Nodes
58493       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
58494       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
58495       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
58496     required:
58497     - element-choice-set-uuid
58498     - element-choice-set-name
58499     properties:
58500       element-choice-set-uuid:
58501         type: string
58502       element-choice-set-name:
58503         type: string
58504       cardinality:
58505         type: string
58506   element-choice-sets:
58507     properties:
58508       element-choice-set:
58509         type: array
58510         items:
58511           $ref: "#/patchDefinitions/element-choice-set"
58512   entitlement:
58513     description: |
58514       Metadata for entitlement group.
58515       ###### Related Nodes
58516       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58517       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
58518     required:
58519     - group-uuid
58520     - resource-uuid
58521     properties:
58522       group-uuid:
58523         type: string
58524         description: Unique ID for the entitlement group the resource comes from, should be uuid.
58525       resource-uuid:
58526         type: string
58527         description: Unique ID of an entitlement resource.
58528   entitlements:
58529     description: |
58530       Entitlements, keyed by group-uuid and resource-uuid, related to license management
58531     properties:
58532       entitlement:
58533         type: array
58534         items:
58535           $ref: "#/patchDefinitions/entitlement"
58536   esr-ems:
58537     description: |
58538       Persist EMS address information used by EMS driver.
58539       ###### Related Nodes
58540       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
58541       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58542     required:
58543     - ems-id
58544     properties:
58545       ems-id:
58546         type: string
58547         description: Unique ID of EMS.
58548   esr-ems-list:
58549     properties:
58550       esr-ems:
58551         type: array
58552         items:
58553           $ref: "#/patchDefinitions/esr-ems"
58554   esr-system-info:
58555     description: |
58556       Persist common address information of external systems.
58557       ###### Related Nodes
58558       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
58559       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
58560       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
58561       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
58562     required:
58563     - esr-system-info-id
58564     - user-name
58565     - password
58566     - system-type
58567     properties:
58568       esr-system-info-id:
58569         type: string
58570         description: Unique ID of esr system info.
58571       system-name:
58572         type: string
58573         description: name of external system.
58574       type:
58575         type: string
58576         description: type of external systems.
58577       vendor:
58578         type: string
58579         description: vendor of external systems.
58580       version:
58581         type: string
58582         description: version of external systems.
58583       service-url:
58584         type: string
58585         description: url used to access external systems.
58586       user-name:
58587         type: string
58588         description: username used to access external systems.
58589       password:
58590         type: string
58591         description: password used to access external systems.
58592       system-type:
58593         type: string
58594         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
58595       protocol:
58596         type: string
58597         description: protocol of third party SDNC, for example netconf/snmp.
58598       ssl-cacert:
58599         type: string
58600         description: ca file content if enabled ssl on auth-url.
58601       ssl-insecure:
58602         type: boolean
58603         description: Whether to verify VIM's certificate.
58604       ip-address:
58605         type: string
58606         description: service IP of ftp server.
58607       port:
58608         type: string
58609         description: service port of ftp server.
58610       cloud-domain:
58611         type: string
58612         description: domain info for authentication.
58613       default-tenant:
58614         type: string
58615         description: default tenant of VIM.
58616       passive:
58617         type: boolean
58618         description: ftp passive mode or not.
58619       remote-path:
58620         type: string
58621         description: resource or performance data file path.
58622       system-status:
58623         type: string
58624         description: the status of external system.
58625   esr-system-info-list:
58626     description: |
58627       Collection of persistent block-level external system auth info.
58628     properties:
58629       esr-system-info:
58630         type: array
58631         items:
58632           $ref: "#/patchDefinitions/esr-system-info"
58633   esr-thirdparty-sdnc:
58634     description: |
58635       Persist SDNC address information used by ONAP SDNC.
58636       ###### Related Nodes
58637       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
58638       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
58639       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58640     required:
58641     - thirdparty-sdnc-id
58642     properties:
58643       thirdparty-sdnc-id:
58644         type: string
58645         description: Unique ID of SDNC.
58646       location:
58647         type: string
58648         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
58649       product-name:
58650         type: string
58651         description: password used to access SDNC server.
58652   esr-thirdparty-sdnc-list:
58653     properties:
58654       esr-thirdparty-sdnc:
58655         type: array
58656         items:
58657           $ref: "#/patchDefinitions/esr-thirdparty-sdnc"
58658   esr-vnfm:
58659     description: |
58660       Persist VNFM address information used by VF-C.
58661       ###### Related Nodes
58662       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
58663       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
58664     required:
58665     - vnfm-id
58666     properties:
58667       vnfm-id:
58668         type: string
58669         description: Unique ID of VNFM.
58670       vim-id:
58671         type: string
58672         description: indecate the VIM to deploy VNF.
58673       certificate-url:
58674         type: string
58675         description: certificate url of VNFM.
58676   esr-vnfm-list:
58677     properties:
58678       esr-vnfm:
58679         type: array
58680         items:
58681           $ref: "#/patchDefinitions/esr-vnfm"
58682   evc:
58683     description: |
58684       evc object is an optional child object of the Configuration object.
58685       ###### Related Nodes
58686       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58687     required:
58688     - evc-id
58689     properties:
58690       evc-id:
58691         type: string
58692         description: Unique/key field for the evc object
58693       forwarding-path-topology:
58694         type: string
58695         description: Point-to-Point, Multi-Point
58696       cir-value:
58697         type: string
58698         description: Commited Information Rate
58699       cir-units:
58700         type: string
58701         description: CIR units
58702       connection-diversity-group-id:
58703         type: string
58704         description: Diversity Group ID
58705       service-hours:
58706         type: string
58707         description: formerly Performance Group
58708       esp-evc-circuit-id:
58709         type: string
58710         description: EVC Circuit ID of ESP EVC
58711       esp-evc-cir-value:
58712         type: string
58713         description: Committed Information Rate (For ESP)
58714       esp-evc-cir-units:
58715         type: string
58716         description: CIR units (For ESP)
58717       esp-itu-code:
58718         type: string
58719         description: Identifies ESP
58720       collector-pop-clli:
58721         type: string
58722         description: Collector POP CLLI (from the hostname of the access pnf)
58723       inter-connect-type-ingress:
58724         type: string
58725         description: Interconnect type on ingress side of EVC.
58726       tagmode-access-ingress:
58727         type: string
58728         description: tagode for collector side of EVC
58729       tagmode-access-egress:
58730         type: string
58731         description: tagMode for network side of EVC
58732   evcs:
58733     properties:
58734       evc:
58735         type: array
58736         items:
58737           $ref: "#/patchDefinitions/evc"
58738   external-system:
58739     description: |
58740       Namespace for external system.
58741     properties:
58742       esr-ems-list:
58743         type: object
58744         $ref: "#/patchDefinitions/esr-ems-list"
58745       esr-vnfm-list:
58746         type: object
58747         $ref: "#/patchDefinitions/esr-vnfm-list"
58748       esr-thirdparty-sdnc-list:
58749         type: object
58750         $ref: "#/patchDefinitions/esr-thirdparty-sdnc-list"
58751   extra-properties:
58752     description: |
58753       Extra properties for inventory item for response list
58754     properties:
58755       extra-property:
58756         type: array
58757         items:
58758           $ref: "#/patchDefinitions/extra-property"
58759   extra-property:
58760     properties:
58761       property-name:
58762         type: string
58763       property-value:
58764         type: string
58765   flavor:
58766     description: |
58767       Openstack flavor.
58768       ###### Related Nodes
58769       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
58770       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
58771       - FLAVOR cannot be deleted if linked to VSERVER
58772     required:
58773     - flavor-id
58774     - flavor-name
58775     - flavor-selflink
58776     properties:
58777       flavor-id:
58778         type: string
58779         description: Flavor id, expected to be unique across cloud-region.
58780       flavor-name:
58781         type: string
58782         description: Flavor name
58783       flavor-vcpus:
58784         type: integer
58785         format: int32
58786         description: Number of CPUs
58787       flavor-ram:
58788         type: integer
58789         format: int32
58790         description: Amount of memory
58791       flavor-disk:
58792         type: integer
58793         format: int32
58794         description: Disk space
58795       flavor-ephemeral:
58796         type: integer
58797         format: int32
58798         description: Amount of ephemeral disk space
58799       flavor-swap:
58800         type: string
58801         description: amount of swap space allocation
58802       flavor-is-public:
58803         type: boolean
58804         description: whether flavor is available to all users or private to the tenant it was created in.
58805       flavor-selflink:
58806         type: string
58807         description: URL to endpoint where AAI can get more details
58808       flavor-disabled:
58809         type: boolean
58810         description: Boolean as to whether this flavor is no longer enabled
58811   flavors:
58812     description: |
58813       Collection of openstack flavors.
58814     properties:
58815       flavor:
58816         type: array
58817         items:
58818           $ref: "#/patchDefinitions/flavor"
58819   forwarder:
58820     description: |
58821       Entity describing a sequenced segment of forwarding path
58822       ###### Related Nodes
58823       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58824       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
58825       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58826       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
58827       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
58828       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
58829     required:
58830     - sequence
58831     properties:
58832       sequence:
58833         type: integer
58834         format: int32
58835         description: Unique ID of this segmentation
58836       forwarder-role:
58837         type: string
58838         description: ingress, intermediate, egress
58839   forwarder-evc:
58840     description: |
58841       forwarder object is an optional child object of the Configuration object.
58842       ###### Related Nodes
58843       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
58844     required:
58845     - forwarder-evc-id
58846     properties:
58847       forwarder-evc-id:
58848         type: string
58849         description: Key for forwarder-evc object
58850       circuit-id:
58851         type: string
58852         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
58853       ivlan:
58854         type: string
58855         description: Internal VLAN.
58856       svlan:
58857         type: string
58858         description: SVLAN value for ingress of egress forwarder.
58859       cvlan:
58860         type: string
58861         description: CVLAN value for ingress of egress forwarder.
58862   forwarder-evcs:
58863     properties:
58864       forwarder-evc:
58865         type: array
58866         items:
58867           $ref: "#/patchDefinitions/forwarder-evc"
58868   forwarders:
58869     properties:
58870       forwarder:
58871         type: array
58872         items:
58873           $ref: "#/patchDefinitions/forwarder"
58874   forwarding-path:
58875     description: |
58876       Entity that describes the sequenced forwarding path between interfaces of services or resources
58877       ###### Related Nodes
58878       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
58879       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
58880       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
58881       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
58882       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
58883     required:
58884     - forwarding-path-id
58885     - forwarding-path-name
58886     properties:
58887       forwarding-path-id:
58888         type: string
58889         description: Unique ID of this FP
58890       forwarding-path-name:
58891         type: string
58892         description: Name of the FP
58893   forwarding-paths:
58894     properties:
58895       forwarding-path:
58896         type: array
58897         items:
58898           $ref: "#/patchDefinitions/forwarding-path"
58899   generic-vnf:
58900     description: |
58901       General purpose VNF
58902       ###### Related Nodes
58903       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
58904       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
58905       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
58906       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
58907       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
58908       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
58909       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
58910       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
58911       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
58912       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
58913       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
58914       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
58915       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
58916       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
58917       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
58918       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58919       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58920       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58921       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58922       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58923       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58924       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
58925       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
58926       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
58927       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
58928       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
58929       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
58930       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
58931       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
58932     required:
58933     - vnf-id
58934     - vnf-instance-id
58935     - vnf-name
58936     - vnf-type
58937     - vnf-package-name
58938     - vnf-discriptor-name
58939     - job-id
58940     - in-maint
58941     - is-closed-loop-disabled
58942     properties:
58943       vnf-id:
58944         type: string
58945         description: Unique id of VNF.  This is unique across the graph.
58946       vnf-instance-id:
58947         type: string
58948         description: vnf instance id.
58949       vnf-name:
58950         type: string
58951         description: Name of VNF.
58952       vnf-name2:
58953         type: string
58954         description: Alternate name of VNF.
58955       vnf-type:
58956         type: string
58957         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.
58958       service-id:
58959         type: string
58960         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
58961       regional-resource-zone:
58962         type: string
58963         description: Regional way of organizing pservers, source of truth should define values
58964       prov-status:
58965         type: string
58966         description: Trigger for operational monitoring of this resource by Service Assurance systems.
58967       operational-status:
58968         type: string
58969         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
58970       license-key:
58971         type: string
58972         description: OBSOLETE -  do not use
58973       equipment-role:
58974         type: string
58975         description: Client should send valid enumerated value
58976       orchestration-status:
58977         type: string
58978         description: Orchestration status of this VNF, used by MSO.
58979       vnf-package-name:
58980         type: string
58981       vnf-discriptor-name:
58982         type: string
58983         description: vnf discriptor name
58984       job-id:
58985         type: string
58986         description: job id corresponding to vnf
58987       heat-stack-id:
58988         type: string
58989         description: Heat stack id corresponding to this instance, managed by MSO
58990       mso-catalog-key:
58991         type: string
58992         description: Corresponds to the SDN-C catalog id used to configure this VCE
58993       management-option:
58994         type: string
58995         description: identifier of managed by ATT or customer
58996       ipv4-oam-address:
58997         type: string
58998         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
58999       ipv4-loopback0-address:
59000         type: string
59001         description: v4 Loopback0 address
59002       nm-lan-v6-address:
59003         type: string
59004         description: v6 Loopback address
59005       management-v6-address:
59006         type: string
59007         description: v6 management address
59008       vcpu:
59009         type: integer
59010         format: int64
59011         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
59012       vcpu-units:
59013         type: string
59014         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
59015       vmemory:
59016         type: integer
59017         format: int64
59018         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
59019       vmemory-units:
59020         type: string
59021         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
59022       vdisk:
59023         type: integer
59024         format: int64
59025         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
59026       vdisk-units:
59027         type: string
59028         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
59029       nshd:
59030         type: integer
59031         format: int64
59032         description: number of associated SHD in vnf.
59033       nvm:
59034         type: integer
59035         format: int64
59036         description: number of vms in vnf.
59037       nnet:
59038         type: integer
59039         format: int64
59040         description: number of network in vnf.
59041       in-maint:
59042         type: boolean
59043       is-closed-loop-disabled:
59044         type: boolean
59045   generic-vnfs:
59046     description: |
59047       Collection of VNFs
59048     properties:
59049       generic-vnf:
59050         type: array
59051         items:
59052           $ref: "#/patchDefinitions/generic-vnf"
59053   group-assignment:
59054     description: |
59055       Openstack group-assignment used to store exclusivity groups (EG).
59056       ###### Related Nodes
59057       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59058       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
59059       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
59060     required:
59061     - group-id
59062     - group-type
59063     - group-name
59064     properties:
59065       group-id:
59066         type: string
59067         description: Group id, expected to be unique across cloud-region.
59068       group-type:
59069         type: string
59070         description: Group type - the type of group this instance refers to
59071       group-name:
59072         type: string
59073         description: Group name - name assigned to the group
59074       group-description:
59075         type: string
59076         description: Group description - description of the group
59077   group-assignments:
59078     description: |
59079       Collection of openstack group assignments
59080     properties:
59081       group-assignment:
59082         type: array
59083         items:
59084           $ref: "#/patchDefinitions/group-assignment"
59085   host-route:
59086     description: |
59087       ###### Related Nodes
59088       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
59089     required:
59090     - host-route-id
59091     - route-prefix
59092     - next-hop
59093     properties:
59094       host-route-id:
59095         type: string
59096         description: host-route id
59097       route-prefix:
59098         type: string
59099         description: subnet prefix
59100       next-hop:
59101         type: string
59102         description: Could be ip-address, hostname, or service-instance
59103       next-hop-type:
59104         type: string
59105         description: Should be ip-address, hostname, or service-instance to match next-hop
59106   host-routes:
59107     properties:
59108       host-route:
59109         type: array
59110         items:
59111           $ref: "#/patchDefinitions/host-route"
59112   image:
59113     description: |
59114       Openstack image.
59115       ###### Related Nodes
59116       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
59117       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59118       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
59119       - IMAGE cannot be deleted if linked to VSERVER
59120       - IMAGE is DELETED when these are DELETED METADATUM
59121     required:
59122     - image-id
59123     - image-name
59124     - image-os-distro
59125     - image-os-version
59126     - image-selflink
59127     properties:
59128       image-id:
59129         type: string
59130         description: Image id, expected to be unique across cloud region
59131       image-name:
59132         type: string
59133         description: Image name
59134       image-architecture:
59135         type: string
59136         description: Operating system architecture.
59137       image-os-distro:
59138         type: string
59139         description: The common name of the operating system distribution in lowercase
59140       image-os-version:
59141         type: string
59142         description: The operating system version as specified by the distributor.
59143       application:
59144         type: string
59145         description: The application that the image instantiates.
59146       application-vendor:
59147         type: string
59148         description: The vendor of the application.
59149       application-version:
59150         type: string
59151         description: The version of the application.
59152       image-selflink:
59153         type: string
59154         description: URL to endpoint where AAI can get more details
59155   images:
59156     description: |
59157       Collectio of Openstack images.
59158     properties:
59159       image:
59160         type: array
59161         items:
59162           $ref: "#/patchDefinitions/image"
59163   include-node-filter:
59164     properties:
59165       include-node-type:
59166         type: string
59167   instance-filter:
59168     description: |
59169       InstanceFilter for performing a named-query or model query
59170   instance-filters:
59171     description: |
59172       InstanceFilters for performing a named-query or model query
59173     properties:
59174       instance-filter:
59175         type: array
59176         items:
59177           $ref: "#/patchDefinitions/instance-filter"
59178   instance-group:
59179     description: |
59180       General mechanism for grouping instances
59181       ###### Related Nodes
59182       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59183       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59184       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59185       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59186       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59187       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59188       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59189       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59190       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59191       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59192       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59193       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59194     required:
59195     - instance-group-role
59196     - model-invariant-id
59197     - model-version-id
59198     - id
59199     - description
59200     - type
59201     properties:
59202       instance-group-role:
59203         type: string
59204         description: role of the instance group.
59205       model-invariant-id:
59206         type: string
59207         description: ASDC model id for this resource or service model.
59208       model-version-id:
59209         type: string
59210         description: ASDC model version uid for this resource model.
59211       id:
59212         type: string
59213         description: Instance Group ID, UUID assigned to this instance.
59214       description:
59215         type: string
59216         description: Descriptive text to help identify the usage of this instance-group
59217       type:
59218         type: string
59219         description: Only valid value today is lower case ha for high availability
59220       sub-type:
59221         type: string
59222         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
59223   instance-groups:
59224     description: |
59225       Collection of openstack route table references
59226     properties:
59227       instance-group:
59228         type: array
59229         items:
59230           $ref: "#/patchDefinitions/instance-group"
59231   inventory:
59232     properties:
59233       search:
59234         type: object
59235         $ref: "#/patchDefinitions/search"
59236       actions:
59237         type: object
59238         $ref: "#/patchDefinitions/actions"
59239       cloud-infrastructure:
59240         type: object
59241         $ref: "#/patchDefinitions/cloud-infrastructure"
59242       external-system:
59243         type: object
59244         $ref: "#/patchDefinitions/external-system"
59245       business:
59246         type: object
59247         $ref: "#/patchDefinitions/business"
59248       service-design-and-creation:
59249         type: object
59250         $ref: "#/patchDefinitions/service-design-and-creation"
59251       network:
59252         type: object
59253         $ref: "#/patchDefinitions/network"
59254       aai-internal:
59255         type: object
59256         $ref: "#/patchDefinitions/aai-internal"
59257       nodes:
59258         type: array
59259         items:
59260           $ref: "#/patchDefinitions/aai-internal"
59261   inventory-item:
59262     properties:
59263       inventory-item-type:
59264         type: string
59265       inventory-item-link:
59266         type: string
59267       inventory-item-data:
59268         type: array
59269         items:
59270           $ref: "#/patchDefinitions/inventory-item-data"
59271       tagged-inventory-item-list:
59272         type: array
59273         items:
59274           $ref: "#/patchDefinitions/tagged-inventory-item-list"
59275   inventory-item-data:
59276     properties:
59277       property-name:
59278         type: string
59279       property-value:
59280         type: string
59281   inventory-response-item:
59282     description: |
59283       Inventory item for response list
59284     properties:
59285       model-name:
59286         type: string
59287       extra-properties:
59288         type: object
59289         $ref: "#/patchDefinitions/extra-properties"
59290       inventory-response-items:
59291         type: object
59292         $ref: "#/patchDefinitions/inventory-response-items"
59293   inventory-response-items:
59294     description: |
59295       Container for inventory items in response list
59296     properties:
59297       inventory-response-item:
59298         type: array
59299         items:
59300           $ref: "#/patchDefinitions/inventory-response-item"
59301   ipsec-configuration:
59302     description: |
59303       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
59304       ###### Related Nodes
59305       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
59306       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
59307       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
59308     required:
59309     - ipsec-configuration-id
59310     properties:
59311       ipsec-configuration-id:
59312         type: string
59313         description: UUID of this configuration
59314       requested-vig-address-type:
59315         type: string
59316         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
59317       requested-encryption-strength:
59318         type: string
59319         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
59320       requested-dmz-type:
59321         type: string
59322         description: ATT can offer a shared DMZ or a DMZ specific to a customer
59323       shared-dmz-network-address:
59324         type: string
59325         description: Network address of shared DMZ
59326       requested-customer-name:
59327         type: string
59328         description: If the DMZ is a custom DMZ, this field will indicate the customer information
59329       ike-version:
59330         type: string
59331         description: can be 1 or 2
59332       ikev1-authentication:
59333         type: string
59334         description: Contains values like md5, sha1, sha256, sha384
59335       ikev1-encryption:
59336         type: string
59337         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59338       ikev1-dh-group:
59339         type: string
59340         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
59341       ikev1-am-group-id:
59342         type: string
59343         description: Group name defined in VIG for clients using aggressive mode
59344       ikev1-am-password:
59345         type: string
59346         description: pre-shared key for the above group name
59347       ikev1-sa-lifetime:
59348         type: string
59349         description: Lifetime for IKEv1 SA
59350       ipsec-authentication:
59351         type: string
59352         description: md5, sha1, sha256, sha384
59353       ipsec-encryption:
59354         type: string
59355         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
59356       ipsec-sa-lifetime:
59357         type: string
59358         description: Life time for IPSec SA
59359       ipsec-pfs:
59360         type: string
59361         description: enable PFS or not
59362       xauth-userid:
59363         type: string
59364         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
59365       xauth-user-password:
59366         type: string
59367         description: Encrypted using the Juniper $9$ algorithm
59368       dpd-interval:
59369         type: string
59370         description: The time between DPD probe
59371       dpd-frequency:
59372         type: string
59373         description: Maximum number of DPD before claiming the tunnel is down
59374   ipsec-configurations:
59375     properties:
59376       ipsec-configuration:
59377         type: array
59378         items:
59379           $ref: "#/patchDefinitions/ipsec-configuration"
59380   key-data:
59381     properties:
59382       key-name:
59383         type: string
59384       key-value:
59385         type: string
59386   l-interface:
59387     description: |
59388       Logical interfaces, e.g., a vnic.
59389       ###### Related Nodes
59390       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59391       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59392       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59393       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59394       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59395       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
59396       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
59397       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
59398       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
59399       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59400       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59401       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
59402       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
59403       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59404       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
59405       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
59406     required:
59407     - interface-name
59408     - is-port-mirrored
59409     - in-maint
59410     - is-ip-unnumbered
59411     properties:
59412       interface-name:
59413         type: string
59414         description: Name given to the interface
59415       interface-role:
59416         type: string
59417         description: E.g., CUSTOMER, UPLINK, etc.
59418       v6-wan-link-ip:
59419         type: string
59420         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
59421       selflink:
59422         type: string
59423         description: URL to endpoint where AAI can get more details
59424       interface-id:
59425         type: string
59426         description: ID of interface
59427       macaddr:
59428         type: string
59429         description: MAC address for the interface
59430       network-name:
59431         type: string
59432         description: Name of the network
59433       management-option:
59434         type: string
59435         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
59436       interface-description:
59437         type: string
59438         description: Human friendly text regarding this interface.
59439       is-port-mirrored:
59440         type: boolean
59441   l-interfaces:
59442     description: |
59443       Collection of logical interfaces.
59444     properties:
59445       l-interface:
59446         type: array
59447         items:
59448           $ref: "#/patchDefinitions/l-interface"
59449   l3-interface-ipv4-address-list:
59450     description: |
59451       IPv4 Address Range
59452       ###### Related Nodes
59453       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59454       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59455       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59456       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59457       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59458       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59459     required:
59460     - l3-interface-ipv4-address
59461     properties:
59462       l3-interface-ipv4-address:
59463         type: string
59464         description: IP address
59465       l3-interface-ipv4-prefix-length:
59466         type: integer
59467         format: int64
59468         description: Prefix length, 32 for single address
59469       vlan-id-inner:
59470         type: integer
59471         format: int64
59472         description: Inner VLAN tag
59473       vlan-id-outer:
59474         type: integer
59475         format: int64
59476         description: Outer VLAN tag
59477       is-floating:
59478         type: boolean
59479         description: Indicator of fixed or floating address
59480   l3-interface-ipv6-address-list:
59481     description: |
59482       IPv6 Address Range
59483       ###### Related Nodes
59484       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
59485       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59486       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
59487       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
59488       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
59489       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
59490     required:
59491     - l3-interface-ipv6-address
59492     properties:
59493       l3-interface-ipv6-address:
59494         type: string
59495         description: IP address
59496       l3-interface-ipv6-prefix-length:
59497         type: integer
59498         format: int64
59499         description: Prefix length, 128 for single address
59500       vlan-id-inner:
59501         type: integer
59502         format: int64
59503         description: Inner VLAN tag
59504       vlan-id-outer:
59505         type: integer
59506         format: int64
59507         description: Outer VLAN tag
59508       is-floating:
59509         type: boolean
59510         description: Indicator of fixed or floating address
59511   l3-network:
59512     description: |
59513       Generic network definition
59514       ###### Related Nodes
59515       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
59516       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
59517       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
59518       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59519       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
59520       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59521       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59522       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59523       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59524       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
59525       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59526       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59527       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
59528       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
59529       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
59530       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
59531       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
59532     required:
59533     - network-id
59534     - network-name
59535     - is-bound-to-vpn
59536     - is-provider-network
59537     - is-shared-network
59538     - is-external-network
59539     properties:
59540       network-id:
59541         type: string
59542         description: Network ID, should be uuid. Unique across A&AI.
59543       network-name:
59544         type: string
59545         description: Name of the network, governed by some naming convention..
59546       network-type:
59547         type: string
59548         description: Type of the network - who defines these values?
59549       network-role:
59550         type: string
59551         description: Role the network plans - who defines these values?
59552       network-technology:
59553         type: string
59554         description: Network technology - who defines these values?
59555       neutron-network-id:
59556         type: string
59557         description: Neutron network id of this Interface
59558       is-bound-to-vpn:
59559         type: boolean
59560       service-id:
59561         type: string
59562         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
59563       network-role-instance:
59564         type: integer
59565         format: int64
59566         description: network role instance
59567   l3-networks:
59568     properties:
59569       l3-network:
59570         type: array
59571         items:
59572           $ref: "#/patchDefinitions/l3-network"
59573   lag-interface:
59574     description: |
59575       Link aggregate interface
59576       ###### Related Nodes
59577       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59578       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59579       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59580       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
59581       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
59582       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
59583       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
59584       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
59585       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
59586       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
59587     required:
59588     - interface-name
59589     - in-maint
59590     properties:
59591       interface-name:
59592         type: string
59593         description: Name that identifies the link aggregate interface
59594       interface-description:
59595         type: string
59596         description: Human friendly text regarding this interface.
59597   lag-interfaces:
59598     description: |
59599       Collection of link aggregate interfaces.
59600     properties:
59601       lag-interface:
59602         type: array
59603         items:
59604           $ref: "#/patchDefinitions/lag-interface"
59605   lag-link:
59606     description: |
59607       LAG links can connect lag-interfaces
59608       ###### Related Nodes
59609       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
59610       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59611     required:
59612     - link-name
59613     properties:
59614       link-name:
59615         type: string
59616         description: Alphabetical concatenation of lag-interface names
59617   lag-links:
59618     description: |
59619       Collection of link aggregation connections
59620     properties:
59621       lag-link:
59622         type: array
59623         items:
59624           $ref: "#/patchDefinitions/lag-link"
59625   license:
59626     description: |
59627       Metadata for license group.
59628       ###### Related Nodes
59629       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
59630       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
59631     required:
59632     - group-uuid
59633     - resource-uuid
59634     properties:
59635       group-uuid:
59636         type: string
59637         description: Unique ID for the license group the resource belongs to, should be uuid.
59638       resource-uuid:
59639         type: string
59640         description: Unique ID of a license resource.
59641   licenses:
59642     description: |
59643       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
59644     properties:
59645       license:
59646         type: array
59647         items:
59648           $ref: "#/patchDefinitions/license"
59649   line-of-business:
59650     description: |
59651       describes a line-of-business
59652       ###### Related Nodes
59653       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
59654     required:
59655     - line-of-business-name
59656     properties:
59657       line-of-business-name:
59658         type: string
59659         description: Name of the line-of-business (product)
59660   lines-of-business:
59661     description: |
59662       Collection of lines-of-business
59663     properties:
59664       line-of-business:
59665         type: array
59666         items:
59667           $ref: "#/patchDefinitions/line-of-business"
59668   logical-link:
59669     description: |
59670       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
59671       ###### Related Nodes
59672       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
59673       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
59674       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
59675       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59676       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
59677       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
59678       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
59679       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
59680       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59681       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59682       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
59683       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
59684       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
59685       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59686       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
59687     required:
59688     - link-name
59689     - in-maint
59690     - link-type
59691     properties:
59692       link-name:
59693         type: string
59694         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
59695       in-maint:
59696         type: boolean
59697       link-type:
59698         type: string
59699         description: Type of logical link, e.g., evc
59700       speed-value:
59701         type: string
59702         description: Captures the numeric part of the speed
59703       speed-units:
59704         type: string
59705         description: Captures the units corresponding to the speed
59706       ip-version:
59707         type: string
59708         description: v4, v6, or ds for dual stack
59709       routing-protocol:
59710         type: string
59711         description: For example, static or BGP
59712   logical-links:
59713     description: |
59714       Collection of logical connections
59715     properties:
59716       logical-link:
59717         type: array
59718         items:
59719           $ref: "#/patchDefinitions/logical-link"
59720   metadata:
59721     description: |
59722       Collection of metadatum (key/value pairs)
59723     properties:
59724       metadatum:
59725         type: array
59726         items:
59727           $ref: "#/patchDefinitions/metadatum"
59728   metadatum:
59729     description: |
59730       Key/value pairs
59731       ###### Related Nodes
59732       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
59733       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
59734       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
59735       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
59736       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59737     required:
59738     - metaname
59739     - metaval
59740     properties:
59741       metaname:
59742         type: string
59743       metaval:
59744         type: string
59745   model:
59746     description: |
59747       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
59748       ###### Related Nodes
59749       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59750       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
59751       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59752       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59753       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59754       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
59755       - MODEL is DELETED when these are DELETED MODEL-VER
59756     required:
59757     - model-invariant-id
59758     - model-type
59759     properties:
59760       model-invariant-id:
59761         type: string
59762         description: Unique identifier corresponding to the main definition of a model in ASDC
59763       model-type:
59764         type: string
59765         description: Type of the model, e.g., service, resource, widget, etc.
59766   model-and-named-query-search:
59767     description: |
59768       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
59769     properties:
59770       query-parameters:
59771         type: object
59772         $ref: "#/patchDefinitions/query-parameters"
59773       instance-filters:
59774         type: object
59775         $ref: "#/patchDefinitions/instance-filters"
59776       secondary-filts:
59777         type: object
59778         $ref: "#/patchDefinitions/secondary-filts"
59779       top-node-type:
59780         type: string
59781       secondary-filter-cut-point:
59782         type: string
59783   model-constraint:
59784     description: |
59785       This is how we would capture constraints defining allowed sets of elements.
59786       ###### Related Nodes
59787       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59788       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
59789       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
59790     required:
59791     - model-constraint-uuid
59792     - constrained-element-set-uuid-to-replace
59793     properties:
59794       model-constraint-uuid:
59795         type: string
59796       constrained-element-set-uuid-to-replace:
59797         type: string
59798       constrained-element-sets:
59799         type: array
59800         items:
59801           $ref: "#/patchDefinitions/constrained-element-set"
59802   model-constraints:
59803     properties:
59804       model-constraint:
59805         type: array
59806         items:
59807           $ref: "#/patchDefinitions/model-constraint"
59808   model-element:
59809     description: |
59810       Defines how other models combine to make up a higher-level model.
59811       ###### Related Nodes
59812       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
59813       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59814       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59815       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59816       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59817       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59818       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
59819       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
59820     required:
59821     - model-element-uuid
59822     - new-data-del-flag
59823     - cardinality
59824     properties:
59825       model-element-uuid:
59826         type: string
59827       new-data-del-flag:
59828         type: string
59829         description: Indicates whether this element was created as part of instantiation from this model
59830       cardinality:
59831         type: string
59832         description: How many of this type of element are required/allowed
59833       linkage-points:
59834         type: string
59835   model-elements:
59836     properties:
59837       model-element:
59838         type: array
59839         items:
59840           $ref: "#/patchDefinitions/model-element"
59841   model-ver:
59842     description: |
59843       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
59844       ###### Related Nodes
59845       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
59846       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
59847       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59848       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
59849       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
59850       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
59851     required:
59852     - model-version-id
59853     - model-name
59854     - model-version
59855     properties:
59856       model-version-id:
59857         type: string
59858         description: Unique identifier corresponding to one version of a model in ASDC
59859       model-name:
59860         type: string
59861         description: Name of the model, which can change from version to version.
59862       model-version:
59863         type: string
59864         description: Version
59865       model-description:
59866         type: string
59867         description: Description
59868   model-vers:
59869     properties:
59870       model-ver:
59871         type: array
59872         items:
59873           $ref: "#/patchDefinitions/model-ver"
59874   models:
59875     description: |
59876       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
59877     properties:
59878       model:
59879         type: array
59880         items:
59881           $ref: "#/patchDefinitions/model"
59882   multicast-configuration:
59883     description: |
59884       ###### Related Nodes
59885       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
59886     required:
59887     - multicast-configuration-id
59888     - multicast-protocol
59889     - rp-type
59890     properties:
59891       multicast-configuration-id:
59892         type: string
59893         description: Unique id of multicast configuration.
59894       multicast-protocol:
59895         type: string
59896         description: protocol of multicast configuration
59897       rp-type:
59898         type: string
59899         description: rp type of multicast configuration
59900   multicast-configurations:
59901     description: |
59902       multicast configuration of generic-vnf ip-address
59903     properties:
59904       multicast-configuration:
59905         type: array
59906         items:
59907           $ref: "#/patchDefinitions/multicast-configuration"
59908   named-queries:
59909     properties:
59910       named-query:
59911         type: array
59912         items:
59913           $ref: "#/patchDefinitions/named-query"
59914   named-query:
59915     description: |
59916       TBD
59917       ###### Related Nodes
59918       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59919       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
59920       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59921       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
59922     required:
59923     - named-query-uuid
59924     - named-query-name
59925     - named-query-version
59926     properties:
59927       named-query-uuid:
59928         type: string
59929       named-query-name:
59930         type: string
59931       named-query-version:
59932         type: string
59933       required-input-param:
59934         type: string
59935       description:
59936         type: string
59937   named-query-element:
59938     description: |
59939       TBD
59940       ###### Related Nodes
59941       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
59942       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
59943       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59944       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59945       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59946       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
59947       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
59948     required:
59949     - named-query-element-uuid
59950     properties:
59951       named-query-element-uuid:
59952         type: string
59953       property-collect-list:
59954         type: string
59955   named-query-elements:
59956     properties:
59957       named-query-element:
59958         type: array
59959         items:
59960           $ref: "#/patchDefinitions/named-query-element"
59961   network:
59962     description: |
59963       Namespace for network inventory resources.
59964     properties:
59965       logical-links:
59966         type: array
59967         items:
59968           $ref: "#/patchDefinitions/logical-link"
59969       site-pair-sets:
59970         type: array
59971         items:
59972           $ref: "#/patchDefinitions/site-pair-set"
59973       vpn-bindings:
59974         type: array
59975         items:
59976           $ref: "#/patchDefinitions/vpn-binding"
59977       vpls-pes:
59978         type: array
59979         items:
59980           $ref: "#/patchDefinitions/vpls-pe"
59981       multicast-configurations:
59982         type: array
59983         items:
59984           $ref: "#/patchDefinitions/multicast-configuration"
59985       vces:
59986         type: array
59987         items:
59988           $ref: "#/patchDefinitions/vce"
59989       vnfcs:
59990         type: array
59991         items:
59992           $ref: "#/patchDefinitions/vnfc"
59993       l3-networks:
59994         type: array
59995         items:
59996           $ref: "#/patchDefinitions/l3-network"
59997       network-policies:
59998         type: array
59999         items:
60000           $ref: "#/patchDefinitions/network-policy"
60001       generic-vnfs:
60002         type: array
60003         items:
60004           $ref: "#/patchDefinitions/generic-vnf"
60005       lag-links:
60006         type: array
60007         items:
60008           $ref: "#/patchDefinitions/lag-link"
60009       newvces:
60010         type: array
60011         items:
60012           $ref: "#/patchDefinitions/newvce"
60013       pnfs:
60014         type: array
60015         items:
60016           $ref: "#/patchDefinitions/pnf"
60017       physical-links:
60018         type: array
60019         items:
60020           $ref: "#/patchDefinitions/physical-link"
60021       ipsec-configurations:
60022         type: array
60023         items:
60024           $ref: "#/patchDefinitions/ipsec-configuration"
60025       route-table-references:
60026         type: array
60027         items:
60028           $ref: "#/patchDefinitions/route-table-reference"
60029       instance-groups:
60030         type: array
60031         items:
60032           $ref: "#/patchDefinitions/instance-group"
60033       zones:
60034         type: array
60035         items:
60036           $ref: "#/patchDefinitions/zone"
60037       configurations:
60038         type: array
60039         items:
60040           $ref: "#/patchDefinitions/configurations"
60041   network-policies:
60042     properties:
60043       network-policy:
60044         type: array
60045         items:
60046           $ref: "#/patchDefinitions/network-policy"
60047   network-policy:
60048     description: |
60049       ###### Related Nodes
60050       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
60051       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
60052     required:
60053     - network-policy-id
60054     properties:
60055       network-policy-id:
60056         type: string
60057         description: UUID representing unique key to this instance
60058       network-policy-fqdn:
60059         type: string
60060         description: Contrail FQDN for the policy
60061       heat-stack-id:
60062         type: string
60063         description: ID for the openStack Heat instance
60064   network-profile:
60065     description: |
60066       Network profile populated by SDN-GP for SNMP
60067       ###### Related Nodes
60068       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
60069     required:
60070     - nm-profile-name
60071     properties:
60072       nm-profile-name:
60073         type: string
60074         description: Unique name of network profile.
60075       community-string:
60076         type: string
60077         description: Encrypted SNMP community string
60078   network-profiles:
60079     description: |
60080       Collection of network profiles
60081     properties:
60082       network-profile:
60083         type: array
60084         items:
60085           $ref: "#/patchDefinitions/network-profile"
60086   newvce:
60087     description: |
60088       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60089       ###### Related Nodes
60090       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
60091       - NEWVCE is DELETED when these are DELETED L-INTERFACE
60092     required:
60093     - vnf-id2
60094     - vnf-name
60095     - vnf-type
60096     properties:
60097       vnf-id2:
60098         type: string
60099         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
60100       vnf-name:
60101         type: string
60102         description: Name of VNF.
60103       vnf-name2:
60104         type: string
60105         description: Alternate name of VNF.
60106       vnf-type:
60107         type: string
60108         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.
60109       prov-status:
60110         type: string
60111         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
60112       operational-status:
60113         type: string
60114         description: Indicator for whether the resource is considered operational
60115       license-key:
60116         type: string
60117         description: OBSOLETE -  do not use
60118       ipv4-oam-address:
60119         type: string
60120         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).
60121       equipment-role:
60122         type: string
60123         description: Client should send valid enumerated value.
60124   newvces:
60125     description: |
60126       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
60127     properties:
60128       newvce:
60129         type: array
60130         items:
60131           $ref: "#/patchDefinitions/newvce"
60132   notification-event:
60133     properties:
60134       cambria.partition:
60135         type: string
60136       notification-event-header:
60137         type: object
60138         $ref: "#/patchDefinitions/notification-event-header"
60139   notification-event-header:
60140     properties:
60141       id:
60142         type: string
60143       timestamp:
60144         type: string
60145       source-name:
60146         type: string
60147       domain:
60148         type: string
60149       sequence-number:
60150         type: string
60151       severity:
60152         type: string
60153       event-type:
60154         type: string
60155       version:
60156         type: string
60157       action:
60158         type: string
60159       entity-type:
60160         type: string
60161       top-entity-type:
60162         type: string
60163       entity-link:
60164         type: string
60165       status:
60166         type: string
60167   notify:
60168     required:
60169     - event-id
60170     properties:
60171       event-id:
60172         type: string
60173       node-type:
60174         type: string
60175       event-trigger:
60176         type: string
60177       key-data:
60178         type: array
60179         items:
60180           $ref: "#/patchDefinitions/key-data"
60181       selflink:
60182         type: string
60183   oam-network:
60184     description: |
60185       OAM network, to be deprecated shortly.  Do not use for new purposes.
60186       ###### Related Nodes
60187       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
60188       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
60189       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60190     required:
60191     - network-uuid
60192     - network-name
60193     - cvlan-tag
60194     properties:
60195       network-uuid:
60196         type: string
60197         description: UUID of the network. Unique across a cloud-region
60198       network-name:
60199         type: string
60200         description: Name of the network.
60201       cvlan-tag:
60202         type: integer
60203         format: int64
60204         description: cvlan-id
60205       ipv4-oam-gateway-address:
60206         type: string
60207         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60208       ipv4-oam-gateway-address-prefix-length:
60209         type: integer
60210         format: int32
60211         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
60212   oam-networks:
60213     description: |
60214       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
60215     properties:
60216       oam-network:
60217         type: array
60218         items:
60219           $ref: "#/patchDefinitions/oam-network"
60220   operational-environment:
60221     description: |
60222       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
60223       ###### Related Nodes
60224       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60225       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
60226     required:
60227     - operational-environment-id
60228     - operational-environment-name
60229     - operational-environment-type
60230     - operational-environment-status
60231     - tenant-context
60232     - workload-context
60233     properties:
60234       operational-environment-id:
60235         type: string
60236         description: UUID of an operational environment
60237       operational-environment-name:
60238         type: string
60239         description: Operational Environment name
60240       operational-environment-type:
60241         type: string
60242         description: Operational Environment Type.
60243       operational-environment-status:
60244         type: string
60245         description: Status
60246       tenant-context:
60247         type: string
60248         description: Tenant Context.
60249       workload-context:
60250         type: string
60251         description: Workload Context.
60252   operational-environments:
60253     description: |
60254       a logical partition of the cloud which allows to have multiple environments in the production AIC.
60255     properties:
60256       operational-environment:
60257         type: array
60258         items:
60259           $ref: "#/patchDefinitions/operational-environment"
60260   overloaded-model:
60261     description: |
60262       Allows for legacy POST of old-style and new-style models
60263     required:
60264     - model-invariant-id
60265     - model-name-version-id
60266     - model-type
60267     - model-name
60268     - model-id
60269     - model-version
60270     properties:
60271       model-invariant-id:
60272         type: string
60273         description: Unique identifier corresponding to the main definition of a model in ASDC
60274       model-name-version-id:
60275         type: string
60276         description: Unique identifier corresponding to one version of a model in ASDC
60277       model-type:
60278         type: string
60279         description: Type of the model, e.g., service, resource, widget, etc.
60280       model-name:
60281         type: string
60282         description: Name of the model, which can change from version to version.
60283       model-id:
60284         type: string
60285         description: Invariant unique ID which does not change from version to version
60286       model-version:
60287         type: string
60288         description: Version
60289       model-description:
60290         type: string
60291         description: Description
60292   owning-entities:
60293     description: |
60294       Collection of owning-entities
60295     properties:
60296       owning-entity:
60297         type: array
60298         items:
60299           $ref: "#/patchDefinitions/owning-entity"
60300   owning-entity:
60301     description: |
60302       describes an owning-entity
60303       ###### Related Nodes
60304       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
60305     required:
60306     - owning-entity-id
60307     - owning-entity-name
60308     properties:
60309       owning-entity-id:
60310         type: string
60311         description: UUID of an owning entity
60312       owning-entity-name:
60313         type: string
60314         description: Owning entity name
60315   p-interface:
60316     description: |
60317       Physical interface (e.g., nic)
60318       ###### Related Nodes
60319       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
60320       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60321       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60322       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60323       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
60324       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
60325       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
60326       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
60327       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
60328       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
60329     required:
60330     - interface-name
60331     - in-maint
60332     properties:
60333       interface-name:
60334         type: string
60335         description: Name that identifies the physical interface
60336       speed-value:
60337         type: string
60338         description: Captures the numeric part of the speed
60339       speed-units:
60340         type: string
60341         description: Captures the units corresponding to the speed
60342       port-description:
60343         type: string
60344         description: Nature of the services and connectivity on this port.
60345       equipment-identifier:
60346         type: string
60347         description: CLEI or other specification for p-interface hardware.
60348       interface-role:
60349         type: string
60350         description: Role specification for p-interface hardware.
60351       interface-type:
60352         type: string
60353         description: Indicates the physical properties of the interface.
60354       prov-status:
60355         type: string
60356         description: Trigger for operational monitoring of this resource by Service Assurance systems.
60357       mac-addresss:
60358         type: string
60359         description: MAC Address of the p-interface.
60360   p-interfaces:
60361     description: |
60362       Collection of physical interfaces.
60363     properties:
60364       p-interface:
60365         type: array
60366         items:
60367           $ref: "#/patchDefinitions/p-interface"
60368   physical-link:
60369     description: |
60370       Collection of physical connections, typically between p-interfaces
60371       ###### Related Nodes
60372       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
60373     required:
60374     - link-name
60375     properties:
60376       link-name:
60377         type: string
60378         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
60379       speed-value:
60380         type: string
60381         description: Captures the numeric part of the speed
60382       speed-units:
60383         type: string
60384         description: Captures the units corresponding to the speed
60385       circuit-id:
60386         type: string
60387         description: Circuit it
60388       dual-mode:
60389         type: string
60390         description: Dual access mode (e.g., primary, secondary
60391       management-option:
60392         type: string
60393         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
60394       service-provider-name:
60395         type: string
60396         description: Name of the service Provider on this link.
60397       service-provider-bandwidth-up-value:
60398         type: integer
60399         format: int32
60400         description: Upstream Bandwidth value agreed with the service provider
60401       service-provider-bandwidth-up-units:
60402         type: string
60403         description: Units for the upstream BW value
60404       service-provider-bandwidth-down-value:
60405         type: integer
60406         format: int32
60407         description: Downstream Bandwidth value agreed with the service provider
60408       service-provider-bandwidth-down-units:
60409         type: string
60410         description: Units for downstream BW value
60411   physical-links:
60412     description: |
60413       Collection of physical connections, typically between p-interfaces
60414     properties:
60415       physical-link:
60416         type: array
60417         items:
60418           $ref: "#/patchDefinitions/physical-link"
60419   platform:
60420     description: |
60421       describes a platform
60422       ###### Related Nodes
60423       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
60424     required:
60425     - platform-name
60426     properties:
60427       platform-name:
60428         type: string
60429         description: Name of the platform
60430   platforms:
60431     description: |
60432       Collection of platforms
60433     properties:
60434       platform:
60435         type: array
60436         items:
60437           $ref: "#/patchDefinitions/platform"
60438   pnf:
60439     description: |
60440       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
60441       ###### Related Nodes
60442       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60443       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
60444       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60445       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
60446       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
60447       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
60448       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60449       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
60450       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
60451       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60452     required:
60453     - pnf-name
60454     - in-maint
60455     properties:
60456       pnf-name:
60457         type: string
60458         description: unique name of Physical Network Function.
60459       pnf-name2:
60460         type: string
60461         description: name of Physical Network Function.
60462       pnf-name2-source:
60463         type: string
60464         description: source of name2
60465       pnf-id:
60466         type: string
60467         description: id of pnf
60468       equip-type:
60469         type: string
60470         description: Equipment type.  Source of truth should define valid values.
60471       equip-vendor:
60472         type: string
60473         description: Equipment vendor.  Source of truth should define valid values.
60474       equip-model:
60475         type: string
60476         description: Equipment model.  Source of truth should define valid values.
60477       management-option:
60478         type: string
60479         description: identifier of managed by ATT or customer
60480       ipaddress-v4-oam:
60481         type: string
60482         description: ipv4-oam-address with new naming convention for IP addresses
60483       sw-version:
60484         type: string
60485         description: sw-version is the version of SW for the hosted application on the PNF.
60486       in-maint:
60487         type: boolean
60488       frame-id:
60489         type: string
60490         description: ID of the physical frame (relay rack) where pnf is installed.
60491       serial-number:
60492         type: string
60493         description: Serial number of the device
60494       ipaddress-v4-loopback-0:
60495         type: string
60496         description: IPV4 Loopback 0 address
60497       ipaddress-v6-loopback-0:
60498         type: string
60499         description: IPV6 Loopback 0 address
60500       ipaddress-v4-aim:
60501         type: string
60502         description: IPV4 AIM address
60503       ipaddress-v6-aim:
60504         type: string
60505         description: IPV6 AIM address
60506       ipaddress-v6-oam:
60507         type: string
60508         description: IPV6 OAM address
60509       inv-status:
60510         type: string
60511         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60512   pnfs:
60513     description: |
60514       Collection of Physical Network Functions.
60515     properties:
60516       pnf:
60517         type: array
60518         items:
60519           $ref: "#/patchDefinitions/pnf"
60520   port-group:
60521     description: |
60522       Used to capture the network interfaces of this VCE
60523       ###### Related Nodes
60524       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
60525       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
60526       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
60527     required:
60528     - interface-id
60529     - orchestration-status
60530     properties:
60531       interface-id:
60532         type: string
60533         description: Unique ID of the interface
60534       neutron-network-id:
60535         type: string
60536         description: Neutron network id of this Interface
60537       neutron-network-name:
60538         type: string
60539         description: Neutron network name of this Interface
60540       interface-role:
60541         type: string
60542         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
60543   port-groups:
60544     properties:
60545       port-group:
60546         type: array
60547         items:
60548           $ref: "#/patchDefinitions/port-group"
60549   project:
60550     description: |
60551       describes the project
60552       ###### Related Nodes
60553       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
60554     required:
60555     - project-name
60556     properties:
60557       project-name:
60558         type: string
60559         description: Name of the project deploying a service
60560   projects:
60561     description: |
60562       Collection of projects
60563     properties:
60564       project:
60565         type: array
60566         items:
60567           $ref: "#/patchDefinitions/project"
60568   properties:
60569     description: |
60570       Property holder for query properties or instance properties
60571     properties:
60572       property-name:
60573         type: string
60574       property-value:
60575         type: string
60576   property-constraint:
60577     description: |
60578       TBD
60579       ###### Related Nodes
60580       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60581     required:
60582     - property-constraint-uuid
60583     - constraint-type
60584     - property-name
60585     - property-value
60586     properties:
60587       property-constraint-uuid:
60588         type: string
60589       constraint-type:
60590         type: string
60591       property-name:
60592         type: string
60593       property-value:
60594         type: string
60595   property-constraints:
60596     properties:
60597       property-constraint:
60598         type: array
60599         items:
60600           $ref: "#/patchDefinitions/property-constraint"
60601   pserver:
60602     description: |
60603       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
60604       ###### Related Nodes
60605       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
60606       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
60607       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
60608       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
60609       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
60610       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
60611       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
60612       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60613       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
60614       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
60615       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
60616       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
60617       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
60618     required:
60619     - hostname
60620     - in-maint
60621     properties:
60622       hostname:
60623         type: string
60624         description: Value from executing hostname on the compute node.
60625       ptnii-equip-name:
60626         type: string
60627         description: PTNII name
60628       number-of-cpus:
60629         type: integer
60630         format: int32
60631         description: Number of cpus
60632       disk-in-gigabytes:
60633         type: integer
60634         format: int32
60635         description: Disk size, in GBs
60636       ram-in-megabytes:
60637         type: integer
60638         format: int32
60639         description: RAM size, in MBs
60640       equip-type:
60641         type: string
60642         description: Equipment type.  Source of truth should define valid values.
60643       equip-vendor:
60644         type: string
60645         description: Equipment vendor.  Source of truth should define valid values.
60646       equip-model:
60647         type: string
60648         description: Equipment model.  Source of truth should define valid values.
60649       fqdn:
60650         type: string
60651         description: Fully-qualified domain name
60652       pserver-selflink:
60653         type: string
60654         description: URL to endpoint where AAI can get more details
60655       ipv4-oam-address:
60656         type: string
60657         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
60658       serial-number:
60659         type: string
60660         description: Serial number, may be queried
60661       ipaddress-v4-loopback-0:
60662         type: string
60663         description: IPV4 Loopback 0 address
60664       ipaddress-v6-loopback-0:
60665         type: string
60666         description: IPV6 Loopback 0 address
60667       ipaddress-v4-aim:
60668         type: string
60669         description: IPV4 AIM address
60670       ipaddress-v6-aim:
60671         type: string
60672         description: IPV6 AIM address
60673       ipaddress-v6-oam:
60674         type: string
60675         description: IPV6 OAM address
60676       inv-status:
60677         type: string
60678         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
60679       pserver-id:
60680         type: string
60681         description: ID of Pserver
60682       internet-topology:
60683         type: string
60684         description: internet topology of Pserver
60685       in-maint:
60686         type: boolean
60687   pservers:
60688     description: |
60689       Collection of compute hosts.
60690     properties:
60691       pserver:
60692         type: array
60693         items:
60694           $ref: "#/patchDefinitions/pserver"
60695   query-parameters:
60696     description: |
60697       QueryParameters for performing a named-query or model query
60698     properties:
60699       named-query:
60700         type: object
60701         $ref: "#/patchDefinitions/named-query"
60702       overloaded-model:
60703         type: object
60704         $ref: "#/patchDefinitions/overloaded-model"
60705   related-lookup:
60706     description: |
60707       TBD
60708       ###### Related Nodes
60709       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
60710     required:
60711     - related-lookup-uuid
60712     - source-node-type
60713     - source-node-property
60714     - target-node-type
60715     - target-node-property
60716     properties:
60717       related-lookup-uuid:
60718         type: string
60719       source-node-type:
60720         type: string
60721       source-node-property:
60722         type: string
60723       target-node-type:
60724         type: string
60725       target-node-property:
60726         type: string
60727       property-collect-list:
60728         type: string
60729   related-lookups:
60730     properties:
60731       related-lookup:
60732         type: array
60733         items:
60734           $ref: "#/patchDefinitions/related-lookup"
60735   related-to-property:
60736     properties:
60737       property-key:
60738         type: string
60739         description: Key part of a key/value pair
60740       property-value:
60741         type: string
60742         description: Value part of a key/value pair
60743   relationship:
60744     properties:
60745       related-to:
60746         type: string
60747         description: A keyword provided by A&AI to indicate type of node.
60748       related-link:
60749         type: string
60750         description: URL to the object in A&AI.
60751       relationship-data:
60752         type: array
60753         items:
60754           $ref: "#/patchDefinitions/relationship-data"
60755       related-to-property:
60756         type: array
60757         items:
60758           $ref: "#/patchDefinitions/related-to-property"
60759   relationship-data:
60760     required:
60761     - relationship-key
60762     - relationship-value
60763     properties:
60764       relationship-key:
60765         type: string
60766         description: A keyword provided by A&AI to indicate an attribute.
60767       relationship-value:
60768         type: string
60769         description: Value of the attribute.
60770   reserved-prop-names:
60771     description: |
60772       Internal map to define some reserved properties of a vertex
60773     properties:
60774       last-mod-source-of-truth:
60775         type: string
60776       aai-node-type:
60777         type: string
60778       aai-created-ts:
60779         type: integer
60780         format: int64
60781       aai-unique-key:
60782         type: string
60783       aai-last-mod-ts:
60784         type: integer
60785         format: int64
60786       source-of-truth:
60787         type: string
60788       aai-uri:
60789         type: string
60790   response-list:
60791     description: |
60792       Response container for the results of a named-query or model query
60793     properties:
60794       inventory-response-items:
60795         type: object
60796         $ref: "#/patchDefinitions/inventory-response-items"
60797   result-data:
60798     properties:
60799       resource-type:
60800         type: string
60801         description: The specific type of node in the A&AI graph
60802       resource-link:
60803         type: string
60804         description: The URL to the specific resource
60805   route-table-reference:
60806     description: |
60807       Openstack route table reference.
60808       ###### Related Nodes
60809       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
60810     required:
60811     - route-table-reference-id
60812     - route-table-reference-fqdn
60813     properties:
60814       route-table-reference-id:
60815         type: string
60816         description: Route Table Reference id, UUID assigned to this instance.
60817       route-table-reference-fqdn:
60818         type: string
60819         description: FQDN entry in the route table.
60820   route-table-references:
60821     description: |
60822       Collection of openstack route table references
60823     properties:
60824       route-table-reference:
60825         type: array
60826         items:
60827           $ref: "#/patchDefinitions/route-table-reference"
60828   route-target:
60829     description: |
60830       Route target information
60831       ###### Related Nodes
60832       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
60833     required:
60834     - global-route-target
60835     - route-target-role
60836     properties:
60837       global-route-target:
60838         type: string
60839         description: Number used to identify an RT, globally unique in the network
60840       route-target-role:
60841         type: string
60842         description: Role assigned to this route target
60843   route-targets:
60844     description: |
60845       Collection of route target information
60846     properties:
60847       route-target:
60848         type: array
60849         items:
60850           $ref: "#/patchDefinitions/route-target"
60851   routing-instance:
60852     description: |
60853       ###### Related Nodes
60854       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
60855       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
60856       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
60857     required:
60858     - routing-instance-id
60859     properties:
60860       routing-instance-id:
60861         type: string
60862         description: Unique id of routing instance
60863       rpm-owner:
60864         type: string
60865         description: rpm owner
60866   routing-instances:
60867     description: |
60868       set of probes related to generic-vnf routing instance
60869     properties:
60870       routing-instance:
60871         type: array
60872         items:
60873           $ref: "#/patchDefinitions/routing-instance"
60874   sdn-zone-response:
60875     properties:
60876       oam-networks:
60877         type: object
60878         $ref: "#/patchDefinitions/oam-networks"
60879       az-and-dvs-switches:
60880         type: array
60881         items:
60882           $ref: "#/patchDefinitions/az-and-dvs-switches"
60883   search:
60884     properties:
60885       edge-tag-query-result:
60886         type: object
60887         $ref: "#/patchDefinitions/edge-tag-query-result"
60888       edge-tag-query-request:
60889         type: object
60890         $ref: "#/patchDefinitions/edge-tag-query-request"
60891       search-results:
60892         type: object
60893         $ref: "#/patchDefinitions/search-results"
60894       sdn-zone-response:
60895         type: object
60896         $ref: "#/patchDefinitions/sdn-zone-response"
60897   search-results:
60898     properties:
60899       result-data:
60900         type: array
60901         items:
60902           $ref: "#/patchDefinitions/result-data"
60903   secondary-filt:
60904     description: |
60905       SecondaryFilt for performing a named-query or model query
60906   secondary-filter:
60907     properties:
60908       property-name:
60909         type: string
60910       filter-type:
60911         type: string
60912       property-value:
60913         type: string
60914   secondary-filts:
60915     description: |
60916       SecondaryFilts for performing a named-query or model query
60917     properties:
60918       secondary-filt:
60919         type: array
60920         items:
60921           $ref: "#/patchDefinitions/secondary-filt"
60922   segmentation-assignment:
60923     description: |
60924       Openstack segmentation assignment.
60925       ###### Related Nodes
60926       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
60927     required:
60928     - segmentation-id
60929     properties:
60930       segmentation-id:
60931         type: string
60932         description: Route Table Reference id, UUID assigned to this instance.
60933   segmentation-assignments:
60934     description: |
60935       Collection of openstack segmentation assignments
60936     properties:
60937       segmentation-assignment:
60938         type: array
60939         items:
60940           $ref: "#/patchDefinitions/segmentation-assignment"
60941   service:
60942     description: |
60943       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
60944     required:
60945     - service-id
60946     - service-description
60947     properties:
60948       service-id:
60949         type: string
60950         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
60951       service-description:
60952         type: string
60953         description: Description of the service
60954       service-selflink:
60955         type: string
60956         description: URL to endpoint where AAI can get more details
60957   service-capabilities:
60958     description: |
60959       Collection of service capabilities.
60960     properties:
60961       service-capability:
60962         type: array
60963         items:
60964           $ref: "#/patchDefinitions/service-capability"
60965   service-capability:
60966     description: |
60967       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
60968       ###### Related Nodes
60969       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60970       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
60971       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
60972     required:
60973     - service-type
60974     - vnf-type
60975     properties:
60976       service-type:
60977         type: string
60978         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
60979       vnf-type:
60980         type: string
60981         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.
60982   service-design-and-creation:
60983     description: |
60984       Namespace for objects managed by ASDC
60985     properties:
60986       vnf-images:
60987         type: array
60988         items:
60989           $ref: "#/patchDefinitions/vnf-image"
60990       services:
60991         type: array
60992         items:
60993           $ref: "#/patchDefinitions/service"
60994       service-capabilities:
60995         type: array
60996         items:
60997           $ref: "#/patchDefinitions/service-capability"
60998       models:
60999         type: array
61000         items:
61001           $ref: "#/patchDefinitions/model"
61002       named-queries:
61003         type: array
61004         items:
61005           $ref: "#/patchDefinitions/named-query"
61006   service-instance:
61007     description: |
61008       Instance of a service
61009       ###### Related Nodes
61010       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
61011       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
61012       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
61013       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
61014       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
61015       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
61016       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
61017       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
61018       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61019       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
61020       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
61021       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61022       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61023       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
61024       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61025       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61026       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
61027       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61028       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
61029       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
61030       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
61031       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61032     required:
61033     - service-instance-id
61034     - service-type
61035     - service-role
61036     - created-at
61037     - updated-at
61038     - description
61039     properties:
61040       service-instance-id:
61041         type: string
61042         description: Uniquely identifies this instance of a service
61043       service-instance-name:
61044         type: string
61045         description: This field will store a name assigned to the service-instance.
61046       service-type:
61047         type: string
61048         description: String capturing type of service.
61049       service-role:
61050         type: string
61051         description: String capturing the service role.
61052       environment-context:
61053         type: string
61054         description: This field will store the environment context assigned to the service-instance.
61055       workload-context:
61056         type: string
61057         description: This field will store the workload context assigned to the service-instance.
61058       created-at:
61059         type: string
61060         description: create time of Network Service.
61061       updated-at:
61062         type: string
61063         description: last update of Network Service.
61064       description:
61065         type: string
61066         description: short description for service-instance.
61067       model-invariant-id:
61068         type: string
61069         description: the ASDC model id for this resource or service model.
61070       model-version-id:
61071         type: string
61072         description: the ASDC model version for this resource or service model.
61073       persona-model-version:
61074         type: string
61075         description: the ASDC model version for this resource or service model.
61076       widget-model-id:
61077         type: string
61078         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
61079       widget-model-version:
61080         type: string
61081         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
61082       bandwidth-total:
61083         type: string
61084         description: Indicates the total bandwidth to be used for this service.
61085       bandwidth-up-wan1:
61086         type: string
61087         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
61088       bandwidth-down-wan1:
61089         type: string
61090         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
61091       bandwidth-up-wan2:
61092         type: string
61093         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
61094       bandwidth-down-wan2:
61095         type: string
61096         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
61097       vhn-portal-url:
61098         type: string
61099         description: URL customers will use to access the vHN Portal.
61100       service-instance-location-id:
61101         type: string
61102         description: An identifier that customers assign to the location where this service is being used.
61103   service-instances:
61104     description: |
61105       Collection of service instances
61106     properties:
61107       service-instance:
61108         type: array
61109         items:
61110           $ref: "#/patchDefinitions/service-instance"
61111   service-subscription:
61112     description: |
61113       Object that group service instances.
61114       ###### Related Nodes
61115       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
61116       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61117       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
61118       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
61119     required:
61120     - service-type
61121     properties:
61122       service-type:
61123         type: string
61124         description: Value defined by orchestration to identify this service across ECOMP.
61125       temp-ub-sub-account-id:
61126         type: string
61127         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
61128   service-subscriptions:
61129     description: |
61130       Collection of objects that group service instances.
61131     properties:
61132       service-subscription:
61133         type: array
61134         items:
61135           $ref: "#/patchDefinitions/service-subscription"
61136   services:
61137     description: |
61138       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
61139     properties:
61140       service:
61141         type: array
61142         items:
61143           $ref: "#/patchDefinitions/service"
61144   site-pair:
61145     description: |
61146       ###### Related Nodes
61147       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
61148       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
61149       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
61150     required:
61151     - site-pair-id
61152     properties:
61153       site-pair-id:
61154         type: string
61155         description: unique identifier of probe
61156       source-ip:
61157         type: string
61158         description: Prefix address
61159       destination-ip:
61160         type: string
61161         description: Prefix address
61162       ip-version:
61163         type: string
61164         description: ip version, v4, v6
61165       destination-hostname:
61166         type: string
61167         description: Hostname of the destination equipment to which SLAs are measured against.
61168       destination-equip-type:
61169         type: string
61170         description: The type of destinatination equipment. Could be Router, UCPE, etc.
61171   site-pair-set:
61172     description: |
61173       Set of instances for probes used to measure service level agreements
61174       ###### Related Nodes
61175       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
61176       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
61177       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
61178     required:
61179     - site-pair-set-id
61180     properties:
61181       site-pair-set-id:
61182         type: string
61183         description: Unique id of site pair set.
61184   site-pair-sets:
61185     description: |
61186       Collection of sets of instances for probes related to generic-vnf
61187     properties:
61188       site-pair-set:
61189         type: array
61190         items:
61191           $ref: "#/patchDefinitions/site-pair-set"
61192   site-pairs:
61193     description: |
61194       probe within a set
61195     properties:
61196       site-pair:
61197         type: array
61198         items:
61199           $ref: "#/patchDefinitions/site-pair"
61200   snapshot:
61201     description: |
61202       Openstack snapshot
61203       ###### Related Nodes
61204       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61205       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
61206     required:
61207     - snapshot-id
61208     properties:
61209       snapshot-id:
61210         type: string
61211         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
61212       snapshot-name:
61213         type: string
61214         description: Snapshot name
61215       snapshot-architecture:
61216         type: string
61217         description: Operating system architecture
61218       snapshot-os-distro:
61219         type: string
61220         description: The common name of the operating system distribution in lowercase
61221       snapshot-os-version:
61222         type: string
61223         description: The operating system version as specified by the distributor.
61224       application:
61225         type: string
61226         description: The application that the image instantiates.
61227       application-vendor:
61228         type: string
61229         description: The vendor of the application.
61230       application-version:
61231         type: string
61232         description: The version of the application.
61233       snapshot-selflink:
61234         type: string
61235         description: URL to endpoint where AAI can get more details
61236       prev-snapshot-id:
61237         type: string
61238         description: This field contains the UUID of the previous snapshot (if any).
61239   snapshots:
61240     description: |
61241       Collection of openstack snapshots
61242     properties:
61243       snapshot:
61244         type: array
61245         items:
61246           $ref: "#/patchDefinitions/snapshot"
61247   sriov-pf:
61248     description: |
61249       SR-IOV Physical Function
61250       ###### Related Nodes
61251       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
61252       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
61253     required:
61254     - pf-pci-id
61255     properties:
61256       pf-pci-id:
61257         type: string
61258         description: Identifier for the sriov-pf
61259   sriov-pfs:
61260     description: |
61261       Collection of SR-IOV Physical Functions.
61262     properties:
61263       sriov-pf:
61264         type: array
61265         items:
61266           $ref: "#/patchDefinitions/sriov-pf"
61267   sriov-vf:
61268     description: |
61269       SR-IOV Virtual Function (not to be confused with virtual network function)
61270       ###### Related Nodes
61271       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
61272       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
61273     required:
61274     - pci-id
61275     properties:
61276       pci-id:
61277         type: string
61278         description: PCI ID used to identify the sriov-vf
61279       vf-vlan-filter:
61280         type: string
61281         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
61282       vf-mac-filter:
61283         type: string
61284         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
61285       vf-vlan-strip:
61286         type: boolean
61287         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
61288       vf-vlan-anti-spoof-check:
61289         type: boolean
61290         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.
61291       vf-mac-anti-spoof-check:
61292         type: boolean
61293         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.
61294       vf-mirrors:
61295         type: string
61296         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
61297       vf-broadcast-allow:
61298         type: boolean
61299         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
61300       vf-unknown-multicast-allow:
61301         type: boolean
61302         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
61303       vf-unknown-unicast-allow:
61304         type: boolean
61305         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
61306       vf-insert-stag:
61307         type: boolean
61308         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
61309       vf-link-status:
61310         type: string
61311         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
61312   sriov-vfs:
61313     description: |
61314       Collection of SR-IOV Virtual Functions.
61315     properties:
61316       sriov-vf:
61317         type: array
61318         items:
61319           $ref: "#/patchDefinitions/sriov-vf"
61320   start-node-filter:
61321     properties:
61322       property-name:
61323         type: string
61324       property-value:
61325         type: string
61326   subnet:
61327     description: |
61328       ###### Related Nodes
61329       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
61330       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61331       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
61332       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
61333       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61334       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61335       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
61336       - SUBNET is DELETED when these are DELETED HOST-ROUTE
61337     required:
61338     - subnet-id
61339     - dhcp-enabled
61340     properties:
61341       subnet-id:
61342         type: string
61343         description: Subnet ID, should be UUID.
61344       subnet-name:
61345         type: string
61346         description: Name associated with the subnet.
61347       neutron-subnet-id:
61348         type: string
61349         description: Neutron id of this subnet
61350       gateway-address:
61351         type: string
61352         description: gateway ip address
61353       network-start-address:
61354         type: string
61355         description: network start address
61356       cidr-mask:
61357         type: string
61358         description: cidr mask
61359       ip-version:
61360         type: string
61361         description: ip version
61362       orchestration-status:
61363         type: string
61364         description: Orchestration status of this VNF, mastered by MSO
61365       dhcp-enabled:
61366         type: boolean
61367       dhcp-start:
61368         type: string
61369         description: the start address reserved for use by dhcp
61370       dhcp-end:
61371         type: string
61372         description: the last address reserved for use by dhcp
61373       subnet-role:
61374         type: string
61375         description: role of the subnet, referenced when assigning IPs
61376       ip-assignment-direction:
61377         type: string
61378         description: ip address assignment direction of the subnet
61379   subnets:
61380     properties:
61381       subnet:
61382         type: array
61383         items:
61384           $ref: "#/patchDefinitions/subnet"
61385   tagged-inventory-item-list:
61386     properties:
61387       inventory-item:
61388         type: array
61389         items:
61390           $ref: "#/patchDefinitions/inventory-item"
61391   tenant:
61392     description: |
61393       Openstack tenant
61394       ###### Related Nodes
61395       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61396       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
61397       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
61398       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61399       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
61400       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61401       - TENANT cannot be deleted if linked to VSERVER
61402     required:
61403     - tenant-id
61404     - tenant-name
61405     properties:
61406       tenant-id:
61407         type: string
61408         description: Unique id relative to the cloud-region.
61409       tenant-name:
61410         type: string
61411         description: Readable name of tenant
61412       tenant-context:
61413         type: string
61414         description: This field will store the tenant context.
61415   tenants:
61416     description: |
61417       Collection of openstack tenants.
61418     properties:
61419       tenant:
61420         type: array
61421         items:
61422           $ref: "#/patchDefinitions/tenant"
61423   tunnel-xconnect:
61424     description: |
61425       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
61426       ###### Related Nodes
61427       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
61428     required:
61429     - id
61430     - bandwidth-up-wan1
61431     - bandwidth-down-wan1
61432     - bandwidth-up-wan2
61433     - bandwidth-down-wan2
61434     properties:
61435       id:
61436         type: string
61437         description: Allotted Resource id UUID assigned to this instance.
61438       bandwidth-up-wan1:
61439         type: string
61440         description: The WAN uplink bandwidth for WAN1
61441       bandwidth-down-wan1:
61442         type: string
61443         description: The WAN downlink bandwidth for WAN1
61444       bandwidth-up-wan2:
61445         type: string
61446         description: The WAN uplink bandwidth for WAN2
61447       bandwidth-down-wan2:
61448         type: string
61449         description: The WAN downlink bandwidth for WAN2
61450   tunnel-xconnects:
61451     description: |
61452       This object is used to store the specific tunnel cross connect aspects of an allotted resource
61453     properties:
61454       tunnel-xconnect:
61455         type: array
61456         items:
61457           $ref: "#/patchDefinitions/tunnel-xconnect"
61458   update:
61459     description: |
61460       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
61461     required:
61462     - update-node-type
61463     properties:
61464       update-node-type:
61465         type: string
61466       update-node-key:
61467         type: array
61468         items:
61469           $ref: "#/patchDefinitions/update-node-key"
61470       update-node-uri:
61471         type: string
61472       action:
61473         type: array
61474         items:
61475           $ref: "#/patchDefinitions/action"
61476   update-node-key:
61477     properties:
61478       key-name:
61479         type: string
61480       key-value:
61481         type: string
61482   vce:
61483     description: |
61484       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
61485       ###### Related Nodes
61486       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
61487       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
61488       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61489       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61490       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61491       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
61492       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
61493       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
61494     required:
61495     - vnf-id
61496     - vnf-name
61497     - vnf-type
61498     properties:
61499       vnf-id:
61500         type: string
61501         description: Unique id of VNF.  This is unique across the graph.
61502       vnf-name:
61503         type: string
61504         description: Name of VNF.
61505       vnf-name2:
61506         type: string
61507         description: Alternate name of VNF.
61508       vnf-type:
61509         type: string
61510         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.
61511       service-id:
61512         type: string
61513         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
61514       regional-resource-zone:
61515         type: string
61516         description: Regional way of organizing pservers, source of truth should define values
61517       prov-status:
61518         type: string
61519         description: Trigger for operational monitoring of this resource by Service Assurance systems.
61520       operational-status:
61521         type: string
61522         description: Indicator for whether the resource is considered operational
61523       license-key:
61524         type: string
61525         description: OBSOLETE -  do not use
61526       equipment-role:
61527         type: string
61528         description: Network role being played by this VNF
61529       orchestration-status:
61530         type: string
61531         description: Orchestration status of this VNF, mastered by MSO
61532       heat-stack-id:
61533         type: string
61534         description: Heat stack id corresponding to this instance, managed by MSO
61535       mso-catalog-key:
61536         type: string
61537         description: Corresponds to the SDN-C catalog id used to configure this VCE
61538       vpe-id:
61539         type: string
61540         description: Unique ID of VPE connected to this VCE.
61541       v6-vce-wan-address:
61542         type: string
61543         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
61544       ipv4-oam-address:
61545         type: string
61546         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
61547   vces:
61548     description: |
61549       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
61550     properties:
61551       vce:
61552         type: array
61553         items:
61554           $ref: "#/patchDefinitions/vce"
61555   vf-module:
61556     description: |
61557       a deployment unit of VNFCs
61558       ###### Related Nodes
61559       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61560       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
61561       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61562       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61563       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61564       - VF-MODULE cannot be deleted if linked to VNFC
61565     required:
61566     - vf-module-id
61567     - is-base-vf-module
61568     properties:
61569       vf-module-id:
61570         type: string
61571         description: Unique ID of vf-module.
61572       vf-module-name:
61573         type: string
61574         description: Name of vf-module
61575       heat-stack-id:
61576         type: string
61577         description: Heat stack id corresponding to this instance.
61578       orchestration-status:
61579         type: string
61580         description: orchestration status of this vf-module, mastered by MSO
61581       is-base-vf-module:
61582         type: boolean
61583   vf-modules:
61584     description: |
61585       Collection of vf-modules, a deployment unit of VNFCs
61586     properties:
61587       vf-module:
61588         type: array
61589         items:
61590           $ref: "#/patchDefinitions/vf-module"
61591   vig-server:
61592     description: |
61593       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
61594       ###### Related Nodes
61595       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
61596     required:
61597     - vig-address-type
61598     properties:
61599       vig-address-type:
61600         type: string
61601         description: indicates whether the VIG is for AVPN or INTERNET
61602       ipaddress-v4-vig:
61603         type: string
61604         description: v4 IP of the vig server
61605       ipaddress-v6-vig:
61606         type: string
61607         description: v6 IP of the vig server
61608   vig-servers:
61609     properties:
61610       vig-server:
61611         type: array
61612         items:
61613           $ref: "#/patchDefinitions/vig-server"
61614   vip-ipv4-address-list:
61615     description: |
61616       IPv4 Address Range
61617       ###### Related Nodes
61618       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61619       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61620       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61621       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
61622     required:
61623     - vip-ipv4-address
61624     properties:
61625       vip-ipv4-address:
61626         type: string
61627         description: IP address
61628       vip-ipv4-prefix-length:
61629         type: integer
61630         format: int64
61631         description: Prefix length, 32 for single address
61632       vlan-id-inner:
61633         type: integer
61634         format: int64
61635         description: Inner VLAN tag
61636       vlan-id-outer:
61637         type: integer
61638         format: int64
61639         description: Outer VLAN tag
61640       is-floating:
61641         type: boolean
61642         description: Indicator of fixed or floating address
61643   vip-ipv6-address-list:
61644     description: |
61645       IPv6 Address Range
61646       ###### Related Nodes
61647       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61648       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61649       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
61650       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
61651     required:
61652     - vip-ipv6-address
61653     properties:
61654       vip-ipv6-address:
61655         type: string
61656         description: IP address
61657       vip-ipv6-prefix-length:
61658         type: integer
61659         format: int64
61660         description: Prefix length, 128 for single address
61661       vlan-id-inner:
61662         type: integer
61663         format: int64
61664         description: Inner VLAN tag
61665       vlan-id-outer:
61666         type: integer
61667         format: int64
61668         description: Outer VLAN tag
61669       is-floating:
61670         type: boolean
61671         description: Indicator of fixed or floating address
61672   virtual-data-center:
61673     description: |
61674       Virtual organization of cloud infrastructure elements in a data center context
61675       ###### Related Nodes
61676       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61677       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61678       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
61679     required:
61680     - vdc-id
61681     - vdc-name
61682     properties:
61683       vdc-id:
61684         type: string
61685         description: Unique ID of the vdc
61686       vdc-name:
61687         type: string
61688         description: Name of the virtual data center
61689   virtual-data-centers:
61690     description: |
61691       Virtual organization of cloud infrastructure elements in a data center context
61692     properties:
61693       virtual-data-center:
61694         type: array
61695         items:
61696           $ref: "#/patchDefinitions/virtual-data-center"
61697   vlan:
61698     description: |
61699       Definition of vlan
61700       ###### Related Nodes
61701       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
61702       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
61703       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
61704       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
61705       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
61706       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61707       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
61708       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61709       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
61710     required:
61711     - vlan-interface
61712     - in-maint
61713     - is-ip-unnumbered
61714     properties:
61715       vlan-interface:
61716         type: string
61717         description: String that identifies the interface
61718       vlan-id-inner:
61719         type: integer
61720         format: int64
61721         description: Inner VLAN tag
61722       vlan-id-outer:
61723         type: integer
61724         format: int64
61725         description: Outer VLAN tag
61726   vlans:
61727     properties:
61728       vlan:
61729         type: array
61730         items:
61731           $ref: "#/patchDefinitions/vlan"
61732   vnf:
61733     description: |
61734       Abstract vnf class
61735     required:
61736     - vnf-id
61737     properties:
61738       vnf-id:
61739         type: string
61740         description: Unique id of VNF.  This is unique across the graph.
61741   vnf-image:
61742     description: |
61743       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
61744       ###### Related Nodes
61745       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
61746       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
61747     required:
61748     - vnf-image-uuid
61749     - application
61750     - application-vendor
61751     properties:
61752       vnf-image-uuid:
61753         type: string
61754         description: Unique ID of this asset
61755       application:
61756         type: string
61757         description: The application that the image instantiates.
61758       application-vendor:
61759         type: string
61760         description: The vendor of the application.
61761       application-version:
61762         type: string
61763         description: The version of the application.
61764       selflink:
61765         type: string
61766         description: URL to endpoint where AAI can get more details
61767   vnf-images:
61768     description: |
61769       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
61770     properties:
61771       vnf-image:
61772         type: array
61773         items:
61774           $ref: "#/patchDefinitions/vnf-image"
61775   vnfc:
61776     description: |
61777       ###### Related Nodes
61778       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
61779       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
61780       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
61781       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
61782       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61783       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
61784       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61785       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
61786       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
61787     required:
61788     - vnfc-name
61789     - nfc-naming-code
61790     - nfc-function
61791     - in-maint
61792     - is-closed-loop-disabled
61793     properties:
61794       vnfc-name:
61795         type: string
61796         description: Unique ID of vnfc.
61797       nfc-naming-code:
61798         type: string
61799         description: Short code that is used in naming instances of the item being modeled
61800       nfc-function:
61801         type: string
61802         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
61803       prov-status:
61804         type: string
61805         description: prov status of this vnfc
61806       orchestration-status:
61807         type: string
61808         description: Orchestration status of this VNF, mastered by APP-C
61809       ipaddress-v4-oam-vip:
61810         type: string
61811         description: Oam V4 vip address of this vnfc
61812       in-maint:
61813         type: boolean
61814       is-closed-loop-disabled:
61815         type: boolean
61816       group-notation:
61817         type: string
61818         description: Group notation of VNFC
61819       model-invariant-id:
61820         type: string
61821         description: the ASDC model id for this resource or service model.
61822       model-version-id:
61823         type: string
61824         description: the ASDC model version for this resource or service model.
61825   vnfcs:
61826     description: |
61827       virtual network components associated with a vserver from application controller.
61828     properties:
61829       vnfc:
61830         type: array
61831         items:
61832           $ref: "#/patchDefinitions/vnfc"
61833   volume:
61834     description: |
61835       Ephemeral Block storage volume.
61836       ###### Related Nodes
61837       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
61838     required:
61839     - volume-id
61840     - volume-selflink
61841     properties:
61842       volume-id:
61843         type: string
61844         description: Unique ID of block storage volume relative to the vserver.
61845       volume-selflink:
61846         type: string
61847         description: URL to endpoint where AAI can get more details
61848   volume-group:
61849     description: |
61850       Persistent block-level storage.
61851       ###### Related Nodes
61852       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
61853       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61854       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61855       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
61856       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
61857     required:
61858     - volume-group-id
61859     - volume-group-name
61860     - vnf-type
61861     properties:
61862       volume-group-id:
61863         type: string
61864         description: Unique ID of volume-group.
61865       volume-group-name:
61866         type: string
61867         description: Name of the volume group.
61868       heat-stack-id:
61869         type: string
61870         description: Heat stack id corresponding to this volume-group
61871       vnf-type:
61872         type: string
61873         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.
61874       orchestration-status:
61875         type: string
61876         description: Orchestration status of this volume-group
61877       model-customization-id:
61878         type: string
61879         description: captures the id of all the configuration used to customize the resource for the service.
61880       vf-module-model-customization-id:
61881         type: string
61882         description: helps relate the volume group to the vf-module whose components will require the volume group
61883   volume-groups:
61884     description: |
61885       Collection of persistent block-level storage.
61886     properties:
61887       volume-group:
61888         type: array
61889         items:
61890           $ref: "#/patchDefinitions/volume-group"
61891   volumes:
61892     description: |
61893       Collection of ephemeral Block storage volumes.
61894     properties:
61895       volume:
61896         type: array
61897         items:
61898           $ref: "#/patchDefinitions/volume"
61899   vpls-pe:
61900     description: |
61901       VPLS Provider Edge routers.
61902       ###### Related Nodes
61903       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
61904       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
61905       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61906       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
61907       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
61908     required:
61909     - equipment-name
61910     properties:
61911       equipment-name:
61912         type: string
61913       prov-status:
61914         type: string
61915         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
61916       ipv4-oam-address:
61917         type: string
61918         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).
61919       equipment-role:
61920         type: string
61921         description: Client should send valid enumerated value, e.g., VPLS-PE.
61922       vlan-id-outer:
61923         type: integer
61924         format: int64
61925         description: Temporary location for stag to get to VCE
61926   vpls-pes:
61927     description: |
61928       Collection of VPLS Provider Edge routers
61929     properties:
61930       vpls-pe:
61931         type: array
61932         items:
61933           $ref: "#/patchDefinitions/vpls-pe"
61934   vpn-binding:
61935     description: |
61936       VPN binding
61937       ###### Related Nodes
61938       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
61939       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61940       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
61941       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
61942       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
61943       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
61944     required:
61945     - vpn-id
61946     - vpn-name
61947     properties:
61948       vpn-id:
61949         type: string
61950         description: VPN ID, globally unique within A&AI
61951       vpn-name:
61952         type: string
61953         description: VPN Name
61954       vpn-platform:
61955         type: string
61956         description: the platform associated with the VPN example AVPN, Mobility
61957       vpn-type:
61958         type: string
61959         description: Type of the vpn, should be taken from enumerated/valid values
61960       vpn-region:
61961         type: string
61962         description: region of customer vpn
61963       customer-vpn-id:
61964         type: string
61965         description: id for this customer vpn
61966       route-distinguisher:
61967         type: string
61968         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
61969   vpn-bindings:
61970     properties:
61971       vpn-binding:
61972         type: array
61973         items:
61974           $ref: "#/patchDefinitions/vpn-binding"
61975   vserver:
61976     description: |
61977       Virtual Servers, aka virtual machine or VM.
61978       ###### Related Nodes
61979       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
61980       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
61981       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
61982       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
61983       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
61984       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
61985       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
61986       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
61987       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
61988       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
61989       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
61990       - VSERVER is DELETED when these are DELETED L-INTERFACE
61991       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
61992     required:
61993     - vserver-id
61994     - vserver-name
61995     - vserver-selflink
61996     - in-maint
61997     - is-closed-loop-disabled
61998     properties:
61999       vserver-id:
62000         type: string
62001         description: Unique identifier for this vserver relative to its tenant
62002       vserver-name:
62003         type: string
62004         description: Name of vserver
62005       vserver-name2:
62006         type: string
62007         description: Alternative name of vserver
62008       prov-status:
62009         type: string
62010         description: Trigger for operational monitoring of this resource by Service Assurance systems.
62011       vserver-selflink:
62012         type: string
62013         description: URL to endpoint where AAI can get more details
62014       in-maint:
62015         type: boolean
62016       is-closed-loop-disabled:
62017         type: boolean
62018   vservers:
62019     description: |
62020       Collection of virtual Servers, aka virtual machines or VMs.
62021     properties:
62022       vserver:
62023         type: array
62024         items:
62025           $ref: "#/patchDefinitions/vserver"
62026   zone:
62027     description: |
62028       A zone is a grouping of assets in a location homing to the same connections into the CBB
62029       ###### Related Nodes
62030       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62031       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62032       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62033       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62034       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62035     required:
62036     - zone-id
62037     - zone-name
62038     - design-type
62039     - zone-context
62040     properties:
62041       zone-id:
62042         type: string
62043         description: Code assigned by AIC to the zone
62044       zone-name:
62045         type: string
62046         description: English name associated with the zone
62047       design-type:
62048         type: string
62049         description: Design of zone [Medium/Large?]
62050       zone-context:
62051         type: string
62052         description: Context of zone [production/test]
62053       status:
62054         type: string
62055         description: Status of a zone.
62056   zones:
62057     description: |
62058       Collection of zones
62059     properties:
62060       zone:
62061         type: array
62062         items:
62063           $ref: "#/patchDefinitions/zone"
62064 getDefinitions:
62065   aai-internal:
62066     properties:
62067       property-name:
62068         type: string
62069       property-value:
62070         type: string
62071   action:
62072     properties:
62073       action-type:
62074         type: string
62075       action-data:
62076         type: array
62077         items:
62078           $ref: "#/getDefinitions/action-data"
62079   action-data:
62080     properties:
62081       property-name:
62082         type: string
62083       property-value:
62084         type: string
62085   actions:
62086     description: |
62087       APIs that are more action related than REST (e.g., notify, update).
62088     properties:
62089       update:
62090         type: object
62091         $ref: "#/getDefinitions/update"
62092       notify:
62093         type: object
62094         $ref: "#/getDefinitions/notify"
62095   allotted-resource:
62096     description: |
62097       Represents a slice or partial piece of a resource that gets separately allotted
62098       ###### Related Nodes
62099       - TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
62100       - TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
62101       - TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
62102       - TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
62103       - TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
62104       - TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
62105       - TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
62106       - TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
62107       - TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
62108       - FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
62109       - FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
62110       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
62111       - FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
62112       - ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
62113     required:
62114     - id
62115     properties:
62116       id:
62117         type: string
62118         description: Allotted Resource id UUID assigned to this instance.
62119       description:
62120         type: string
62121         description: The descriptive information assigned to this allotted resource instance
62122       selflink:
62123         type: string
62124         description: Link back to more information in the controller
62125       model-invariant-id:
62126         type: string
62127         description: the ASDC model id for this resource or service model.
62128       model-version-id:
62129         type: string
62130         description: the ASDC model version for this resource or service model.
62131       persona-model-version:
62132         type: string
62133         description: the ASDC model version for this resource or service model.
62134       resource-version:
62135         type: string
62136         description: Concurrency value
62137       orchestration-status:
62138         type: string
62139         description: Orchestration status
62140       operational-status:
62141         type: string
62142         description: Indicator for whether the resource is considered operational
62143       type:
62144         type: string
62145         description: Generic description of the type of allotted resource.
62146       role:
62147         type: string
62148         description: role in the network that this resource will be providing.
62149       tunnel-xconnects:
62150         type: array
62151         items:
62152           $ref: "#/getDefinitions/tunnel-xconnect"
62153       relationship-list:
62154         type: array
62155         items:
62156           $ref: "#/getDefinitions/relationship"
62157   allotted-resources:
62158     description: |
62159       This object is used to store slices of services being offered
62160     properties:
62161       allotted-resource:
62162         type: array
62163         items:
62164           $ref: "#/getDefinitions/allotted-resource"
62165   availability-zone:
62166     description: |
62167       Availability zone, a collection of compute hosts/pservers
62168       ###### Related Nodes
62169       - TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62170       - TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
62171       - TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62172       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62173       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62174       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62175       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
62176       - FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
62177       - AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
62178     required:
62179     - availability-zone-name
62180     - hypervisor-type
62181     properties:
62182       availability-zone-name:
62183         type: string
62184         description: Name of the availability zone.  Unique across a cloud region
62185       hypervisor-type:
62186         type: string
62187         description: Type of hypervisor.  Source of truth should define valid values.
62188       operational-status:
62189         type: string
62190         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
62191       resource-version:
62192         type: string
62193         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62194       relationship-list:
62195         type: array
62196         items:
62197           $ref: "#/getDefinitions/relationship"
62198   availability-zones:
62199     description: |
62200       Collection of availability zones
62201     properties:
62202       availability-zone:
62203         type: array
62204         items:
62205           $ref: "#/getDefinitions/availability-zone"
62206   az-and-dvs-switches:
62207     properties:
62208       dvs-switches:
62209         type: object
62210         $ref: "#/getDefinitions/dvs-switches"
62211       availability-zone:
62212         type: object
62213         $ref: "#/getDefinitions/availability-zone"
62214   business:
62215     description: |
62216       Namespace for business related constructs
62217     properties:
62218       connectors:
62219         type: array
62220         items:
62221           $ref: "#/getDefinitions/connector"
62222       customers:
62223         type: array
62224         items:
62225           $ref: "#/getDefinitions/customer"
62226       lines-of-business:
62227         type: array
62228         items:
62229           $ref: "#/getDefinitions/line-of-business"
62230       owning-entities:
62231         type: array
62232         items:
62233           $ref: "#/getDefinitions/owning-entity"
62234       platforms:
62235         type: array
62236         items:
62237           $ref: "#/getDefinitions/platform"
62238       projects:
62239         type: array
62240         items:
62241           $ref: "#/getDefinitions/project"
62242   class-of-service:
62243     description: |
62244       ###### Related Nodes
62245       - TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
62246     required:
62247     - cos
62248     properties:
62249       cos:
62250         type: string
62251         description: unique identifier of probe
62252       probe-id:
62253         type: string
62254         description: identifier of probe
62255       probe-type:
62256         type: string
62257         description: type of probe
62258       resource-version:
62259         type: string
62260         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62261       relationship-list:
62262         type: array
62263         items:
62264           $ref: "#/getDefinitions/relationship"
62265   classes-of-service:
62266     description: |
62267       class-of-service of probe
62268     properties:
62269       class-of-service:
62270         type: array
62271         items:
62272           $ref: "#/getDefinitions/class-of-service"
62273   cloud-infrastructure:
62274     description: |
62275       Namespace for cloud infrastructure.
62276     properties:
62277       complexes:
62278         type: array
62279         items:
62280           $ref: "#/getDefinitions/complex"
62281       cloud-regions:
62282         type: array
62283         items:
62284           $ref: "#/getDefinitions/cloud-region"
62285       network-profiles:
62286         type: array
62287         items:
62288           $ref: "#/getDefinitions/network-profile"
62289       pservers:
62290         type: array
62291         items:
62292           $ref: "#/getDefinitions/pserver"
62293       virtual-data-centers:
62294         type: array
62295         items:
62296           $ref: "#/getDefinitions/virtual-data-center"
62297   cloud-region:
62298     description: |
62299       cloud-region designates an installation of a cloud cluster or region or instantiation.
62300       ###### Related Nodes
62301       - TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
62302       - TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62303       - TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62304       - TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
62305       - FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62306       - FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62307       - FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62308       - FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62309       - FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62310       - FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62311       - FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62312       - FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62313       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62314       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62315       - FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62316       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
62317       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
62318       - CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
62319       - CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
62320       - CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
62321     required:
62322     - cloud-owner
62323     - cloud-region-id
62324     - sriov-automation
62325     properties:
62326       cloud-owner:
62327         type: string
62328         description: Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
62329       cloud-region-id:
62330         type: string
62331         description: Identifier used by the vendor for the region. Second part of composite key
62332       cloud-type:
62333         type: string
62334         description: Type of the cloud (e.g., openstack)
62335       owner-defined-type:
62336         type: string
62337         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
62338       cloud-region-version:
62339         type: string
62340         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
62341       identity-url:
62342         type: string
62343         description: URL of the keystone identity service
62344       cloud-zone:
62345         type: string
62346         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
62347       complex-name:
62348         type: string
62349         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
62350       sriov-automation:
62351         type: boolean
62352       cloud-extra-info:
62353         type: string
62354         description: ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
62355       cloud-epa-caps:
62356         type: string
62357         description: MultiVIM will discover and expose EPA capabilities.
62358       resource-version:
62359         type: string
62360         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62361       volume-groups:
62362         type: array
62363         items:
62364           $ref: "#/getDefinitions/volume-group"
62365       tenants:
62366         type: array
62367         items:
62368           $ref: "#/getDefinitions/tenant"
62369       flavors:
62370         type: array
62371         items:
62372           $ref: "#/getDefinitions/flavor"
62373       group-assignments:
62374         type: array
62375         items:
62376           $ref: "#/getDefinitions/group-assignment"
62377       snapshots:
62378         type: array
62379         items:
62380           $ref: "#/getDefinitions/snapshot"
62381       images:
62382         type: array
62383         items:
62384           $ref: "#/getDefinitions/image"
62385       dvs-switches:
62386         type: array
62387         items:
62388           $ref: "#/getDefinitions/dvs-switch"
62389       oam-networks:
62390         type: array
62391         items:
62392           $ref: "#/getDefinitions/oam-network"
62393       availability-zones:
62394         type: array
62395         items:
62396           $ref: "#/getDefinitions/availability-zone"
62397       relationship-list:
62398         type: array
62399         items:
62400           $ref: "#/getDefinitions/relationship"
62401       esr-system-info-list:
62402         type: array
62403         items:
62404           $ref: "#/getDefinitions/esr-system-info"
62405       vip-ipv4-address-list:
62406         type: array
62407         items:
62408           $ref: "#/getDefinitions/vip-ipv4-address-list"
62409       vip-ipv6-address-list:
62410         type: array
62411         items:
62412           $ref: "#/getDefinitions/vip-ipv6-address-list"
62413   cloud-regions:
62414     properties:
62415       cloud-region:
62416         type: array
62417         items:
62418           $ref: "#/getDefinitions/cloud-region"
62419   complex:
62420     description: |
62421       Collection of physical locations that can house cloud-regions.
62422       ###### Related Nodes
62423       - TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
62424       - FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62425       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62426       - FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
62427       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62428       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
62429       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62430       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62431       - FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
62432       - FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62433       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62434       - FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
62435       - COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
62436       - COMPLEX is DELETED when these are DELETED CTAG-POOL
62437     required:
62438     - physical-location-id
62439     - physical-location-type
62440     - street1
62441     - city
62442     - postal-code
62443     - country
62444     - region
62445     properties:
62446       physical-location-id:
62447         type: string
62448         description: Unique identifier for physical location, e.g., CLLI
62449       data-center-code:
62450         type: string
62451         description: Data center code which can be an alternate way to identify a complex
62452       complex-name:
62453         type: string
62454         description: Gamma complex name for LCP instance.
62455       identity-url:
62456         type: string
62457         description: URL of the keystone identity service
62458       resource-version:
62459         type: string
62460         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62461       physical-location-type:
62462         type: string
62463         description: Type, e.g., central office, data center.
62464       street1:
62465         type: string
62466       street2:
62467         type: string
62468       city:
62469         type: string
62470       state:
62471         type: string
62472       postal-code:
62473         type: string
62474       country:
62475         type: string
62476       region:
62477         type: string
62478       latitude:
62479         type: string
62480       longitude:
62481         type: string
62482       elevation:
62483         type: string
62484       lata:
62485         type: string
62486       ctag-pools:
62487         type: array
62488         items:
62489           $ref: "#/getDefinitions/ctag-pool"
62490       relationship-list:
62491         type: array
62492         items:
62493           $ref: "#/getDefinitions/relationship"
62494   complexes:
62495     description: |
62496       Collection of physical locations that can house cloud-regions.
62497     properties:
62498       complex:
62499         type: array
62500         items:
62501           $ref: "#/getDefinitions/complex"
62502   configuration:
62503     description: |
62504       Port Mirror Configuration.
62505       ###### Related Nodes
62506       - TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
62507       - TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
62508       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
62509       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
62510       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
62511       - CONFIGURATION is DELETED when these are DELETED METADATUM
62512       - CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
62513     required:
62514     - configuration-id
62515     - configuration-type
62516     - configuration-sub-type
62517     - orchestration-status
62518     - operational-status
62519     - configuration-selflink
62520     - model-customization-id
62521     properties:
62522       configuration-id:
62523         type: string
62524         description: UUID assigned to configuration.
62525       management-option:
62526         type: string
62527         description: Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
62528       configuration-name:
62529         type: string
62530         description: Name of the configuration.
62531       configuration-type:
62532         type: string
62533         description: port-mirroring-configuration.
62534       configuration-sub-type:
62535         type: string
62536         description: vprobe, pprobe.
62537       model-invariant-id:
62538         type: string
62539         description: the ASDC model id for this resource or service model.
62540       model-version-id:
62541         type: string
62542         description: the ASDC model version for this resource or service model.
62543       orchestration-status:
62544         type: string
62545         description: Orchestration status of the configuration.
62546       operational-status:
62547         type: string
62548         description: Indicator for whether the resource is considered operational.
62549       configuration-selflink:
62550         type: string
62551         description: URL to endpoint where AAI can get more details from SDN-GC.
62552       model-customization-id:
62553         type: string
62554         description: id of  the configuration used to customize the resource
62555       resource-version:
62556         type: string
62557         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62558       relationship-list:
62559         type: array
62560         items:
62561           $ref: "#/getDefinitions/relationship"
62562       metadata:
62563         type: array
62564         items:
62565           $ref: "#/getDefinitions/metadatum"
62566   configurations:
62567     description: |
62568       Collection of configurations
62569     properties:
62570       configuration:
62571         type: array
62572         items:
62573           $ref: "#/getDefinitions/configuration"
62574   connector:
62575     description: |
62576       Collection of resource instances used to connect a variety of disparate inventory widgets
62577       ###### Related Nodes
62578       - TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
62579       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
62580       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
62581       - CONNECTOR is DELETED when these are DELETED METADATUM
62582     required:
62583     - resource-instance-id
62584     properties:
62585       resource-instance-id:
62586         type: string
62587         description: Unique id of resource instance.
62588       resource-version:
62589         type: string
62590         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62591       model-invariant-id:
62592         type: string
62593         description: the ASDC model id for this resource or service model.
62594       model-version-id:
62595         type: string
62596         description: the ASDC model version for this resource or service model.
62597       persona-model-version:
62598         type: string
62599         description: the ASDC model version for this resource or service model.
62600       widget-model-id:
62601         type: string
62602         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
62603       widget-model-version:
62604         type: string
62605         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
62606       relationship-list:
62607         type: array
62608         items:
62609           $ref: "#/getDefinitions/relationship"
62610       metadata:
62611         type: array
62612         items:
62613           $ref: "#/getDefinitions/metadatum"
62614   connectors:
62615     description: |
62616       Collection of resource instances used to connect a variety of disparate inventory widgets
62617     properties:
62618       connector:
62619         type: array
62620         items:
62621           $ref: "#/getDefinitions/connector"
62622   constrained-element-set:
62623     description: |
62624       This is how we would capture constraints defining allowed sets of elements.
62625       ###### Related Nodes
62626       - TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
62627       - TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
62628       - FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
62629       - CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
62630     required:
62631     - constrained-element-set-uuid
62632     - constraint-type
62633     - check-type
62634     properties:
62635       constrained-element-set-uuid:
62636         type: string
62637       constraint-type:
62638         type: string
62639       check-type:
62640         type: string
62641       resource-version:
62642         type: string
62643       element-choice-sets:
62644         type: array
62645         items:
62646           $ref: "#/getDefinitions/element-choice-set"
62647       relationship-list:
62648         type: array
62649         items:
62650           $ref: "#/getDefinitions/relationship"
62651   constrained-element-sets:
62652     properties:
62653       constrained-element-set:
62654         type: array
62655         items:
62656           $ref: "#/getDefinitions/constrained-element-set"
62657   ctag-assignment:
62658     description: |
62659       ###### Related Nodes
62660       - TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
62661       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
62662     required:
62663     - vlan-id-inner
62664     properties:
62665       vlan-id-inner:
62666         type: integer
62667         format: int64
62668         description: id.
62669       resource-version:
62670         type: string
62671         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62672       relationship-list:
62673         type: array
62674         items:
62675           $ref: "#/getDefinitions/relationship"
62676   ctag-assignments:
62677     properties:
62678       ctag-assignment:
62679         type: array
62680         items:
62681           $ref: "#/getDefinitions/ctag-assignment"
62682   ctag-pool:
62683     description: |
62684       A collection of C tags (vlan tags) grouped for a specific purpose.
62685       ###### Related Nodes
62686       - TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
62687       - TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62688       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62689       - FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
62690     required:
62691     - target-pe
62692     - availability-zone-name
62693     - ctag-pool-purpose
62694     properties:
62695       target-pe:
62696         type: string
62697         description: The Target provider edge router
62698       availability-zone-name:
62699         type: string
62700         description: Name of the availability zone
62701       ctag-pool-purpose:
62702         type: string
62703         description: Describes what the intended purpose of this pool is.
62704       ctag-values:
62705         type: string
62706         description: Comma separated list of ctags
62707       resource-version:
62708         type: string
62709         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62710       relationship-list:
62711         type: array
62712         items:
62713           $ref: "#/getDefinitions/relationship"
62714   ctag-pools:
62715     properties:
62716       ctag-pool:
62717         type: array
62718         items:
62719           $ref: "#/getDefinitions/ctag-pool"
62720   customer:
62721     description: |
62722       customer identifiers to provide linkage back to BSS information.
62723       ###### Related Nodes
62724       - FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
62725       - CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
62726     required:
62727     - global-customer-id
62728     - subscriber-name
62729     - subscriber-type
62730     properties:
62731       global-customer-id:
62732         type: string
62733         description: Global customer id used across ECOMP to uniquely identify customer.
62734       subscriber-name:
62735         type: string
62736         description: Subscriber name, an alternate way to retrieve a customer.
62737       subscriber-type:
62738         type: string
62739         description: Subscriber type, a way to provide VID with only the INFRA customers.
62740       resource-version:
62741         type: string
62742         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62743       service-subscriptions:
62744         type: array
62745         items:
62746           $ref: "#/getDefinitions/service-subscription"
62747       relationship-list:
62748         type: array
62749         items:
62750           $ref: "#/getDefinitions/relationship"
62751   customers:
62752     description: |
62753       Collection of customer identifiers to provide linkage back to BSS information.
62754     properties:
62755       customer:
62756         type: array
62757         items:
62758           $ref: "#/getDefinitions/customer"
62759   cvlan-tag-entry:
62760     required:
62761     - cvlan-tag
62762     properties:
62763       cvlan-tag:
62764         type: integer
62765         format: int64
62766         description: See mis-na-virtualization-platform.yang
62767       resource-version:
62768         type: string
62769         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62770       relationship-list:
62771         type: array
62772         items:
62773           $ref: "#/getDefinitions/relationship"
62774   cvlan-tags:
62775     properties:
62776       cvlan-tag-entry:
62777         type: array
62778         items:
62779           $ref: "#/getDefinitions/cvlan-tag-entry"
62780   dvs-switch:
62781     description: |
62782       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.
62783       ###### Related Nodes
62784       - TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
62785       - TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
62786     required:
62787     - switch-name
62788     - vcenter-url
62789     properties:
62790       switch-name:
62791         type: string
62792         description: DVS switch name
62793       vcenter-url:
62794         type: string
62795         description: URL used to reach the vcenter
62796       resource-version:
62797         type: string
62798         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62799       relationship-list:
62800         type: array
62801         items:
62802           $ref: "#/getDefinitions/relationship"
62803   dvs-switches:
62804     description: |
62805       Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
62806     properties:
62807       dvs-switch:
62808         type: array
62809         items:
62810           $ref: "#/getDefinitions/dvs-switch"
62811   edge-prop-names:
62812     description: |
62813       Internal map to define the properties of an edge and interpret the map EdgeRules
62814     properties:
62815       edgeLabel:
62816         type: string
62817       direction:
62818         type: string
62819       multiplicityRule:
62820         type: string
62821       contains-other-v:
62822         type: string
62823       delete-other-v:
62824         type: string
62825       SVC-INFRA:
62826         type: string
62827       prevent-delete:
62828         type: string
62829   edge-tag-query-request:
62830     properties:
62831       edge-tag:
62832         type: string
62833       result-detail:
62834         type: string
62835       start-node-type:
62836         type: string
62837       start-node-filter:
62838         type: array
62839         items:
62840           $ref: "#/getDefinitions/start-node-filter"
62841       include-node-filter:
62842         type: array
62843         items:
62844           $ref: "#/getDefinitions/include-node-filter"
62845       secondary-filter:
62846         type: array
62847         items:
62848           $ref: "#/getDefinitions/secondary-filter"
62849   edge-tag-query-result:
62850     properties:
62851       tagged-inventory-item-list:
62852         type: array
62853         items:
62854           $ref: "#/getDefinitions/tagged-inventory-item-list"
62855   element-choice-set:
62856     description: |
62857       This is how we would capture constraints defining allowed sets of elements.
62858       ###### Related Nodes
62859       - TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
62860       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
62861       - ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
62862     required:
62863     - element-choice-set-uuid
62864     - element-choice-set-name
62865     properties:
62866       element-choice-set-uuid:
62867         type: string
62868       element-choice-set-name:
62869         type: string
62870       cardinality:
62871         type: string
62872       resource-version:
62873         type: string
62874       model-elements:
62875         type: array
62876         items:
62877           $ref: "#/getDefinitions/model-element"
62878       relationship-list:
62879         type: array
62880         items:
62881           $ref: "#/getDefinitions/relationship"
62882   element-choice-sets:
62883     properties:
62884       element-choice-set:
62885         type: array
62886         items:
62887           $ref: "#/getDefinitions/element-choice-set"
62888   entitlement:
62889     description: |
62890       Metadata for entitlement group.
62891       ###### Related Nodes
62892       - TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
62893       - TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
62894     required:
62895     - group-uuid
62896     - resource-uuid
62897     properties:
62898       group-uuid:
62899         type: string
62900         description: Unique ID for the entitlement group the resource comes from, should be uuid.
62901       resource-uuid:
62902         type: string
62903         description: Unique ID of an entitlement resource.
62904       resource-version:
62905         type: string
62906         description: Concurrency value
62907       relationship-list:
62908         type: array
62909         items:
62910           $ref: "#/getDefinitions/relationship"
62911   entitlements:
62912     description: |
62913       Entitlements, keyed by group-uuid and resource-uuid, related to license management
62914     properties:
62915       entitlement:
62916         type: array
62917         items:
62918           $ref: "#/getDefinitions/entitlement"
62919   esr-ems:
62920     description: |
62921       Persist EMS address information used by EMS driver.
62922       ###### Related Nodes
62923       - TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
62924       - ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
62925     required:
62926     - ems-id
62927     properties:
62928       ems-id:
62929         type: string
62930         description: Unique ID of EMS.
62931       resource-version:
62932         type: string
62933         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
62934       esr-system-info-list:
62935         type: object
62936         $ref: "#/getDefinitions/esr-system-info-list"
62937       relationship-list:
62938         type: object
62939         $ref: "#/getDefinitions/relationship-list"
62940   esr-ems-list:
62941     properties:
62942       esr-ems:
62943         type: array
62944         items:
62945           $ref: "#/getDefinitions/esr-ems"
62946   esr-system-info:
62947     description: |
62948       Persist common address information of external systems.
62949       ###### Related Nodes
62950       - FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
62951       - FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
62952       - FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
62953       - FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
62954     required:
62955     - esr-system-info-id
62956     - user-name
62957     - password
62958     - system-type
62959     properties:
62960       esr-system-info-id:
62961         type: string
62962         description: Unique ID of esr system info.
62963       system-name:
62964         type: string
62965         description: name of external system.
62966       type:
62967         type: string
62968         description: type of external systems.
62969       vendor:
62970         type: string
62971         description: vendor of external systems.
62972       version:
62973         type: string
62974         description: version of external systems.
62975       service-url:
62976         type: string
62977         description: url used to access external systems.
62978       user-name:
62979         type: string
62980         description: username used to access external systems.
62981       password:
62982         type: string
62983         description: password used to access external systems.
62984       system-type:
62985         type: string
62986         description: it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
62987       protocol:
62988         type: string
62989         description: protocol of third party SDNC, for example netconf/snmp.
62990       ssl-cacert:
62991         type: string
62992         description: ca file content if enabled ssl on auth-url.
62993       ssl-insecure:
62994         type: boolean
62995         description: Whether to verify VIM's certificate.
62996       ip-address:
62997         type: string
62998         description: service IP of ftp server.
62999       port:
63000         type: string
63001         description: service port of ftp server.
63002       cloud-domain:
63003         type: string
63004         description: domain info for authentication.
63005       default-tenant:
63006         type: string
63007         description: default tenant of VIM.
63008       passive:
63009         type: boolean
63010         description: ftp passive mode or not.
63011       remote-path:
63012         type: string
63013         description: resource or performance data file path.
63014       system-status:
63015         type: string
63016         description: the status of external system.
63017       resource-version:
63018         type: string
63019         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63020       relationship-list:
63021         type: array
63022         items:
63023           $ref: "#/getDefinitions/relationship"
63024   esr-system-info-list:
63025     description: |
63026       Collection of persistent block-level external system auth info.
63027     properties:
63028       esr-system-info:
63029         type: array
63030         items:
63031           $ref: "#/getDefinitions/esr-system-info"
63032   esr-thirdparty-sdnc:
63033     description: |
63034       Persist SDNC address information used by ONAP SDNC.
63035       ###### Related Nodes
63036       - TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
63037       - TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
63038       - ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63039     required:
63040     - thirdparty-sdnc-id
63041     properties:
63042       thirdparty-sdnc-id:
63043         type: string
63044         description: Unique ID of SDNC.
63045       location:
63046         type: string
63047         description: used for DC type to indicate the location of SDNC, such as Core or Edge.
63048       product-name:
63049         type: string
63050         description: password used to access SDNC server.
63051       resource-version:
63052         type: string
63053         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63054       esr-system-info-list:
63055         type: object
63056         $ref: "#/getDefinitions/esr-system-info-list"
63057       relationship-list:
63058         type: object
63059         $ref: "#/getDefinitions/relationship-list"
63060   esr-thirdparty-sdnc-list:
63061     properties:
63062       esr-thirdparty-sdnc:
63063         type: array
63064         items:
63065           $ref: "#/getDefinitions/esr-thirdparty-sdnc"
63066   esr-vnfm:
63067     description: |
63068       Persist VNFM address information used by VF-C.
63069       ###### Related Nodes
63070       - TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
63071       - ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
63072     required:
63073     - vnfm-id
63074     properties:
63075       vnfm-id:
63076         type: string
63077         description: Unique ID of VNFM.
63078       vim-id:
63079         type: string
63080         description: indecate the VIM to deploy VNF.
63081       certificate-url:
63082         type: string
63083         description: certificate url of VNFM.
63084       resource-version:
63085         type: string
63086         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63087       esr-system-info-list:
63088         type: object
63089         $ref: "#/getDefinitions/esr-system-info-list"
63090       relationship-list:
63091         type: object
63092         $ref: "#/getDefinitions/relationship-list"
63093   esr-vnfm-list:
63094     properties:
63095       esr-vnfm:
63096         type: array
63097         items:
63098           $ref: "#/getDefinitions/esr-vnfm"
63099   evc:
63100     description: |
63101       evc object is an optional child object of the Configuration object.
63102       ###### Related Nodes
63103       - TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
63104     required:
63105     - evc-id
63106     properties:
63107       evc-id:
63108         type: string
63109         description: Unique/key field for the evc object
63110       forwarding-path-topology:
63111         type: string
63112         description: Point-to-Point, Multi-Point
63113       cir-value:
63114         type: string
63115         description: Commited Information Rate
63116       cir-units:
63117         type: string
63118         description: CIR units
63119       connection-diversity-group-id:
63120         type: string
63121         description: Diversity Group ID
63122       service-hours:
63123         type: string
63124         description: formerly Performance Group
63125       esp-evc-circuit-id:
63126         type: string
63127         description: EVC Circuit ID of ESP EVC
63128       esp-evc-cir-value:
63129         type: string
63130         description: Committed Information Rate (For ESP)
63131       esp-evc-cir-units:
63132         type: string
63133         description: CIR units (For ESP)
63134       esp-itu-code:
63135         type: string
63136         description: Identifies ESP
63137       collector-pop-clli:
63138         type: string
63139         description: Collector POP CLLI (from the hostname of the access pnf)
63140       inter-connect-type-ingress:
63141         type: string
63142         description: Interconnect type on ingress side of EVC.
63143       tagmode-access-ingress:
63144         type: string
63145         description: tagode for collector side of EVC
63146       tagmode-access-egress:
63147         type: string
63148         description: tagMode for network side of EVC
63149       relationship-list:
63150         type: array
63151         items:
63152           $ref: "#/getDefinitions/relationship"
63153       resource-version:
63154         type: string
63155         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63156   evcs:
63157     properties:
63158       evc:
63159         type: array
63160         items:
63161           $ref: "#/getDefinitions/evc"
63162   external-system:
63163     description: |
63164       Namespace for external system.
63165     properties:
63166       esr-ems-list:
63167         type: object
63168         $ref: "#/getDefinitions/esr-ems-list"
63169       esr-vnfm-list:
63170         type: object
63171         $ref: "#/getDefinitions/esr-vnfm-list"
63172       esr-thirdparty-sdnc-list:
63173         type: object
63174         $ref: "#/getDefinitions/esr-thirdparty-sdnc-list"
63175   extra-properties:
63176     description: |
63177       Extra properties for inventory item for response list
63178     properties:
63179       extra-property:
63180         type: array
63181         items:
63182           $ref: "#/getDefinitions/extra-property"
63183   extra-property:
63184     properties:
63185       property-name:
63186         type: string
63187       property-value:
63188         type: string
63189   flavor:
63190     description: |
63191       Openstack flavor.
63192       ###### Related Nodes
63193       - TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63194       - FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
63195       - FLAVOR cannot be deleted if linked to VSERVER
63196     required:
63197     - flavor-id
63198     - flavor-name
63199     - flavor-selflink
63200     properties:
63201       flavor-id:
63202         type: string
63203         description: Flavor id, expected to be unique across cloud-region.
63204       flavor-name:
63205         type: string
63206         description: Flavor name
63207       flavor-vcpus:
63208         type: integer
63209         format: int32
63210         description: Number of CPUs
63211       flavor-ram:
63212         type: integer
63213         format: int32
63214         description: Amount of memory
63215       flavor-disk:
63216         type: integer
63217         format: int32
63218         description: Disk space
63219       flavor-ephemeral:
63220         type: integer
63221         format: int32
63222         description: Amount of ephemeral disk space
63223       flavor-swap:
63224         type: string
63225         description: amount of swap space allocation
63226       flavor-is-public:
63227         type: boolean
63228         description: whether flavor is available to all users or private to the tenant it was created in.
63229       flavor-selflink:
63230         type: string
63231         description: URL to endpoint where AAI can get more details
63232       flavor-disabled:
63233         type: boolean
63234         description: Boolean as to whether this flavor is no longer enabled
63235       resource-version:
63236         type: string
63237         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63238       relationship-list:
63239         type: array
63240         items:
63241           $ref: "#/getDefinitions/relationship"
63242   flavors:
63243     description: |
63244       Collection of openstack flavors.
63245     properties:
63246       flavor:
63247         type: array
63248         items:
63249           $ref: "#/getDefinitions/flavor"
63250   forwarder:
63251     description: |
63252       Entity describing a sequenced segment of forwarding path
63253       ###### Related Nodes
63254       - TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
63255       - TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
63256       - TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
63257       - TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
63258       - TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
63259       - FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
63260     required:
63261     - sequence
63262     properties:
63263       sequence:
63264         type: integer
63265         format: int32
63266         description: Unique ID of this segmentation
63267       forwarder-role:
63268         type: string
63269         description: ingress, intermediate, egress
63270       relationship-list:
63271         type: array
63272         items:
63273           $ref: "#/getDefinitions/relationship"
63274       resource-version:
63275         type: string
63276         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63277   forwarder-evc:
63278     description: |
63279       forwarder object is an optional child object of the Configuration object.
63280       ###### Related Nodes
63281       - TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
63282     required:
63283     - forwarder-evc-id
63284     properties:
63285       forwarder-evc-id:
63286         type: string
63287         description: Key for forwarder-evc object
63288       circuit-id:
63289         type: string
63290         description: Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
63291       ivlan:
63292         type: string
63293         description: Internal VLAN.
63294       svlan:
63295         type: string
63296         description: SVLAN value for ingress of egress forwarder.
63297       cvlan:
63298         type: string
63299         description: CVLAN value for ingress of egress forwarder.
63300       relationship-list:
63301         type: array
63302         items:
63303           $ref: "#/getDefinitions/relationship"
63304       resource-version:
63305         type: string
63306         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63307   forwarder-evcs:
63308     properties:
63309       forwarder-evc:
63310         type: array
63311         items:
63312           $ref: "#/getDefinitions/forwarder-evc"
63313   forwarders:
63314     properties:
63315       forwarder:
63316         type: array
63317         items:
63318           $ref: "#/getDefinitions/forwarder"
63319   forwarding-path:
63320     description: |
63321       Entity that describes the sequenced forwarding path between interfaces of services or resources
63322       ###### Related Nodes
63323       - TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
63324       - TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
63325       - FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
63326       - FORWARDING-PATH is DELETED when these are DELETED FORWARDER
63327       - FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
63328     required:
63329     - forwarding-path-id
63330     - forwarding-path-name
63331     properties:
63332       forwarding-path-id:
63333         type: string
63334         description: Unique ID of this FP
63335       forwarding-path-name:
63336         type: string
63337         description: Name of the FP
63338       relationship-list:
63339         type: array
63340         items:
63341           $ref: "#/getDefinitions/relationship"
63342       resource-version:
63343         type: string
63344         description: Used for optimistic concurrency. Must be empty on create, valid on update and delete.
63345       selflink:
63346         type: string
63347         description: the self link for this FP
63348       forwarders:
63349         type: array
63350         items:
63351           $ref: "#/getDefinitions/forwarder"
63352   forwarding-paths:
63353     properties:
63354       forwarding-path:
63355         type: array
63356         items:
63357           $ref: "#/getDefinitions/forwarding-path"
63358   generic-vnf:
63359     description: |
63360       General purpose VNF
63361       ###### Related Nodes
63362       - TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
63363       - TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
63364       - TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
63365       - TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
63366       - TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63367       - TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
63368       - TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
63369       - TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
63370       - TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
63371       - TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
63372       - TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
63373       - TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
63374       - TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
63375       - TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
63376       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
63377       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63378       - FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63379       - FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63380       - FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63381       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63382       - FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
63383       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
63384       - FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
63385       - FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63386       - FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
63387       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
63388       - FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
63389       - GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
63390       - GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION
63391     required:
63392     - vnf-id
63393     - vnf-instance-id
63394     - vnf-name
63395     - vnf-type
63396     - vnf-package-name
63397     - vnf-discriptor-name
63398     - job-id
63399     - in-maint
63400     - is-closed-loop-disabled
63401     properties:
63402       vnf-id:
63403         type: string
63404         description: Unique id of VNF.  This is unique across the graph.
63405       vnf-instance-id:
63406         type: string
63407         description: vnf instance id.
63408       vnf-name:
63409         type: string
63410         description: Name of VNF.
63411       vnf-name2:
63412         type: string
63413         description: Alternate name of VNF.
63414       vnf-type:
63415         type: string
63416         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.
63417       service-id:
63418         type: string
63419         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
63420       regional-resource-zone:
63421         type: string
63422         description: Regional way of organizing pservers, source of truth should define values
63423       prov-status:
63424         type: string
63425         description: Trigger for operational monitoring of this resource by Service Assurance systems.
63426       operational-status:
63427         type: string
63428         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
63429       license-key:
63430         type: string
63431         description: OBSOLETE -  do not use
63432       equipment-role:
63433         type: string
63434         description: Client should send valid enumerated value
63435       orchestration-status:
63436         type: string
63437         description: Orchestration status of this VNF, used by MSO.
63438       vnf-package-name:
63439         type: string
63440       vnf-discriptor-name:
63441         type: string
63442         description: vnf discriptor name
63443       job-id:
63444         type: string
63445         description: job id corresponding to vnf
63446       heat-stack-id:
63447         type: string
63448         description: Heat stack id corresponding to this instance, managed by MSO
63449       mso-catalog-key:
63450         type: string
63451         description: Corresponds to the SDN-C catalog id used to configure this VCE
63452       management-option:
63453         type: string
63454         description: identifier of managed by ATT or customer
63455       ipv4-oam-address:
63456         type: string
63457         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
63458       ipv4-loopback0-address:
63459         type: string
63460         description: v4 Loopback0 address
63461       nm-lan-v6-address:
63462         type: string
63463         description: v6 Loopback address
63464       management-v6-address:
63465         type: string
63466         description: v6 management address
63467       vcpu:
63468         type: integer
63469         format: int64
63470         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
63471       vcpu-units:
63472         type: string
63473         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
63474       vmemory:
63475         type: integer
63476         format: int64
63477         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
63478       vmemory-units:
63479         type: string
63480         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
63481       vdisk:
63482         type: integer
63483         format: int64
63484         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
63485       vdisk-units:
63486         type: string
63487         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
63488       nshd:
63489         type: integer
63490         format: int64
63491         description: number of associated SHD in vnf.
63492       nvm:
63493         type: integer
63494         format: int64
63495         description: number of vms in vnf.
63496       nnet:
63497         type: integer
63498         format: int64
63499         description: number of network in vnf.
63500       in-maint:
63501         type: boolean
63502       is-closed-loop-disabled:
63503         type: boolean
63504       resource-version:
63505         type: string
63506         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63507       summary-status:
63508         type: string
63509         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
63510       encrypted-access-flag:
63511         type: boolean
63512         description: indicates whether generic-vnf access uses SSH
63513       entitlement-assignment-group-uuid:
63514         type: string
63515         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
63516       entitlement-resource-uuid:
63517         type: string
63518         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
63519       license-assignment-group-uuid:
63520         type: string
63521         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
63522       license-key-uuid:
63523         type: string
63524         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
63525       model-invariant-id:
63526         type: string
63527         description: the ASDC model id for this resource or service model.
63528       model-version-id:
63529         type: string
63530         description: the ASDC model version for this resource or service model.
63531       persona-model-version:
63532         type: string
63533         description: the ASDC model version for this resource or service model.
63534       model-customization-id:
63535         type: string
63536         description: captures the id of all the configuration used to customize the resource for the service.
63537       widget-model-id:
63538         type: string
63539         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
63540       widget-model-version:
63541         type: string
63542         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
63543       as-number:
63544         type: string
63545         description: as-number of the VNF
63546       regional-resource-subzone:
63547         type: string
63548         description: represents sub zone of the rr plane
63549       nf-type:
63550         type: string
63551         description: Generic description of the type of NF
63552       nf-function:
63553         type: string
63554         description: English description of Network function that the specific VNF deployment is providing
63555       nf-role:
63556         type: string
63557         description: role in the network that this model will be providing
63558       nf-naming-code:
63559         type: string
63560         description: string assigned to this model used for naming purposes
63561       selflink:
63562         type: string
63563         description: Path to the controller object.
63564       ipv4-oam-gateway-address:
63565         type: string
63566         description: Gateway address
63567       ipv4-oam-gateway-address-prefix-length:
63568         type: integer
63569         format: int32
63570         description: Prefix length for oam-address
63571       vlan-id-outer:
63572         type: integer
63573         format: int64
63574         description: Temporary location for S-TAG to get to VCE
63575       nm-profile-name:
63576         type: string
63577         description: Network Management profile of this VNF
63578       relationship-list:
63579         type: array
63580         items:
63581           $ref: "#/getDefinitions/relationship"
63582       l-interfaces:
63583         type: array
63584         items:
63585           $ref: "#/getDefinitions/l-interface"
63586       lag-interfaces:
63587         type: array
63588         items:
63589           $ref: "#/getDefinitions/lag-interface"
63590       vf-modules:
63591         type: array
63592         items:
63593           $ref: "#/getDefinitions/vf-module"
63594       licenses:
63595         type: array
63596         items:
63597           $ref: "#/getDefinitions/license"
63598       entitlements:
63599         type: array
63600         items:
63601           $ref: "#/getDefinitions/entitlement"
63602   generic-vnfs:
63603     description: |
63604       Collection of VNFs
63605     properties:
63606       generic-vnf:
63607         type: array
63608         items:
63609           $ref: "#/getDefinitions/generic-vnf"
63610   group-assignment:
63611     description: |
63612       Openstack group-assignment used to store exclusivity groups (EG).
63613       ###### Related Nodes
63614       - TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63615       - FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
63616       - FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
63617     required:
63618     - group-id
63619     - group-type
63620     - group-name
63621     properties:
63622       group-id:
63623         type: string
63624         description: Group id, expected to be unique across cloud-region.
63625       group-type:
63626         type: string
63627         description: Group type - the type of group this instance refers to
63628       group-name:
63629         type: string
63630         description: Group name - name assigned to the group
63631       group-description:
63632         type: string
63633         description: Group description - description of the group
63634       resource-version:
63635         type: string
63636         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63637       relationship-list:
63638         type: array
63639         items:
63640           $ref: "#/getDefinitions/relationship"
63641   group-assignments:
63642     description: |
63643       Collection of openstack group assignments
63644     properties:
63645       group-assignment:
63646         type: array
63647         items:
63648           $ref: "#/getDefinitions/group-assignment"
63649   host-route:
63650     description: |
63651       ###### Related Nodes
63652       - TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
63653     required:
63654     - host-route-id
63655     - route-prefix
63656     - next-hop
63657     properties:
63658       host-route-id:
63659         type: string
63660         description: host-route id
63661       route-prefix:
63662         type: string
63663         description: subnet prefix
63664       next-hop:
63665         type: string
63666         description: Could be ip-address, hostname, or service-instance
63667       next-hop-type:
63668         type: string
63669         description: Should be ip-address, hostname, or service-instance to match next-hop
63670       resource-version:
63671         type: string
63672         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63673       relationship-list:
63674         type: array
63675         items:
63676           $ref: "#/getDefinitions/relationship"
63677   host-routes:
63678     properties:
63679       host-route:
63680         type: array
63681         items:
63682           $ref: "#/getDefinitions/host-route"
63683   image:
63684     description: |
63685       Openstack image.
63686       ###### Related Nodes
63687       - TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
63688       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
63689       - FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
63690       - IMAGE cannot be deleted if linked to VSERVER
63691       - IMAGE is DELETED when these are DELETED METADATUM
63692     required:
63693     - image-id
63694     - image-name
63695     - image-os-distro
63696     - image-os-version
63697     - image-selflink
63698     properties:
63699       image-id:
63700         type: string
63701         description: Image id, expected to be unique across cloud region
63702       image-name:
63703         type: string
63704         description: Image name
63705       image-architecture:
63706         type: string
63707         description: Operating system architecture.
63708       image-os-distro:
63709         type: string
63710         description: The common name of the operating system distribution in lowercase
63711       image-os-version:
63712         type: string
63713         description: The operating system version as specified by the distributor.
63714       application:
63715         type: string
63716         description: The application that the image instantiates.
63717       application-vendor:
63718         type: string
63719         description: The vendor of the application.
63720       application-version:
63721         type: string
63722         description: The version of the application.
63723       image-selflink:
63724         type: string
63725         description: URL to endpoint where AAI can get more details
63726       resource-version:
63727         type: string
63728         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63729       relationship-list:
63730         type: array
63731         items:
63732           $ref: "#/getDefinitions/relationship"
63733       metadata:
63734         type: array
63735         items:
63736           $ref: "#/getDefinitions/metadatum"
63737   images:
63738     description: |
63739       Collectio of Openstack images.
63740     properties:
63741       image:
63742         type: array
63743         items:
63744           $ref: "#/getDefinitions/image"
63745   include-node-filter:
63746     properties:
63747       include-node-type:
63748         type: string
63749   instance-filter:
63750     description: |
63751       InstanceFilter for performing a named-query or model query
63752   instance-filters:
63753     description: |
63754       InstanceFilters for performing a named-query or model query
63755     properties:
63756       instance-filter:
63757         type: array
63758         items:
63759           $ref: "#/getDefinitions/instance-filter"
63760   instance-group:
63761     description: |
63762       General mechanism for grouping instances
63763       ###### Related Nodes
63764       - TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
63765       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63766       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63767       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
63768       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
63769       - FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63770       - FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63771       - FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63772       - FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63773       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63774       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63775       - FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63776     required:
63777     - instance-group-role
63778     - model-invariant-id
63779     - model-version-id
63780     - id
63781     - description
63782     - type
63783     properties:
63784       instance-group-role:
63785         type: string
63786         description: role of the instance group.
63787       model-invariant-id:
63788         type: string
63789         description: ASDC model id for this resource or service model.
63790       model-version-id:
63791         type: string
63792         description: ASDC model version uid for this resource model.
63793       id:
63794         type: string
63795         description: Instance Group ID, UUID assigned to this instance.
63796       description:
63797         type: string
63798         description: Descriptive text to help identify the usage of this instance-group
63799       type:
63800         type: string
63801         description: Only valid value today is lower case ha for high availability
63802       sub-type:
63803         type: string
63804         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
63805       resource-version:
63806         type: string
63807         description: Concurrency value
63808       relationship-list:
63809         type: array
63810         items:
63811           $ref: "#/getDefinitions/relationship"
63812   instance-groups:
63813     description: |
63814       Collection of openstack route table references
63815     properties:
63816       instance-group:
63817         type: array
63818         items:
63819           $ref: "#/getDefinitions/instance-group"
63820   inventory:
63821     properties:
63822       search:
63823         type: object
63824         $ref: "#/getDefinitions/search"
63825       actions:
63826         type: object
63827         $ref: "#/getDefinitions/actions"
63828       cloud-infrastructure:
63829         type: object
63830         $ref: "#/getDefinitions/cloud-infrastructure"
63831       external-system:
63832         type: object
63833         $ref: "#/getDefinitions/external-system"
63834       business:
63835         type: object
63836         $ref: "#/getDefinitions/business"
63837       service-design-and-creation:
63838         type: object
63839         $ref: "#/getDefinitions/service-design-and-creation"
63840       network:
63841         type: object
63842         $ref: "#/getDefinitions/network"
63843       aai-internal:
63844         type: object
63845         $ref: "#/getDefinitions/aai-internal"
63846       nodes:
63847         type: array
63848         items:
63849           $ref: "#/getDefinitions/aai-internal"
63850   inventory-item:
63851     properties:
63852       inventory-item-type:
63853         type: string
63854       inventory-item-link:
63855         type: string
63856       inventory-item-data:
63857         type: array
63858         items:
63859           $ref: "#/getDefinitions/inventory-item-data"
63860       tagged-inventory-item-list:
63861         type: array
63862         items:
63863           $ref: "#/getDefinitions/tagged-inventory-item-list"
63864   inventory-item-data:
63865     properties:
63866       property-name:
63867         type: string
63868       property-value:
63869         type: string
63870   inventory-response-item:
63871     description: |
63872       Inventory item for response list
63873     properties:
63874       model-name:
63875         type: string
63876       extra-properties:
63877         type: object
63878         $ref: "#/getDefinitions/extra-properties"
63879       inventory-response-items:
63880         type: object
63881         $ref: "#/getDefinitions/inventory-response-items"
63882   inventory-response-items:
63883     description: |
63884       Container for inventory items in response list
63885     properties:
63886       inventory-response-item:
63887         type: array
63888         items:
63889           $ref: "#/getDefinitions/inventory-response-item"
63890   ipsec-configuration:
63891     description: |
63892       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
63893       ###### Related Nodes
63894       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
63895       - FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
63896       - IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
63897     required:
63898     - ipsec-configuration-id
63899     properties:
63900       ipsec-configuration-id:
63901         type: string
63902         description: UUID of this configuration
63903       requested-vig-address-type:
63904         type: string
63905         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
63906       requested-encryption-strength:
63907         type: string
63908         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
63909       requested-dmz-type:
63910         type: string
63911         description: ATT can offer a shared DMZ or a DMZ specific to a customer
63912       shared-dmz-network-address:
63913         type: string
63914         description: Network address of shared DMZ
63915       requested-customer-name:
63916         type: string
63917         description: If the DMZ is a custom DMZ, this field will indicate the customer information
63918       ike-version:
63919         type: string
63920         description: can be 1 or 2
63921       ikev1-authentication:
63922         type: string
63923         description: Contains values like md5, sha1, sha256, sha384
63924       ikev1-encryption:
63925         type: string
63926         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
63927       ikev1-dh-group:
63928         type: string
63929         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
63930       ikev1-am-group-id:
63931         type: string
63932         description: Group name defined in VIG for clients using aggressive mode
63933       ikev1-am-password:
63934         type: string
63935         description: pre-shared key for the above group name
63936       ikev1-sa-lifetime:
63937         type: string
63938         description: Lifetime for IKEv1 SA
63939       ipsec-authentication:
63940         type: string
63941         description: md5, sha1, sha256, sha384
63942       ipsec-encryption:
63943         type: string
63944         description: 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
63945       ipsec-sa-lifetime:
63946         type: string
63947         description: Life time for IPSec SA
63948       ipsec-pfs:
63949         type: string
63950         description: enable PFS or not
63951       xauth-userid:
63952         type: string
63953         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
63954       xauth-user-password:
63955         type: string
63956         description: Encrypted using the Juniper $9$ algorithm
63957       dpd-interval:
63958         type: string
63959         description: The time between DPD probe
63960       dpd-frequency:
63961         type: string
63962         description: Maximum number of DPD before claiming the tunnel is down
63963       resource-version:
63964         type: string
63965         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
63966       relationship-list:
63967         type: array
63968         items:
63969           $ref: "#/getDefinitions/relationship"
63970       vig-servers:
63971         type: array
63972         items:
63973           $ref: "#/getDefinitions/vig-server"
63974   ipsec-configurations:
63975     properties:
63976       ipsec-configuration:
63977         type: array
63978         items:
63979           $ref: "#/getDefinitions/ipsec-configuration"
63980   key-data:
63981     properties:
63982       key-name:
63983         type: string
63984       key-value:
63985         type: string
63986   l-interface:
63987     description: |
63988       Logical interfaces, e.g., a vnic.
63989       ###### Related Nodes
63990       - TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
63991       - TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
63992       - TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
63993       - TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
63994       - TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
63995       - TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
63996       - TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
63997       - TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
63998       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
63999       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64000       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64001       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
64002       - FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
64003       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64004       - L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
64005       - L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
64006     required:
64007     - interface-name
64008     - is-port-mirrored
64009     - in-maint
64010     - is-ip-unnumbered
64011     properties:
64012       interface-name:
64013         type: string
64014         description: Name given to the interface
64015       interface-role:
64016         type: string
64017         description: E.g., CUSTOMER, UPLINK, etc.
64018       v6-wan-link-ip:
64019         type: string
64020         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
64021       selflink:
64022         type: string
64023         description: URL to endpoint where AAI can get more details
64024       interface-id:
64025         type: string
64026         description: ID of interface
64027       macaddr:
64028         type: string
64029         description: MAC address for the interface
64030       network-name:
64031         type: string
64032         description: Name of the network
64033       management-option:
64034         type: string
64035         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
64036       interface-description:
64037         type: string
64038         description: Human friendly text regarding this interface.
64039       is-port-mirrored:
64040         type: boolean
64041       resource-version:
64042         type: string
64043         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64044       in-maint:
64045         type: boolean
64046       prov-status:
64047         type: string
64048         description: Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
64049       is-ip-unnumbered:
64050         type: boolean
64051       allowed-address-pairs:
64052         type: string
64053         description: Freeform field for storing an ip address, list of ip addresses or a subnet block.
64054       vlans:
64055         type: array
64056         items:
64057           $ref: "#/getDefinitions/vlan"
64058       sriov-vfs:
64059         type: array
64060         items:
64061           $ref: "#/getDefinitions/sriov-vf"
64062       l-interfaces:
64063         type: array
64064         items:
64065           $ref: "#/getDefinitions/l-interface"
64066       relationship-list:
64067         type: array
64068         items:
64069           $ref: "#/getDefinitions/relationship"
64070       l3-interface-ipv4-address-list:
64071         type: array
64072         items:
64073           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
64074       l3-interface-ipv6-address-list:
64075         type: array
64076         items:
64077           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
64078   l-interfaces:
64079     description: |
64080       Collection of logical interfaces.
64081     properties:
64082       l-interface:
64083         type: array
64084         items:
64085           $ref: "#/getDefinitions/l-interface"
64086   l3-interface-ipv4-address-list:
64087     description: |
64088       IPv4 Address Range
64089       ###### Related Nodes
64090       - TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
64091       - TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64092       - TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
64093       - TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64094       - TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
64095       - TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
64096     required:
64097     - l3-interface-ipv4-address
64098     properties:
64099       l3-interface-ipv4-address:
64100         type: string
64101         description: IP address
64102       l3-interface-ipv4-prefix-length:
64103         type: integer
64104         format: int64
64105         description: Prefix length, 32 for single address
64106       vlan-id-inner:
64107         type: integer
64108         format: int64
64109         description: Inner VLAN tag
64110       vlan-id-outer:
64111         type: integer
64112         format: int64
64113         description: Outer VLAN tag
64114       is-floating:
64115         type: boolean
64116         description: Indicator of fixed or floating address
64117       resource-version:
64118         type: string
64119         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64120       neutron-network-id:
64121         type: string
64122         description: Neutron network id of the interface that address belongs to
64123       neutron-subnet-id:
64124         type: string
64125         description: Neutron id of subnet that address belongs to
64126       relationship-list:
64127         type: array
64128         items:
64129           $ref: "#/getDefinitions/relationship"
64130   l3-interface-ipv6-address-list:
64131     description: |
64132       IPv6 Address Range
64133       ###### Related Nodes
64134       - TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
64135       - TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64136       - TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
64137       - TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
64138       - TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
64139       - TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
64140     required:
64141     - l3-interface-ipv6-address
64142     properties:
64143       l3-interface-ipv6-address:
64144         type: string
64145         description: IP address
64146       l3-interface-ipv6-prefix-length:
64147         type: integer
64148         format: int64
64149         description: Prefix length, 128 for single address
64150       vlan-id-inner:
64151         type: integer
64152         format: int64
64153         description: Inner VLAN tag
64154       vlan-id-outer:
64155         type: integer
64156         format: int64
64157         description: Outer VLAN tag
64158       is-floating:
64159         type: boolean
64160         description: Indicator of fixed or floating address
64161       resource-version:
64162         type: string
64163         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64164       neutron-network-id:
64165         type: string
64166         description: Neutron network id of the interface that address belongs to
64167       neutron-subnet-id:
64168         type: string
64169         description: Neutron id of subnet that address belongs to
64170       relationship-list:
64171         type: array
64172         items:
64173           $ref: "#/getDefinitions/relationship"
64174   l3-network:
64175     description: |
64176       Generic network definition
64177       ###### Related Nodes
64178       - TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
64179       - TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
64180       - TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
64181       - TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
64182       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
64183       - FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64184       - FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64185       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64186       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64187       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
64188       - FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64189       - FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64190       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
64191       - FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
64192       - FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
64193       - FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
64194       - L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
64195     required:
64196     - network-id
64197     - network-name
64198     - is-bound-to-vpn
64199     - is-provider-network
64200     - is-shared-network
64201     - is-external-network
64202     properties:
64203       network-id:
64204         type: string
64205         description: Network ID, should be uuid. Unique across A&AI.
64206       network-name:
64207         type: string
64208         description: Name of the network, governed by some naming convention..
64209       network-type:
64210         type: string
64211         description: Type of the network - who defines these values?
64212       network-role:
64213         type: string
64214         description: Role the network plans - who defines these values?
64215       network-technology:
64216         type: string
64217         description: Network technology - who defines these values?
64218       neutron-network-id:
64219         type: string
64220         description: Neutron network id of this Interface
64221       is-bound-to-vpn:
64222         type: boolean
64223       service-id:
64224         type: string
64225         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
64226       network-role-instance:
64227         type: integer
64228         format: int64
64229         description: network role instance
64230       resource-version:
64231         type: string
64232         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64233       orchestration-status:
64234         type: string
64235         description: Orchestration status of this VNF, mastered by MSO
64236       heat-stack-id:
64237         type: string
64238         description: Heat stack id corresponding to this instance, managed by MSO
64239       mso-catalog-key:
64240         type: string
64241         description: Corresponds to the SDN-C catalog id used to configure this VCE
64242       contrail-network-fqdn:
64243         type: string
64244         description: Contrail FQDN for the network
64245       model-invariant-id:
64246         type: string
64247         description: the ASDC model id for this resource or service model.
64248       model-version-id:
64249         type: string
64250         description: the ASDC model version for this resource or service model.
64251       persona-model-version:
64252         type: string
64253         description: the ASDC model version for this resource or service model.
64254       model-customization-id:
64255         type: string
64256         description: captures the id of all the configuration used to customize the resource for the service.
64257       widget-model-id:
64258         type: string
64259         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
64260       widget-model-version:
64261         type: string
64262         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
64263       physical-network-name:
64264         type: string
64265         description: Name associated with the physical network.
64266       is-provider-network:
64267         type: boolean
64268       is-shared-network:
64269         type: boolean
64270       is-external-network:
64271         type: boolean
64272       selflink:
64273         type: string
64274         description: Path to the controller object.
64275       operational-status:
64276         type: string
64277         description: Indicator for whether the resource is considered operational.
64278       subnets:
64279         type: array
64280         items:
64281           $ref: "#/getDefinitions/subnet"
64282       ctag-assignments:
64283         type: array
64284         items:
64285           $ref: "#/getDefinitions/ctag-assignment"
64286       segmentation-assignments:
64287         type: array
64288         items:
64289           $ref: "#/getDefinitions/segmentation-assignment"
64290       relationship-list:
64291         type: array
64292         items:
64293           $ref: "#/getDefinitions/relationship"
64294         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
64295   l3-networks:
64296     properties:
64297       l3-network:
64298         type: array
64299         items:
64300           $ref: "#/getDefinitions/l3-network"
64301   lag-interface:
64302     description: |
64303       Link aggregate interface
64304       ###### Related Nodes
64305       - TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64306       - TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
64307       - TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64308       - TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
64309       - TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
64310       - TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
64311       - TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
64312       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
64313       - LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
64314       - LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
64315     required:
64316     - interface-name
64317     - in-maint
64318     properties:
64319       interface-name:
64320         type: string
64321         description: Name that identifies the link aggregate interface
64322       interface-description:
64323         type: string
64324         description: Human friendly text regarding this interface.
64325       resource-version:
64326         type: string
64327         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64328       speed-value:
64329         type: string
64330         description: Captures the numeric part of the speed
64331       speed-units:
64332         type: string
64333         description: Captures the units corresponding to the speed
64334       interface-id:
64335         type: string
64336         description: ID of interface
64337       interface-role:
64338         type: string
64339         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
64340       prov-status:
64341         type: string
64342         description: Trigger for operational monitoring of this resource by Service Assurance systems.
64343       in-maint:
64344         type: boolean
64345       relationship-list:
64346         type: array
64347         items:
64348           $ref: "#/getDefinitions/relationship"
64349       l-interfaces:
64350         type: array
64351         items:
64352           $ref: "#/getDefinitions/l-interface"
64353   lag-interfaces:
64354     description: |
64355       Collection of link aggregate interfaces.
64356     properties:
64357       lag-interface:
64358         type: array
64359         items:
64360           $ref: "#/getDefinitions/lag-interface"
64361   lag-link:
64362     description: |
64363       LAG links can connect lag-interfaces
64364       ###### Related Nodes
64365       - FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
64366       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
64367     required:
64368     - link-name
64369     properties:
64370       link-name:
64371         type: string
64372         description: Alphabetical concatenation of lag-interface names
64373       resource-version:
64374         type: string
64375         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64376       relationship-list:
64377         type: array
64378         items:
64379           $ref: "#/getDefinitions/relationship"
64380   lag-links:
64381     description: |
64382       Collection of link aggregation connections
64383     properties:
64384       lag-link:
64385         type: array
64386         items:
64387           $ref: "#/getDefinitions/lag-link"
64388   license:
64389     description: |
64390       Metadata for license group.
64391       ###### Related Nodes
64392       - TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
64393       - TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
64394     required:
64395     - group-uuid
64396     - resource-uuid
64397     properties:
64398       group-uuid:
64399         type: string
64400         description: Unique ID for the license group the resource belongs to, should be uuid.
64401       resource-uuid:
64402         type: string
64403         description: Unique ID of a license resource.
64404       resource-version:
64405         type: string
64406         description: Concurrency value
64407       relationship-list:
64408         type: array
64409         items:
64410           $ref: "#/getDefinitions/relationship"
64411   licenses:
64412     description: |
64413       Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
64414     properties:
64415       license:
64416         type: array
64417         items:
64418           $ref: "#/getDefinitions/license"
64419   line-of-business:
64420     description: |
64421       describes a line-of-business
64422       ###### Related Nodes
64423       - TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
64424     required:
64425     - line-of-business-name
64426     properties:
64427       line-of-business-name:
64428         type: string
64429         description: Name of the line-of-business (product)
64430       resource-version:
64431         type: string
64432         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64433       relationship-list:
64434         type: array
64435         items:
64436           $ref: "#/getDefinitions/relationship"
64437   lines-of-business:
64438     description: |
64439       Collection of lines-of-business
64440     properties:
64441       line-of-business:
64442         type: array
64443         items:
64444           $ref: "#/getDefinitions/line-of-business"
64445   logical-link:
64446     description: |
64447       Logical links generally connect l-interfaces but are used to express logical connectivity between two points
64448       ###### Related Nodes
64449       - TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
64450       - TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
64451       - TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
64452       - TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64453       - TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
64454       - TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
64455       - TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
64456       - TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
64457       - FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
64458       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64459       - FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
64460       - FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
64461       - FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
64462       - FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64463       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
64464     required:
64465     - link-name
64466     - in-maint
64467     - link-type
64468     properties:
64469       link-name:
64470         type: string
64471         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
64472       in-maint:
64473         type: boolean
64474       link-type:
64475         type: string
64476         description: Type of logical link, e.g., evc
64477       speed-value:
64478         type: string
64479         description: Captures the numeric part of the speed
64480       speed-units:
64481         type: string
64482         description: Captures the units corresponding to the speed
64483       ip-version:
64484         type: string
64485         description: v4, v6, or ds for dual stack
64486       routing-protocol:
64487         type: string
64488         description: For example, static or BGP
64489       resource-version:
64490         type: string
64491         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64492       model-invariant-id:
64493         type: string
64494         description: the ASDC model id for this resource or service model.
64495       model-version-id:
64496         type: string
64497         description: the ASDC model version for this resource or service model.
64498       persona-model-version:
64499         type: string
64500         description: the ASDC model version for this resource or service model.
64501       widget-model-id:
64502         type: string
64503         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
64504       widget-model-version:
64505         type: string
64506         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
64507       operational-status:
64508         type: string
64509         description: Indication of operational status of the logical link.
64510       prov-status:
64511         type: string
64512         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
64513       link-role:
64514         type: string
64515         description: Indication of the network use of the logical link.
64516       link-name2:
64517         type: string
64518         description: Alias or alternate name (CLCI or D1 name).
64519       link-id:
64520         type: string
64521         description: UUID of the logical-link, SDNC generates this.
64522       circuit-id:
64523         type: string
64524         description: Circuit id
64525       purpose:
64526         type: string
64527         description: Reason for this entity, role it is playing
64528       relationship-list:
64529         type: array
64530         items:
64531           $ref: "#/getDefinitions/relationship"
64532   logical-links:
64533     description: |
64534       Collection of logical connections
64535     properties:
64536       logical-link:
64537         type: array
64538         items:
64539           $ref: "#/getDefinitions/logical-link"
64540   metadata:
64541     description: |
64542       Collection of metadatum (key/value pairs)
64543     properties:
64544       metadatum:
64545         type: array
64546         items:
64547           $ref: "#/getDefinitions/metadatum"
64548   metadatum:
64549     description: |
64550       Key/value pairs
64551       ###### Related Nodes
64552       - TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
64553       - TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
64554       - TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
64555       - TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
64556       - TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64557     required:
64558     - metaname
64559     - metaval
64560     properties:
64561       metaname:
64562         type: string
64563       metaval:
64564         type: string
64565       resource-version:
64566         type: string
64567         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64568   model:
64569     description: |
64570       Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
64571       ###### Related Nodes
64572       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
64573       - FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
64574       - FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
64575       - FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
64576       - FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
64577       - MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
64578       - MODEL is DELETED when these are DELETED MODEL-VER
64579     required:
64580     - model-invariant-id
64581     - model-type
64582     properties:
64583       model-invariant-id:
64584         type: string
64585         description: Unique identifier corresponding to the main definition of a model in ASDC
64586       model-type:
64587         type: string
64588         description: Type of the model, e.g., service, resource, widget, etc.
64589       resource-version:
64590         type: string
64591         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64592       model-vers:
64593         type: array
64594         items:
64595           $ref: "#/getDefinitions/model-ver"
64596       relationship-list:
64597         type: array
64598         items:
64599           $ref: "#/getDefinitions/relationship"
64600   model-and-named-query-search:
64601     description: |
64602       ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
64603     properties:
64604       query-parameters:
64605         type: object
64606         $ref: "#/getDefinitions/query-parameters"
64607       instance-filters:
64608         type: object
64609         $ref: "#/getDefinitions/instance-filters"
64610       secondary-filts:
64611         type: object
64612         $ref: "#/getDefinitions/secondary-filts"
64613       top-node-type:
64614         type: string
64615       secondary-filter-cut-point:
64616         type: string
64617   model-constraint:
64618     description: |
64619       This is how we would capture constraints defining allowed sets of elements.
64620       ###### Related Nodes
64621       - TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64622       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
64623       - MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
64624     required:
64625     - model-constraint-uuid
64626     - constrained-element-set-uuid-to-replace
64627     properties:
64628       model-constraint-uuid:
64629         type: string
64630       constrained-element-set-uuid-to-replace:
64631         type: string
64632       constrained-element-sets:
64633         type: array
64634         items:
64635           $ref: "#/getDefinitions/constrained-element-set"
64636       resource-version:
64637         type: string
64638         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64639   model-constraints:
64640     properties:
64641       model-constraint:
64642         type: array
64643         items:
64644           $ref: "#/getDefinitions/model-constraint"
64645   model-element:
64646     description: |
64647       Defines how other models combine to make up a higher-level model.
64648       ###### Related Nodes
64649       - TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
64650       - TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64651       - TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
64652       - TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64653       - FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64654       - FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64655       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
64656       - MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
64657     required:
64658     - model-element-uuid
64659     - new-data-del-flag
64660     - cardinality
64661     properties:
64662       model-element-uuid:
64663         type: string
64664       new-data-del-flag:
64665         type: string
64666         description: Indicates whether this element was created as part of instantiation from this model
64667       cardinality:
64668         type: string
64669         description: How many of this type of element are required/allowed
64670       linkage-points:
64671         type: string
64672       resource-version:
64673         type: string
64674         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64675       model-elements:
64676         type: array
64677         items:
64678           $ref: "#/getDefinitions/model-element"
64679         description: Defines how other models combine to make up a higher-level model
64680       model-constraints:
64681         type: array
64682         items:
64683           $ref: "#/getDefinitions/model-constraint"
64684         description: Describes new constraints on this model element that are not part of that model's definition
64685       relationship-list:
64686         type: array
64687         items:
64688           $ref: "#/getDefinitions/relationship"
64689   model-elements:
64690     properties:
64691       model-element:
64692         type: array
64693         items:
64694           $ref: "#/getDefinitions/model-element"
64695   model-ver:
64696     description: |
64697       Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
64698       ###### Related Nodes
64699       - TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
64700       - FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
64701       - FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64702       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
64703       - MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
64704       - MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
64705     required:
64706     - model-version-id
64707     - model-name
64708     - model-version
64709     properties:
64710       model-version-id:
64711         type: string
64712         description: Unique identifier corresponding to one version of a model in ASDC
64713       model-name:
64714         type: string
64715         description: Name of the model, which can change from version to version.
64716       model-version:
64717         type: string
64718         description: Version
64719       model-description:
64720         type: string
64721         description: Description
64722       resource-version:
64723         type: string
64724         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64725       model-elements:
64726         type: array
64727         items:
64728           $ref: "#/getDefinitions/model-element"
64729       metadata:
64730         type: array
64731         items:
64732           $ref: "#/getDefinitions/metadatum"
64733       relationship-list:
64734         type: array
64735         items:
64736           $ref: "#/getDefinitions/relationship"
64737   model-vers:
64738     properties:
64739       model-ver:
64740         type: array
64741         items:
64742           $ref: "#/getDefinitions/model-ver"
64743   models:
64744     description: |
64745       Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
64746     properties:
64747       model:
64748         type: array
64749         items:
64750           $ref: "#/getDefinitions/model"
64751   multicast-configuration:
64752     description: |
64753       ###### Related Nodes
64754       - FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
64755     required:
64756     - multicast-configuration-id
64757     - multicast-protocol
64758     - rp-type
64759     properties:
64760       multicast-configuration-id:
64761         type: string
64762         description: Unique id of multicast configuration.
64763       multicast-protocol:
64764         type: string
64765         description: protocol of multicast configuration
64766       rp-type:
64767         type: string
64768         description: rp type of multicast configuration
64769       resource-version:
64770         type: string
64771         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64772       relationship-list:
64773         type: array
64774         items:
64775           $ref: "#/getDefinitions/relationship"
64776   multicast-configurations:
64777     description: |
64778       multicast configuration of generic-vnf ip-address
64779     properties:
64780       multicast-configuration:
64781         type: array
64782         items:
64783           $ref: "#/getDefinitions/multicast-configuration"
64784   named-queries:
64785     properties:
64786       named-query:
64787         type: array
64788         items:
64789           $ref: "#/getDefinitions/named-query"
64790   named-query:
64791     description: |
64792       TBD
64793       ###### Related Nodes
64794       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
64795       - TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
64796       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
64797       - NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
64798     required:
64799     - named-query-uuid
64800     - named-query-name
64801     - named-query-version
64802     properties:
64803       named-query-uuid:
64804         type: string
64805       named-query-name:
64806         type: string
64807       named-query-version:
64808         type: string
64809       required-input-param:
64810         type: string
64811       description:
64812         type: string
64813       resource-version:
64814         type: string
64815       named-query-elements:
64816         type: array
64817         items:
64818           $ref: "#/getDefinitions/named-query-element"
64819       relationship-list:
64820         type: array
64821         items:
64822           $ref: "#/getDefinitions/relationship"
64823   named-query-element:
64824     description: |
64825       TBD
64826       ###### Related Nodes
64827       - TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
64828       - TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
64829       - TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
64830       - FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
64831       - FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
64832       - FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
64833       - NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
64834     required:
64835     - named-query-element-uuid
64836     properties:
64837       named-query-element-uuid:
64838         type: string
64839       property-collect-list:
64840         type: string
64841       resource-version:
64842         type: string
64843       property-limit-desc:
64844         type: string
64845       do-not-output:
64846         type: string
64847       named-query-elements:
64848         type: array
64849         items:
64850           $ref: "#/getDefinitions/named-query-element"
64851       related-lookups:
64852         type: array
64853         items:
64854           $ref: "#/getDefinitions/related-lookup"
64855       property-constraints:
64856         type: array
64857         items:
64858           $ref: "#/getDefinitions/property-constraint"
64859       relationship-list:
64860         type: array
64861         items:
64862           $ref: "#/getDefinitions/relationship"
64863   named-query-elements:
64864     properties:
64865       named-query-element:
64866         type: array
64867         items:
64868           $ref: "#/getDefinitions/named-query-element"
64869   network:
64870     description: |
64871       Namespace for network inventory resources.
64872     properties:
64873       logical-links:
64874         type: array
64875         items:
64876           $ref: "#/getDefinitions/logical-link"
64877       site-pair-sets:
64878         type: array
64879         items:
64880           $ref: "#/getDefinitions/site-pair-set"
64881       vpn-bindings:
64882         type: array
64883         items:
64884           $ref: "#/getDefinitions/vpn-binding"
64885       vpls-pes:
64886         type: array
64887         items:
64888           $ref: "#/getDefinitions/vpls-pe"
64889       multicast-configurations:
64890         type: array
64891         items:
64892           $ref: "#/getDefinitions/multicast-configuration"
64893       vces:
64894         type: array
64895         items:
64896           $ref: "#/getDefinitions/vce"
64897       vnfcs:
64898         type: array
64899         items:
64900           $ref: "#/getDefinitions/vnfc"
64901       l3-networks:
64902         type: array
64903         items:
64904           $ref: "#/getDefinitions/l3-network"
64905       network-policies:
64906         type: array
64907         items:
64908           $ref: "#/getDefinitions/network-policy"
64909       generic-vnfs:
64910         type: array
64911         items:
64912           $ref: "#/getDefinitions/generic-vnf"
64913       lag-links:
64914         type: array
64915         items:
64916           $ref: "#/getDefinitions/lag-link"
64917       newvces:
64918         type: array
64919         items:
64920           $ref: "#/getDefinitions/newvce"
64921       pnfs:
64922         type: array
64923         items:
64924           $ref: "#/getDefinitions/pnf"
64925       physical-links:
64926         type: array
64927         items:
64928           $ref: "#/getDefinitions/physical-link"
64929       ipsec-configurations:
64930         type: array
64931         items:
64932           $ref: "#/getDefinitions/ipsec-configuration"
64933       route-table-references:
64934         type: array
64935         items:
64936           $ref: "#/getDefinitions/route-table-reference"
64937       instance-groups:
64938         type: array
64939         items:
64940           $ref: "#/getDefinitions/instance-group"
64941       zones:
64942         type: array
64943         items:
64944           $ref: "#/getDefinitions/zone"
64945       configurations:
64946         type: array
64947         items:
64948           $ref: "#/getDefinitions/configurations"
64949   network-policies:
64950     properties:
64951       network-policy:
64952         type: array
64953         items:
64954           $ref: "#/getDefinitions/network-policy"
64955   network-policy:
64956     description: |
64957       ###### Related Nodes
64958       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
64959       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
64960     required:
64961     - network-policy-id
64962     properties:
64963       network-policy-id:
64964         type: string
64965         description: UUID representing unique key to this instance
64966       network-policy-fqdn:
64967         type: string
64968         description: Contrail FQDN for the policy
64969       heat-stack-id:
64970         type: string
64971         description: ID for the openStack Heat instance
64972       resource-version:
64973         type: string
64974         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64975       relationship-list:
64976         type: array
64977         items:
64978           $ref: "#/getDefinitions/relationship"
64979   network-profile:
64980     description: |
64981       Network profile populated by SDN-GP for SNMP
64982       ###### Related Nodes
64983       - TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
64984     required:
64985     - nm-profile-name
64986     properties:
64987       nm-profile-name:
64988         type: string
64989         description: Unique name of network profile.
64990       community-string:
64991         type: string
64992         description: Encrypted SNMP community string
64993       resource-version:
64994         type: string
64995         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
64996       relationship-list:
64997         type: array
64998         items:
64999           $ref: "#/getDefinitions/relationship"
65000   network-profiles:
65001     description: |
65002       Collection of network profiles
65003     properties:
65004       network-profile:
65005         type: array
65006         items:
65007           $ref: "#/getDefinitions/network-profile"
65008   newvce:
65009     description: |
65010       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
65011       ###### Related Nodes
65012       - FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
65013       - NEWVCE is DELETED when these are DELETED L-INTERFACE
65014     required:
65015     - vnf-id2
65016     - vnf-name
65017     - vnf-type
65018     properties:
65019       vnf-id2:
65020         type: string
65021         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
65022       vnf-name:
65023         type: string
65024         description: Name of VNF.
65025       vnf-name2:
65026         type: string
65027         description: Alternate name of VNF.
65028       vnf-type:
65029         type: string
65030         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.
65031       prov-status:
65032         type: string
65033         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
65034       operational-status:
65035         type: string
65036         description: Indicator for whether the resource is considered operational
65037       license-key:
65038         type: string
65039         description: OBSOLETE -  do not use
65040       ipv4-oam-address:
65041         type: string
65042         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).
65043       equipment-role:
65044         type: string
65045         description: Client should send valid enumerated value.
65046       resource-version:
65047         type: string
65048         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65049       ipv4-loopback0-address:
65050         type: string
65051         description: v4 Loopback0 address
65052       orchestration-status:
65053         type: string
65054         description: Orchestration status of this VNF, mastered by MSO.
65055       heat-stack-id:
65056         type: string
65057         description: Heat stack id corresponding to this instance, managed by MSO
65058       mso-catalog-key:
65059         type: string
65060         description: Corresponds to the SDN-C catalog id used to configure this VCE
65061       relationship-list:
65062         type: array
65063         items:
65064           $ref: "#/getDefinitions/relationship"
65065       l-interfaces:
65066         type: array
65067         items:
65068           $ref: "#/getDefinitions/l-interface"
65069   newvces:
65070     description: |
65071       This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
65072     properties:
65073       newvce:
65074         type: array
65075         items:
65076           $ref: "#/getDefinitions/newvce"
65077   notification-event:
65078     properties:
65079       cambria.partition:
65080         type: string
65081       notification-event-header:
65082         type: object
65083         $ref: "#/getDefinitions/notification-event-header"
65084   notification-event-header:
65085     properties:
65086       id:
65087         type: string
65088       timestamp:
65089         type: string
65090       source-name:
65091         type: string
65092       domain:
65093         type: string
65094       sequence-number:
65095         type: string
65096       severity:
65097         type: string
65098       event-type:
65099         type: string
65100       version:
65101         type: string
65102       action:
65103         type: string
65104       entity-type:
65105         type: string
65106       top-entity-type:
65107         type: string
65108       entity-link:
65109         type: string
65110       status:
65111         type: string
65112   notify:
65113     required:
65114     - event-id
65115     properties:
65116       event-id:
65117         type: string
65118       node-type:
65119         type: string
65120       event-trigger:
65121         type: string
65122       key-data:
65123         type: array
65124         items:
65125           $ref: "#/getDefinitions/key-data"
65126       selflink:
65127         type: string
65128   oam-network:
65129     description: |
65130       OAM network, to be deprecated shortly.  Do not use for new purposes.
65131       ###### Related Nodes
65132       - TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
65133       - TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
65134       - TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
65135     required:
65136     - network-uuid
65137     - network-name
65138     - cvlan-tag
65139     properties:
65140       network-uuid:
65141         type: string
65142         description: UUID of the network. Unique across a cloud-region
65143       network-name:
65144         type: string
65145         description: Name of the network.
65146       cvlan-tag:
65147         type: integer
65148         format: int64
65149         description: cvlan-id
65150       ipv4-oam-gateway-address:
65151         type: string
65152         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
65153       ipv4-oam-gateway-address-prefix-length:
65154         type: integer
65155         format: int32
65156         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
65157       resource-version:
65158         type: string
65159         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65160       relationship-list:
65161         type: array
65162         items:
65163           $ref: "#/getDefinitions/relationship"
65164   oam-networks:
65165     description: |
65166       Collection of OAM networks, to be deprecated shortly.  Do not use for new purposes.
65167     properties:
65168       oam-network:
65169         type: array
65170         items:
65171           $ref: "#/getDefinitions/oam-network"
65172   operational-environment:
65173     description: |
65174       It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
65175       ###### Related Nodes
65176       - TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
65177       - FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
65178     required:
65179     - operational-environment-id
65180     - operational-environment-name
65181     - operational-environment-type
65182     - operational-environment-status
65183     - tenant-context
65184     - workload-context
65185     properties:
65186       operational-environment-id:
65187         type: string
65188         description: UUID of an operational environment
65189       operational-environment-name:
65190         type: string
65191         description: Operational Environment name
65192       operational-environment-type:
65193         type: string
65194         description: Operational Environment Type.
65195       operational-environment-status:
65196         type: string
65197         description: Status
65198       tenant-context:
65199         type: string
65200         description: Tenant Context.
65201       workload-context:
65202         type: string
65203         description: Workload Context.
65204       resource-version:
65205         type: string
65206         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65207       relationship-list:
65208         type: array
65209         items:
65210           $ref: "#/getDefinitions/relationship"
65211   operational-environments:
65212     description: |
65213       a logical partition of the cloud which allows to have multiple environments in the production AIC.
65214     properties:
65215       operational-environment:
65216         type: array
65217         items:
65218           $ref: "#/getDefinitions/operational-environment"
65219   overloaded-model:
65220     description: |
65221       Allows for legacy POST of old-style and new-style models
65222     required:
65223     - model-invariant-id
65224     - model-name-version-id
65225     - model-type
65226     - model-name
65227     - model-id
65228     - model-version
65229     properties:
65230       model-invariant-id:
65231         type: string
65232         description: Unique identifier corresponding to the main definition of a model in ASDC
65233       model-name-version-id:
65234         type: string
65235         description: Unique identifier corresponding to one version of a model in ASDC
65236       model-type:
65237         type: string
65238         description: Type of the model, e.g., service, resource, widget, etc.
65239       model-name:
65240         type: string
65241         description: Name of the model, which can change from version to version.
65242       model-id:
65243         type: string
65244         description: Invariant unique ID which does not change from version to version
65245       model-version:
65246         type: string
65247         description: Version
65248       model-description:
65249         type: string
65250         description: Description
65251       resource-version:
65252         type: string
65253         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65254       model-vers:
65255         type: object
65256         $ref: "#/getDefinitions/model-vers"
65257       relationship-list:
65258         type: object
65259         $ref: "#/getDefinitions/relationship-list"
65260   owning-entities:
65261     description: |
65262       Collection of owning-entities
65263     properties:
65264       owning-entity:
65265         type: array
65266         items:
65267           $ref: "#/getDefinitions/owning-entity"
65268   owning-entity:
65269     description: |
65270       describes an owning-entity
65271       ###### Related Nodes
65272       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
65273     required:
65274     - owning-entity-id
65275     - owning-entity-name
65276     properties:
65277       owning-entity-id:
65278         type: string
65279         description: UUID of an owning entity
65280       owning-entity-name:
65281         type: string
65282         description: Owning entity name
65283       resource-version:
65284         type: string
65285         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65286       relationship-list:
65287         type: array
65288         items:
65289           $ref: "#/getDefinitions/relationship"
65290   p-interface:
65291     description: |
65292       Physical interface (e.g., nic)
65293       ###### Related Nodes
65294       - TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
65295       - TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
65296       - TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65297       - TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65298       - TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
65299       - FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
65300       - FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
65301       - FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
65302       - P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
65303       - P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
65304     required:
65305     - interface-name
65306     - in-maint
65307     properties:
65308       interface-name:
65309         type: string
65310         description: Name that identifies the physical interface
65311       speed-value:
65312         type: string
65313         description: Captures the numeric part of the speed
65314       speed-units:
65315         type: string
65316         description: Captures the units corresponding to the speed
65317       port-description:
65318         type: string
65319         description: Nature of the services and connectivity on this port.
65320       equipment-identifier:
65321         type: string
65322         description: CLEI or other specification for p-interface hardware.
65323       interface-role:
65324         type: string
65325         description: Role specification for p-interface hardware.
65326       interface-type:
65327         type: string
65328         description: Indicates the physical properties of the interface.
65329       prov-status:
65330         type: string
65331         description: Trigger for operational monitoring of this resource by Service Assurance systems.
65332       mac-addresss:
65333         type: string
65334         description: MAC Address of the p-interface.
65335       resource-version:
65336         type: string
65337         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65338       in-maint:
65339         type: boolean
65340       inv-status:
65341         type: string
65342         description: inventory status
65343       relationship-list:
65344         type: array
65345         items:
65346           $ref: "#/getDefinitions/relationship"
65347       sriov-pfs:
65348         type: array
65349         items:
65350           $ref: "#/getDefinitions/sriov-pf"
65351       l-interfaces:
65352         type: array
65353         items:
65354           $ref: "#/getDefinitions/l-interface"
65355   p-interfaces:
65356     description: |
65357       Collection of physical interfaces.
65358     properties:
65359       p-interface:
65360         type: array
65361         items:
65362           $ref: "#/getDefinitions/p-interface"
65363   physical-link:
65364     description: |
65365       Collection of physical connections, typically between p-interfaces
65366       ###### Related Nodes
65367       - FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
65368     required:
65369     - link-name
65370     properties:
65371       link-name:
65372         type: string
65373         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
65374       speed-value:
65375         type: string
65376         description: Captures the numeric part of the speed
65377       speed-units:
65378         type: string
65379         description: Captures the units corresponding to the speed
65380       circuit-id:
65381         type: string
65382         description: Circuit it
65383       dual-mode:
65384         type: string
65385         description: Dual access mode (e.g., primary, secondary
65386       management-option:
65387         type: string
65388         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
65389       service-provider-name:
65390         type: string
65391         description: Name of the service Provider on this link.
65392       service-provider-bandwidth-up-value:
65393         type: integer
65394         format: int32
65395         description: Upstream Bandwidth value agreed with the service provider
65396       service-provider-bandwidth-up-units:
65397         type: string
65398         description: Units for the upstream BW value
65399       service-provider-bandwidth-down-value:
65400         type: integer
65401         format: int32
65402         description: Downstream Bandwidth value agreed with the service provider
65403       service-provider-bandwidth-down-units:
65404         type: string
65405         description: Units for downstream BW value
65406       resource-version:
65407         type: string
65408         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65409       relationship-list:
65410         type: array
65411         items:
65412           $ref: "#/getDefinitions/relationship"
65413   physical-links:
65414     description: |
65415       Collection of physical connections, typically between p-interfaces
65416     properties:
65417       physical-link:
65418         type: array
65419         items:
65420           $ref: "#/getDefinitions/physical-link"
65421   platform:
65422     description: |
65423       describes a platform
65424       ###### Related Nodes
65425       - TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
65426     required:
65427     - platform-name
65428     properties:
65429       platform-name:
65430         type: string
65431         description: Name of the platform
65432       resource-version:
65433         type: string
65434         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65435       relationship-list:
65436         type: array
65437         items:
65438           $ref: "#/getDefinitions/relationship"
65439   platforms:
65440     description: |
65441       Collection of platforms
65442     properties:
65443       platform:
65444         type: array
65445         items:
65446           $ref: "#/getDefinitions/platform"
65447   pnf:
65448     description: |
65449       PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
65450       ###### Related Nodes
65451       - TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
65452       - TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
65453       - TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
65454       - FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
65455       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
65456       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
65457       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65458       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
65459       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
65460       - PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
65461     required:
65462     - pnf-name
65463     - in-maint
65464     properties:
65465       pnf-name:
65466         type: string
65467         description: unique name of Physical Network Function.
65468       pnf-name2:
65469         type: string
65470         description: name of Physical Network Function.
65471       pnf-name2-source:
65472         type: string
65473         description: source of name2
65474       pnf-id:
65475         type: string
65476         description: id of pnf
65477       equip-type:
65478         type: string
65479         description: Equipment type.  Source of truth should define valid values.
65480       equip-vendor:
65481         type: string
65482         description: Equipment vendor.  Source of truth should define valid values.
65483       equip-model:
65484         type: string
65485         description: Equipment model.  Source of truth should define valid values.
65486       management-option:
65487         type: string
65488         description: identifier of managed by ATT or customer
65489       ipaddress-v4-oam:
65490         type: string
65491         description: ipv4-oam-address with new naming convention for IP addresses
65492       sw-version:
65493         type: string
65494         description: sw-version is the version of SW for the hosted application on the PNF.
65495       in-maint:
65496         type: boolean
65497       frame-id:
65498         type: string
65499         description: ID of the physical frame (relay rack) where pnf is installed.
65500       serial-number:
65501         type: string
65502         description: Serial number of the device
65503       ipaddress-v4-loopback-0:
65504         type: string
65505         description: IPV4 Loopback 0 address
65506       ipaddress-v6-loopback-0:
65507         type: string
65508         description: IPV6 Loopback 0 address
65509       ipaddress-v4-aim:
65510         type: string
65511         description: IPV4 AIM address
65512       ipaddress-v6-aim:
65513         type: string
65514         description: IPV6 AIM address
65515       ipaddress-v6-oam:
65516         type: string
65517         description: IPV6 OAM address
65518       inv-status:
65519         type: string
65520         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
65521       resource-version:
65522         type: string
65523         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65524       prov-status:
65525         type: string
65526         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
65527       nf-role:
65528         type: string
65529         description: Nf Role is the role performed by this instance in the network.
65530       relationship-list:
65531         type: array
65532         items:
65533           $ref: "#/getDefinitions/relationship"
65534       p-interfaces:
65535         type: array
65536         items:
65537           $ref: "#/getDefinitions/p-interface"
65538       lag-interfaces:
65539         type: array
65540         items:
65541           $ref: "#/getDefinitions/lag-interface"
65542   pnfs:
65543     description: |
65544       Collection of Physical Network Functions.
65545     properties:
65546       pnf:
65547         type: array
65548         items:
65549           $ref: "#/getDefinitions/pnf"
65550   port-group:
65551     description: |
65552       Used to capture the network interfaces of this VCE
65553       ###### Related Nodes
65554       - TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
65555       - FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
65556       - PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
65557     required:
65558     - interface-id
65559     - orchestration-status
65560     properties:
65561       interface-id:
65562         type: string
65563         description: Unique ID of the interface
65564       neutron-network-id:
65565         type: string
65566         description: Neutron network id of this Interface
65567       neutron-network-name:
65568         type: string
65569         description: Neutron network name of this Interface
65570       interface-role:
65571         type: string
65572         description: Role assigned to this Interface, should use values as defined in ECOMP Yang models.
65573       resource-version:
65574         type: string
65575         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65576       port-group-id:
65577         type: string
65578         description: Unique ID for port group in vmware
65579       port-group-name:
65580         type: string
65581         description: Likely to duplicate value of neutron network name
65582       switch-name:
65583         type: string
65584         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
65585       orchestration-status:
65586         type: string
65587         description: Orchestration status of this VNF, mastered by MSO
65588       heat-stack-id:
65589         type: string
65590         description: Heat stack id corresponding to this instance, managed by MSO
65591       mso-catalog-key:
65592         type: string
65593         description: Corresponds to the SDN-C catalog id used to configure this VCE
65594       cvlan-tags:
65595         type: array
65596         items:
65597           $ref: "#/getDefinitions/cvlan-tag-entry"
65598       relationship-list:
65599         type: array
65600         items:
65601           $ref: "#/getDefinitions/relationship"
65602   port-groups:
65603     properties:
65604       port-group:
65605         type: array
65606         items:
65607           $ref: "#/getDefinitions/port-group"
65608   project:
65609     description: |
65610       describes the project
65611       ###### Related Nodes
65612       - TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
65613     required:
65614     - project-name
65615     properties:
65616       project-name:
65617         type: string
65618         description: Name of the project deploying a service
65619       resource-version:
65620         type: string
65621         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65622       relationship-list:
65623         type: array
65624         items:
65625           $ref: "#/getDefinitions/relationship"
65626   projects:
65627     description: |
65628       Collection of projects
65629     properties:
65630       project:
65631         type: array
65632         items:
65633           $ref: "#/getDefinitions/project"
65634   properties:
65635     description: |
65636       Property holder for query properties or instance properties
65637     properties:
65638       property-name:
65639         type: string
65640       property-value:
65641         type: string
65642   property-constraint:
65643     description: |
65644       TBD
65645       ###### Related Nodes
65646       - TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65647     required:
65648     - property-constraint-uuid
65649     - constraint-type
65650     - property-name
65651     - property-value
65652     properties:
65653       property-constraint-uuid:
65654         type: string
65655       constraint-type:
65656         type: string
65657       property-name:
65658         type: string
65659       property-value:
65660         type: string
65661       resource-version:
65662         type: string
65663   property-constraints:
65664     properties:
65665       property-constraint:
65666         type: array
65667         items:
65668           $ref: "#/getDefinitions/property-constraint"
65669   pserver:
65670     description: |
65671       Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
65672       ###### Related Nodes
65673       - TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
65674       - TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
65675       - TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
65676       - TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
65677       - TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
65678       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
65679       - FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
65680       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65681       - FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
65682       - FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
65683       - PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
65684       - PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
65685       - PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
65686     required:
65687     - hostname
65688     - in-maint
65689     properties:
65690       hostname:
65691         type: string
65692         description: Value from executing hostname on the compute node.
65693       ptnii-equip-name:
65694         type: string
65695         description: PTNII name
65696       number-of-cpus:
65697         type: integer
65698         format: int32
65699         description: Number of cpus
65700       disk-in-gigabytes:
65701         type: integer
65702         format: int32
65703         description: Disk size, in GBs
65704       ram-in-megabytes:
65705         type: integer
65706         format: int32
65707         description: RAM size, in MBs
65708       equip-type:
65709         type: string
65710         description: Equipment type.  Source of truth should define valid values.
65711       equip-vendor:
65712         type: string
65713         description: Equipment vendor.  Source of truth should define valid values.
65714       equip-model:
65715         type: string
65716         description: Equipment model.  Source of truth should define valid values.
65717       fqdn:
65718         type: string
65719         description: Fully-qualified domain name
65720       pserver-selflink:
65721         type: string
65722         description: URL to endpoint where AAI can get more details
65723       ipv4-oam-address:
65724         type: string
65725         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
65726       serial-number:
65727         type: string
65728         description: Serial number, may be queried
65729       ipaddress-v4-loopback-0:
65730         type: string
65731         description: IPV4 Loopback 0 address
65732       ipaddress-v6-loopback-0:
65733         type: string
65734         description: IPV6 Loopback 0 address
65735       ipaddress-v4-aim:
65736         type: string
65737         description: IPV4 AIM address
65738       ipaddress-v6-aim:
65739         type: string
65740         description: IPV6 AIM address
65741       ipaddress-v6-oam:
65742         type: string
65743         description: IPV6 OAM address
65744       inv-status:
65745         type: string
65746         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
65747       pserver-id:
65748         type: string
65749         description: ID of Pserver
65750       internet-topology:
65751         type: string
65752         description: internet topology of Pserver
65753       in-maint:
65754         type: boolean
65755       resource-version:
65756         type: string
65757         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65758       pserver-name2:
65759         type: string
65760         description: alternative pserver name
65761       purpose:
65762         type: string
65763         description: purpose of pserver
65764       prov-status:
65765         type: string
65766         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
65767       management-option:
65768         type: string
65769         description: Indicates who owns and or manages the device.
65770       host-profile:
65771         type: string
65772         description: The host profile that defines the configuration of the pserver.
65773       relationship-list:
65774         type: array
65775         items:
65776           $ref: "#/getDefinitions/relationship"
65777       p-interfaces:
65778         type: array
65779         items:
65780           $ref: "#/getDefinitions/p-interface"
65781       lag-interfaces:
65782         type: array
65783         items:
65784           $ref: "#/getDefinitions/lag-interface"
65785   pservers:
65786     description: |
65787       Collection of compute hosts.
65788     properties:
65789       pserver:
65790         type: array
65791         items:
65792           $ref: "#/getDefinitions/pserver"
65793   query-parameters:
65794     description: |
65795       QueryParameters for performing a named-query or model query
65796     properties:
65797       named-query:
65798         type: object
65799         $ref: "#/getDefinitions/named-query"
65800       overloaded-model:
65801         type: object
65802         $ref: "#/getDefinitions/overloaded-model"
65803   related-lookup:
65804     description: |
65805       TBD
65806       ###### Related Nodes
65807       - TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
65808     required:
65809     - related-lookup-uuid
65810     - source-node-type
65811     - source-node-property
65812     - target-node-type
65813     - target-node-property
65814     properties:
65815       related-lookup-uuid:
65816         type: string
65817       source-node-type:
65818         type: string
65819       source-node-property:
65820         type: string
65821       target-node-type:
65822         type: string
65823       target-node-property:
65824         type: string
65825       property-collect-list:
65826         type: string
65827       resource-version:
65828         type: string
65829       relationship-list:
65830         type: array
65831         items:
65832           $ref: "#/getDefinitions/relationship"
65833   related-lookups:
65834     properties:
65835       related-lookup:
65836         type: array
65837         items:
65838           $ref: "#/getDefinitions/related-lookup"
65839   related-to-property:
65840     properties:
65841       property-key:
65842         type: string
65843         description: Key part of a key/value pair
65844       property-value:
65845         type: string
65846         description: Value part of a key/value pair
65847   relationship:
65848     properties:
65849       related-to:
65850         type: string
65851         description: A keyword provided by A&AI to indicate type of node.
65852       related-link:
65853         type: string
65854         description: URL to the object in A&AI.
65855       relationship-data:
65856         type: array
65857         items:
65858           $ref: "#/getDefinitions/relationship-data"
65859       related-to-property:
65860         type: array
65861         items:
65862           $ref: "#/getDefinitions/related-to-property"
65863   relationship-data:
65864     required:
65865     - relationship-key
65866     - relationship-value
65867     properties:
65868       relationship-key:
65869         type: string
65870         description: A keyword provided by A&AI to indicate an attribute.
65871       relationship-value:
65872         type: string
65873         description: Value of the attribute.
65874   relationship-list:
65875     properties:
65876       relationship:
65877         type: array
65878         items:
65879           $ref: "#/getDefinitions/relationship"
65880   reserved-prop-names:
65881     description: |
65882       Internal map to define some reserved properties of a vertex
65883     properties:
65884       last-mod-source-of-truth:
65885         type: string
65886       aai-node-type:
65887         type: string
65888       aai-created-ts:
65889         type: integer
65890         format: int64
65891       aai-unique-key:
65892         type: string
65893       aai-last-mod-ts:
65894         type: integer
65895         format: int64
65896       source-of-truth:
65897         type: string
65898       aai-uri:
65899         type: string
65900   response-list:
65901     description: |
65902       Response container for the results of a named-query or model query
65903     properties:
65904       inventory-response-items:
65905         type: object
65906         $ref: "#/getDefinitions/inventory-response-items"
65907   result-data:
65908     properties:
65909       resource-type:
65910         type: string
65911         description: The specific type of node in the A&AI graph
65912       resource-link:
65913         type: string
65914         description: The URL to the specific resource
65915   route-table-reference:
65916     description: |
65917       Openstack route table reference.
65918       ###### Related Nodes
65919       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
65920     required:
65921     - route-table-reference-id
65922     - route-table-reference-fqdn
65923     properties:
65924       route-table-reference-id:
65925         type: string
65926         description: Route Table Reference id, UUID assigned to this instance.
65927       route-table-reference-fqdn:
65928         type: string
65929         description: FQDN entry in the route table.
65930       resource-version:
65931         type: string
65932         description: Concurrency value
65933       relationship-list:
65934         type: array
65935         items:
65936           $ref: "#/getDefinitions/relationship"
65937   route-table-references:
65938     description: |
65939       Collection of openstack route table references
65940     properties:
65941       route-table-reference:
65942         type: array
65943         items:
65944           $ref: "#/getDefinitions/route-table-reference"
65945   route-target:
65946     description: |
65947       Route target information
65948       ###### Related Nodes
65949       - TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
65950     required:
65951     - global-route-target
65952     - route-target-role
65953     properties:
65954       global-route-target:
65955         type: string
65956         description: Number used to identify an RT, globally unique in the network
65957       route-target-role:
65958         type: string
65959         description: Role assigned to this route target
65960       resource-version:
65961         type: string
65962         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65963       relationship-list:
65964         type: array
65965         items:
65966           $ref: "#/getDefinitions/relationship"
65967   route-targets:
65968     description: |
65969       Collection of route target information
65970     properties:
65971       route-target:
65972         type: array
65973         items:
65974           $ref: "#/getDefinitions/route-target"
65975   routing-instance:
65976     description: |
65977       ###### Related Nodes
65978       - TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
65979       - FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
65980       - ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
65981     required:
65982     - routing-instance-id
65983     properties:
65984       routing-instance-id:
65985         type: string
65986         description: Unique id of routing instance
65987       rpm-owner:
65988         type: string
65989         description: rpm owner
65990       resource-version:
65991         type: string
65992         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
65993       site-pairs:
65994         type: array
65995         items:
65996           $ref: "#/getDefinitions/site-pair"
65997       relationship-list:
65998         type: array
65999         items:
66000           $ref: "#/getDefinitions/relationship"
66001   routing-instances:
66002     description: |
66003       set of probes related to generic-vnf routing instance
66004     properties:
66005       routing-instance:
66006         type: array
66007         items:
66008           $ref: "#/getDefinitions/routing-instance"
66009   sdn-zone-response:
66010     properties:
66011       oam-networks:
66012         type: object
66013         $ref: "#/getDefinitions/oam-networks"
66014       az-and-dvs-switches:
66015         type: array
66016         items:
66017           $ref: "#/getDefinitions/az-and-dvs-switches"
66018   search:
66019     properties:
66020       edge-tag-query-result:
66021         type: object
66022         $ref: "#/getDefinitions/edge-tag-query-result"
66023       edge-tag-query-request:
66024         type: object
66025         $ref: "#/getDefinitions/edge-tag-query-request"
66026       search-results:
66027         type: object
66028         $ref: "#/getDefinitions/search-results"
66029       sdn-zone-response:
66030         type: object
66031         $ref: "#/getDefinitions/sdn-zone-response"
66032   search-results:
66033     properties:
66034       result-data:
66035         type: array
66036         items:
66037           $ref: "#/getDefinitions/result-data"
66038   secondary-filt:
66039     description: |
66040       SecondaryFilt for performing a named-query or model query
66041   secondary-filter:
66042     properties:
66043       property-name:
66044         type: string
66045       filter-type:
66046         type: string
66047       property-value:
66048         type: string
66049   secondary-filts:
66050     description: |
66051       SecondaryFilts for performing a named-query or model query
66052     properties:
66053       secondary-filt:
66054         type: array
66055         items:
66056           $ref: "#/getDefinitions/secondary-filt"
66057   segmentation-assignment:
66058     description: |
66059       Openstack segmentation assignment.
66060       ###### Related Nodes
66061       - TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66062     required:
66063     - segmentation-id
66064     properties:
66065       segmentation-id:
66066         type: string
66067         description: Route Table Reference id, UUID assigned to this instance.
66068       resource-version:
66069         type: string
66070         description: Concurrency value
66071       relationship-list:
66072         type: array
66073         items:
66074           $ref: "#/getDefinitions/relationship"
66075   segmentation-assignments:
66076     description: |
66077       Collection of openstack segmentation assignments
66078     properties:
66079       segmentation-assignment:
66080         type: array
66081         items:
66082           $ref: "#/getDefinitions/segmentation-assignment"
66083   service:
66084     description: |
66085       Stand-in for service model definitions.  Likely to be deprecated in favor of models from ASDC.  Does not strictly map to ASDC services.
66086     required:
66087     - service-id
66088     - service-description
66089     properties:
66090       service-id:
66091         type: string
66092         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
66093       service-description:
66094         type: string
66095         description: Description of the service
66096       service-selflink:
66097         type: string
66098         description: URL to endpoint where AAI can get more details
66099       resource-version:
66100         type: string
66101         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66102       service-version:
66103         type: string
66104         description: service version
66105       relationship-list:
66106         type: array
66107         items:
66108           $ref: "#/getDefinitions/relationship"
66109   service-capabilities:
66110     description: |
66111       Collection of service capabilities.
66112     properties:
66113       service-capability:
66114         type: array
66115         items:
66116           $ref: "#/getDefinitions/service-capability"
66117   service-capability:
66118     description: |
66119       Early definition of server/resource pairings, likely to be replaced by models.  No new use should be made of this.
66120       ###### Related Nodes
66121       - FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
66122       - FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
66123       - SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
66124     required:
66125     - service-type
66126     - vnf-type
66127     properties:
66128       service-type:
66129         type: string
66130         description: This gets defined by others to provide a unique ID for the service, we accept what is sent.
66131       vnf-type:
66132         type: string
66133         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.
66134       resource-version:
66135         type: string
66136         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66137       relationship-list:
66138         type: array
66139         items:
66140           $ref: "#/getDefinitions/relationship"
66141   service-design-and-creation:
66142     description: |
66143       Namespace for objects managed by ASDC
66144     properties:
66145       vnf-images:
66146         type: array
66147         items:
66148           $ref: "#/getDefinitions/vnf-image"
66149       services:
66150         type: array
66151         items:
66152           $ref: "#/getDefinitions/service"
66153       service-capabilities:
66154         type: array
66155         items:
66156           $ref: "#/getDefinitions/service-capability"
66157       models:
66158         type: array
66159         items:
66160           $ref: "#/getDefinitions/model"
66161       named-queries:
66162         type: array
66163         items:
66164           $ref: "#/getDefinitions/named-query"
66165   service-instance:
66166     description: |
66167       Instance of a service
66168       ###### Related Nodes
66169       - TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
66170       - TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
66171       - TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
66172       - TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
66173       - TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
66174       - TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
66175       - TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
66176       - TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
66177       - TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66178       - TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
66179       - TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
66180       - TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
66181       - TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
66182       - TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
66183       - TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
66184       - TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
66185       - FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
66186       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
66187       - FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
66188       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
66189       - SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
66190       - SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
66191     required:
66192     - service-instance-id
66193     - service-type
66194     - service-role
66195     - created-at
66196     - updated-at
66197     - description
66198     properties:
66199       service-instance-id:
66200         type: string
66201         description: Uniquely identifies this instance of a service
66202       service-instance-name:
66203         type: string
66204         description: This field will store a name assigned to the service-instance.
66205       service-type:
66206         type: string
66207         description: String capturing type of service.
66208       service-role:
66209         type: string
66210         description: String capturing the service role.
66211       environment-context:
66212         type: string
66213         description: This field will store the environment context assigned to the service-instance.
66214       workload-context:
66215         type: string
66216         description: This field will store the workload context assigned to the service-instance.
66217       created-at:
66218         type: string
66219         description: create time of Network Service.
66220       updated-at:
66221         type: string
66222         description: last update of Network Service.
66223       description:
66224         type: string
66225         description: short description for service-instance.
66226       model-invariant-id:
66227         type: string
66228         description: the ASDC model id for this resource or service model.
66229       model-version-id:
66230         type: string
66231         description: the ASDC model version for this resource or service model.
66232       persona-model-version:
66233         type: string
66234         description: the ASDC model version for this resource or service model.
66235       widget-model-id:
66236         type: string
66237         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
66238       widget-model-version:
66239         type: string
66240         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
66241       bandwidth-total:
66242         type: string
66243         description: Indicates the total bandwidth to be used for this service.
66244       bandwidth-up-wan1:
66245         type: string
66246         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
66247       bandwidth-down-wan1:
66248         type: string
66249         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
66250       bandwidth-up-wan2:
66251         type: string
66252         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
66253       bandwidth-down-wan2:
66254         type: string
66255         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
66256       vhn-portal-url:
66257         type: string
66258         description: URL customers will use to access the vHN Portal.
66259       service-instance-location-id:
66260         type: string
66261         description: An identifier that customers assign to the location where this service is being used.
66262       resource-version:
66263         type: string
66264         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66265       selflink:
66266         type: string
66267         description: Path to the controller object.
66268       orchestration-status:
66269         type: string
66270         description: Orchestration status of this service.
66271       relationship-list:
66272         type: array
66273         items:
66274           $ref: "#/getDefinitions/relationship"
66275       metadata:
66276         type: array
66277         items:
66278           $ref: "#/getDefinitions/metadatum"
66279       allotted-resources:
66280         type: array
66281         items:
66282           $ref: "#/getDefinitions/allotted-resource"
66283   service-instances:
66284     description: |
66285       Collection of service instances
66286     properties:
66287       service-instance:
66288         type: array
66289         items:
66290           $ref: "#/getDefinitions/service-instance"
66291   service-subscription:
66292     description: |
66293       Object that group service instances.
66294       ###### Related Nodes
66295       - TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
66296       - TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
66297       - FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
66298       - SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
66299     required:
66300     - service-type
66301     properties:
66302       service-type:
66303         type: string
66304         description: Value defined by orchestration to identify this service across ECOMP.
66305       temp-ub-sub-account-id:
66306         type: string
66307         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
66308       resource-version:
66309         type: string
66310         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66311       service-instances:
66312         type: array
66313         items:
66314           $ref: "#/getDefinitions/service-instance"
66315       relationship-list:
66316         type: array
66317         items:
66318           $ref: "#/getDefinitions/relationship"
66319   service-subscriptions:
66320     description: |
66321       Collection of objects that group service instances.
66322     properties:
66323       service-subscription:
66324         type: array
66325         items:
66326           $ref: "#/getDefinitions/service-subscription"
66327   services:
66328     description: |
66329       Collection of service model definitions.  Likely to be deprecated in favor of models from ASDC.
66330     properties:
66331       service:
66332         type: array
66333         items:
66334           $ref: "#/getDefinitions/service"
66335   site-pair:
66336     description: |
66337       ###### Related Nodes
66338       - TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
66339       - FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
66340       - SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
66341     required:
66342     - site-pair-id
66343     properties:
66344       site-pair-id:
66345         type: string
66346         description: unique identifier of probe
66347       source-ip:
66348         type: string
66349         description: Prefix address
66350       destination-ip:
66351         type: string
66352         description: Prefix address
66353       ip-version:
66354         type: string
66355         description: ip version, v4, v6
66356       destination-hostname:
66357         type: string
66358         description: Hostname of the destination equipment to which SLAs are measured against.
66359       destination-equip-type:
66360         type: string
66361         description: The type of destinatination equipment. Could be Router, UCPE, etc.
66362       resource-version:
66363         type: string
66364         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66365       classes-of-service:
66366         type: array
66367         items:
66368           $ref: "#/getDefinitions/class-of-service"
66369       relationship-list:
66370         type: array
66371         items:
66372           $ref: "#/getDefinitions/relationship"
66373   site-pair-set:
66374     description: |
66375       Set of instances for probes used to measure service level agreements
66376       ###### Related Nodes
66377       - TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
66378       - FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
66379       - SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
66380     required:
66381     - site-pair-set-id
66382     properties:
66383       site-pair-set-id:
66384         type: string
66385         description: Unique id of site pair set.
66386       resource-version:
66387         type: string
66388         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66389       routing-instances:
66390         type: array
66391         items:
66392           $ref: "#/getDefinitions/routing-instance"
66393       relationship-list:
66394         type: array
66395         items:
66396           $ref: "#/getDefinitions/relationship"
66397   site-pair-sets:
66398     description: |
66399       Collection of sets of instances for probes related to generic-vnf
66400     properties:
66401       site-pair-set:
66402         type: array
66403         items:
66404           $ref: "#/getDefinitions/site-pair-set"
66405   site-pairs:
66406     description: |
66407       probe within a set
66408     properties:
66409       site-pair:
66410         type: array
66411         items:
66412           $ref: "#/getDefinitions/site-pair"
66413   snapshot:
66414     description: |
66415       Openstack snapshot
66416       ###### Related Nodes
66417       - TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66418       - FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
66419     required:
66420     - snapshot-id
66421     properties:
66422       snapshot-id:
66423         type: string
66424         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
66425       snapshot-name:
66426         type: string
66427         description: Snapshot name
66428       snapshot-architecture:
66429         type: string
66430         description: Operating system architecture
66431       snapshot-os-distro:
66432         type: string
66433         description: The common name of the operating system distribution in lowercase
66434       snapshot-os-version:
66435         type: string
66436         description: The operating system version as specified by the distributor.
66437       application:
66438         type: string
66439         description: The application that the image instantiates.
66440       application-vendor:
66441         type: string
66442         description: The vendor of the application.
66443       application-version:
66444         type: string
66445         description: The version of the application.
66446       snapshot-selflink:
66447         type: string
66448         description: URL to endpoint where AAI can get more details
66449       prev-snapshot-id:
66450         type: string
66451         description: This field contains the UUID of the previous snapshot (if any).
66452       resource-version:
66453         type: string
66454         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66455       relationship-list:
66456         type: array
66457         items:
66458           $ref: "#/getDefinitions/relationship"
66459   snapshots:
66460     description: |
66461       Collection of openstack snapshots
66462     properties:
66463       snapshot:
66464         type: array
66465         items:
66466           $ref: "#/getDefinitions/snapshot"
66467   sriov-pf:
66468     description: |
66469       SR-IOV Physical Function
66470       ###### Related Nodes
66471       - TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
66472       - FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
66473     required:
66474     - pf-pci-id
66475     properties:
66476       pf-pci-id:
66477         type: string
66478         description: Identifier for the sriov-pf
66479       resource-version:
66480         type: string
66481         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66482       relationship-list:
66483         type: array
66484         items:
66485           $ref: "#/getDefinitions/relationship"
66486   sriov-pfs:
66487     description: |
66488       Collection of SR-IOV Physical Functions.
66489     properties:
66490       sriov-pf:
66491         type: array
66492         items:
66493           $ref: "#/getDefinitions/sriov-pf"
66494   sriov-vf:
66495     description: |
66496       SR-IOV Virtual Function (not to be confused with virtual network function)
66497       ###### Related Nodes
66498       - TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
66499       - TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
66500     required:
66501     - pci-id
66502     properties:
66503       pci-id:
66504         type: string
66505         description: PCI ID used to identify the sriov-vf
66506       vf-vlan-filter:
66507         type: string
66508         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
66509       vf-mac-filter:
66510         type: string
66511         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
66512       vf-vlan-strip:
66513         type: boolean
66514         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
66515       vf-vlan-anti-spoof-check:
66516         type: boolean
66517         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.
66518       vf-mac-anti-spoof-check:
66519         type: boolean
66520         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.
66521       vf-mirrors:
66522         type: string
66523         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
66524       vf-broadcast-allow:
66525         type: boolean
66526         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
66527       vf-unknown-multicast-allow:
66528         type: boolean
66529         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
66530       vf-unknown-unicast-allow:
66531         type: boolean
66532         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
66533       vf-insert-stag:
66534         type: boolean
66535         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
66536       vf-link-status:
66537         type: string
66538         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
66539       resource-version:
66540         type: string
66541         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66542       neutron-network-id:
66543         type: string
66544         description: Neutron network id of the interface
66545       relationship-list:
66546         type: array
66547         items:
66548           $ref: "#/getDefinitions/relationship"
66549   sriov-vfs:
66550     description: |
66551       Collection of SR-IOV Virtual Functions.
66552     properties:
66553       sriov-vf:
66554         type: array
66555         items:
66556           $ref: "#/getDefinitions/sriov-vf"
66557   start-node-filter:
66558     properties:
66559       property-name:
66560         type: string
66561       property-value:
66562         type: string
66563   subnet:
66564     description: |
66565       ###### Related Nodes
66566       - TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
66567       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66568       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
66569       - FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
66570       - FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
66571       - FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
66572       - SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
66573       - SUBNET is DELETED when these are DELETED HOST-ROUTE
66574     required:
66575     - subnet-id
66576     - dhcp-enabled
66577     properties:
66578       subnet-id:
66579         type: string
66580         description: Subnet ID, should be UUID.
66581       subnet-name:
66582         type: string
66583         description: Name associated with the subnet.
66584       neutron-subnet-id:
66585         type: string
66586         description: Neutron id of this subnet
66587       gateway-address:
66588         type: string
66589         description: gateway ip address
66590       network-start-address:
66591         type: string
66592         description: network start address
66593       cidr-mask:
66594         type: string
66595         description: cidr mask
66596       ip-version:
66597         type: string
66598         description: ip version
66599       orchestration-status:
66600         type: string
66601         description: Orchestration status of this VNF, mastered by MSO
66602       dhcp-enabled:
66603         type: boolean
66604       dhcp-start:
66605         type: string
66606         description: the start address reserved for use by dhcp
66607       dhcp-end:
66608         type: string
66609         description: the last address reserved for use by dhcp
66610       subnet-role:
66611         type: string
66612         description: role of the subnet, referenced when assigning IPs
66613       ip-assignment-direction:
66614         type: string
66615         description: ip address assignment direction of the subnet
66616       resource-version:
66617         type: string
66618         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66619       subnet-sequence:
66620         type: integer
66621         format: int32
66622         description: sequence of the subnet
66623       host-routes:
66624         type: array
66625         items:
66626           $ref: "#/getDefinitions/host-route"
66627       relationship-list:
66628         type: array
66629         items:
66630           $ref: "#/getDefinitions/relationship"
66631   subnets:
66632     properties:
66633       subnet:
66634         type: array
66635         items:
66636           $ref: "#/getDefinitions/subnet"
66637   tagged-inventory-item-list:
66638     properties:
66639       inventory-item:
66640         type: array
66641         items:
66642           $ref: "#/getDefinitions/inventory-item"
66643   tenant:
66644     description: |
66645       Openstack tenant
66646       ###### Related Nodes
66647       - TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66648       - TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
66649       - TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
66650       - TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
66651       - FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
66652       - FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
66653       - TENANT cannot be deleted if linked to VSERVER
66654     required:
66655     - tenant-id
66656     - tenant-name
66657     properties:
66658       tenant-id:
66659         type: string
66660         description: Unique id relative to the cloud-region.
66661       tenant-name:
66662         type: string
66663         description: Readable name of tenant
66664       tenant-context:
66665         type: string
66666         description: This field will store the tenant context.
66667       resource-version:
66668         type: string
66669         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66670       vservers:
66671         type: array
66672         items:
66673           $ref: "#/getDefinitions/vserver"
66674       relationship-list:
66675         type: array
66676         items:
66677           $ref: "#/getDefinitions/relationship"
66678   tenants:
66679     description: |
66680       Collection of openstack tenants.
66681     properties:
66682       tenant:
66683         type: array
66684         items:
66685           $ref: "#/getDefinitions/tenant"
66686   tunnel-xconnect:
66687     description: |
66688       Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
66689       ###### Related Nodes
66690       - TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
66691     required:
66692     - id
66693     - bandwidth-up-wan1
66694     - bandwidth-down-wan1
66695     - bandwidth-up-wan2
66696     - bandwidth-down-wan2
66697     properties:
66698       id:
66699         type: string
66700         description: Allotted Resource id UUID assigned to this instance.
66701       bandwidth-up-wan1:
66702         type: string
66703         description: The WAN uplink bandwidth for WAN1
66704       bandwidth-down-wan1:
66705         type: string
66706         description: The WAN downlink bandwidth for WAN1
66707       bandwidth-up-wan2:
66708         type: string
66709         description: The WAN uplink bandwidth for WAN2
66710       bandwidth-down-wan2:
66711         type: string
66712         description: The WAN downlink bandwidth for WAN2
66713       resource-version:
66714         type: string
66715         description: Concurrency value
66716       relationship-list:
66717         type: array
66718         items:
66719           $ref: "#/getDefinitions/relationship"
66720   tunnel-xconnects:
66721     description: |
66722       This object is used to store the specific tunnel cross connect aspects of an allotted resource
66723     properties:
66724       tunnel-xconnect:
66725         type: array
66726         items:
66727           $ref: "#/getDefinitions/tunnel-xconnect"
66728   update:
66729     description: |
66730       Serves a PATCH like function.  Does not enforce concurrency control.  Clear each usage with AAI team.
66731     required:
66732     - update-node-type
66733     properties:
66734       update-node-type:
66735         type: string
66736       update-node-key:
66737         type: array
66738         items:
66739           $ref: "#/getDefinitions/update-node-key"
66740       update-node-uri:
66741         type: string
66742       action:
66743         type: array
66744         items:
66745           $ref: "#/getDefinitions/action"
66746   update-node-key:
66747     properties:
66748       key-name:
66749         type: string
66750       key-value:
66751         type: string
66752   vce:
66753     description: |
66754       Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
66755       ###### Related Nodes
66756       - TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
66757       - TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
66758       - TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
66759       - FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66760       - FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66761       - FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
66762       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
66763       - VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
66764     required:
66765     - vnf-id
66766     - vnf-name
66767     - vnf-type
66768     properties:
66769       vnf-id:
66770         type: string
66771         description: Unique id of VNF.  This is unique across the graph.
66772       vnf-name:
66773         type: string
66774         description: Name of VNF.
66775       vnf-name2:
66776         type: string
66777         description: Alternate name of VNF.
66778       vnf-type:
66779         type: string
66780         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.
66781       service-id:
66782         type: string
66783         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
66784       regional-resource-zone:
66785         type: string
66786         description: Regional way of organizing pservers, source of truth should define values
66787       prov-status:
66788         type: string
66789         description: Trigger for operational monitoring of this resource by Service Assurance systems.
66790       operational-status:
66791         type: string
66792         description: Indicator for whether the resource is considered operational
66793       license-key:
66794         type: string
66795         description: OBSOLETE -  do not use
66796       equipment-role:
66797         type: string
66798         description: Network role being played by this VNF
66799       orchestration-status:
66800         type: string
66801         description: Orchestration status of this VNF, mastered by MSO
66802       heat-stack-id:
66803         type: string
66804         description: Heat stack id corresponding to this instance, managed by MSO
66805       mso-catalog-key:
66806         type: string
66807         description: Corresponds to the SDN-C catalog id used to configure this VCE
66808       vpe-id:
66809         type: string
66810         description: Unique ID of VPE connected to this VCE.
66811       v6-vce-wan-address:
66812         type: string
66813         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
66814       ipv4-oam-address:
66815         type: string
66816         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
66817       resource-version:
66818         type: string
66819         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66820       ipv4-loopback0-address:
66821         type: string
66822         description: Loopback0 address
66823       entitlement-resource-uuid:
66824         type: string
66825         description: OBSOLETE -  see child relationships
66826       port-groups:
66827         type: array
66828         items:
66829           $ref: "#/getDefinitions/port-group"
66830       licenses:
66831         type: array
66832         items:
66833           $ref: "#/getDefinitions/license"
66834       entitlements:
66835         type: array
66836         items:
66837           $ref: "#/getDefinitions/entitlement"
66838       relationship-list:
66839         type: array
66840         items:
66841           $ref: "#/getDefinitions/relationship"
66842   vces:
66843     description: |
66844       Collection of Virtual Customer Edge Routers, used specifically for Gamma.  This object is deprecated.
66845     properties:
66846       vce:
66847         type: array
66848         items:
66849           $ref: "#/getDefinitions/vce"
66850   vf-module:
66851     description: |
66852       a deployment unit of VNFCs
66853       ###### Related Nodes
66854       - TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
66855       - TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
66856       - TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
66857       - TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
66858       - TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
66859       - VF-MODULE cannot be deleted if linked to VNFC
66860     required:
66861     - vf-module-id
66862     - is-base-vf-module
66863     properties:
66864       vf-module-id:
66865         type: string
66866         description: Unique ID of vf-module.
66867       vf-module-name:
66868         type: string
66869         description: Name of vf-module
66870       heat-stack-id:
66871         type: string
66872         description: Heat stack id corresponding to this instance.
66873       orchestration-status:
66874         type: string
66875         description: orchestration status of this vf-module, mastered by MSO
66876       is-base-vf-module:
66877         type: boolean
66878       resource-version:
66879         type: string
66880         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66881       model-invariant-id:
66882         type: string
66883         description: the ASDC model id for this resource or service model.
66884       model-version-id:
66885         type: string
66886         description: the ASDC model version for this resource or service model.
66887       persona-model-version:
66888         type: string
66889         description: the ASDC model version for this resource or service model.
66890       model-customization-id:
66891         type: string
66892         description: captures the id of all the configuration used to customize the resource for the service.
66893       widget-model-id:
66894         type: string
66895         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
66896       widget-model-version:
66897         type: string
66898         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
66899       contrail-service-instance-fqdn:
66900         type: string
66901         description: the Contrail unique ID for a service-instance
66902       module-index:
66903         type: integer
66904         format: int32
66905         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
66906       selflink:
66907         type: string
66908         description: Path to the controller object.
66909       relationship-list:
66910         type: array
66911         items:
66912           $ref: "#/getDefinitions/relationship"
66913   vf-modules:
66914     description: |
66915       Collection of vf-modules, a deployment unit of VNFCs
66916     properties:
66917       vf-module:
66918         type: array
66919         items:
66920           $ref: "#/getDefinitions/vf-module"
66921   vig-server:
66922     description: |
66923       vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
66924       ###### Related Nodes
66925       - TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
66926     required:
66927     - vig-address-type
66928     properties:
66929       vig-address-type:
66930         type: string
66931         description: indicates whether the VIG is for AVPN or INTERNET
66932       ipaddress-v4-vig:
66933         type: string
66934         description: v4 IP of the vig server
66935       ipaddress-v6-vig:
66936         type: string
66937         description: v6 IP of the vig server
66938       resource-version:
66939         type: string
66940         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66941       relationship-list:
66942         type: array
66943         items:
66944           $ref: "#/getDefinitions/relationship"
66945   vig-servers:
66946     properties:
66947       vig-server:
66948         type: array
66949         items:
66950           $ref: "#/getDefinitions/vig-server"
66951   vip-ipv4-address-list:
66952     description: |
66953       IPv4 Address Range
66954       ###### Related Nodes
66955       - TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66956       - TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66957       - TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
66958       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
66959     required:
66960     - vip-ipv4-address
66961     properties:
66962       vip-ipv4-address:
66963         type: string
66964         description: IP address
66965       vip-ipv4-prefix-length:
66966         type: integer
66967         format: int64
66968         description: Prefix length, 32 for single address
66969       vlan-id-inner:
66970         type: integer
66971         format: int64
66972         description: Inner VLAN tag
66973       vlan-id-outer:
66974         type: integer
66975         format: int64
66976         description: Outer VLAN tag
66977       is-floating:
66978         type: boolean
66979         description: Indicator of fixed or floating address
66980       resource-version:
66981         type: string
66982         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
66983       neutron-network-id:
66984         type: string
66985         description: Neutron network id of the interface that address belongs to
66986       neutron-subnet-id:
66987         type: string
66988         description: Neutron id of subnet that address belongs to
66989       relationship-list:
66990         type: array
66991         items:
66992           $ref: "#/getDefinitions/relationship"
66993   vip-ipv6-address-list:
66994     description: |
66995       IPv6 Address Range
66996       ###### Related Nodes
66997       - TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
66998       - TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
66999       - TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
67000       - FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
67001     required:
67002     - vip-ipv6-address
67003     properties:
67004       vip-ipv6-address:
67005         type: string
67006         description: IP address
67007       vip-ipv6-prefix-length:
67008         type: integer
67009         format: int64
67010         description: Prefix length, 128 for single address
67011       vlan-id-inner:
67012         type: integer
67013         format: int64
67014         description: Inner VLAN tag
67015       vlan-id-outer:
67016         type: integer
67017         format: int64
67018         description: Outer VLAN tag
67019       is-floating:
67020         type: boolean
67021         description: Indicator of fixed or floating address
67022       resource-version:
67023         type: string
67024         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67025       neutron-network-id:
67026         type: string
67027         description: Neutron network id of the interface that address belongs to
67028       neutron-subnet-id:
67029         type: string
67030         description: Neutron id of subnet that address belongs to
67031       relationship-list:
67032         type: array
67033         items:
67034           $ref: "#/getDefinitions/relationship"
67035   virtual-data-center:
67036     description: |
67037       Virtual organization of cloud infrastructure elements in a data center context
67038       ###### Related Nodes
67039       - FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
67040       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
67041       - FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
67042     required:
67043     - vdc-id
67044     - vdc-name
67045     properties:
67046       vdc-id:
67047         type: string
67048         description: Unique ID of the vdc
67049       vdc-name:
67050         type: string
67051         description: Name of the virtual data center
67052       resource-version:
67053         type: string
67054         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67055       relationship-list:
67056         type: array
67057         items:
67058           $ref: "#/getDefinitions/relationship"
67059   virtual-data-centers:
67060     description: |
67061       Virtual organization of cloud infrastructure elements in a data center context
67062     properties:
67063       virtual-data-center:
67064         type: array
67065         items:
67066           $ref: "#/getDefinitions/virtual-data-center"
67067   vlan:
67068     description: |
67069       Definition of vlan
67070       ###### Related Nodes
67071       - TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
67072       - TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
67073       - TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
67074       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
67075       - FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
67076       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
67077       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
67078       - VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
67079       - VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
67080     required:
67081     - vlan-interface
67082     - in-maint
67083     - is-ip-unnumbered
67084     properties:
67085       vlan-interface:
67086         type: string
67087         description: String that identifies the interface
67088       vlan-id-inner:
67089         type: integer
67090         format: int64
67091         description: Inner VLAN tag
67092       vlan-id-outer:
67093         type: integer
67094         format: int64
67095         description: Outer VLAN tag
67096       resource-version:
67097         type: string
67098         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67099       speed-value:
67100         type: string
67101         description: Captures the numeric part of the speed
67102       speed-units:
67103         type: string
67104         description: Captures the units corresponding to the speed
67105       vlan-description:
67106         type: string
67107         description: Used to describe (the service associated with) the vlan
67108       backdoor-connection:
67109         type: string
67110         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
67111       vpn-key:
67112         type: string
67113         description: This indicates the customers VPN ID associated with this vlan
67114       orchestration-status:
67115         type: string
67116         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
67117       in-maint:
67118         type: boolean
67119       prov-status:
67120         type: string
67121         description: Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
67122       is-ip-unnumbered:
67123         type: boolean
67124       relationship-list:
67125         type: array
67126         items:
67127           $ref: "#/getDefinitions/relationship"
67128       l3-interface-ipv4-address-list:
67129         type: array
67130         items:
67131           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
67132       l3-interface-ipv6-address-list:
67133         type: array
67134         items:
67135           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
67136   vlans:
67137     properties:
67138       vlan:
67139         type: array
67140         items:
67141           $ref: "#/getDefinitions/vlan"
67142   vnf:
67143     description: |
67144       Abstract vnf class
67145     required:
67146     - vnf-id
67147     properties:
67148       vnf-id:
67149         type: string
67150         description: Unique id of VNF.  This is unique across the graph.
67151   vnf-image:
67152     description: |
67153       Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
67154       ###### Related Nodes
67155       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
67156       - VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
67157     required:
67158     - vnf-image-uuid
67159     - application
67160     - application-vendor
67161     properties:
67162       vnf-image-uuid:
67163         type: string
67164         description: Unique ID of this asset
67165       application:
67166         type: string
67167         description: The application that the image instantiates.
67168       application-vendor:
67169         type: string
67170         description: The vendor of the application.
67171       application-version:
67172         type: string
67173         description: The version of the application.
67174       selflink:
67175         type: string
67176         description: URL to endpoint where AAI can get more details
67177       resource-version:
67178         type: string
67179         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67180       relationship-list:
67181         type: array
67182         items:
67183           $ref: "#/getDefinitions/relationship"
67184   vnf-images:
67185     description: |
67186       Collection of image objects that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
67187     properties:
67188       vnf-image:
67189         type: array
67190         items:
67191           $ref: "#/getDefinitions/vnf-image"
67192   vnfc:
67193     description: |
67194       ###### Related Nodes
67195       - TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
67196       - TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
67197       - TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
67198       - TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
67199       - TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
67200       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
67201       - FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
67202       - FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
67203       - VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
67204     required:
67205     - vnfc-name
67206     - nfc-naming-code
67207     - nfc-function
67208     - in-maint
67209     - is-closed-loop-disabled
67210     properties:
67211       vnfc-name:
67212         type: string
67213         description: Unique ID of vnfc.
67214       nfc-naming-code:
67215         type: string
67216         description: Short code that is used in naming instances of the item being modeled
67217       nfc-function:
67218         type: string
67219         description: English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
67220       prov-status:
67221         type: string
67222         description: prov status of this vnfc
67223       orchestration-status:
67224         type: string
67225         description: Orchestration status of this VNF, mastered by APP-C
67226       ipaddress-v4-oam-vip:
67227         type: string
67228         description: Oam V4 vip address of this vnfc
67229       in-maint:
67230         type: boolean
67231       is-closed-loop-disabled:
67232         type: boolean
67233       group-notation:
67234         type: string
67235         description: Group notation of VNFC
67236       model-invariant-id:
67237         type: string
67238         description: the ASDC model id for this resource or service model.
67239       model-version-id:
67240         type: string
67241         description: the ASDC model version for this resource or service model.
67242       resource-version:
67243         type: string
67244         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67245       relationship-list:
67246         type: array
67247         items:
67248           $ref: "#/getDefinitions/relationship"
67249       l3-interface-ipv4-address-list:
67250         type: array
67251         items:
67252           $ref: "#/getDefinitions/l3-interface-ipv4-address-list"
67253       l3-interface-ipv6-address-list:
67254         type: array
67255         items:
67256           $ref: "#/getDefinitions/l3-interface-ipv6-address-list"
67257   vnfcs:
67258     description: |
67259       virtual network components associated with a vserver from application controller.
67260     properties:
67261       vnfc:
67262         type: array
67263         items:
67264           $ref: "#/getDefinitions/vnfc"
67265   volume:
67266     description: |
67267       Ephemeral Block storage volume.
67268       ###### Related Nodes
67269       - FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
67270     required:
67271     - volume-id
67272     - volume-selflink
67273     properties:
67274       volume-id:
67275         type: string
67276         description: Unique ID of block storage volume relative to the vserver.
67277       volume-selflink:
67278         type: string
67279         description: URL to endpoint where AAI can get more details
67280       resource-version:
67281         type: string
67282         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67283       relationship-list:
67284         type: array
67285         items:
67286           $ref: "#/getDefinitions/relationship"
67287   volume-group:
67288     description: |
67289       Persistent block-level storage.
67290       ###### Related Nodes
67291       - TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
67292       - TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67293       - FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
67294       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
67295       - FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
67296     required:
67297     - volume-group-id
67298     - volume-group-name
67299     - vnf-type
67300     properties:
67301       volume-group-id:
67302         type: string
67303         description: Unique ID of volume-group.
67304       volume-group-name:
67305         type: string
67306         description: Name of the volume group.
67307       heat-stack-id:
67308         type: string
67309         description: Heat stack id corresponding to this volume-group
67310       vnf-type:
67311         type: string
67312         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.
67313       orchestration-status:
67314         type: string
67315         description: Orchestration status of this volume-group
67316       model-customization-id:
67317         type: string
67318         description: captures the id of all the configuration used to customize the resource for the service.
67319       vf-module-model-customization-id:
67320         type: string
67321         description: helps relate the volume group to the vf-module whose components will require the volume group
67322       resource-version:
67323         type: string
67324         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67325       relationship-list:
67326         type: array
67327         items:
67328           $ref: "#/getDefinitions/relationship"
67329   volume-groups:
67330     description: |
67331       Collection of persistent block-level storage.
67332     properties:
67333       volume-group:
67334         type: array
67335         items:
67336           $ref: "#/getDefinitions/volume-group"
67337   volumes:
67338     description: |
67339       Collection of ephemeral Block storage volumes.
67340     properties:
67341       volume:
67342         type: array
67343         items:
67344           $ref: "#/getDefinitions/volume"
67345   vpls-pe:
67346     description: |
67347       VPLS Provider Edge routers.
67348       ###### Related Nodes
67349       - TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67350       - TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
67351       - FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
67352       - FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
67353       - VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
67354     required:
67355     - equipment-name
67356     properties:
67357       equipment-name:
67358         type: string
67359       prov-status:
67360         type: string
67361         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
67362       ipv4-oam-address:
67363         type: string
67364         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).
67365       equipment-role:
67366         type: string
67367         description: Client should send valid enumerated value, e.g., VPLS-PE.
67368       vlan-id-outer:
67369         type: integer
67370         format: int64
67371         description: Temporary location for stag to get to VCE
67372       resource-version:
67373         type: string
67374         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67375       relationship-list:
67376         type: array
67377         items:
67378           $ref: "#/getDefinitions/relationship"
67379       p-interfaces:
67380         type: array
67381         items:
67382           $ref: "#/getDefinitions/p-interface"
67383       lag-interfaces:
67384         type: array
67385         items:
67386           $ref: "#/getDefinitions/lag-interface"
67387   vpls-pes:
67388     description: |
67389       Collection of VPLS Provider Edge routers
67390     properties:
67391       vpls-pe:
67392         type: array
67393         items:
67394           $ref: "#/getDefinitions/vpls-pe"
67395   vpn-binding:
67396     description: |
67397       VPN binding
67398       ###### Related Nodes
67399       - FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
67400       - FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
67401       - FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
67402       - FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
67403       - VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
67404       - VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
67405     required:
67406     - vpn-id
67407     - vpn-name
67408     properties:
67409       vpn-id:
67410         type: string
67411         description: VPN ID, globally unique within A&AI
67412       vpn-name:
67413         type: string
67414         description: VPN Name
67415       vpn-platform:
67416         type: string
67417         description: the platform associated with the VPN example AVPN, Mobility
67418       vpn-type:
67419         type: string
67420         description: Type of the vpn, should be taken from enumerated/valid values
67421       vpn-region:
67422         type: string
67423         description: region of customer vpn
67424       customer-vpn-id:
67425         type: string
67426         description: id for this customer vpn
67427       route-distinguisher:
67428         type: string
67429         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
67430       resource-version:
67431         type: string
67432         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67433       route-targets:
67434         type: array
67435         items:
67436           $ref: "#/getDefinitions/route-target"
67437       relationship-list:
67438         type: array
67439         items:
67440           $ref: "#/getDefinitions/relationship"
67441         description: l3-networks relate to vpn-bindings
67442   vpn-bindings:
67443     properties:
67444       vpn-binding:
67445         type: array
67446         items:
67447           $ref: "#/getDefinitions/vpn-binding"
67448   vserver:
67449     description: |
67450       Virtual Servers, aka virtual machine or VM.
67451       ###### Related Nodes
67452       - TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
67453       - TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
67454       - TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
67455       - TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
67456       - TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
67457       - TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
67458       - FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
67459       - FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
67460       - FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
67461       - FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
67462       - FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
67463       - VSERVER is DELETED when these are DELETED L-INTERFACE
67464       - VSERVER deletion means associated objects of these types are also DELETED:VOLUME
67465     required:
67466     - vserver-id
67467     - vserver-name
67468     - vserver-selflink
67469     - in-maint
67470     - is-closed-loop-disabled
67471     properties:
67472       vserver-id:
67473         type: string
67474         description: Unique identifier for this vserver relative to its tenant
67475       vserver-name:
67476         type: string
67477         description: Name of vserver
67478       vserver-name2:
67479         type: string
67480         description: Alternative name of vserver
67481       prov-status:
67482         type: string
67483         description: Trigger for operational monitoring of this resource by Service Assurance systems.
67484       vserver-selflink:
67485         type: string
67486         description: URL to endpoint where AAI can get more details
67487       in-maint:
67488         type: boolean
67489       is-closed-loop-disabled:
67490         type: boolean
67491       resource-version:
67492         type: string
67493         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
67494       volumes:
67495         type: array
67496         items:
67497           $ref: "#/getDefinitions/volume"
67498       relationship-list:
67499         type: array
67500         items:
67501           $ref: "#/getDefinitions/relationship"
67502       l-interfaces:
67503         type: array
67504         items:
67505           $ref: "#/getDefinitions/l-interface"
67506   vservers:
67507     description: |
67508       Collection of virtual Servers, aka virtual machines or VMs.
67509     properties:
67510       vserver:
67511         type: array
67512         items:
67513           $ref: "#/getDefinitions/vserver"
67514   zone:
67515     description: |
67516       A zone is a grouping of assets in a location homing to the same connections into the CBB
67517       ###### Related Nodes
67518       - TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
67519       - FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67520       - FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67521       - FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67522       - FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
67523     required:
67524     - zone-id
67525     - zone-name
67526     - design-type
67527     - zone-context
67528     properties:
67529       zone-id:
67530         type: string
67531         description: Code assigned by AIC to the zone
67532       zone-name:
67533         type: string
67534         description: English name associated with the zone
67535       design-type:
67536         type: string
67537         description: Design of zone [Medium/Large?]
67538       zone-context:
67539         type: string
67540         description: Context of zone [production/test]
67541       status:
67542         type: string
67543         description: Status of a zone.
67544       resource-version:
67545         type: string
67546         description: Concurrency value
67547       relationship-list:
67548         type: array
67549         items:
67550           $ref: "#/getDefinitions/relationship"
67551   zones:
67552     description: |
67553       Collection of zones
67554     properties:
67555       zone:
67556         type: array
67557         items:
67558           $ref: "#/getDefinitions/zone"